vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updating env var documentation

Browse source 
The position was a bit too early. Fleshed out the example.
Also, using the _ underscore for emphasis was confusing because it is also used to indicate
a level change.

Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony 2015-04-27 15:49:19 -07:00
parent fab7e7f2c2
commit 5043bdbc93
1 changed files with 28 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/configuration.md
View file

@ -9,18 +9,6 @@ You configure a registry server using a YAML file. This page explains the
configuration options and the values they can take. You'll also find examples of configuration options and the values they can take. You'll also find examples of
middleware and development environment configurations. middleware and development environment configurations.
## Overriding configuration options
Environment variables may be used to override configuration parameters other than
version. To override a configuration option, create an environment variable named
REGISTRY\_variable_ where *variable* is the name of the configuration option.
e.g
```
REGISTRY_STORAGE_FILESYSTEM_ROOTDIRECTORY=/tmp/registry/test
```
will set the storage root directory to `/tmp/registry/test`
## List of configuration options ## List of configuration options
This section lists all the registry configuration options. Some options in This section lists all the registry configuration options. Some options in
@ -134,6 +122,34 @@ options marked as **required**. This indicates that you can omit the parent with
all its children. However, if the parent is included, you must also include all all its children. However, if the parent is included, you must also include all
the children marked **required**. the children marked **required**.
## Override configuration options
You can use environment variables to override most configuration parameters. The
exception is the `version` variable which cannot be overridden. You can set
environment variables on the command line using the `-e` flag on `docker run` or
from within a Dockerfile using the `ENV` instruction.
To override a configuration option, create an environment variable named
`REGISTRY\variable_` where *`variable`* is the name of the configuration option
and the `_` (underscore) represents indention levels. For example, you can
configure the `rootdirectory` of the `filesystem` storage backend:
```
storage:
filesystem:
rootdirectory: /tmp/registry
```
To override this value, set an environment variable like this:
```
REGISTRY_STORAGE_FILESYSTEM_ROOTDIRECTORY=/tmp/registry/test
```
This variable overrides the `/tmp/registry` value to the `/tmp/registry/test`
directory.
## version ## version
```yaml ```yaml