discourse/docs/INSTALL.md

# How Do I Install Discourse?

It is still early times for Discourse. From [our FAQ](http://www.discourse.org/faq/):

> Discourse is brand new. Discourse is early beta software, and likely to remain so for many months.
> Please experiment with it, play with it, give us feedback, submit pull requests – but any consideration
> of fully adopting Discourse is for people and organizations who are eager to live on the bleeding and broken edge.

Still interested?

### [**Click here for the OFFICIAL INSTALL GUIDE**][1]

Alternately, you can try the [unofficial Heroku install guide][2], the [BitNami Discourse Virtual Machine package][3] or [Cloud66][4].

## Quick and Dirty Install

### Hardware

- Dual core CPU recommended
- 2 GB RAM recommended (and 2 GB of swap space)

### Software

1. **Postgres 9.1+**
 - Enable support for HSTORE
 - Create a discourse database and seed it with a basic image

2. **Redis 2.6+**

3. **Ruby 1.9.3+** (we recommend 2.0.0-p195 or higher)
  - Install all rubygems via bundler
  - Edit database.yml and redis.yml and point them at your databases.
  - Run `rake db:seed_fu` to add seed data
  - Prepackage all assets using rake
  - Run the Rails database migrations
  - Run a sidekiq process for background jobs
  - Run several Rails processes, preferably behind a proxy like Nginx.

### Low memory (less than 2 GB)

Remember you *will* need swap enabled (enough for a total of 4 GB, so 2 GB swap with 2 GB RAM, and 3 GB swap with 1 GB ram, etc) and working!

[1]: https://github.com/discourse/discourse/blob/master/docs/INSTALL-ubuntu.md
[2]: https://github.com/discourse/discourse/blob/master/docs/HEROKU.md
[3]: http://bitnami.com/stack/discourse
[4]: https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud66.md
-												copyedits
											
										
										
											2013-07-31 05:48:40 +08:00
+								# How Do I Install Discourse?
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
-												clean up master install guide a bit
											
										
										
											2013-07-31 05:47:21 +08:00
+								It is still early times for Discourse. From [our FAQ](http://www.discourse.org/faq/):
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
-												Fixes #157 - Add mention of seed_fu to docs.

											
										
										
											2013-02-27 01:45:56 +08:00
+								> Discourse is brand new. Discourse is early beta software, and likely to remain so for many months.
 								> Please experiment with it, play with it, give us feedback, submit pull requests – but any consideration
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
+								> of fully adopting Discourse is for people and organizations who are eager to live on the bleeding and broken edge.
-												update install doc
											
										
										
											2013-07-31 05:42:07 +08:00
+								Still interested?
-												add link to official-ish install docs
											
										
										
											2013-06-08 06:57:55 +08:00
-												clean up master install guide a bit
											
										
										
											2013-07-31 05:47:21 +08:00
+								### [**Click here for the OFFICIAL INSTALL GUIDE**][1]
-												three main pre-reqs
											
										
										
											2013-06-08 07:00:01 +08:00
-												Moved cloud66 config out of .cloud66 into config/cloud/cloud66 it is way too prominent as the first folder in github
Amended documentation to point to it from the install guide in the alternative section
Removed callout from the ubuntu guide, as it is unrelated

											
										
										
											2013-10-15 19:31:57 +08:00
+								Alternately, you can try the [unofficial Heroku install guide][2], the [BitNami Discourse Virtual Machine package][3] or [Cloud66][4].
-												update install doc
											
										
										
											2013-07-31 05:42:07 +08:00
-												clean up master install guide a bit
											
										
										
											2013-07-31 05:47:21 +08:00
+								## Quick and Dirty Install
-												update install doc
											
										
										
											2013-07-31 05:42:07 +08:00
 								### Hardware
-												add hardware reqs
											
										
										
											2013-07-04 15:43:17 +08:00
 								- Dual core CPU recommended
-												clarify 4 GB total with swap
											
										
										
											2013-08-02 07:42:42 +08:00
+								- 2 GB RAM recommended (and 2 GB of swap space)
-												add hardware reqs
											
										
										
											2013-07-04 15:43:17 +08:00
-												update install doc
											
										
										
											2013-07-31 05:42:07 +08:00
+								### Software
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
-												three main pre-reqs
											
										
										
											2013-06-08 07:00:01 +08:00
+. **Postgres 9.1+**
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
+								 - Enable support for HSTORE
 								 - Create a discourse database and seed it with a basic image
-												three main pre-reqs
											
										
										
											2013-06-08 07:00:01 +08:00
 . **Redis 2.6+**
 . **Ruby 1.9.3+** (we recommend 2.0.0-p195 or higher)
 								  - Install all rubygems via bundler
 								  - Edit database.yml and redis.yml and point them at your databases.
 								  - Run `rake db:seed_fu` to add seed data
 								  - Prepackage all assets using rake
 								  - Run the Rails database migrations
 								  - Run a sidekiq process for background jobs
 								  - Run several Rails processes, preferably behind a proxy like Nginx.
-												Initial release of Discourse

											
										
										
											2013-02-06 03:16:51 +08:00
-												clean up master install guide a bit
											
										
										
											2013-07-31 05:47:21 +08:00
+								### Low memory (less than 2 GB)
-												added EMBED_CLOCKWORK so users can embed clockwork scheduling inside another process

											
										
										
											2013-07-09 09:01:51 +08:00
-												Replace Clockwork with Sidetiq
											
										
										
											2013-08-08 01:25:05 +08:00
+								Remember you *will* need swap enabled (enough for a total of 4 GB, so 2 GB swap with 2 GB RAM, and 3 GB swap with 1 GB ram, etc) and working!
-												added EMBED_CLOCKWORK so users can embed clockwork scheduling inside another process

											
										
										
											2013-07-09 09:01:51 +08:00
-												add link to official-ish install docs
											
										
										
											2013-06-08 06:57:55 +08:00
+								[1]: https://github.com/discourse/discourse/blob/master/docs/INSTALL-ubuntu.md
 								[2]: https://github.com/discourse/discourse/blob/master/docs/HEROKU.md
-												update install doc
											
										
										
											2013-07-31 05:42:07 +08:00
+								[3]: http://bitnami.com/stack/discourse
-												Moved cloud66 config out of .cloud66 into config/cloud/cloud66 it is way too prominent as the first folder in github
Amended documentation to point to it from the install guide in the alternative section
Removed callout from the ubuntu guide, as it is unrelated

											
										
										
											2013-10-15 19:31:57 +08:00
+								[4]: https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud66.md