Skip to content

Commit

Permalink
Docs: Adding production notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanlelek committed Dec 29, 2015
1 parent 498334d commit 5be361c
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------

Expand Down

0 comments on commit 5be361c

Please sign in to comment.