discourse/docs/INSTALL-digital-ocean.md

8 KiB

Set up Discourse on a cloud server in under 30 minutes with zero knowledge of Ruby, Rails or Linux shell using our Discourse Docker image. We prefer Digital Ocean, although these steps may work on other cloud providers that also support Docker. Let's begin!

Create New Digital Ocean Droplet

Sign up for Digital Ocean, update billing info, then begin creating your new cloud server (Droplet).

Use the URL of your new site as the Droplet hostname, e.g. discourse.example.com. Discourse requires a minimum of 1 GB RAM for small communities; we recommend 2 GB RAM for medium communities.

Install Discourse on Ubuntu 14.04 LTS x64. Always select the latest LTS distribution.

You will receive a mail from Digital Ocean with the root password to your Droplet. (However, if you know how to use SSH keys, you may not need a password to log in.)

Access Your Droplet

Connect to your Droplet via SSH, or use Putty on Windows:

ssh root@192.168.1.1

Replace 192.168.1.1 with the IP address of your Droplet.

You will be asked for permission to connect, type yes, then enter the root password from the email Digital Ocean sent you when the Droplet was set up.

Set up Swap (if needed)

  • If you're using the minimum 1 GB install, you must set up a swap file.

  • If you're using 2 GB+ memory, you can probably get by without a swap file.

Install Git

apt-get install git

Install Docker

wget -qO- https://get.docker.io/ | sh

Install Discourse

Create a /var/docker folder:

mkdir /var/docker

Clone the Official Discourse Docker Image into this /var/docker folder:

git clone https://github.com/discourse/discourse_docker.git /var/docker

Switch to your Docker folder:

cd /var/docker

Copy the samples/standalone.yml file into the containers folder as app.yml:

cp samples/standalone.yml containers/app.yml

Edit Discourse Configuration

Edit the Discourse configuration at app.yml:

nano containers/app.yml

We recommend Nano because it works like a typical GUI text editor, just use your arrow keys.

  • Set DISCOURSE_DEVELOPER_EMAILS to your email address.

  • Set DISCOURSE_HOSTNAME to discourse.example.com, this means you want your Discourse available at http://discourse.example.com/. You'll need to update the DNS A record for this domain with the IP address of your server.

  • Place your mail credentials in DISCOURSE_SMTP_ADDRESS, DISCOURSE_SMTP_PORT, DISCOURSE_SMTP_USER_NAME, DISCOURSE_SMTP_PASSWORD. Be sure you remove the comment # character and space from the front of these lines as necessary.

  • If you are using a 1 GB instance, set UNICORN_WORKERS to 2 so you have more memory room.

After completing your edits, press CtrlO then Enter to save and CtrlX to exit.

Email

Email is critical for account creation and notifications in Discourse. If you do not configure email before bootstrapping you will have a broken site!

  • Already have a mail server? Great. Use your existing mail server credentials.

  • No existing mail server, or you don't know what it is? No problem, create a free account on Mandrill (or Mailgun, or Mailjet), and use the credentials provided in the dashboard.

  • For proper email deliverability, you must set the SPF and DKIM records in your DNS. In Mandrill, that's under Sending Domains, View DKIM/SPF setup instructions.

Bootstrap Discourse

Be sure to save the app.yml file, and begin bootstrapping Discourse:

./launcher bootstrap app

This command can take up to 8 minutes. It is automagically configuring your Discourse environment.

After that completes, start Discourse:

./launcher start app

Congratulations! You now have your own instance of Discourse!

It should be accessible via the domain name discourse.example.com you entered earlier, provided you configured DNS. If not, you can also visit the server IP directly, e.g. http://192.168.1.1.

Register New Account and Become Admin

There is a reminder at the top about DISCOURSE_DEVELOPER_EMAILS; be sure you register a new account via one of those email addresses, and your account will automatically be made an Admin.

You should see Staff topics and the Admin Quick Start Guide. Please read it!

Post-Install Maintenance

To upgrade Discourse to the latest version, visit /admin/docker and follow the instructions.

The launcher command in the /var/docker folder can be used for various kinds of maintenance:

Usage: launcher COMMAND CONFIG
Commands:
    start:      Start/initialize a container
    stop:       Stop a running container
    restart:    Restart a container
    destroy:    Stop and remove a container
    ssh:        Start a bash shell in a running container
    logs:       Docker logs for container
    bootstrap:  Bootstrap a container for the config based on a template
    rebuild:    Rebuild a container (destroy old, bootstrap, start new)

Other Awesome Stuff

Do you want...

If anything needs to be improved in this guide, feel free to ask on meta.discourse.org, or even better, submit a pull request.