X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=be05ba87a18c2e55a51755dcbf3674ab67c40024;hb=4a4b0f8e470aa063f7f2e119da9c3a97f7d3886d;hp=af713711c31f638b594c85cc108bd6453168cb63;hpb=4ee18c8d227778811716513d0391270a451178dd;p=discourse_docker.git diff --git a/README.md b/README.md index af71371..be05ba8 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The Docker repository will always contain the latest built version at: https://h The base directory contains a single bash script which is used to manage containers. You can use it to "bootstrap" a new container, enter, start, stop and destroy a container. -``` +```yaml Usage: launcher COMMAND CONFIG [--skip-prereqs] Commands: start: Start/initialize a container @@ -66,7 +66,7 @@ The beginning of the container definition can contain the following "special" se #### templates: -``` +```yaml templates: - "templates/cron.template.yml" - "templates/postgres.template.yml" @@ -76,7 +76,7 @@ This template is "composed" out of all these child templates, this allows for a #### expose: -``` +```yaml expose: - "2222:22" - "127.0.0.1:20080:80" @@ -87,7 +87,7 @@ Publish port 22 inside the container on port 2222 on ALL local host interfaces. #### volumes: -``` +```yaml volumes: - volume: host: /var/discourse/shared @@ -98,7 +98,8 @@ volumes: Expose a directory inside the host to the container. #### links: -``` + +```yaml links: - link: name: postgres @@ -112,23 +113,24 @@ to the options when running the container. Setting environment variables to the current container. -``` +```yaml # app.yml env: DISCOURSE_DB_HOST: some-host - DISCOURSE_DB_NAME: {{config}}_discourse + 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: -``` + +```yaml # app.yml labels: - monitor: 'true' - app_name: {{config}}_discourse + monitor: "true" + app_name: "{{config}}_discourse" ``` Add labels to the current container. The above will add `--l monitor=true -l app_name=dev_discourse` to the options