ported heroku docs

v1.18.x
psychobunny 11 years ago
parent cc106d1251
commit f3695cf2da

@ -1,4 +1,7 @@
Installation instructions for the Cloud 9 web based IDE.
Cloud 9 IDE
===========
The following are installation instructions for the `Cloud 9 <https://c9.io/>`_ web based IDE.
**Step 1:** Clone NodeBB into a new workspace from GitHub. You can use the following command from the terminal:
`git clone git://github.com/designcreateplay/NodeBB.git nodebb`

@ -1,40 +1,47 @@
### Installation
Heroku
======
**Note**: Installations to Heroku require a local machine with some flavour of unix, as NodeBB does not run on Windows.
1. Download and install [Heroku Toolbelt](https://toolbelt.heroku.com/) for your operating system
1. Log into your Heroku account: `heroku login`
1. Verify your Heroku account by adding a credit card (at http://heroku.com/verify)
1. Clone the repository: `git clone https://github.com/designcreateplay/NodeBB.git /path/to/repo/clone`
1. `cd /path/to/repo/clone`
1. Install dependencies locally `npm install`
1. Create the heroku app: `heroku create`
1. Enable WebSocket support (beta): `heroku labs:enable websockets -a {APP_NAME}`, where `{APP_NAME}` is provided by Heroku, and looks something like `adjective-noun-wxyz.herokuapp.com` (NOTE: [See this doc](https://discussion.heroku.com/t/application-error/160)): drop the `.herokuapp.com` when entering `{APP_NAME}` above.
1. Enable [Redis To Go](https://addons.heroku.com/redistogo) for your heroku account: `heroku addons:add redistogo:nano`
1. Run the NodeBB setup script: `node app --setup` (information for your Heroku server and Redis to Go instance can be found in your account page)
* Your server name is found in your Heroku app's "settings" page, and looks something like `adjective-noun-wxyz.herokuapp.com`
1. Download and install `Heroku Toolbelt <https://toolbelt.heroku.com/>`_ for your operating system
2. Log into your Heroku account: ``heroku login``
3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify)
4. Clone the repository: ``git clone https://github.com/designcreateplay/NodeBB.git /path/to/repo/clone``
5. ``cd /path/to/repo/clone``
6. Install dependencies locally ``npm install``
7. Create the heroku app: ``heroku create``
8. Enable WebSocket support (beta): ``heroku labs:enable websockets -a {APP_NAME}``, where ``{APP_NAME}`` is provided by Heroku, and looks something like ``adjective-noun-wxyz.herokuapp.com`` (NOTE: `See this doc <https://discussion.heroku.com/t/application-error/160>`_): drop the `.herokuapp.com` when entering ``{APP_NAME}`` above.
9. Enable `Redis To Go <https://addons.heroku.com/redistogo>`_ for your heroku account: ``heroku addons:add redistogo:nano``
10. Run the NodeBB setup script: ``node app --setup`` (information for your Heroku server and Redis to Go instance can be found in your account page)
* Your server name is found in your Heroku app's "settings" page, and looks something like ``adjective-noun-wxyz.herokuapp.com``
* Use any port number. It will be ignored.
* Specify "n" when asked if a port will be used. Heroku transparently proxies all requests.
* Your redis server can be found as part of the redis url. For example, for the url: `redis://redistogo:h28h3wgh37fns7@crestfish.redistogo.com:12345/`
* The server is `fishyfish.redistogo.com`
* The port is `12345`
* The password is `h28h3wgh37fns7`
1. Create a Procfile for Heroku: `echo "web: node app.js" > Procfile`
1. `git add -f Procfile config.json public/config.json && git commit -am "adding Procfile and configs for Heroku"`
1. Push to heroku: `git push heroku master`
* Your redis server can be found as part of the redis url. For example, for the url: ``redis://redistogo:h28h3wgh37fns7@crestfish.redistogo.com:12345/``
* The server is ``fishyfish.redistogo.com``
* The port is ``12345``
* The password is ``h28h3wgh37fns7``
11. Create a Procfile for Heroku: ``echo "web: node app.js" > Procfile``
12. Commit the Procfile:
.. code:: bash
git add -f Procfile config.json public/config.json && git commit -am "adding Procfile and configs for Heroku"
13. Push to heroku: ``git push heroku master``
* Ensure that a proper SSH key was added to your account, otherwise the push will not succeed!
1. Initialise a single dyno: `heroku ps:scale web=1`
1. Visit your app!
14. Initialise a single dyno: ``heroku ps:scale web=1``
15. Visit your app!
If these instructions are unclear or if you run into trouble, please let us know by [filing an issue](https://github.com/designcreateplay/NodeBB/issues).
If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/designcreateplay/NodeBB/issues>`_.
### Keeping it up to date
Keeping it up to date
---------------------
If you wish to pull the latest changes from the git repository to your Heroku app:
1. Navigate to your repository at `/path/to/nodebb`
2. `git pull`
3. `npm install`
4. `node app --upgrade`
5. `git commit -am "upgrading to latest nodebb"
6. `git push heroku master`
1. Navigate to your repository at ``/path/to/nodebb``
2. ``git pull``
3. ``npm install``
4. ``node app --upgrade``
5. ``git commit -am "upgrading to latest nodebb"``
6. ``git push heroku master``
Loading…
Cancel
Save