discourse/docs/DEVELOPER-ADVANCED.md

# Discourse Advanced Developer Install Guide

This guide is aimed at advanced Rails developers who have installed their own Rails apps before.

Note: If you are developing on a Mac, you will probably want to look at [these instructions](DEVELOPMENT-OSX-NATIVE.md) as well.

# Preparing a fresh Ubuntu install

To get your Ubuntu 16.04 or 18.04 LTS install up and running to develop Discourse and Discourse plugins follow the commands below. We assume an English install of Ubuntu.

    # Basics
    whoami > /tmp/username
    sudo add-apt-repository ppa:chris-lea/redis-server
    sudo apt-get -yqq update
    sudo apt-get -yqq install python-software-properties vim curl expect debconf-utils git-core build-essential zlib1g-dev libssl-dev openssl libcurl4-openssl-dev libreadline6-dev libpcre3 libpcre3-dev imagemagick redis-server advancecomp gifsicle jhead jpegoptim libjpeg-turbo-progs optipng pngcrush pngquant gnupg2

    # Ruby
    curl -sSL https://rvm.io/mpapis.asc | gpg2 --import -
    curl -sSL https://get.rvm.io | bash -s stable
    echo 'gem: --no-document' >> ~/.gemrc

    # exit the terminal and open it again to activate RVM

    rvm install 2.6.2
    rvm --default use 2.6.2 # If this error out check https://rvm.io/integration/gnome-terminal
    gem install bundler mailcatcher rake

    # Download and install postgresql-10 from https://wiki.postgresql.org/wiki/Apt

    # Postgresql
    sudo -u postgres -i
    createuser --superuser -Upostgres $(cat /tmp/username)
    psql -c "ALTER USER $(cat /tmp/username) WITH PASSWORD 'password';"
    exit

    # Node
    curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash

    # exit the terminal and open it again to activate NVM

    nvm install node
    nvm alias default node
    npm install -g svgo


If everything goes alright, let's clone Discourse and start hacking:

    git clone https://github.com/discourse/discourse.git ~/discourse
    cd ~/discourse
    bundle install

    # run this if there was a pre-existing database
    bundle exec rake db:drop
    RAILS_ENV=test bundle exec rake db:drop

    # time to create the database and run migrations
    bundle exec rake db:create
    bundle exec rake db:migrate
    RAILS_ENV=test bundle exec rake db:create db:migrate

    # run the specs (optional)
    bundle exec rake autospec # CTRL + C to stop

    # launch discourse
    bundle exec rails s -b 0.0.0.0 # open browser on http://localhost:3000 and you should see Discourse

Create an admin account with:

    bundle exec rake admin:create

If you ever need to recreate your database:

    bundle exec rake db:drop db:create db:migrate
    bundle exec rake admin:create
    RAILS_ENV=test bundle exec rake db:drop db:create db:migrate

Discourse does a lot of stuff async, so it's better to run sidekiq even on development mode:

    mailcatcher # open http://localhost:1080 to see the emails, stop with pkill -f mailcatcher
    bundle exec sidekiq # open http://localhost:3000/sidekiq to see queues
    bundle exec rails server

And happy hacking!
Introduction of Chef to Vagrant. Removed redis.yml and database.yml. Also updated instructions a lot, and included setup instructions for provisioning your own VM. Closes #28 and #61. 2013-02-13 00:18:59 +08:00			`# Discourse Advanced Developer Install Guide`

remove everything about vagrant 2018-04-05 04:04:31 +08:00			`This guide is aimed at advanced Rails developers who have installed their own Rails apps before.`
Clarify install doc wrt how to create databases 2013-08-24 19:31:02 +08:00
			`Note: If you are developing on a Mac, you will probably want to look at [these instructions](DEVELOPMENT-OSX-NATIVE.md) as well.`
Introduction of Chef to Vagrant. Removed redis.yml and database.yml. Also updated instructions a lot, and included setup instructions for provisioning your own VM. Closes #28 and #61. 2013-02-13 00:18:59 +08:00
Update the guide 2016-06-02 02:42:05 +08:00			`# Preparing a fresh Ubuntu install`

