cd48a7026a
Removed 'Compose command line completion' and 'Compose environment variables' from the list. command line completion is linked to from install docs, and environment variables are deprecated. Signed-off-by: Daniel Nephin <dnephin@docker.com>
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
<!--[metadata]>
|
|
+++
|
|
title = "Compose environment variables reference"
|
|
description = "Compose CLI reference"
|
|
keywords = ["fig, composition, compose, docker, orchestration, cli, reference"]
|
|
[menu.main]
|
|
parent="smn_compose_ref"
|
|
weight=3
|
|
+++
|
|
<![end-metadata]-->
|
|
|
|
# Compose environment variables reference
|
|
|
|
**Note:** Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](yml.md#links) for details.
|
|
|
|
Compose 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.
|
|
|
|
To see what environment variables are available to a service, run `docker-compose run SERVICE env`.
|
|
|
|
<b><i>name</i>\_PORT</b><br>
|
|
Full URL, e.g. `DB_PORT=tcp://172.17.0.5:5432`
|
|
|
|
<b><i>name</i>\_PORT\_<i>num</i>\_<i>protocol</i></b><br>
|
|
Full URL, e.g. `DB_PORT_5432_TCP=tcp://172.17.0.5:5432`
|
|
|
|
<b><i>name</i>\_PORT\_<i>num</i>\_<i>protocol</i>\_ADDR</b><br>
|
|
Container's IP address, e.g. `DB_PORT_5432_TCP_ADDR=172.17.0.5`
|
|
|
|
<b><i>name</i>\_PORT\_<i>num</i>\_<i>protocol</i>\_PORT</b><br>
|
|
Exposed port number, e.g. `DB_PORT_5432_TCP_PORT=5432`
|
|
|
|
<b><i>name</i>\_PORT\_<i>num</i>\_<i>protocol</i>\_PROTO</b><br>
|
|
Protocol (tcp or udp), e.g. `DB_PORT_5432_TCP_PROTO=tcp`
|
|
|
|
<b><i>name</i>\_NAME</b><br>
|
|
Fully qualified container name, e.g. `DB_1_NAME=/myapp_web_1/myapp_db_1`
|
|
|
|
[Docker links]: http://docs.docker.com/userguide/dockerlinks/
|
|
|
|
## Compose documentation
|
|
|
|
- [User guide](/)
|
|
- [Installing Compose](install.md)
|
|
- [Command line reference](/reference)
|
|
- [Yaml file reference](yml.md)
|