pulling in nginx config

[oweals/karmaworld.git] / README.md

diff --git a/README.md b/README.md
index f6998bb1c36bf1af1c1c9d01808d5d53cc0cd7b8..1c643823fdc57a12e16f4de0e2a3f3f0607087da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,13 +40,14 @@ directory underneath that (`{project_root}/karmaworld`) alongside files like
 # Development Install
 
 If you need to setup the project for development, it is highly recommend that
-you grab an existing development virtual machine for create one yourself, and
-then configure the virtual machine for production with the steps shown in the
-next section. Instructions for creating a virtual machine follow:
+you grab an existing development virtual machine or create one yourself. 
+Configure the virtual machine for production with the steps shown in the
+next section (Production Install). Instructions for creating a virtual machine
+follow:
 
-1. Install (VirtualBox)[http://www.virtualbox.com/]
+1. Install [VirtualBox](http://www.virtualbox.com/)
 
-1. Install (vagrant)[http://www.vagrantup.com/]
+1. Install [vagrant](http://www.vagrantup.com/) 1.3 or higher
 
 1. Use Vagrant to create the virtual machine.
     * While in `cd {project_root}`, type `vagrant up`
@@ -59,6 +60,7 @@ follow the steps below.
 1. Ensure the following are installed:
    * `git`
    * `PostgreSQL` (server and client)
+   * `nginx`
    * `Python`
    * `PIP`
    * `virtualenv` and `virtualenvwrapper`
@@ -80,10 +82,13 @@ follow the steps below.
        * Ensure *.py in `secret/` are never added to the git repo. (.gitignore
          should help warn against taking this action)
 
+1. Make sure that /var/www exists, is owned by the www-data group, and that
+   the user is a member of the www-data group.
+
 1. Make sure that you're in the root of the project that you just cloned and
    run
 
-        fab here first_deploy
+        fab -H 127.0.0.1 first_deploy
 
    This will make a virtualenv, install the development dependencies and create
    the database tables.
@@ -96,6 +101,15 @@ follow the steps below.
 If you have installed a virtual machine using `vagrant up`, you can connect
 to it by running `vagrant ssh` from `{project_root}`.
 
+## Connecting to the development website on the VM
+To access the website running on the VM, point your browser at
+http://localhost:6659/ using your host computer.
+
+Port 6659 on your local machine is set to forward to the VM's port 80.
+
+Fun fact: 6659 was chosen because of OM (sanskrit) and KW (KarmaWorld) on a
+phone: 66 59.
+
 ## Updating the VM code repository
 Once connected to the virtual machine by SSH, you will see `karmaworld` in
 the home directory. That is the `{project_root}` in the virtual machine.
@@ -114,7 +128,7 @@ pulls from the local repository on your local file system without needing
 credentials, etc.
 
 ## Other Vagrant commands
-Please see (vagrant documentation)[http://docs.vagrantup.com/v2/cli/index.html]
+Please see [vagrant documentation](http://docs.vagrantup.com/v2/cli/index.html)
 for more information on how to use the vagrant CLI to manage your development
 VM.