From 0967f3f7bf4ad7c1630db8520b375eb6703f3113 Mon Sep 17 00:00:00 2001 From: Tan Jay Jun Date: Sun, 3 Feb 2019 16:04:00 +0800 Subject: [PATCH] Fix Getting Started guides style --- docs/getting-started/advanced-installation.md | 26 +++++----- docs/getting-started/install/azure.md | 10 ++-- docs/getting-started/install/digitalocean.md | 14 ++--- docs/getting-started/install/dreamhost.md | 8 ++- docs/getting-started/install/vagrant.md | 16 +++--- docs/getting-started/installation.md | 10 ++-- docs/getting-started/troubleshooting.md | 51 +++++++++---------- docs/getting-started/upgrading.md | 4 +- docs/getting-started/where-to-get-help.md | 2 +- 9 files changed, 70 insertions(+), 71 deletions(-) diff --git a/docs/getting-started/advanced-installation.md b/docs/getting-started/advanced-installation.md index 42c951c82..c72f7c332 100644 --- a/docs/getting-started/advanced-installation.md +++ b/docs/getting-started/advanced-installation.md @@ -1,6 +1,6 @@ # Advanced installation -You can always install Dokku straight from the latest - potentially unstable - master release via the following bash command: +You can always install Dokku straight from the latest - potentially unstable - `master` branch via the following Bash command: ```shell # using a branch results in installing from source @@ -10,7 +10,7 @@ sudo DOKKU_BRANCH=master bash bootstrap.sh ## Development -If you plan on developing dokku, the easiest way to install from your own repository is cloning the repository and calling the install script. Example: +If you plan on developing Dokku, the easiest way to install from your own repository is cloning the repository and calling the install script. Example: ```shell git clone https://github.com/yourusername/dokku.git @@ -34,9 +34,9 @@ chmod +x bootstrap.sh sudo DOKKU_REPO=https://github.com/yourusername/dokku.git DOKKU_BRANCH=master ./bootstrap.sh ``` -## Custom herokuish build +## Custom Herokuish build -Dokku ships with a pre-built version of version of the [herokuish](https://github.com/gliderlabs/herokuish) component by default. If you want to build your own version you can specify that with an env variable. +Dokku ships with a pre-built version of version of the [Herokuish](https://github.com/gliderlabs/herokuish) component by default. If you want to build your own version you can specify that with an environment variable. ```shell git clone https://github.com/dokku/dokku.git @@ -44,29 +44,29 @@ cd dokku sudo BUILD_STACK=true STACK_URL=https://github.com/gliderlabs/herokuish.git make install ``` -## Skipping herokuish installation +## Skipping Herokuish installation -The `herokuish` package is recommended but not required if not using Heroku Buildpacks for deployment. Debian-based OS users can run the bootstrap installer via `sudo DOKKU_NO_INSTALL_RECOMMENDS=true bash bootstrap.sh` to skip the dependency. Please note that this will _also_ skip installation of other recommended dependencies. +The Herokuish package is recommended but not required if not using Heroku buildpacks for deployment. Debian-based OS users can run the bootstrap installer via `sudo DOKKU_NO_INSTALL_RECOMMENDS=true bash bootstrap.sh` to skip the dependency. Please note that this will _also_ skip installation of other recommended dependencies. ## Configuring an unattended installation -Once Dokku is installed, if you are not using the web-installer, you'll want to configure a the virtualhost setup as well as the push user. If you do not, your installation will be considered incomplete and you will not be able to deploy applications. +Once Dokku is installed, if you are not using the web-installer, you'll want to configure the virtualhost setup as well as the push user. If you do not, your installation will be considered incomplete and you will not be able to deploy applications. For Debian, unattended installation is described [Debian installation guide](/docs/getting-started/install/debian.md). *You should also stop and disable the `dokku-installer` service to remove public access to adding SSH keys.* -Set up a domain using your preferred vendor and a wildcard domain pointing to the host running dokku. You can manage this global domain using the [domains plugin](/docs/configuration/domains.md). +Set up a domain using your preferred vendor and a wildcard domain pointing to the host running Dokku. You can manage this global domain using the [domains plugin](/docs/configuration/domains.md). -Follow the [user management documentation](/docs/deployment/user-management.md) in order to add ssh keys for users to Dokku, or to give other Unix accounts access to Dokku. +Follow the [user management documentation](/docs/deployment/user-management.md) in order to add SSH keys for users to Dokku, or to give other Unix accounts access to Dokku. -## VMs with less than 1GB of memory +## VMs with less than 1 GB of memory -Having less than 1GB of system memory available for Dokku and its containers may result in unexpected errors, such as **! [remote rejected] master -> master (pre-receive hook declined)** during installation of NPM dependencies (https://github.com/npm/npm/issues/3867). +Having less than 1 GB of system memory available for Dokku and its containers may result in unexpected errors, such as `! [remote rejected] master -> master (pre-receive hook declined)` during installation of NPM dependencies (https://github.com/npm/npm/issues/3867). -To work around this issue, it might suffice to augment the linux swap file size to a maximum of twice the physical memory size. +To work around this issue, it might suffice to augment the Linux swap file size to a maximum of twice the physical memory size. -To resize the swap file of a 512MB machine to 1GB, follow these steps while in SSH within your machine: +To resize the swap file of a 512 MB machine to 1 GB, follow these steps while in SSH within your machine: ```shell cd /var diff --git a/docs/getting-started/install/azure.md b/docs/getting-started/install/azure.md index 6d6bedd55..6d61ddda9 100644 --- a/docs/getting-started/install/azure.md +++ b/docs/getting-started/install/azure.md @@ -1,11 +1,11 @@ # Microsoft Azure -- If you don't already have one [generate an SSH key pair](https://help.github.com/articles/generating-ssh-keys/). +1. If you don't already have one [generate an SSH key pair](https://help.github.com/articles/generating-ssh-keys/). -- Go to the [Dokku on Azure deployment page](https://github.com/azure/azure-quickstart-templates/tree/master/dokku-vm) and click **Deploy to Azure**. +2. Go to the [Dokku on Azure deployment page](https://github.com/azure/azure-quickstart-templates/tree/master/dokku-vm) and click **Deploy to Azure**. -- You'll be prompted to enter a few parameters, including a unique storage account name and a unique name for the sub-domain used for your public IP address. For the `sshKeyData` parameter, copy and paste the contents of the *public* key file you just created. After a few minutes the Dokku instance will be deployed. +3. You'll be prompted to enter a few parameters, including a unique storage account name and a unique name for the subdomain used for your public IP address. For the `sshKeyData` parameter, copy and paste the contents of the *public* key file you just created. After a few minutes the Dokku instance will be deployed. -- In your browser of choice, navigate to `http://[dnsNameForPublicIP].[location].cloudapp.azure.com`. Where `[dnsNameForPublicIP]` and `[location]` are template parameters you used to deploy the template. +4. In your browser of choice, navigate to `http://[dnsNameForPublicIP].[location].cloudapp.azure.com`. Where `[dnsNameForPublicIP]` and `[location]` are template parameters you used to deploy the template. -- Finish your Dokku setup like you normally would by creating a *new* public/private key pair for your deployments using `ssh-keygen` (don't use the same one as you created in the first step). You should select **Use Virtual Host Naming** and set the **Hostname** to a *public DNS name* that you own such as one you would purchase from [Namecheap](http://namecheap.com). Alternatively thanks to [xip.io](http://xip.io/) you can just use `[yourAzurePublicIP].xip.io` for free. For example, if your public IP is `44.44.44.44` then you would set it to `44.44.44.44.xip.io`. +5. Finish your Dokku setup like you normally would by creating a *new* public/private key pair for your deployments using `ssh-keygen` (don't use the same one as you created in the first step). You should select **Use Virtual Host Naming** and set the **Hostname** to a *public DNS name* that you own such as one you would purchase from [Namecheap](http://namecheap.com). Alternatively thanks to [xip.io](http://xip.io/) you can just use `[yourAzurePublicIP].xip.io` for free. For example, if your public IP is `44.44.44.44` then you would set it to `44.44.44.44.xip.io`. diff --git a/docs/getting-started/install/digitalocean.md b/docs/getting-started/install/digitalocean.md index 677c8fc00..2d9462413 100644 --- a/docs/getting-started/install/digitalocean.md +++ b/docs/getting-started/install/digitalocean.md @@ -1,14 +1,14 @@ -# Digital Ocean Droplet +# DigitalOcean Droplet -[Digital Ocean](https://www.digitalocean.com/products/compute/) offers a pre-installed Dokku image. You can run this image on any sized Droplet, although larger Droplets will allow you to run larger applications. +[DigitalOcean](https://www.digitalocean.com/products/compute/) offers a pre-installed Dokku image. You can run this image on any sized Droplet, although larger Droplets will allow you to run larger applications. -> **Please disable IPv6**. There are known issues with IPv6 on Digital Ocean and Docker. If you would like to run Dokku on an IPv6 Digital Ocean Droplet, please consult [this guide](https://jeffloughridge.wordpress.com/2015/01/17/native-ipv6-functionality-in-docker/). +> **Please disable IPv6**. There are known issues with IPv6 on DigitalOcean and Docker. If you would like to run Dokku on an IPv6 DigitalOcean Droplet, please consult [this guide](https://jeffloughridge.wordpress.com/2015/01/17/native-ipv6-functionality-in-docker/). -1. Login to your [Digital Ocean](https://m.do.co/c/fe06b043a083) account. +1. Login to your [DigitalOcean](https://m.do.co/c/fe06b043a083) account. 2. Click **Create a Droplet**. -3. Under **Choose an image > One-click apps** and choose the latest **Dokku** release for 16.04 _(version numbers may vary)_. -4. Under **Choose a size** and select your a machine spec. We recommend a machine with _at least_ 1GB of memory. -5. Under **Choose a datacenter region** select your region. +3. Under **Choose an image > One-click apps**, choose the latest **Dokku** release for 16.04 _(version numbers may vary)_. +4. Under **Choose a size**, select your machine spec. +5. Under **Choose a datacenter region**, select your region. 6. Add an SSH Key. * New Keys 1. Under **Add your SSH keys** click **New SSH Key** _(this opens a dialog)_. diff --git a/docs/getting-started/install/dreamhost.md b/docs/getting-started/install/dreamhost.md index cb3a38657..0f4d005f2 100644 --- a/docs/getting-started/install/dreamhost.md +++ b/docs/getting-started/install/dreamhost.md @@ -19,7 +19,7 @@ source openrc.sh # Set the environment variables for DreamHost Cloud This allows OpenStack client to connect to DreamHost API endpoints. The command below creates a new server instance named `my-dokku-instance` -based on Ubuntu 14.04, with 2GB RAM and 1CPU (the flavor called +based on Ubuntu 14.04, with 2 GB RAM and 1 CPU (the flavor called `supersonic`), opening network port access to HTTP and SSH (the `default` security group), and the name of the chosen SSH key. This key will be automatically added to the new server in the @@ -185,13 +185,11 @@ packages: ``` Shortly after running the create command you will get a confirmation that the -instance has been created, and after about a minute it should be ready to login. -Check the IP of the instance through the web UI or by running: +instance has been created, and after about a minute it should be ready to login. Check the IP of the instance through the web UI or by running: ```sh nova list ``` SSH with the `ubuntu` username and the public key previously added. -Keep in mind that if you logged in quick enough dokku might still be installing -in the background, and not be ready. The installation takes a few minutes. +Keep in mind that if you logged in quick enough Dokku might still be installing in the background, and not be ready. The installation takes a few minutes. diff --git a/docs/getting-started/install/vagrant.md b/docs/getting-started/install/vagrant.md index faa5916a8..3ea1e9f72 100644 --- a/docs/getting-started/install/vagrant.md +++ b/docs/getting-started/install/vagrant.md @@ -1,14 +1,16 @@ # Install Dokku using Vagrant -- Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) -- Download and install [Vagrant](http://www.vagrantup.com/downloads.html) -- Clone Dokku +1. Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads). + +2. Download and install [Vagrant](http://www.vagrantup.com/downloads.html). + +3. Clone Dokku. ```shell git clone https://github.com/dokku/dokku.git ``` -- Create VM +4. Create VM. ```shell # Optional ENV arguments: @@ -27,7 +29,7 @@ vagrant up dokku-windows ``` -- Setup SSH Config in `~/.ssh/config`. +5. Setup SSH Config in `~/.ssh/config`. ```ini Host dokku.me @@ -36,8 +38,8 @@ > For users that have customized the IP address of their VM - either in a custom `Vagrantfile` or via the `DOKKU_IP` environment variable - and are not using `10.0.0.2` for the Vagrant IP, you'll need to instead use the output of `vagrant ssh-config dokku` for your `~/.ssh/config` entry. -- Copy your SSH key via `cat ~/.ssh/id_rsa.pub | pbcopy` and paste it into the dokku-installer at http://dokku.me . Change the `Hostname` field on the Dokku Setup screen to your domain and then check the box that says **Use virtualhost naming**. Then click **Finish Setup** to install your key. You'll be directed to application deployment instructions from here. +6. Copy your SSH key via `cat ~/.ssh/id_rsa.pub | pbcopy` and paste it into the dokku-installer at http://dokku.me . Change the `Hostname` field on the Dokku Setup screen to your domain and then check the box that says **Use virtualhost naming**. Then click **Finish Setup** to install your key. You'll be directed to application deployment instructions from here. -Please note, the `dokku.me` domain is setup to point to `10.0.0.2` along with all subdomains (i.e. `yourapp.dokku.me`). If you change the `DOKKU_IP` in your Vagrant setup you'll need to update your `/etc/hosts` file to point your reconfigured ip address. +Please note, the `dokku.me` domain is setup to point to `10.0.0.2` along with all subdomains (i.e. `yourapp.dokku.me`). If you change the `DOKKU_IP` in your Vagrant setup you'll need to update your `/etc/hosts` file to point your reconfigured IP address. You are now ready to deploy an app or install plugins. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index f04d52d1a..34bbb633d 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -7,7 +7,7 @@ Dokku is an extensible, open source Platform as a Service that runs on a single To start using Dokku, you'll need a system that meets the following minimum requirements: - A fresh installation of [Ubuntu 16.04 x64](https://www.ubuntu.com/download), [Ubuntu 14.04 x64](https://www.ubuntu.com/download), [Debian 8.2 x64](https://www.debian.org/distrib/) or [CentOS 7 x64](https://www.centos.org/download/) *(experimental)* with the FQDN set [1] -- At least `1GB` of system memory [2] +- At least 1 GB of system memory [2] You can *optionally* have a domain name pointed at the host's IP, though this is not necessary. @@ -15,7 +15,7 @@ Dokku is designed for usage on a fresh VM installation, and should install all n ### Installing the latest stable version -#### 1. Install dokku +#### 1. Install Dokku To install the latest stable version of Dokku, you can run the following shell commands: @@ -27,7 +27,7 @@ sudo DOKKU_TAG=v0.14.5 bash bootstrap.sh The installation process takes about 5-10 minutes, depending upon internet connection speed. -If you're using Debian 8 or Ubuntu 14.04, make sure your package manager is configured to install a sufficiently recent version of nginx[3], otherwise, the installation may fail due to "unmet dependencies" relating nginx. +If you're using Debian 8 or Ubuntu 14.04, make sure your package manager is configured to install a sufficiently recent version of nginx[3], otherwise, the installation may fail due to `unmet dependencies` relating nginx. #### 2. Setup SSH key and Virtualhost Settings @@ -47,11 +47,11 @@ Once you save your settings, the web admin will self-terminate and you should be For various reasons, certain hosting providers may have other steps that should be preferred to the above. If hosted on any of the following popular hosts, please follow the linked to instructions: -- [Digital Ocean Installation Notes](/docs/getting-started/install/digitalocean.md) +- [DigitalOcean Installation Notes](/docs/getting-started/install/digitalocean.md) - [DreamHost Cloud Installation Notes](/docs/getting-started/install/dreamhost.md) - [Microsoft Azure Installation Notes](/docs/getting-started/install/azure.md) -As well, you may wish to customize your installation in some other fashion. or experiment with vagrant. The guides below should get you started: +As well, you may wish to customize your installation in some other fashion. or experiment with Vagrant. The guides below should get you started: - [Debian Package Installation Notes](/docs/getting-started/install/debian.md) - [RPM Package Installation Notes](/docs/getting-started/install/rpm.md) diff --git a/docs/getting-started/troubleshooting.md b/docs/getting-started/troubleshooting.md index 04c01fb16..627664275 100644 --- a/docs/getting-started/troubleshooting.md +++ b/docs/getting-started/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting -__Symptom:__ I deployed my app but I am getting the default nginx page +__Symptom:__ I deployed my app but I am getting the default nginx page. __Solution:__ @@ -11,7 +11,7 @@ nginx -t ## nginx: [emerg] could not build the server_names_hash, you should increase server_names_hash_bucket_size: 32 ``` -If you get a similar error just edit __/etc/nginx/nginx.conf__ and add the following line to your http section: +If you get a similar error just edit `/etc/nginx/nginx.conf` and add the following line to your `http` section: ```nginx http { @@ -35,7 +35,7 @@ Save the file and try stopping nginx and starting it again: *** -__Symptom:__ I want to deploy my app, but while pushing I get the following error +__Symptom:__ I want to deploy my app, but while pushing I get the following error. ! [remote rejected] master -> master (pre-receive hook declined) @@ -50,30 +50,30 @@ To enable Dokku tracing, simply run the following command: dokku trace on ``` -In versions older than 0.3.9, you can create a `/home/dokku/dokkurc` file containing the following : +In versions older than 0.3.9, you can create a `/home/dokku/dokkurc` file containing the following: ```shell export DOKKU_TRACE=1 ``` -This will trace all of dokku's activity. If this does not help you, create a [gist](https://gist.github.com) containing the full log, and create an issue. +This will trace all of Dokku's activity. If this does not help you, create a [gist](https://gist.github.com) containing the full log, and create an issue. *** -__Symptom:__ I get the aforementioned error in the build phase (after turning on Dokku tracing) +__Symptom:__ I get the aforementioned error in the build phase (after turning on Dokku tracing). - Most errors that happen in this phase are due to transient network issues (either locally or remotely) buildpack bugs. +Most errors that happen in this phase are due to transient network issues (either locally or remotely) buildpack bugs. __Solution (Less solution, more helpful troubleshooting steps):__ - Find the failed phase's container image (*077581956a92* in this example) +Find the failed phase's container image (`077581956a92` in this example). ```shell docker ps -a | grep build ## 94d9515e6d93 077581956a92 "/build" 29 minutes ago Exited (0) 25 minutes ago cocky_bell ``` - Start a new container with the failed image and poke around (i.e. ensure you can access the internet from within the container or attempt the failed command, if known) +Start a new container with the failed image and poke around (i.e. ensure you can access the internet from within the container or attempt the failed command, if known). ```shell docker run -ti 077581956a92 /bin/bash @@ -84,38 +84,37 @@ tar tzf node-v0.10.30-linux-x64.tar.gz ## ... ``` - Sometimes (especially on DO) deploying again seems to get past these seemingly transient issues - Additionally we've seen issues if changing networks that have different DNS resolvers. In this case, you can run the following to update your resolv.conf +Sometimes (especially on DigitalOcean) deploying again seems to get past these seemingly transient issues. Additionally we've seen issues if changing networks that have different DNS resolvers. In this case, you can run the following to update your `resolv.conf`. ```shell resolvconf -u ``` -Please see https://github.com/dokku/dokku/issues/841 and https://github.com/dokku/dokku/issues/649 +Please see https://github.com/dokku/dokku/issues/841 and https://github.com/dokku/dokku/issues/649. *** -__Symptom:__ I want to deploy my app but I am getting asked for the password of the git user and the error message +__Symptom:__ I want to deploy my app but I am getting asked for the password of the Git user and the error message. fatal: 'NAME' does not appear to be a git repository fatal: Could not read from remote repository. __Solution:__ -You get asked for a password because your ssh secret key can't be found. This may happen if the private key corresponding to the public key you added with `sshcommand acl-add` is not located in the default location `~/.ssh/id_rsa`. +You get asked for a password because your SSH secret key can't be found. This may happen if the private key corresponding to the public key you added with `sshcommand acl-add` is not located in the default location `~/.ssh/id_rsa`. -You have to point ssh to the correct secret key for your domain name. Add the following to your `~/.ssh/config`: +You have to point SSH to the correct secret key for your domain name. Add the following to your `~/.ssh/config`: ```ini Host DOKKU_HOSTNAME IdentityFile "~/.ssh/KEYNAME" ``` -Also see [issue #116](https://github.com/dokku/dokku/issues/116) +Also see [issue #116](https://github.com/dokku/dokku/issues/116). *** -__Symptom:__ I successfully deployed my application with no deployment errors and receiving Bad Gateway when attempting to access the application +__Symptom:__ I successfully deployed my application with no deployment errors and receiving **Bad Gateway** when attempting to access the application. __Solution:__ @@ -127,11 +126,11 @@ When specifying your port you may want to use something similar to: var port = process.env.PORT || 3000 ``` -Please see https://github.com/dokku/dokku/issues/282 +Please see https://github.com/dokku/dokku/issues/282. *** -__Symptom:__ Deployment fails because of slow internet connection, messages shows `gzip: stdin: unexpected end of file` +__Symptom:__ Deployment fails because of slow internet connection, messages shows `gzip: stdin: unexpected end of file`. __Solution:__ @@ -146,16 +145,16 @@ If you see output similar this when deploying: ! tar: Error is not recoverable: exiting now ``` -it might that the curl command that is supposed to fetch the buildpack (anything in the low megabyte file size range) takes too long to finish, due to slowish connection. To overwrite the default values (connection timeout: 90 seconds, total maximum time for operation: 600 seconds), set the following environment variables: +it might that the cURL command that is supposed to fetch the buildpack (anything in the low megabyte file size range) takes too long to finish, due to slowish connection. To overwrite the default values (connection timeout: 90 seconds, total maximum time for operation: 600 seconds), set the following environment variables: ```shell dokku config:set --global CURL_TIMEOUT=1200 dokku config:set --global CURL_CONNECT_TIMEOUT=180 ``` -Please see https://github.com/dokku/dokku/issues/509 +Please see https://github.com/dokku/dokku/issues/509. -Another reason for this error (although it may respond immediately ruling out a timeout issue) may be because you've set the config setting `SSL_CERT_FILE`. Using a config setting with this key interferes with the buildpack's ability to download it's dependencies, so you must rename the config setting to something else, e.g. `MY_APP_SSL_CERT_FILE`. +Another reason for this error (although it may respond immediately ruling out a timeout issue) may be because you've set the config setting `SSL_CERT_FILE`. Using a config setting with this key interferes with the buildpack's ability to download its dependencies, so you must rename the config setting to something else, e.g. `MY_APP_SSL_CERT_FILE`. *** @@ -163,7 +162,7 @@ __Symptom:__ Build fails with `Killed` message. __Solution:__ -This generally occurs when the server runs out of memory. You can either add more ram to your server or setup swap space. The follow script will create 2gb of swap space. +This generally occurs when the server runs out of memory. You can either add more RAM to your server or setup swap space. The follow script will create 2 GB of swap space. ```shell sudo install -o root -g root -m 0600 /dev/null /swapfile @@ -181,13 +180,13 @@ __Symptom:__ I successfully deployed my application with no deployment errors bu __Solution:__ -This can occur if Dokku is running on a system with a firewall like ufw enabled (some OS versions like Ubuntu 16.04 have this enabled by default). You can check if this is your case by running the following script: +This can occur if Dokku is running on a system with a firewall like UFW enabled (some OS versions like Ubuntu 16.04 have this enabled by default). You can check if this is your case by running the following script: ```shell sudo ufw status ``` -If the previous script returned `Status: active` and a list of ports, ufw is enabled and is probably the cause of the symptom described above. To disable it, run: +If the previous script returned `Status: active` and a list of ports, UFW is enabled and is probably the cause of the symptom described above. To disable it, run: ```shell sudo ufw disable @@ -201,6 +200,6 @@ __Solution:__ This isn't usually an issue with Dokku, but rather an app config problem. This can happen when your application is configured to enforce secure connections/HSTS, but you don't have SSL set up for the app. -In Rails at least, if your `application.rb` or `environmnents/production.rb` include the line `configure.force_ssl = true`, which includes HSTS try commenting that out and redeploying. +In Rails at least, if your `application.rb` or `environmnents/production.rb` include the line `configure.force_ssl = true` which includes HSTS, try commenting that out and redeploying. If this solves the issue temporarily, longer term you should consider [configuring SSL](http://dokku.viewdocs.io/dokku/configuration/ssl/). diff --git a/docs/getting-started/upgrading.md b/docs/getting-started/upgrading.md index c68c88310..5e29befc2 100644 --- a/docs/getting-started/upgrading.md +++ b/docs/getting-started/upgrading.md @@ -4,7 +4,7 @@ If your version of Dokku is pre 0.3.0 (check with `dokku version`), we recommend ## Security Updates -For any security related updates, please follow our [twitter account](https://twitter.com/dokku). As Dokku does not run any daemons, the security risk introduced by our software is minimal. +For any security related updates, please follow our [Twitter account](https://twitter.com/dokku). As Dokku does not run any daemons, the security risk introduced by our software is minimal. Your operating system may occasionally provide security updates. We recommend setting unattended upgrades for your operating system. Here are some helpful links: @@ -101,7 +101,7 @@ sudo make install dokku ps:rebuildall # rebuilds all applications ``` -To upgrade herokuish from source, upgrade with: +To upgrade Herokuish from source, upgrade with: ```shell cd /tmp diff --git a/docs/getting-started/where-to-get-help.md b/docs/getting-started/where-to-get-help.md index f96dac057..e02d73223 100644 --- a/docs/getting-started/where-to-get-help.md +++ b/docs/getting-started/where-to-get-help.md @@ -6,7 +6,7 @@ If you’re stuck, there are a number of places you can get help: - [http://dokku.viewdocs.io/dokku/](/docs/) -The Official Dokku website is always a great place to visit. It features links to oft-used developer tools, community plugins, and guides on using dokku. +The Official Dokku website is always a great place to visit. It features links to oft-used developer tools, community plugins, and guides on using Dokku. ## The IRC and Slack Channels