From ce26004fc8c4b460e716ee69cbccb85c3b72c66d Mon Sep 17 00:00:00 2001 From: Kim Ausloos Date: Wed, 4 Nov 2015 21:26:54 -0600 Subject: [PATCH] Various small doc updates Replaces #1622, addresses comments by @josegonzalez [ci skip] --- docs/checks-examples.md | 6 +++--- docs/configuration-management.md | 4 ++-- docs/dns.md | 6 +++--- docs/nginx.md | 6 +++--- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/checks-examples.md b/docs/checks-examples.md index 150303128..dbd4af5da 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -2,7 +2,7 @@ > New as of 0.3.0 -Following a deploy, dokku will now wait `10` seconds before routing traffic to the new container. If the container is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can configure this time using the following command: +Following a deploy, dokku will now wait `10` seconds before routing traffic to the new container. If the container is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can modify this value using the following command: ```shell dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30 @@ -18,13 +18,13 @@ A check is a relative URL and may be followed by expected content from the page, /about Our Amazing Team ``` -Dokku will wait `5` seconds before running the checks to give server time to start. This time can be overridden on a per-app basis in the `CHECKS` file by setting `WAIT=nn`. You may also override this for the global dokku installation: +Dokku will wait `5` seconds before running the checks to give the server time to start. This value can be overridden on a per-app basis in the `CHECKS` file by setting `WAIT=nn`. You may also override this for the global dokku installation: ```shell dokku config:set --global DOKKU_CHECKS_WAIT=15 ``` -Dokku will wait `60` seconds before stopping the old container so that existing connections are given a chance to complete. This time is also configurable globally: +Dokku will wait `60` seconds before stopping the old container so that existing connections are given a chance to complete. This value is also configurable globally: ```shell dokku config:set --global DOKKU_WAIT_TO_RETIRE=120 diff --git a/docs/configuration-management.md b/docs/configuration-management.md index 320450d69..bb2bb4e07 100644 --- a/docs/configuration-management.md +++ b/docs/configuration-management.md @@ -21,13 +21,13 @@ You can set multiple environment variables at once: dokku config:set node-js-app ENV=prod COMPILE_ASSETS=1 ``` -When setting variables with whitespace, you need to escape the whitespace: +When setting variables with whitespaces, you need to escape them: ```shell dokku config:set node-js-app KEY=\"VAL\ WITH\ SPACES\" ``` -When setting or unsetting environment variables, you may wish sometimes to avoid an application restart. This is useful when developing plugins or when setting multiple environment variables in a scripted manner. To do so, use the `--no-restart` flag: +When setting or unsetting environment variables, you may wish to avoid an application restart. This is useful when developing plugins or when setting multiple environment variables in a scripted manner. To do so, use the `--no-restart` flag: ```shell dokku --no-restart config:set node-js-app ENV=prod diff --git a/docs/dns.md b/docs/dns.md index 1c0293c90..dcdf1cc92 100644 --- a/docs/dns.md +++ b/docs/dns.md @@ -1,6 +1,6 @@ # DNS Configuration -This is a work in progress. +> Note: This is a work in progress. ### DNS Versions @@ -26,9 +26,9 @@ Don't be afraid to ask if you need help. Create a [new issue](https://github.co For the examples, we will use the domain name `example.tld` and the IP address `127.0.0.1`. -Dokku uses a DNS to differentiate between apps on your dokku-powered server. If you are using the domain `example.tld`, and you have two apps `myapp1` and `myapp2`, dokku will make them available at `myapp1.example.tld` and `myapp2.example.tld`. +Dokku uses DNS to differentiate between apps on your dokku-powered server. If you are using the domain `example.tld`, and you have two apps `myapp1` and `myapp2`, dokku will make them available at `myapp1.example.tld` and `myapp2.example.tld`. -To get started, you need to know the IP address of your dokku server. Connect in to it and run `ifconfig` or `ip addr` to see the IP address. +To get started, you need to know the IP address of your dokku server. Connect to it and run `ifconfig` or `ip addr` to see the IP address. # Caching diff --git a/docs/nginx.md b/docs/nginx.md index 71b344712..eabd1550c 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -1,6 +1,6 @@ # Nginx Configuration -Dokku uses nginx as it's server for routing requests to specific applications. By default, access and error logs are written for each app to `/var/log/nginx/${APP}-access.log` and `/var/log/nginx/${APP}-error.log` respectively +Dokku uses nginx as its server for routing requests to specific applications. By default, access and error logs are written for each app to `/var/log/nginx/${APP}-access.log` and `/var/log/nginx/${APP}-error.log` respectively ``` nginx:access-logs [-t] Show the nginx access logs for an application (-t follows) @@ -22,7 +22,7 @@ Dokku currently templates out an nginx configuration that is included in the `ng - `nginx.conf.ssl_terminated.template` (since 0.4.0) - `nginx.ssl.conf.template` (since 0.4.2) -> If placed on disk on the dokku server, the template file **must** be owned by the user `dokku:dokku`. +> If placed on the dokku server, the template file **must** be owned by user and group `dokku:dokku`. For instance - assuming defaults - to customize the nginx template in use for the `myapp` application, create the file `nginx.conf.template` in your repo or on disk with the with the following contents: @@ -70,7 +70,7 @@ The default nginx.conf- templates will include everything from your apps `nginx. include $DOKKU_ROOT/$APP/nginx.conf.d/*.conf; ``` -. That means you can put additional configuration in separate files, for example to limit the uploaded body size to 50 megabytes, do +That means you can put additional configuration in separate files, for example to limit the uploaded body size to 50 megabytes, do ```shell mkdir /home/dokku/myapp/nginx.conf.d/