From 5be361cedc13433c122dde86c131d125a93606b6 Mon Sep 17 00:00:00 2001 From: Ryan Lelek Date: Tue, 29 Dec 2015 03:26:47 -0600 Subject: [PATCH] Docs: Adding production notes --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7af22c61..bf1a4506 100644 --- a/README.md +++ b/README.md @@ -22,16 +22,31 @@ Install from Source 2. Create a new directory where you would like to run the app, and un-zip the package to that location 3. Fire up a Terminal, the Node Command Prompt or shell and change directory to the root of the Raneto application (where app.js and config.js are) 4. run `npm install` to install the node dependencies -5. To start Raneto, run `npm start` -6. Visit `http://localhost:3000` in your web browser +5. To start Raneto, run `npm start` (or `npm run start_win` on Windows) -Note: When running on a live site you'll want to set the `PORT` env variable to `80` so you don't need to add `:3000` to the URL. +Accessing Raneto +---------------- + +Visit `http://localhost:3000` in your web browser. Demo & Docs ----------- See http://docs.raneto.com +Production Notes +---------------- + +When running a live site you'll want to set the `PORT` env variable to `80` so you don't need to add `:3000` to the URL. +This requires root privileges and is not recommended. + +Instead it is preferred to use a reverse proxy for security reasons. +Heroku and other services handle this aspect for you, but you can implement your own reverse proxy with Nginx or Apache. +If you want an example with Nginx, please submit an issue. + +You can change the port anytime by setting the environment variable in your propfile, or running in-line as below: +`$ PORT=1234 npm start` + Contribute ----------