update docs/DEVELOPER-ADVANCED.md 2018-10-01 12:28:16 +08:00			`To get your Ubuntu 16.04 or 18.04 LTS install up and running to develop Discourse and Discourse plugins follow the commands below. We assume an English install of Ubuntu.`
Update the guide 2016-06-02 02:42:05 +08:00
			`# Basics`
			`whoami > /tmp/username`
			`sudo add-apt-repository ppa:chris-lea/redis-server`
			`sudo apt-get -yqq update`
Change postgres version 9.5 to 10 in docs/ and README.md 2018-10-01 12:12:52 +08:00			`sudo apt-get -yqq install python-software-properties vim curl expect debconf-utils git-core build-essential zlib1g-dev libssl-dev openssl libcurl4-openssl-dev libreadline6-dev libpcre3 libpcre3-dev imagemagick redis-server advancecomp gifsicle jhead jpegoptim libjpeg-turbo-progs optipng pngcrush pngquant gnupg2`
Update the guide 2016-06-02 02:42:05 +08:00
			`# Ruby`
			`curl -sSL https://rvm.io/mpapis.asc \| gpg2 --import -`
Update and clarify instructions for developer environment in Ubuntu 2016-06-03 01:06:04 +08:00			`curl -sSL https://get.rvm.io \| bash -s stable`
Update the guide 2016-06-02 02:42:05 +08:00			`echo 'gem: --no-document' >> ~/.gemrc`
Update and clarify instructions for developer environment in Ubuntu 2016-06-03 01:06:04 +08:00
Update DEVELOPER-ADVANCED doc with latest ruby & node versions 2017-07-31 17:09:09 +08:00			`# exit the terminal and open it again to activate RVM`
Update and clarify instructions for developer environment in Ubuntu 2016-06-03 01:06:04 +08:00
DEV: update version of ruby in docs Honestly I am not sure we should be carrying this document in the repo, just a link to meta. 2019-03-22 12:00:04 +08:00			`rvm install 2.6.2`
			`rvm --default use 2.6.2 # If this error out check https://rvm.io/integration/gnome-terminal`
Add 'rake' to bundle install command Without installing rake, `bundle install` fails when trying to install `sassc`. 2018-07-31 11:18:27 +08:00			`gem install bundler mailcatcher rake`
Update the guide 2016-06-02 02:42:05 +08:00
Change postgres version 9.5 to 10 in docs/ and README.md 2018-10-01 12:12:52 +08:00			`# Download and install postgresql-10 from https://wiki.postgresql.org/wiki/Apt`

Update the guide 2016-06-02 02:42:05 +08:00			`# Postgresql`
DEVELOPER-ADVANCED.md: update instructions to use rake tasks instead of (outdated) manual commands 2017-10-03 22:25:08 +08:00			`sudo -u postgres -i`
			`createuser --superuser -Upostgres $(cat /tmp/username)`
Update the guide 2016-06-02 02:42:05 +08:00			`psql -c "ALTER USER $(cat /tmp/username) WITH PASSWORD 'password';"`
Update and clarify instructions for developer environment in Ubuntu 2016-06-03 01:06:04 +08:00			`exit`
Introduction of Chef to Vagrant. Removed redis.yml and database.yml. Also updated instructions a lot, and included setup instructions for provisioning your own VM. Closes #28 and #61. 2013-02-13 00:18:59 +08:00
Update the guide 2016-06-02 02:42:05 +08:00			`# Node`
Update DEVELOPER-ADVANCED doc with latest ruby & node versions 2017-07-31 17:09:09 +08:00			`curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh \| bash`

			`# exit the terminal and open it again to activate NVM`

			`nvm install node`
			`nvm alias default node`
Switch to chrome headless mode instead of phantomjs. 2017-12-19 15:59:41 +08:00			`npm install -g svgo`
Introduction of Chef to Vagrant. Removed redis.yml and database.yml. Also updated instructions a lot, and included setup instructions for provisioning your own VM. Closes #28 and #61. 2013-02-13 00:18:59 +08:00
Update development docs regarding SMTP 2014-06-04 07:18:32 +08:00
Update the guide 2016-06-02 02:42:05 +08:00			`If everything goes alright, let's clone Discourse and start hacking:`
Update development docs regarding SMTP 2014-06-04 07:18:32 +08:00
Update the guide 2016-06-02 02:42:05 +08:00			`git clone https://github.com/discourse/discourse.git ~/discourse`
			`cd ~/discourse`
			`bundle install`
