Pin uglify-js to 2.x for now

[discourse_docker.git] / README.md

diff --git a/README.md b/README.md
index 99730fa4e2ea87e4d159e25c8ba2e9e2e623e96e..4cd622699eedb86bd1ad111de3044a4a8e12c542 100644 (file)
--- 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,21 +32,17 @@ 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/discourse/, 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.
 
 ```
 Usage: launcher COMMAND CONFIG [--skip-prereqs]
@@ -55,10 +51,9 @@ Commands:
     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)
 ```
@@ -67,7 +62,7 @@ If the environment variable "SUPERVISED" is set to true, the container won't be
 
 ### 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:
 
@@ -146,8 +141,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.
@@ -176,7 +169,24 @@ 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)
-- [Replace rubygems.org with taobao mirror to resolve network error in China](https://meta.discourse.org/t/replace-rubygems-org-with-taobao-mirror-to-resolve-network-error-in-china/21988/1)
+- [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)
+
+### Developing with Vagrant
+
+If you are looking to make modifications to this repository, you can easily test
+out your changes before committing, using the magic of
+[Vagrant](http://vagrantup.com).  Install Vagrant as per [the default
+instructions](http://docs.vagrantup.com/v2/installation/index.html), and
+then run:
+
+    vagrant up
+
+This will spawn a new Ubuntu VM, install Docker, and then await your
+instructions.  You can then SSH into the VM with `vagrant ssh`, become
+`root` with `sudo -i`, and then you're right to go.  Your live git repo is
+already available at `/var/discourse`, so you can just `cd /var/discourse`
+and then start running `launcher`.
+
 
 License
 ===