diff --git a/docs/checks-examples.md b/docs/checks-examples.md index 07087223e..864ec2c13 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -3,10 +3,10 @@ > New as of 0.5.0 ``` -checks Show zero-downtime status -checks:disable [process-type(s)] Disable zero-downtime deployment for all processes (or comma-separated process-type list) ***WARNING: this will cause downtime during deployments*** -checks:enable [process-type(s)] Enable zero-downtime deployment for all processes (or comma-separated process-type list) -checks:skip [process-type(s)] Skip zero-downtime checks for all processes (or comma-separated process-type list) +checks # Show zero-downtime status +checks:disable [process-type(s)] # Disable zero-downtime deployment for all processes (or comma-separated process-type list) ***WARNING: this will cause downtime during deployments*** +checks:enable [process-type(s)] # Enable zero-downtime deployment for all processes (or comma-separated process-type list) +checks:skip [process-type(s)] # Skip zero-downtime checks for all processes (or comma-separated process-type list) ``` Following a deploy, dokku will wait `10` seconds before routing traffic to the new container to give your application time to boot up. If the application is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can modify this value globally or on a per-application basis: diff --git a/docs/deployment/domain-configuration.md b/docs/deployment/domain-configuration.md index 95eece474..9c83b64c4 100644 --- a/docs/deployment/domain-configuration.md +++ b/docs/deployment/domain-configuration.md @@ -2,14 +2,14 @@ > New as of 0.3.10 -```shell -domains:add DOMAIN Add a domain to app -domains [] List domains -domains:clear Clear all domains for app -domains:disable Disable VHOST support -domains:enable Enable VHOST support -domains:remove DOMAIN Remove a domain from app -domains:set-global Set global domain name +``` +domains:add DOMAIN # Add a domain to app +domains [] # List domains +domains:clear # Clear all domains for app +domains:disable # Disable VHOST support +domains:enable # Enable VHOST support +domains:remove DOMAIN # Remove a domain from app +domains:set-global # Set global domain name ``` ## Customizing hostnames diff --git a/docs/deployment/ssl-configuration.md b/docs/deployment/ssl-configuration.md index b145fe33c..a69e27f56 100644 --- a/docs/deployment/ssl-configuration.md +++ b/docs/deployment/ssl-configuration.md @@ -5,12 +5,14 @@ Dokku supports SSL/TLS certificate inspection and CSR/Self-signed certificate generation via the `certs` plugin. Note that whenever SSL/TLS support is enabled SPDY is also enabled. ``` -certs:add CRT KEY Add an ssl endpoint to an app. Can also import from a tarball on stdin. -certs:generate DOMAIN Generate a key and certificate signing request (and self-signed certificate) -certs:info Show certificate information for an ssl endpoint. -certs:remove Remove an SSL Endpoint from an app. -certs:update CRT KEY Update an SSL Endpoint on an app. Can also import from a tarball on stdin +certs:add CRT KEY # Add an ssl endpoint to an app. Can also import from a tarball on stdin. +certs:generate DOMAIN # Generate a key and certificate signing request (and self-signed certificate) +certs:info # Show certificate information for an ssl endpoint. +certs:remove # Remove an SSL Endpoint from an app. +certs:update CRT KEY # Update an SSL Endpoint on an app. Can also import from a tarball on stdin +``` +```shell # for 0.3.x dokku nginx:import-ssl < certs.tar ``` diff --git a/docs/docker-options.md b/docs/docker-options.md index e9666efb2..2c67221fc 100644 --- a/docs/docker-options.md +++ b/docs/docker-options.md @@ -5,9 +5,9 @@ Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases ``` -docker-options [phase(s)] Display app's Docker options for all phases (or comma separated phase list) -docker-options:add OPTION Add Docker option to app for phase (comma-separated phase list) -docker-options:remove OPTION Remove Docker option from app for phase (comma-separated phase list) +docker-options [phase(s)] # Display app's Docker options for all phases (or comma separated phase list) +docker-options:add OPTION # Add Docker option to app for phase (comma-separated phase list) +docker-options:remove OPTION # Remove Docker option from app for phase (comma-separated phase list) ``` > When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so: diff --git a/docs/dokku-events-logs.md b/docs/dokku-events-logs.md index c93d82a1e..b6b02dafc 100644 --- a/docs/dokku-events-logs.md +++ b/docs/dokku-events-logs.md @@ -5,10 +5,10 @@ Docker provides an _events_ command to show system's real time events. Likewise, Dokku can record events as syslog entries and also provides a plugin to display the last ones. ``` -events [-t] Show the last events (-t follows) -events:list List logged events -events:on Enable events logger -events:off Disable events logger +events [-t] # Show the last events (-t follows) +events:list # List logged events +events:on # Enable events logger +events:off # Disable events logger ``` ## Usage diff --git a/docs/dokku-storage.md b/docs/dokku-storage.md index 1dd40733f..4c593dadd 100644 --- a/docs/dokku-storage.md +++ b/docs/dokku-storage.md @@ -5,10 +5,10 @@ The preferred method to mount external containers to a dokku managed container, is to use the dokku storage plugin. -```shell -storage:list , List bind mounts for app's container(s) (host:container) -storage:mount , Create a new bind mount -storage:unmount , Remove an existing bind mount +``` +storage:list # List bind mounts for app's container(s) (host:container) +storage:mount # Create a new bind mount +storage:unmount # Remove an existing bind mount ``` ## Ideology and Background diff --git a/docs/nginx.md b/docs/nginx.md index 9fadd65ca..8c3d05a2f 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -3,9 +3,9 @@ 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) -nginx:build-config (Re)builds nginx config for given app -nginx:error-logs [-t] Show the nginx error logs for an application (-t follows) +nginx:access-logs [-t] # Show the nginx access logs for an application (-t follows) +nginx:build-config # (Re)builds nginx config for given app +nginx:error-logs [-t] # Show the nginx error logs for an application (-t follows) ``` ## Customizing the nginx configuration diff --git a/docs/process-management.md b/docs/process-management.md index e10754162..51e477f4a 100644 --- a/docs/process-management.md +++ b/docs/process-management.md @@ -5,14 +5,14 @@ Dokku supports rudimentary process (really container) management via the `ps` plugin. ``` -ps List processes running in app container(s) -ps:rebuildall Rebuild all apps -ps:rebuild Rebuild an app -ps:restartall Restart all deployed app containers -ps:restart Restart app container(s) -ps:scale = [=] Set how many processes of a given process to run -ps:start Start app container(s) -ps:stop Stop app container(s) +ps # List processes running in app container(s) +ps:rebuildall # Rebuild all apps +ps:rebuild # Rebuild an app +ps:restartall # Restart all deployed app containers +ps:restart # Restart app container(s) +ps:scale = [=] # Set how many processes of a given process to run +ps:start # Start app container(s) +ps:stop # Stop app container(s) ``` ## Scaling diff --git a/docs/proxy.md b/docs/proxy.md index 692cba32d..5d97da498 100644 --- a/docs/proxy.md +++ b/docs/proxy.md @@ -3,14 +3,14 @@ > New as of 0.5.0, Enhanced in 0.6.0 ``` -proxy Show proxy settings for app -proxy:disable Disable proxy for app -proxy:enable Enable proxy for app -proxy:ports List proxy port mappings for app -proxy:ports-add :: [::...] Set proxy port mappings for app -proxy:ports-clear Clear all proxy port mappings for app -proxy:ports-remove [|::...] Unset proxy port mappings for app -proxy:set Set proxy type for app +proxy # Show proxy settings for app +proxy:disable # Disable proxy for app +proxy:enable # Enable proxy for app +proxy:ports # List proxy port mappings for app +proxy:ports-add :: [::...] # Set proxy port mappings for app +proxy:ports-clear # Clear all proxy port mappings for app +proxy:ports-remove [|::...] # Unset proxy port mappings for app +proxy:set # Set proxy type for app ``` In Dokku 0.5.0, port proxying was decoupled from the `nginx-vhosts` plugin into the proxy plugin. Dokku 0.6.0 introduced the ability to map host ports to specific container ports. In the future this will allow other proxy software - such as HAProxy or Caddy - to be used in place of nginx.