Skip to content

Commit 475a7e1

Browse files
committed
Merge pull request #521 from aanand/clean-up-env-docs
Clean up environment variable docs
2 parents 2680756 + f43bfaa commit 475a7e1

1 file changed

Lines changed: 7 additions & 9 deletions

File tree

docs/cli.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,18 +99,16 @@ By default if there are existing containers for a service, `fig up` will stop an
9999

100100
## Environment Variables
101101

102-
Fig commands support the following environment variables
102+
Several environment variables can be used to configure Fig's behaviour.
103103

104-
### FIG_PROJECT_NAME
104+
### FIG\_PROJECT\_NAME
105105

106-
Set the project name. Defaults to the `basename` of the current working
107-
directory.
106+
Set the project name, which is prepended to the name of every container started by Fig. Defaults to the `basename` of the current working directory.
108107

109-
### FIG_FILE
108+
### FIG\_FILE
110109

111-
Set the path to the `fig.yml` to use. Defaults to `fig.yml` in the current
112-
working directory.
110+
Set the path to the `fig.yml` to use. Defaults to `fig.yml` in the current working directory.
113111

114-
### DOCKER_HOST
112+
### DOCKER\_HOST
115113

116-
Set the url to the docker remote.
114+
Set the URL to the docker daemon. Defaults to `unix:///var/run/docker.sock`, as with the docker client.

0 commit comments

Comments
 (0)