X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=be05ba87a18c2e55a51755dcbf3674ab67c40024;hb=4a4b0f8e470aa063f7f2e119da9c3a97f7d3886d;hp=980715c632b5f31c9e045bfe1b093f25553fd0b5;hpb=fc49d1d658a8053731a0c4b6526d7e5276a2c8d5;p=discourse_docker.git diff --git a/README.md b/README.md index 980715c..be05ba8 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The simplest way to get started is via the **standalone** template, which can be installed in 30 minutes or less. For detailed install instructions, see -https://github.com/discourse/discourse/blob/master/docs/INSTALL-digital-ocean.md +https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud.md ### Directory Structure @@ -32,73 +32,109 @@ Placeholder spot for shared volumes with various Discourse containers. You may e #### `/templates` -[pups](https://github.com/samsaffron/pups) managed pups templates you may use to bootstrap your environment. +[pups](https://github.com/samsaffron/pups)-managed templates you may use to bootstrap your environment. #### `/image` -Dockerfile for both the base image `/discourse_base` and discourse image `/discourse`. +Dockerfiles for Discourse; see [the README](image/README.md) for further details. -- `/discourse_base` contains all the OS dependencies including sshd, runit, postgres, nginx, ruby. - -- `/discourse` builds on the base image and configures a discourse user and `/var/www/discourse` directory for the Discourse source. - -The Docker repository will always contain the latest built version at: https://index.docker.io/u/samsaffron/discourse/ , you should not need to build the base image. +The Docker repository will always contain the latest built version at: https://hub.docker.com/r/discourse/base/, you should not need to build the base image. ### Launcher -The base directory contains a single bash script which is used to manage containers. You can use it to "bootstrap" a new container, ssh in, start, stop and destroy a container. +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 stop: Stop a running container restart: Restart a container destroy: Stop and remove a container - enter: Use nsenter to enter a container - ssh: Start a bash shell in a running container + enter: Use docker exec to enter a container logs: Docker logs for container - mailtest: Test the mail settings in a container + memconfig: Configure sane defaults for available RAM bootstrap: Bootstrap a container for the config based on a template rebuild: Rebuild a container (destroy old, bootstrap, start new) ``` +If the environment variable "SUPERVISED" is set to true, the container won't be detached, allowing a process monitoring tool to manage the restart behaviour of the container. + ### Container Configuration -The beginning of the container definition will contain 3 "special" sections: +The beginning of the container definition can contain the following "special" sections: #### templates: -``` +```yaml templates: - "templates/cron.template.yml" - "templates/postgres.template.yml" ``` -This template is "composed" out of all these child templates, this allows for a very flexible configuration struture. Furthermore you may add specific hooks that extend the templates you reference. +This template is "composed" out of all these child templates, this allows for a very flexible configuration structure. Furthermore you may add specific hooks that extend the templates you reference. #### expose: -``` +```yaml expose: - "2222:22" - "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_port]])|():][/udp]` as defined in the [docker port binding documentation](http://docs.docker.io/en/latest/use/port_redirection/) +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_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: -``` +```yaml volumes: - volume: - host: /var/docker/shared + host: /var/discourse/shared guest: /shared ``` -Expose a directory inside the host inside the container. +Expose a directory inside the host to the container. + +#### links: + +```yaml +links: + - link: + name: postgres + alias: postgres +``` + +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. + +```yaml +# 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: + +```yaml +# app.yml + +labels: + 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 +when running the container ### Upgrading Discourse @@ -133,8 +169,6 @@ For a Discourse instance to function properly Email must be set up. Use the `SMT View the container logs: `./launcher logs my_container` -You can ssh into your container using `./launcher ssh my_container`, we will automatically set up ssh access during bootstrap. - Spawn a shell inside your container using `./launcher enter my_container`. This is the most foolproof method if you have host root access. If you see network errors trying to retrieve code from `github.com` or `rubygems.org` try again - sometimes there are temporary interruptions and a retry is all it takes. @@ -162,6 +196,8 @@ installs you can ensure they are in sync by looking at `/etc/passwd` and - [Setting up SSL with Discourse Docker](https://meta.discourse.org/t/allowing-ssl-for-your-discourse-docker-setup/13847) - [Multisite configuration with Docker](https://meta.discourse.org/t/multisite-configuration-with-docker/14084) +- [Linking containers for a multiple container setup](https://meta.discourse.org/t/linking-containers-for-a-multiple-container-setup/20867) +- [Using Rubygems mirror to improve connection problem in China](https://meta.discourse.org/t/replace-rubygems-org-with-taobao-mirror-to-resolve-network-error-in-china/21988/1) License ===