From: Régis Hanol Date: Thu, 12 Dec 2013 17:33:21 +0000 (+0100) Subject: Update README.md X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5858417652a6ac2e5a04e64beb9b0a314f020e1e;p=discourse_docker.git Update README.md Improved Getting Started section Fix formatting --- diff --git a/README.md b/README.md index af80760..cefb1bc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -##Discourse Docker +## Discourse Docker A toolkit for building and managing Docker images for Discourse. @@ -10,43 +10,43 @@ These templates are agnostic, you may run Discourse in multiple containers or a The templates and base image take care of configuring Discourse with best practices in mind. The latest version of Ruby 2.0 is included as is fairly extensive memory and GC tuning. The web template uses unicorn which helps cut down on overall memory usage making this very suitable for VPS type installs. -###Getting started +### Getting started -The simplest (though slightly more fragile) way of getting started is using the standalone template. +The simplest (though slightly more fragile) way of getting started is using the **standalone** template. -- `mkdir -p /var/docker/data` -- Clone this project from github into `/var/docker` -- `cp samples/standalone.yml containers/app.yml` -- **Edit** app.yml with your environment specific information, including binds and volumes -- `sudo ./launcher bootstrap app` -- `sudo ./launcher start app` -- Ensure you setup iptables or some other firewall to protect various ports (like postgres/redis in multi image setups) +- **Clone** this project from github: `git clone https://github.com/SamSaffron/discourse_docker.git` +- **Copy** the standalone sample into the containers directory: `cp samples/standalone.yml containers/app.yml` +- **Edit** `containers/app.yml` with your environment specific information + - [bindings](#expose) + - [volumes](#volumes) +- **Bootstrap** the image: `sudo ./launcher bootstrap app` +- **Start** the image: `sudo ./launcher start app` -Note: you can add yourself to the docker group if you wish to avoid `sudo` with `usermod -a -G docker your-user-name`. +Note: you can add yourself to the docker group if you wish to avoid `sudo` with `usermod -aG docker `. ### Directory Structure -- cids +#### cids Contains container ids for currently running Docker containers. cids are Docker's "equivalent" of pids. Each container will have a unique git like hash. -- containers +#### containers This directory is to contain container definitions for your various Discourse containers. You are in charge of this directory, it ships empty. -- samples +#### samples Sample container definitions you may use to bootstrap your environment. You can copy and amend templates here into the containers directory. -- shared +#### shared Placeholder spot for shared volumes with various Discourse containers. You may elect to store certain persistent information outside of a container, in our case we keep various logfiles and upload directory outside. This allows you to rebuild containers easily without losing important information. Keeping uploads outside of the container allows you to share them between multiple web instances. -- templates +#### templates [pups](https://github.com/samsaffron/pups) managed pups templates you may use to bootstrap your environment. -- image +#### image Dockerfile for both the base image `samsaffron/discoruse_base` and discourse image `samsaffron/discourse`. @@ -56,7 +56,7 @@ Dockerfile for both the base image `samsaffron/discoruse_base` and discourse ima 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. -###launcher +### 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. @@ -73,11 +73,11 @@ Commands: ``` -###About the container configuration +### About the container configuration The beggining of the container definition will contain 3 "special" sections: -- templates: +#### templates: ``` templates: @@ -87,7 +87,7 @@ templates: This template is "composed" out of all these child templates, this allows for a very flexible configuration struture. Further more you may add specific hooks that extend the templates you reference. -- expose: +#### expose: ``` expose: @@ -97,7 +97,7 @@ expose: Expose port 22 inside the container on port 2222 on ALL local host interfaces. -- volumes: +#### volumes: ``` volumes: @@ -109,7 +109,7 @@ volumes: Expose a directory inside the host inside the container. -###Upgrading discourse +### Upgrading discourse The docker setup gives you multiple upgrade options: @@ -120,15 +120,17 @@ The docker setup gives you multiple upgrade options: - `./launcher destroy my_image` - `./launcher start my_image` -###Multi image vs Single image setups +### Multi image vs Single image setups -The samples directory conains a standalone template. This template will bundle all of the programs required to run discourse into a single image. The advantage is that it is very easy to get started as you do not need to wire up comms between containers. +The samples directory contains a standalone template. This template will bundle all of the programs required to run discourse into a single image. The advantage is that it is very easy to get started as you do not need to wire up communications between containers. However, the disadvantage is that the bootstrapping process will launch a new postgres instance, having 2 postgres instances running against a single directory can lead to unexpected results. Due to that, if you are ever to bootstrap the `standalone` template again you should first stop the existing container. -A multi image setup allows you to bootstrap new web processes while your site is running and only after it is built, switch the new image in. The setup is far more flexible and robust, however is a bit more complicated to setup. See the `data.yml` and `web_only.yml` templates in the samples directory. To ease this process, `launcher` will inject an env var called `DISCOURSE_HOST_IP` which will be available inside the image. +A multi images setup allows you to bootstrap new web processes while your site is running and only after it is built, switch the new image in. The setup is far more flexible and robust, however is a bit more complicated to setup. See the `data.yml` and `web_only.yml` templates in the samples directory. To ease this process, `launcher` will inject an env var called `DISCOURSE_HOST_IP` which will be available inside the image. -###Email setup +WARNING: If you launch multiple images, **make sure** you setup iptables or some other firewall to protect various ports (for postgres/redis). + +### Email setup For a Discourse instance to function properly Email must be setup. You can use an after_code hook in your template to setup mail, for example this will setup email integration with mandrill (which offer free smtp services). @@ -154,7 +156,7 @@ For a Discourse instance to function properly Email must be setup. You can use a The docker image does not contain postfix, exim or another mta, it was omitted cause it is very tricky to setup perfectly. -###Troubleshooting +### Troubleshooting It is strongly recommended you have ssh access to your running containers, this allows you very easily take sneak peak of the internals. Simplest way to gain access is: @@ -165,11 +167,6 @@ It is strongly recommended you have ssh access to your running containers, this 5. bootstrap and run your container 6. `./launcher ssh my_container` -###Security +### Security Directory permissions in Linux are sid based, if your sids on the host do not match the sids in the guest, permissions will mismatch. On clean installs you can ensure they are in sync by looking at `/etc/passwd` and `/etc/group`, the discourse account will have the sid 1000. - - - - -