DEVELOPER-ADVANCED.md: update instructions to use rake tasks instead of (outdated) manual commands 2017-10-03 22:25:08 +08:00
			`# run this if there was a pre-existing database`
			`bundle exec rake db:drop`
			`RAILS_ENV=test bundle exec rake db:drop`

			`# time to create the database and run migrations`
FIX: Split migration into two steps in developer guide (#8103) 2019-09-18 22:09:17 +08:00			`bundle exec rake db:create`
			`bundle exec rake db:migrate`
DEVELOPER-ADVANCED.md: update instructions to use rake tasks instead of (outdated) manual commands 2017-10-03 22:25:08 +08:00			`RAILS_ENV=test bundle exec rake db:create db:migrate`
Switch to chrome headless mode instead of phantomjs. 2017-12-19 15:59:41 +08:00
Update DEVELOPER-ADVANCED doc with latest ruby & node versions 2017-07-31 17:09:09 +08:00			`# run the specs (optional)`
			`bundle exec rake autospec # CTRL + C to stop`
Switch to chrome headless mode instead of phantomjs. 2017-12-19 15:59:41 +08:00
Update DEVELOPER-ADVANCED doc with latest ruby & node versions 2017-07-31 17:09:09 +08:00			`# launch discourse`
			`bundle exec rails s -b 0.0.0.0 # open browser on http://localhost:3000 and you should see Discourse`
Update DEVELOPER-ADVANCED.md 2013-03-25 11:49:22 +08:00
Update DEVELOPER-ADVANCED.md: use rake task to create first user * with the new startup wizard, you can no longer create a user with no admins present, so use the rake task instead 2017-10-03 06:08:07 +08:00			`Create an admin account with:`
Update DEVELOPER-ADVANCED.md with Sidekiq info I was confused as to why activation emails weren't showing up in Mailcatcher, and finally took a look at the non-advanced developer guide to find the mention of Sidekiq. I thought it would be appropriate to mention it here as well. 2014-07-01 22:12:52 +08:00
Update DEVELOPER-ADVANCED.md: use rake task to create first user * with the new startup wizard, you can no longer create a user with no admins present, so use the rake task instead 2017-10-03 06:08:07 +08:00			`bundle exec rake admin:create`
Update DEVELOPER-ADVANCED.md with Sidekiq info I was confused as to why activation emails weren't showing up in Mailcatcher, and finally took a look at the non-advanced developer guide to find the mention of Sidekiq. I thought it would be appropriate to mention it here as well. 2014-07-01 22:12:52 +08:00
DEVELOPER-ADVANCED.md: update instructions to use rake tasks instead of (outdated) manual commands 2017-10-03 22:25:08 +08:00			`If you ever need to recreate your database:`

			`bundle exec rake db:drop db:create db:migrate`
			`bundle exec rake admin:create`
			`RAILS_ENV=test bundle exec rake db:drop db:create db:migrate`

Update the guide 2016-06-02 02:42:05 +08:00			`Discourse does a lot of stuff async, so it's better to run sidekiq even on development mode:`
Update DEVELOPER-ADVANCED.md 2013-03-25 11:49:22 +08:00
This was probably intended to be 'ruby $(which mailcatcher)' but it works without all that 2017-10-03 06:12:35 +08:00			`mailcatcher # open http://localhost:1080 to see the emails, stop with pkill -f mailcatcher`
Fix sidekiq command in docs to start all queues instead of only critical. 2017-07-25 14:55:22 +08:00			`bundle exec sidekiq # open http://localhost:3000/sidekiq to see queues`
Update the guide 2016-06-02 02:42:05 +08:00			`bundle exec rails server`
Update DEVELOPER-ADVANCED.md 2013-03-25 11:49:22 +08:00
Update the guide 2016-06-02 02:42:05 +08:00			`And happy hacking!`