First pass in moving to debian
[discourse_docker.git] / README.md
index e8762b2b174a6da2f8fad401ad01f510d6c01d22..9afa70d579a5eb904333e9ffdcef0a99dfe9c602 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,7 +82,7 @@ expose:
   - "127.0.0.1:20080:80"
 ```
 
-Expose port 22 inside the container on port 2222 on ALL local host interfaces. In order to bind to only one interface, you may specify the host's IP address as `([<host_interface>:[host_port]])|(<host_port>):<container_port>[/udp]` as defined in the [docker port binding documentation](http://docs.docker.com/userguide/dockerlinks/)
+Publish port 22 inside the container on port 2222 on ALL local host interfaces. In order to bind to only one interface, you may specify the host's IP address as `([<host_interface>:[host_port]])|(<host_port>):<container_port>[/udp]` as defined in the [docker port binding documentation](http://docs.docker.com/userguide/dockerlinks/). To expose a port without publishing it, specify only the port number (e.g., `80`).
 
 
 #### volumes:
@@ -108,6 +108,20 @@ links:
 Links another container to the current container. This will add `--link postgres:postgres`
 to the options when running the container.
 
+#### environment variables:
+
+Setting environment variables to the current container.
+
+```
+# app.yml
+
+env:
+  DISCOURSE_DB_HOST: some-host
+  DISCOURSE_DB_NAME: {{config}}_discourse
+```
+
+The above will add `-e DISCOURSE_DB_HOST=some-host -e DISCOURSE_DB_NAME=app_discourse` to the options when running the container.
+
 #### labels:
 ```
 # app.yml