Use a single format for all the help output

[ci skip]
This commit is contained in:
Jose Diaz-Gonzalez committed 2016-07-03 17:16:01 -04:00
1 parent 04ec0ff5c4
commit 4c976d8097
9 files changed
+49 -47

No files matched your search

+4 -4
View File
@@ -3,10 +3,10 @@
> New as of 0.5.0 > New as of 0.5.0
``` ```
checks <app> Show zero-downtime status checks <app> # Show zero-downtime status
checks:disable <app> [process-type(s)] Disable zero-downtime deployment for all processes (or comma-separated process-type list) ***WARNING: this will cause downtime during deployments*** checks:disable <app> [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 <app> [process-type(s)] Enable zero-downtime deployment for all processes (or comma-separated process-type list) checks:enable <app> [process-type(s)] # Enable zero-downtime deployment for all processes (or comma-separated process-type list)
checks:skip <app> [process-type(s)] Skip zero-downtime checks for all processes (or comma-separated process-type list) checks:skip <app> [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: 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:
+8 -8
View File
@@ -2,14 +2,14 @@
> New as of 0.3.10 > New as of 0.3.10
```shell ```
domains:add <app> DOMAIN Add a domain to app domains:add <app> DOMAIN # Add a domain to app
domains [<app>] List domains domains [<app>] # List domains
domains:clear <app> Clear all domains for app domains:clear <app> # Clear all domains for app
domains:disable <app> Disable VHOST support domains:disable <app> # Disable VHOST support
domains:enable <app> Enable VHOST support domains:enable <app> # Enable VHOST support
domains:remove <app> DOMAIN Remove a domain from app domains:remove <app> DOMAIN # Remove a domain from app
domains:set-global <domain> Set global domain name domains:set-global <domain> # Set global domain name
``` ```
## Customizing hostnames ## Customizing hostnames
+7 -5
View File
@@ -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. 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 <app> CRT KEY Add an ssl endpoint to an app. Can also import from a tarball on stdin. certs:add <app> CRT KEY # Add an ssl endpoint to an app. Can also import from a tarball on stdin.
certs:generate <app> DOMAIN Generate a key and certificate signing request (and self-signed certificate) certs:generate <app> DOMAIN # Generate a key and certificate signing request (and self-signed certificate)
certs:info <app> Show certificate information for an ssl endpoint. certs:info <app> # Show certificate information for an ssl endpoint.
certs:remove <app> Remove an SSL Endpoint from an app. certs:remove <app> # Remove an SSL Endpoint from an app.
certs:update <app> CRT KEY Update an SSL Endpoint on an app. Can also import from a tarball on stdin certs:update <app> CRT KEY # Update an SSL Endpoint on an app. Can also import from a tarball on stdin
```
```shell
# for 0.3.x # for 0.3.x
dokku nginx:import-ssl <app> < certs.tar dokku nginx:import-ssl <app> < certs.tar
``` ```
+3 -3
View File
@@ -5,9 +5,9 @@
Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases Pass [options](https://docs.docker.com/engine/reference/run/) to Docker during Dokku's `build`, `deploy` and `run` phases
``` ```
docker-options <app> [phase(s)] Display app's Docker options for all phases (or comma separated phase list) docker-options <app> [phase(s)] # Display app's Docker options for all phases (or comma separated phase list)
docker-options:add <app> <phase(s)> OPTION Add Docker option to app for phase (comma-separated phase list) docker-options:add <app> <phase(s)> OPTION # Add Docker option to app for phase (comma-separated phase list)
docker-options:remove <app> <phase(s)> OPTION Remove Docker option from app for phase (comma-separated phase list) docker-options:remove <app> <phase(s)> 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: > When specifying multiple phases, they **must** be comma-separated _without_ spaces in between each phase, like so:
+4 -4
View File
@@ -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. 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 [-t] # Show the last events (-t follows)
events:list List logged events events:list # List logged events
events:on Enable events logger events:on # Enable events logger
events:off Disable events logger events:off # Disable events logger
``` ```
## Usage ## Usage
+4 -4
View File
@@ -5,10 +5,10 @@
The preferred method to mount external containers to a dokku managed container, is to use the dokku storage plugin. The preferred method to mount external containers to a dokku managed container, is to use the dokku storage plugin.
```shell ```
storage:list <app>, List bind mounts for app's container(s) (host:container) storage:list <app> # List bind mounts for app's container(s) (host:container)
storage:mount <app> <host-dir:container-dir>, Create a new bind mount storage:mount <app> <host-dir:container-dir> # Create a new bind mount
storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount storage:unmount <app> <host-dir:container-dir> # Remove an existing bind mount
``` ```
## Ideology and Background ## Ideology and Background
+3 -3
View File
@@ -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 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 <app> [-t] Show the nginx access logs for an application (-t follows) nginx:access-logs <app> [-t] # Show the nginx access logs for an application (-t follows)
nginx:build-config <app> (Re)builds nginx config for given app nginx:build-config <app> # (Re)builds nginx config for given app
nginx:error-logs <app> [-t] Show the nginx error logs for an application (-t follows) nginx:error-logs <app> [-t] # Show the nginx error logs for an application (-t follows)
``` ```
## Customizing the nginx configuration ## Customizing the nginx configuration
+8 -8
View File
@@ -5,14 +5,14 @@
Dokku supports rudimentary process (really container) management via the `ps` plugin. Dokku supports rudimentary process (really container) management via the `ps` plugin.
``` ```
ps <app> List processes running in app container(s) ps <app> # List processes running in app container(s)
ps:rebuildall Rebuild all apps ps:rebuildall # Rebuild all apps
ps:rebuild <app> Rebuild an app ps:rebuild <app> # Rebuild an app
ps:restartall Restart all deployed app containers ps:restartall # Restart all deployed app containers
ps:restart <app> Restart app container(s) ps:restart <app> # Restart app container(s)
ps:scale <app> <proc>=<count> [<proc>=<count>] Set how many processes of a given process to run ps:scale <app> <proc>=<count> [<proc>=<count>] # Set how many processes of a given process to run
ps:start <app> Start app container(s) ps:start <app> # Start app container(s)
ps:stop <app> Stop app container(s) ps:stop <app> # Stop app container(s)
``` ```
## Scaling ## Scaling
+8 -8
View File
@@ -3,14 +3,14 @@
> New as of 0.5.0, Enhanced in 0.6.0 > New as of 0.5.0, Enhanced in 0.6.0
``` ```
proxy <app> Show proxy settings for app proxy <app> # Show proxy settings for app
proxy:disable <app> Disable proxy for app proxy:disable <app> # Disable proxy for app
proxy:enable <app> Enable proxy for app proxy:enable <app> # Enable proxy for app
proxy:ports <app> List proxy port mappings for app proxy:ports <app> # List proxy port mappings for app
proxy:ports-add <app> <scheme>:<host-port>:<container-port> [<scheme>:<host-port>:<container-port>...] Set proxy port mappings for app proxy:ports-add <app> <scheme>:<host-port>:<container-port> [<scheme>:<host-port>:<container-port>...] # Set proxy port mappings for app
proxy:ports-clear <app> Clear all proxy port mappings for app proxy:ports-clear <app> # Clear all proxy port mappings for app
proxy:ports-remove <app> <host-port> [<host-port>|<scheme>:<host-port>:<container-port>...] Unset proxy port mappings for app proxy:ports-remove <app> <host-port> [<host-port>|<scheme>:<host-port>:<container-port>...] # Unset proxy port mappings for app
proxy:set <app> <proxy-type> Set proxy type for app proxy:set <app> <proxy-type> # 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. 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.