2013-02-13 00:18:59 +08:00
# Discourse Advanced Developer Install Guide
2013-08-24 19:31:02 +08:00
This guide is aimed at advanced Rails developers who have installed their own Rails apps before. If you are new to Rails, you are likely much better off with our ** [Discourse Vagrant Developer Guide ](VAGRANT.md )**.
Note: If you are developing on a Mac, you will probably want to look at [these instructions ](DEVELOPMENT-OSX-NATIVE.md ) as well.
2013-02-13 00:18:59 +08:00
## First Steps
2015-05-23 19:47:06 +08:00
1. Install and configure PostgreSQL 9.3+.
2014-05-29 14:37:30 +08:00
1. Run `postgres -V` to see if you already have it.
1. Make sure that the server's messages language is English; this is [required ](https://github.com/rails/rails/blob/3006c59bc7a50c925f6b744447f1d94533a64241/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L1140 ) by the ActiveRecord Postgres adapter.
2016-04-01 05:33:25 +08:00
2. Install and configure Redis 2.8.12+.
2014-05-29 14:37:30 +08:00
1. Run `redis-server -v` to see if you already have it.
3. Install ImageMagick
2016-04-01 05:33:25 +08:00
4. Install libxml2, libpq-dev, g++, gifsicle, libjpeg-progs and make.
2014-11-21 06:35:17 +08:00
5. Install Ruby 2.1.3 and Bundler.
6. Clone the project and bundle.
2013-02-13 00:18:59 +08:00
## Before you start Rails
1. `bundle install`
2015-05-24 12:33:35 +08:00
2. Start up Redis by running `redis-server`
2015-05-24 12:33:56 +08:00
3. `bundle exec rake db:create db:migrate db:test:prepare`
2013-08-30 20:56:59 +08:00
4. Try running the specs: `bundle exec rake autospec`
5. `bundle exec rails server`
2013-02-13 00:18:59 +08:00
2013-08-24 19:31:02 +08:00
You should now be able to connect to rails on [http://localhost:3000 ](http://localhost:3000 ) - try it out! The seed data includes a pinned topic that explains how to get an admin account, so start there! Happy hacking!
2013-02-13 00:18:59 +08:00
2013-02-13 00:39:32 +08:00
# Building your own Vagrant VM
2013-02-13 00:18:59 +08:00
2013-05-24 22:32:45 +08:00
Here are the steps we used to create the ** [Vagrant Virtual Machine ](VAGRANT.md )**. They might be useful if you plan on setting up an environment from scratch on Linux:
2013-02-13 00:18:59 +08:00
## Base box
2013-03-20 01:39:16 +08:00
Vagrant version 1.1.2. With this Vagrantfile:
2013-02-13 00:18:59 +08:00
Vagrant::Config.run do |config|
config.vm.box = 'precise32'
config.vm.box_url = 'http://files.vagrantup.com/precise32.box'
config.vm.network :hostonly, '192.168.10.200'
2013-02-27 01:45:56 +08:00
2013-02-13 00:18:59 +08:00
if RUBY_PLATFORM =~ /darwin/
config.vm.share_folder("v-root", "/vagrant", ".", :nfs => true)
end
end
vagrant up
vagrant ssh
## Some basic setup:
sudo su -
ln -sf /usr/share/zoneinfo/Canada/Eastern /etc/localtime
apt-get -yqq update
apt-get -yqq install python-software-properties
2014-07-01 22:36:54 +08:00
apt-get -yqq install vim curl expect debconf-utils git-core build-essential zlib1g-dev libssl-dev openssl libcurl4-openssl-dev libreadline6-dev libpcre3 libpcre3-dev imagemagick
2013-02-13 00:18:59 +08:00
## Unicode
echo "export LANGUAGE=en_US.UTF-8" >> /etc/bash.bashrc
echo "export LANG=en_US.UTF-8" >> /etc/bash.bashrc
echo "export LC_ALL=en_US.UTF-8" >> /etc/bash.bashrc
export LANGUAGE=en_US.UTF-8
export LANG=en_US.UTF-8
export LC_ALL=en_US.UTF-8
2013-02-27 01:45:56 +08:00
2013-02-13 00:18:59 +08:00
locale-gen en_US.UTF-8
dpkg-reconfigure locales
## RVM and Ruby
apt-get -yqq install libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt-dev autoconf libc6-dev ncurses-dev automake libtool bison subversion pkg-config curl build-essential git
2013-02-27 01:45:56 +08:00
2013-02-13 00:18:59 +08:00
su - vagrant -c "sudo bash -s stable < < (curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer)"
adduser vagrant rvm
source /etc/profile.d/rvm.sh
su - vagrant -c "rvm pkg install libyaml"
2013-03-20 01:39:16 +08:00
su - vagrant -c "rvm install 2.0.0-turbo"
su - vagrant -c "rvm use 2.0.0-turbo --default"
2013-02-27 01:45:56 +08:00
2014-02-17 04:27:55 +08:00
echo "gem: --no-document" >> /etc/gemrc
su - vagrant -c "echo 'gem: --no-document' >> ~/.gemrc"
2013-02-13 00:18:59 +08:00
2015-04-27 22:49:12 +08:00
## Postgres
2013-02-13 00:18:59 +08:00
Configure so that the vagrant user doesn't need to provide username and password.
2015-04-25 16:16:18 +08:00
apt-get -yqq install postgresql postgresql-contrib-9.3 libpq-dev postgresql-server-dev-9.3
2013-02-13 00:18:59 +08:00
su - postgres
2013-03-25 11:49:22 +08:00
createuser --createdb --superuser -Upostgres vagrant
2013-02-13 00:18:59 +08:00
psql -c "ALTER USER vagrant WITH PASSWORD 'password';"
psql -c "create database discourse_development owner vagrant encoding 'UTF8' TEMPLATE template0;"
psql -c "create database discourse_test owner vagrant encoding 'UTF8' TEMPLATE template0;"
2013-03-25 11:49:22 +08:00
psql -d discourse_development -c "CREATE EXTENSION hstore;"
psql -d discourse_development -c "CREATE EXTENSION pg_trgm;"
2013-02-13 00:18:59 +08:00
2015-04-27 14:06:41 +08:00
Edit /etc/postgresql/9.3/main/pg_hba.conf to have this:
2013-02-13 00:18:59 +08:00
2013-02-27 01:45:56 +08:00
local all all trust
2013-02-13 00:18:59 +08:00
host all all 127.0.0.1/32 trust
host all all ::1/128 trust
host all all 0.0.0.0/0 trust # wide-open
## Redis
2013-03-25 04:46:28 +08:00
sudo su -
2013-02-13 00:18:59 +08:00
mkdir /tmp/redis_install
cd /tmp/redis_install
wget http://redis.googlecode.com/files/redis-2.6.7.tar.gz
tar xvf redis-2.6.7.tar.gz
cd redis-2.6.7
make
make install
cd utils
./install_server.sh
# Press enter to accept all the defaults
2013-02-13 20:20:57 +08:00
/etc/init.d/redis_6379 start
2013-02-17 12:55:43 +08:00
2014-06-04 07:18:32 +08:00
## Sending email (SMTP)
By default, development.rb will attempt to connect locally to send email.
```rb
config.action_mailer.smtp_settings = { address: "localhost", port: 1025 }
```
Set up [MailCatcher ](https://github.com/sj26/mailcatcher ) so the app can intercept
outbound email and you can verify what is being sent.
2013-03-25 11:49:22 +08:00
2014-07-01 22:12:52 +08:00
Note also that mail is sent asynchronously by Sidekiq, so you'll need to have it running to process jobs. Run it with this command:
```
bundle exec sidekiq
```
2013-03-25 11:49:22 +08:00
## Phantomjs
Needed to run javascript tests.
cd /usr/local/share
wget https://phantomjs.googlecode.com/files/phantomjs-1.8.2-linux-i686.tar.bz2
tar xvf phantomjs-1.8.2-linux-i686.tar.bz2
rm phantomjs-1.8.2-linux-i686.tar.bz2
ln -s /usr/local/share/phantomjs-1.8.2-linux-i686/bin/phantomjs /usr/local/bin/phantomjs