discourse/docs/INSTALL.md

47 lines
1.9 KiB
Markdown
Raw Normal View History

2013-07-30 17:48:40 -04:00
# How Do I Install Discourse?
2013-02-05 14:16:51 -05:00
2013-07-30 17:47:21 -04:00
It is still early times for Discourse. From [our FAQ](http://www.discourse.org/faq/):
2013-02-05 14:16:51 -05: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
2013-02-05 14:16:51 -05:00
> of fully adopting Discourse is for people and organizations who are eager to live on the bleeding and broken edge.
2013-07-30 17:42:07 -04:00
Still interested?
2013-06-07 18:57:55 -04:00
2013-07-30 17:47:21 -04:00
### [**Click here for the OFFICIAL INSTALL GUIDE**][1]
2013-06-07 19:00:01 -04:00
2013-07-30 17:42:07 -04:00
Alternately, you can try the [unofficial Heroku install guide][2], or the [BitNami Discourse Virtual Machine package][3].
2013-07-30 17:47:21 -04:00
## Quick and Dirty Install
2013-07-30 17:42:07 -04:00
### Hardware
2013-07-04 03:43:17 -04:00
- Dual core CPU recommended
2013-08-01 19:42:42 -04:00
- 2 GB RAM recommended (and 2 GB of swap space)
2013-07-04 03:43:17 -04:00
2013-07-30 17:42:07 -04:00
### Software
2013-02-05 14:16:51 -05:00
2013-06-07 19:00:01 -04:00
1. **Postgres 9.1+**
2013-02-05 14:16:51 -05:00
- Enable support for HSTORE
- Create a discourse database and seed it with a basic image
2013-06-07 19:00:01 -04:00
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 a clockwork process for enqueing scheduled jobs
- Run several Rails processes, preferably behind a proxy like Nginx.
2013-02-05 14:16:51 -05:00
2013-07-30 17:47:21 -04:00
### Low memory (less than 2 GB)
2013-08-01 19:42:42 -04: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! To reduce memory footprint, clockwork can run inside your web server. If you launch the your web server with `EMBED_CLOCKWORK=1`, clockwork will run in a backgroud thread. As clockwork itself only performs scheduling, it will have very little impact on performance.
2013-06-07 18:57:55 -04:00
[1]: https://github.com/discourse/discourse/blob/master/docs/INSTALL-ubuntu.md
[2]: https://github.com/discourse/discourse/blob/master/docs/HEROKU.md
2013-07-30 17:42:07 -04:00
[3]: http://bitnami.com/stack/discourse