tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add commands section to readme

This commit is contained in:
Ben Firshman 2014-01-02 22:20:54 +00:00
parent e0a21e3df4
commit 0fb915e57e
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -194,6 +194,52 @@ environment:
RACK_ENV: development
```
### Commands
Most commands are run against one or more services. If the service is omitted, it will apply to all services.
#### `build [SERVICE...]`
Build or rebuild services.
Services are built once and then tagged as `project\_service`. If you change a service's `Dockerfile` or its configuration in `fig.yml`, you will probably need to run `fig build` to rebuild it.
#### `kill [SERVICE...]`
Force stop service containers.
#### `logs [SERVICE...]`
View output from services.
#### `ps`
List running containers.
#### `rm [SERVICE...]`
Remove stopped service containers.
#### `run SERVICE COMMAND [ARGS...]`
Run a one-off command for a service.
Note that this will not start any services that the command's service links to. So if, for example, your one-off command talks to your database, you will need to run `fig up -d db` first.
#### `start [SERVICE...]`
Start existing containers for a service.
#### `stop [SERVICE...]`
Stop running containers without removing them. They can be started again with `fig start`.
#### `up [SERVICE...]`
Build, create, start and attach to containers for a service.
### Environment variables
Fig uses [Docker links] to expose services' containers to one another. Each linked container injects a set of environment variables, each of which begins with the uppercase name of the container.