mirror of
https://github.com/danbulant/docker-compose
synced 2026-05-19 04:18:32 +00:00
add readme to docs as first content
This commit is contained in:
Alexander Zeitler
GitHub
parent
2e405d4e88
commit
4475f70864
1 changed files with 110 additions and 126 deletions
236
docs/index.md
236
docs/index.md
|
|
@ -1,149 +1,133 @@
|
|||
---
|
||||
layout: default
|
||||
title: Markdown kitchen sink
|
||||
title: README
|
||||
nav_order: 99
|
||||
---
|
||||
|
||||
Text can be **bold**, _italic_, or ~~strikethrough~~.
|
||||
<img src="https://img.shields.io/circleci/project/github/PDMLab/docker-compose.svg" /> <a href="https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY"><img src="https://img.shields.io/badge/Slack-join-green.svg?logo=slack" /></a>
|
||||
|
||||
[Link to another page](another-page).
|
||||
# Manage Docker-Compose via Node.js
|
||||
|
||||
There should be whitespace between paragraphs.
|
||||
`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/)(which is still required) via Node.js. This is useful to bootstrap test environments. You might also generate your `docker-compose.yml` files using [composefile](https://www.npmjs.com/package/composefile).
|
||||
|
||||
There should be whitespace between paragraphs. We recommend including a README, or a file with information about your project.
|
||||
## Existing user? We need your help
|
||||
First of all: thanks for using the `docker-compose` module.
|
||||
As described in [#44][i44], we're planning to provide more guidance for CI/CD when using the `docker-compose` module and it would be great if you could support us here. More details in [#44][i44].
|
||||
|
||||
# [](#header-1)Header 1
|
||||
[i44]: https://github.com/PDMLab/docker-compose/issues/44
|
||||
|
||||
This is a normal paragraph following a header. GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
|
||||
## Installation
|
||||
|
||||
## [](#header-2)Header 2
|
||||
```
|
||||
npm install --save-dev docker-compose
|
||||
```
|
||||
|
||||
> This is a blockquote following a header.
|
||||
>
|
||||
> When something is important enough, you do it even if the odds are not in your favor.
|
||||
## Usage
|
||||
|
||||
### [](#header-3)Header 3
|
||||
`docker-compose` current supports these commands:
|
||||
|
||||
```js
|
||||
// Javascript code with syntax highlighting.
|
||||
var fun = function lang(l) {
|
||||
dateformat.i18n = require('./lang/' + l)
|
||||
return true;
|
||||
* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
|
||||
* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
|
||||
* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
|
||||
* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
|
||||
* `kill(options)` - Force stop service containers
|
||||
* `stop(options)` - Stop running containers without removing them
|
||||
* `rm(options)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode
|
||||
* `exec(container, command, options)` - Exec `command` inside `container`, uses `-T` to properly handle stdin & stdout
|
||||
* `logs(container, command, options)` - Show logs of service. Use `options.follow` `true|false` to turn on `--follow` flag.
|
||||
* `run(service, command, options)` - Run a one-off `command` on a service, uses `-T` to properly handle stdin & stdout
|
||||
* `buildAll(options)` - Build or rebuild services
|
||||
* `buildMany(services, options)` - Build or rebuild services
|
||||
* `buildOne(service, options)` - Build or rebuild service
|
||||
* `restartAll(options)` - Restart all services
|
||||
* `restartMany(services, options)` - Restart services
|
||||
* `restartOne(service, options)` - Restart service
|
||||
* `ps(options)` - Lists containers information
|
||||
* `config(options)` - Validates configuration files and returns configuration yaml
|
||||
* `configServices(options)` - Returns list of services defined in configuration files
|
||||
* `configVolumes(options)` - Returns list of volumes defined in configuration files
|
||||
|
||||
All commands return a `Promise({object})` with stdout and stderr strings and an exit code:
|
||||
```javascript
|
||||
{
|
||||
out: 'stdout contents',
|
||||
err: 'stderr contents',
|
||||
exitCode: 0, // !== 0 in case of an error
|
||||
}
|
||||
```
|
||||
|
||||
```ruby
|
||||
# Ruby code with syntax highlighting
|
||||
GitHubPages::Dependencies.gems.each do |gem, version|
|
||||
s.add_dependency(gem, "= #{version}")
|
||||
end
|
||||
### Example
|
||||
|
||||
To start service containers based on the `docker-compose.yml` file in your current directory, just call `compose.up` like this:
|
||||
|
||||
```javascript
|
||||
compose.upAll({ cwd: path.join(__dirname), log: true })
|
||||
.then(
|
||||
() => { console.log('done')},
|
||||
err => { console.log('something went wrong:', err.message)}
|
||||
);
|
||||
```
|
||||
|
||||
#### [](#header-4)Header 4
|
||||
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
|
||||
##### [](#header-5)Header 5
|
||||
|
||||
1. This is an ordered list following a header.
|
||||
2. This is an ordered list following a header.
|
||||
3. This is an ordered list following a header.
|
||||
|
||||
###### [](#header-6)Header 6
|
||||
|
||||
| head1 | head two | three |
|
||||
|:-------------|:------------------|:------|
|
||||
| ok | good swedish fish | nice |
|
||||
| out of stock | good and plenty | nice |
|
||||
| ok | good `oreos` | hmm |
|
||||
| ok | good `zoute` drop | yumm |
|
||||
|
||||
### There's a horizontal rule below this.
|
||||
|
||||
* * *
|
||||
|
||||
### Here is an unordered list:
|
||||
|
||||
* Item foo
|
||||
* Item bar
|
||||
* Item baz
|
||||
* Item zip
|
||||
|
||||
### And an ordered list:
|
||||
|
||||
1. Item one
|
||||
1. Item two
|
||||
1. Item three
|
||||
1. Item four
|
||||
|
||||
### And a nested list:
|
||||
|
||||
- level 1 item
|
||||
- level 2 item
|
||||
- level 2 item
|
||||
- level 3 item
|
||||
- level 3 item
|
||||
- level 1 item
|
||||
- level 2 item
|
||||
- level 2 item
|
||||
- level 2 item
|
||||
- level 1 item
|
||||
- level 2 item
|
||||
- level 2 item
|
||||
- level 1 item
|
||||
|
||||
### Nesting an ol in ul in an ol
|
||||
|
||||
- level 1 item (ul)
|
||||
1. level 2 item (ol)
|
||||
1. level 2 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
- level 1 item (ul)
|
||||
1. level 2 item (ol)
|
||||
1. level 2 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
1. level 4 item (ol)
|
||||
1. level 4 item (ol)
|
||||
- level 3 item (ul)
|
||||
- level 3 item (ul)
|
||||
- level 1 item (ul)
|
||||
|
||||
### And a task list
|
||||
|
||||
- [ ] Hello, this is a TODO item
|
||||
- [ ] Hello, this is another TODO item
|
||||
- [x] Goodbye, this item is done
|
||||
|
||||
### Small image
|
||||
|
||||
|
||||
|
||||
### Large image
|
||||
|
||||
|
||||
|
||||
|
||||
### Definition lists can be used with HTML syntax.
|
||||
|
||||
<dl>
|
||||
<dt>Name</dt>
|
||||
<dd>Godzilla</dd>
|
||||
<dt>Born</dt>
|
||||
<dd>1952</dd>
|
||||
<dt>Birthplace</dt>
|
||||
<dd>Japan</dd>
|
||||
<dt>Color</dt>
|
||||
<dd>Green</dd>
|
||||
</dl>
|
||||
|
||||
```
|
||||
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
||||
To execute command inside a running container
|
||||
```javascript
|
||||
compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
`docker-compose` accepts these params:
|
||||
|
||||
* `cwd {string}`: mandatory folder path to the `docker-compose.yml`
|
||||
* `config {(string|string[])}`: custom and/or multiple yml files can be specified (relative to `cwd`)
|
||||
* `[log] {boolean}`: optional setting to enable console logging (output of `docker-compose` `stdout`/`stderr` output)
|
||||
* `[composeOptions] string[]|Array<string|string[]`: pass optional compose options like `"--verbose"` or `[["--verbose"], ["--log-level", "DEBUG"]]` or `["--verbose", ["--loglevel", "DEBUG"]]` for *all* commands.
|
||||
* `[commandOptions] string[]|Array<string|string[]`: pass optional command options like `"--build"` or `[["--build"], ["--timeout", "5"]]` or `["--build", ["--timeout", "5"]]` for the `up` command. Viable `commandOptions` depend on the command (`up`, `down` etc.) itself
|
||||
|
||||
## Running the tests
|
||||
|
||||
While `docker-compose` runs on Node.js 6+, running the tests requires you to use Node.js 8 as they make use of `async/await`.
|
||||
|
||||
```
|
||||
The final element.
|
||||
npm test
|
||||
```
|
||||
|
||||
## Want to help?
|
||||
|
||||
This project is just getting off the ground and could use some help with cleaning things up and refactoring.
|
||||
|
||||
If you want to contribute - we'd love it! Just open an issue to work against so you get full credit for your fork. You can open the issue first so we can discuss and you can work your fork as we go along.
|
||||
|
||||
If you see a bug, please be so kind as to show how it's failing, and we'll do our best to get it fixed quickly.
|
||||
|
||||
Before sending a PR, please [create an issue](https://github.com/PDMLab/docker-compose/issues/new) to introduce your idea and have a reference for your PR.
|
||||
|
||||
Also please add tests and make sure to run `npm run eslint`.
|
||||
|
||||
### Slack
|
||||
|
||||
If you want to discuss an `docker-compose` issue or PR in more detail, feel free to [join our Slack workspace](https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY).
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 - 2019 PDMLab
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue