Merge pull request #78 from Supermathie/v1run
[discourse_docker.git] / README.md
index 011587153bd94857d416d646c634d4a9f9d30e23..792f6c0299a8475aa34ba3317fb13d585c3564c8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,22 +9,23 @@
 
 ### IMPORTANT: Before You Start
 
-1. Make sure you're running a **64 bit** version of either [Ubuntu 12.04 LTS](http://releases.ubuntu.com/precise/), [Ubuntu 13.04](http://releases.ubuntu.com/13.04/) or [Ubuntu 13.10](http://releases.ubuntu.com/13.10/).
-2. Upgrade to the [latest version of Docker](http://docs.docker.io/en/latest/installation/ubuntulinux/).
-3. Run Docker and launcher as **root**.
-4. Install Discourse Docker into the expected path `/var/docker`
+1. Make sure you're running a **64 bit** version of either [Ubuntu 12.04 LTS](http://releases.ubuntu.com/precise/),  or [Ubuntu 14.04 LTS](http://releases.ubuntu.com/14.04/).
+1. Upgrade to the [latest version of Docker](http://docs.docker.io/en/latest/installation/ubuntulinux/).
+1. Create a directory for Discourse Docker (the expected path is `/var/docker`): `install -g docker -m 2775 -d /var/docker`
+1. Run the docker installation and launcher as **root** or a member of the **docker** group.
+1. Add your user account to the docker group: `usermod -a -G docker yourusername` and re-login.
 
-If you do not do any of the above, as RoboCop once said, ["there will be ... trouble."](http://www.youtube.com/watch?v=XxarhampSNI) *Please double check the above list before proceeding!*
+If you do not do any of the above, as RoboCop once said, ["there will be trouble."](http://www.youtube.com/watch?v=XxarhampSNI) *Please double check the above list before proceeding!*
 
 ### Getting Started
 
 The simplest way to get started is the  **standalone** template:
 
-1. **Clone** this project from github: `git clone https://github.com/SamSaffron/discourse_docker.git /var/docker`
+1. **Clone** this project from github into `/var/docker` on your server: `git clone https://github.com/discourse/discourse_docker.git /var/docker`
 2. **Copy** the standalone sample into the containers directory: `cp samples/standalone.yml containers/app.yml`
 3. **Edit** `containers/app.yml` with your environment specific information
   - [bindings](#expose)
-  - [volumes](#volumes) (make sure you create the appropriate directories on the host)
+  - [volumes](#volumes)
 4. **Bootstrap** the image: `sudo ./launcher bootstrap app`
 5. **Start** the image: `sudo ./launcher start app`
 
@@ -54,7 +55,7 @@ Placeholder spot for shared volumes with various Discourse containers. You may e
 
 #### `/image`
 
-Dockerfile for both the base image `samsaffron/discoruse_base` and discourse image `samsaffron/discourse`.
+Dockerfile for both the base image `samsaffron/discourse_base` and discourse image `samsaffron/discourse`.
 
 - `samsaffron/discourse_base` contains all the OS dependencies including sshd, runit, postgres, nginx, ruby.
 
@@ -98,9 +99,10 @@ This template is "composed" out of all these child templates, this allows for a
 ```
 expose:
   - "2222:22"
+  - "127.0.0.1:20080:80"
 ```
 
-Expose port 22 inside the container on port 2222 on ALL local host interfaces.
+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.io/en/latest/use/port_redirection/) 
 
 
 #### volumes:
@@ -108,7 +110,7 @@ Expose port 22 inside the container on port 2222 on ALL local host interfaces.
 ```
 volumes:
   - volume:
-      host: /var/docker/data
+      host: /var/docker/shared
       guest: /shared
 
 ```
@@ -122,8 +124,8 @@ The Docker setup gives you multiple upgrade options:
 1. Use the front end at http://yoursite.com/admin/docker to upgrade an already running image.
 
 2. Create a new base image by running:
-  - `./launcher bootstrap my_image`
   - `./launcher destroy my_image`
+  - `./launcher bootstrap my_image`
   - `./launcher start my_image`
 
 ### Single Container vs. Multiple Container
@@ -140,6 +142,7 @@ The multiple container configuration setup is far more flexible and robust, howe
 If you want a multiple container 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.
 
 WARNING: In a multiple container configuration, *make sure* you setup iptables or some other firewall to protect various ports (for postgres/redis).
+On Ubuntu, install the `ufw` or `iptables-persistent` package to manage firewall rules.
 
 ### Email
 
@@ -147,15 +150,21 @@ For a Discourse instance to function properly Email must be set up. Use the `SMT
 
 ### Troubleshooting
 
-We strongly recommend you have ssh access to your running containers, this allows you very easily take a sneak peek at internals. The simplest way to gain access is:
-
-1. Run a terminal as root
-2. cd `~/.ssh`
-3. `ssh-key-gen`
-4. paste the contents of `id_rsa.pub` into your templates (see placeholder in samples)
-5. bootstrap and run your container
-6. `./launcher ssh my_container`
+You can ssh into your container using `./launcher ssh my_container`, we will automatically set up ssh access during bootstrap.
 
 ### 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.
+Directory permissions in Linux are UID/GID based, if your numeric IDs on the
+host do not match the IDs 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 UID 1000.
+
+
+### Advanced topics
+
+- [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)
+
+License
+===
+MIT