Skip to content

Latest commit

 

History

History
147 lines (105 loc) · 5.29 KB

DEVELOPER-ADVANCED.md

File metadata and controls

147 lines (105 loc) · 5.29 KB
Raw

Discourse Advanced Developer Install Guide

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.

Note: If you are developing on a Mac, you will probably want to look at these instructions as well.

First Steps

  1. Install and configure PostgreSQL 9.3+.
  2. Run postgres -V to see if you already have it.
  3. Make sure that the server's messages language is English; this is required by the ActiveRecord Postgres adapter.
  4. Install and configure Redis 2+.
  5. Run redis-server -v to see if you already have it.
  6. Install ImageMagick
  7. Install libxml2, libpq-dev, g++, and make.
  8. Install Ruby 2.1.3 and Bundler.
  9. Clone the project and bundle.

Before you start Rails

  1. bundle install
  2. Start up Redis by running redis-server
  3. bundle exec rake db:create db:migrate db:test:prepare
  4. Try running the specs: bundle exec rake autospec
  5. bundle exec rails server

You should now be able to connect to rails on 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!

Building your own Vagrant VM

Here are the steps we used to create the Vagrant Virtual Machine. They might be useful if you plan on setting up an environment from scratch on Linux:

Base box

Vagrant version 1.1.2. With this Vagrantfile:

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'

  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
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

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

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

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"
su - vagrant -c "rvm install 2.0.0-turbo"
su - vagrant -c "rvm use 2.0.0-turbo --default"

echo "gem: --no-document" >> /etc/gemrc
su - vagrant -c "echo 'gem: --no-document' >> ~/.gemrc"

Postgres

Configure so that the vagrant user doesn't need to provide username and password.

apt-get -yqq install postgresql postgresql-contrib-9.3 libpq-dev postgresql-server-dev-9.3
su - postgres
createuser --createdb --superuser -Upostgres vagrant
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;"
psql -d discourse_development -c "CREATE EXTENSION hstore;"
psql -d discourse_development -c "CREATE EXTENSION pg_trgm;"

Edit /etc/postgresql/9.3/main/pg_hba.conf to have this:

local all all trust
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

sudo su -
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
/etc/init.d/redis_6379 start

Sending email (SMTP)

By default, development.rb will attempt to connect locally to send email.

config.action_mailer.smtp_settings = { address: "localhost", port: 1025 }

Set up MailCatcher so the app can intercept outbound email and you can verify what is being sent.

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

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