From 49b4b503e398a622d0eecd200fb1777f9f24376b Mon Sep 17 00:00:00 2001 From: Jeff Atwood Date: Wed, 23 Sep 2015 03:16:03 -0700 Subject: [PATCH] update install guide for Discourse 1.4 --- docs/INSTALL-cloud.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/INSTALL-cloud.md b/docs/INSTALL-cloud.md index 88306633d2e..d5c899cbc98 100644 --- a/docs/INSTALL-cloud.md +++ b/docs/INSTALL-cloud.md @@ -6,13 +6,13 @@ - Enter your domain `discourse.example.com` as the name. -- The default of **1 GB** RAM works fine for small Discourse communities. We do recommend 2 GB RAM for medium communities. +- The default of **1 GB** RAM works fine for small Discourse communities. We recommend 2 GB RAM for larger communities. - The default of **Ubuntu 14.04 LTS x64** works fine. At minimum, a 64-bit Linux OS with a kernel version of 3.10+ is required. - The default of **New York** is a good choice for most US and European audiences. Or select a region that is geographically closer to your audience. -Create your new Droplet. You will receive a mail from Digital Ocean with the root password to your Droplet. (However, if you know [how to use SSH keys](https://www.google.com/search?q=digitalocean+ssh+keys), you may not need a password to log in.) +Create your new Droplet. You will receive an email with the root password to your Droplet. (However, if you know [how to use SSH keys](https://www.google.com/search?q=digitalocean+ssh+keys), you may not need a password to log in.) # Access Your Cloud Server @@ -22,23 +22,20 @@ Connect to your Droplet via SSH, or use [Putty][put] on Windows: 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. You may be prompted to change the root password, too. - + # Set up Swap (if needed) - If you're using the minimum 1 GB install, you *must* [set up a swap file](https://meta.discourse.org/t/create-a-swapfile-for-your-linux-server/13880). - - If you're using 2 GB+ memory, you can probably get by without a swap file. # Install Docker / Git wget -qO- https://get.docker.com/ | sh - +This command installs the latest versions of Docker and Git on your server. Alternately, you can manually install the respective [Docker package for your OS](https://docs.docker.com/installation/). # Install Discourse @@ -49,15 +46,15 @@ Create a `/var/discourse` folder, clone the [Official Discourse Docker Image][dd cd /var/discourse cp samples/standalone.yml containers/app.yml - + # Edit Discourse Configuration -Edit the Discourse configuration at `app.yml`: +Edit the Discourse config file `app.yml`: nano containers/app.yml -We recommend Nano because it works like a typical GUI text editor, just use your arrow keys. +We recommend Nano because it's simple; just use your arrow keys to edit. - Set `DISCOURSE_DEVELOPER_EMAILS` to your email address. @@ -67,7 +64,7 @@ We recommend Nano because it works like a typical GUI text editor, just use your - If you are using a 1 GB instance, set `UNICORN_WORKERS` to 2 and `db_shared_buffers` to 128MB so you have more memory room. - + After completing your edits, press CtrlO then Enter to save and CtrlX to exit. @@ -93,33 +90,32 @@ 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`; register a new account via one of those email addresses, and your account will automatically be made an Admin. +There is a reminder at the top about the `DISCOURSE_DEVELOPER_EMAILS` you entered previously in `app.yml`; register a new account via one of those email addresses, and your account will automatically be made an Admin. (If you *don't* get any email from your install, and are unable to register a new admin account, please see our [Email Troubleshooting checklist](https://meta.discourse.org/t/troubleshooting-email-on-a-new-discourse-install/16326).) - + -You should see Staff topics and the [Admin Quick Start Guide](https://github.com/discourse/discourse/blob/master/docs/ADMIN-QUICK-START-GUIDE.md). It contains the next steps for further configuring and customizing your Discourse install. +You should see Staff topics and the Admin Quick Start Guide. It contains the next steps for further configuring and customizing your Discourse install. Read it closely. (If you are still unable to register a new admin account via email, see [Create Admin Account from Console](https://meta.discourse.org/t/create-admin-account-from-console/17274), but please note that *you will have a broken site* unless you get email working on your instance.) - # Post-Install Maintenance We strongly suggest you: -- turn on automatic security updates via the `dpkg-reconfigure -plow unattended-upgrades` command -- enable stronger passwords via the `apt-get install libpam-cracklib` package +- turn on automatic security updates for your OS. In Ubuntu use the `dpkg-reconfigure -plow unattended-upgrades` command. +- if you are using a password and not a SSH key, be sure to enforce a strong root password. In Ubuntu use the `apt-get install libpam-cracklib` package. To **upgrade Discourse to the latest version**, visit `/admin/upgrade` and follow the instructions. @@ -174,7 +170,7 @@ Do you want... - To embed Discourse [in your WordPress install](https://github.com/discourse/wp-discourse), or [on your static HTML site](https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963)? -If anything needs to be improved in this guide, feel free to ask on [meta.discourse.org][meta], or even better, submit a pull request. +Help us improve this guide! Feel free to ask about it on [meta.discourse.org][meta], or even better, submit a pull request. [dd]: https://github.com/discourse/discourse_docker [man]: https://mandrillapp.com