Merge pull request #2292 from dokku/documentation-cleanup

Documentation cleanup
This commit is contained in:
Jose Diaz-Gonzalez authored and GitHub committed 2016-07-04 23:17:05 -04:00
commit f623a0a8bf
41 files changed
+673 -378

No files matched your search

+3 -3
View File
@@ -18,7 +18,7 @@ To install the latest stable release, you can run the following commands as a us
### Upgrading ### Upgrading
[View the docs for upgrading](http://dokku.viewdocs.io/dokku/upgrading) from an older version of Dokku. [View the docs for upgrading](http://dokku.viewdocs.io/dokku/getting-started/upgrading/) from an older version of Dokku.
## Documentation ## Documentation
@@ -26,11 +26,11 @@ Full documentation - including advanced installation docs - are available online
## Support ## Support
You can use [Github Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](http://dokku.viewdocs.io/dokku/troubleshooting) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku) You can use [Github Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](http://dokku.viewdocs.io/dokku/getting-started/troubleshooting/) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku)
## Contribution ## Contribution
After checking [Github Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](http://dokku.viewdocs.io/dokku/troubleshooting) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request. After checking [Github Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](http://dokku.viewdocs.io/dokku/getting-started/troubleshooting/) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request.
While we may not merge your PR as is, they serve to start conversations and improve the general dokku experience for all users. While we may not merge your PR as is, they serve to start conversations and improve the general dokku experience for all users.
+1 -1
View File
@@ -218,7 +218,7 @@ PAGE = """
$.post('/setup', data) $.post('/setup', data)
.done(function() { .done(function() {
$("#result").html("Success!") $("#result").html("Success!")
window.location.href = "http://progrium.viewdocs.io/dokku/application-deployment"; window.location.href = "http://progrium.viewdocs.io/dokku/deployment/application-deployment/";
}) })
.fail(function(data) { .fail(function(data) {
$("#result").html("Something went wrong...") $("#result").html("Something went wrong...")
+40
View File
@@ -0,0 +1,40 @@
# Backup and Recovery
> The backup plugin was deprecated in 0.4.x, below are backup recommendations for 0.5.x and later.
## Backup and Migration Tutorial
Because Dokku is git based, rebuilding a deployed app is as easy as pushing from git. You can push to a new server by updating the dokku remote in you local app's repo.
```shell
git remote rm dokku
git remote add dokku dokku@[dokku.me:dokku.me]
git push dokku [master]
```
## Databases
Some plugins, like the official [dokku-postgres](https://github.com/dokku/dokku-postgres) plugin, have built-in commands that allow non-volatile data be exported and imported.
For [dokku-postgres](https://github.com/dokku/dokku-postgres), use:
```shell
dokku postgres:export [db_name] > [db_name].dump
dokku postgres:import [db_name] < [db_name].dump
```
## Volumes and Static Assets
Dokku doesn't enforce a [300mb](https://devcenter.heroku.com/articles/slug-compiler#slug-size) limit on apps, but it's best practice to keep binary assets outside of git. Since containers are considered volatile in Dokku, external stores like s3 or storage mounts should be used for non-volatile items like user uploads. The dokku storage core plugin can be used to mount local directories / volumes inside the docker container.
See the [persistent storage documentation](/dokku/advanced-usage/persistent-storage/) for more details.
## Disaster Recovery
The best plan for disaster recovery is to always keep multiple (remote) copies of your local repo, static assets and periodic database dumps. In case of an emergency when your git repo and backups are completely lost, you can recover the last pushed copy from your remote dokku server (assuming you still have the ssh key).
```shell
mkdir [app-name] ; cd !$
git init && git remote add dokku dokku@[dokku.me:app-name]
git pull dokku/master && git checkout dokku/master
```
@@ -11,14 +11,14 @@ Common use cases include:
## `app.json` and `scripts.dokku` ## `app.json` and `scripts.dokku`
Dokku accomplishes this by using an `app.json` file. We (mostly) use the same format as Heroku's [app.json](https://devcenter.heroku.com/articles/app-json-schema). Dokku accomplishes this by using an `app.json` file. The format in use is similar to format of Heroku's [app.json](https://devcenter.heroku.com/articles/app-json-schema).
However, dokku currently only supports the nodes `scripts.dokku.predeploy` and `scripts.dokku.postdeploy`. However, dokku currently only supports the nodes `scripts.dokku.predeploy` and `scripts.dokku.postdeploy`.
Simply place an `app.json` file in the root of your repository or for dockerfile apps, `ADD` it to /app. Simply place an `app.json` file in the root of your repository or for dockerfile apps, `ADD` it to /app.
>NOTE: postdeploy changes are *NOT* committed to the app image. >NOTE: postdeploy changes are *NOT* committed to the app image.
### Example app.json ### Example app.json
``` ```json
{ {
"name": "barebones nodejs", "name": "barebones nodejs",
"description": "A barebones Node.js app using Express 4.", "description": "A barebones Node.js app using Express 4.",
@@ -5,14 +5,14 @@
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:
> >
> ``` > ```shell
> dokku docker-options:add myapp deploy,run "-v /home/dokku/logs/myapp:/app/logs" > dokku docker-options:add myapp deploy,run "-v /home/dokku/logs/myapp:/app/logs"
> ``` > ```
@@ -28,7 +28,7 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu
### Add Docker options ### Add Docker options
Add some options for the deployed/running app and when executing [`dokku run`](deployment/one-off-processes/): Add some options for the deployed/running app and when executing [`dokku run`](/dokku/deployment/one-off-processes/):
```shell ```shell
# Mount a host volume in a Docker container: "-v /host/path:/container/path" # Mount a host volume in a Docker container: "-v /host/path:/container/path"
@@ -42,10 +42,13 @@ dokku docker-options:add myapp run "-v /home/dokku/logs/myapp:/app/logs"
```shell ```shell
dokku docker-options myapp dokku docker-options myapp
# Deploy options: ```
# -v /home/dokku/logs/myapp:/app/logs
# Run options: ```
# -v /home/dokku/logs/myapp:/app/logs Deploy options:
-v /home/dokku/logs/myapp:/app/logs
Run options:
-v /home/dokku/logs/myapp:/app/logs
``` ```
### Remove a Docker option ### Remove a Docker option
@@ -5,22 +5,29 @@
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
Enable the plugin: Enable the plugin:
```shell
dokku events:on
```
``` ```
$ dokku events:on
Enabling dokku events logger Enabling dokku events logger
``` ```
Dokku will then write log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``, which can be easily displayed with the command `dokku events`: Dokku will then write log entries to `/var/log/syslog` as well as a Dokku-specific logs sub-directory `/var/log/dokku/events.log`, which can be easily displayed with the command `dokku events`:
```shell
dokku events
```
``` ```
Jul 3 16:09:48 dokku.me dokku[127630]: INVOKED: pre-release-buildpack( pythonapp ) Jul 3 16:09:48 dokku.me dokku[127630]: INVOKED: pre-release-buildpack( pythonapp )
@@ -42,6 +49,11 @@ Jul 3 16:30:02 dokku.me dokku[131384]: INVOKED: docker-args-run( rubyapp )
``` ```
You can list all events that are currently being recorded via `dokku events:list`: You can list all events that are currently being recorded via `dokku events:list`:
```shell
dokku events:list
```
``` ```
=====> Events currently logged =====> Events currently logged
docker-args-build docker-args-build
@@ -1,14 +1,14 @@
# Dokku Core Storage Plugin # Persistent Storage
> New as of 0.5.0 > New as of 0.5.0
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
@@ -19,11 +19,11 @@ The storage plugin requires explicit paths on the host side. This is intentional
This example demonstrates how to mount the recommended directory to `/storage` inside the container: This example demonstrates how to mount the recommended directory to `/storage` inside the container:
``` ```shell
$ dokku storage:mount app-name /var/lib/dokku/data/storage:/storage dokku storage:mount app-name /var/lib/dokku/data/storage:/storage
``` ```
Dokku will then mount the shared contents of`/var/lib/dokku/data/storage` to `/storage` inside the container. Dokku will then mount the shared contents of `/var/lib/dokku/data/storage` to `/storage` inside the container.
A more complete workflow may require making a custom directory for your application and mounting it within your `/app/storage` directory instead. The mount point is *not* relative to your application's working directory, and is instead relative to the root of the container. A more complete workflow may require making a custom directory for your application and mounting it within your `/app/storage` directory instead. The mount point is *not* relative to your application's working directory, and is instead relative to the root of the container.
@@ -61,8 +61,9 @@ Your app may have services that are running in memory and need to be backed up l
### Build phase ### Build phase
By default, dokku will only bind storage mounts during the deploy and run phases. Under certain conditions, one might want to bind a storage mount during the build phase. This can be accomplished by using the `docker-options` plugin directly. By default, dokku will only bind storage mounts during the deploy and run phases. Under certain conditions, one might want to bind a storage mount during the build phase. This can be accomplished by using the `docker-options` plugin directly.
```
$ dokku docker-options:add <app> "-v /tmp/python-test:/opt/test" ```shell
dokku docker-options:add <app> "-v /tmp/python-test:/opt/test"
``` ```
NOTE: **This can cause data loss** if you bind a mount under `/app` in buildpack apps as herokuish will attempt to remove the original app path during the build phase. NOTE: **This can cause data loss** if you bind a mount under `/app` in buildpack apps as herokuish will attempt to remove the original app path during the build phase.
@@ -1,16 +1,16 @@
# Proxy plugin # Proxy Management
> 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.
@@ -23,21 +23,37 @@ By default, the deployed docker container running your app's web process will bi
> If a proxy is disabled, dokku will bind your container's port to a random port on the host for every deploy, e.g. `0.0.0.0:32771->5000/tcp`. > If a proxy is disabled, dokku will bind your container's port to a random port on the host for every deploy, e.g. `0.0.0.0:32771->5000/tcp`.
By way of example, in the default case, each container is bound to the docker interface:
```shell ```shell
# container bound to docker interface docker ps
$ docker ps ```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1b88d8aec3d1 dokku/node-js-app:latest "/bin/bash -c '/star About a minute ago Up About a minute node-js-app.web.1 1b88d8aec3d1 dokku/node-js-app:latest "/bin/bash -c '/star About a minute ago Up About a minute node-js-app.web.1
```
# internal IP address for the container As such, the container's IP address will be an internal IP, and thus it is only accessible on the host itself:
$ docker inspect --format '{{ .NetworkSettings.IPAddress }}' node-js-app.web.1
```
docker inspect --format '{{ .NetworkSettings.IPAddress }}' node-js-app.web.1
```
```
172.17.0.6 172.17.0.6
```
# disable the proxy so it listens on a host ip address However, you can disable the internal proxying via the `proxy:disable` command so that it will listen on the host's IP address:
$ dokku proxy:disable node-js-app
```shell
dokku proxy:disable node-js-app
# container bound to all interfaces # container bound to all interfaces
$ docker ps docker ps
```
```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d6499edb0edb dokku/node-js-app:latest "/bin/bash -c '/star About a minute ago Up About a minute 0.0.0.0:49153->5000/tcp node-js-app.web.1 d6499edb0edb dokku/node-js-app:latest "/bin/bash -c '/star About a minute ago Up About a minute 0.0.0.0:49153->5000/tcp node-js-app.web.1
``` ```
@@ -48,33 +64,79 @@ d6499edb0edb dokku/node-js-app:latest "/bin/bash -c '/star About a mi
You can now configure `host -> container` port mappings with the `proxy:ports-*` commands. This mapping is currently supported by the built-in nginx-vhosts plugin. You can now configure `host -> container` port mappings with the `proxy:ports-*` commands. This mapping is currently supported by the built-in nginx-vhosts plugin.
To inspect the port mapping for a given application, use the `proxy:ports` command:
```shell ```shell
$ dokku proxy:ports node-js-app dokku proxy:ports node-js-app
```
```
-----> Port mappings for node-js-app -----> Port mappings for node-js-app
-----> scheme host port container port -----> scheme host port container port
http 80 5000 http 80 5000
```
$ curl http://node-js-app.dokku.me The above application is listening on the host's port `80`, which we can test via curl:
```shell
curl http://node-js-app.dokku.me
```
```
Hello World! Hello World!
```
$ curl http://node-js-app.dokku.me:8080 There are cases where we may wish for the service to be listening on more than one port, such as port 8080. Normally, this would not be possible:
```shell
curl http://node-js-app.dokku.me:8080
```
```
curl: (7) Failed to connect to node-js-app.dokku.me port 8080: Connection refused curl: (7) Failed to connect to node-js-app.dokku.me port 8080: Connection refused
```
$ dokku proxy:ports-add node-js-app http:8080:5000 However, we can use the `proxy:ports-add` command to add a second external port mapping - `8080` - to our application's port `5000`.
```shell
dokku proxy:ports-add node-js-app http:8080:5000
```
```
-----> Setting config vars -----> Setting config vars
DOKKU_PROXY_PORT_MAP: http:80:5000 http:8080:5000 DOKKU_PROXY_PORT_MAP: http:80:5000 http:8080:5000
-----> Configuring node-js-app.dokku.me...(using built-in template) -----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating http nginx.conf -----> Creating http nginx.conf
-----> Running nginx-pre-reload -----> Running nginx-pre-reload
Reloading nginx Reloading nginx
```
$ curl http://node-js-app.dokku.me We can now test that port 80 still responds properly:
Hello World!
$ curl http://node-js-app.dokku.me:8080 ```shell
curl http://node-js-app.dokku.me
```
```
Hello World! Hello World!
``` ```
And our new listening port of `8080` also works:
```shell
curl http://node-js-app.dokku.me:8080
```
```
Hello World!
```
You can also remove a port mapping that is no longer necessary:
```shell
dokku proxy:ports-remove node-js-app http:80:5000
```
By default, buildpack apps and dockerfile apps **without** explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on port `80` (and additionally a listener on 443 if ssl is enabled) that will proxy to the application container on port `5000`. Dockerfile apps **with** explicitly exposed ports will be configured with a listener on each exposed port and will proxy to that same port of the deployed application container. By default, buildpack apps and dockerfile apps **without** explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on port `80` (and additionally a listener on 443 if ssl is enabled) that will proxy to the application container on port `5000`. Dockerfile apps **with** explicitly exposed ports will be configured with a listener on each exposed port and will proxy to that same port of the deployed application container.
> NOTE: This default behavior **will not** be automatically changed on subsequent pushes and must be manipulated with the `proxy:ports-*` syntax detailed above. > NOTE: This default behavior **will not** be automatically changed on subsequent pushes and must be manipulated with the `proxy:ports-*` syntax detailed above.
+3 -3
View File
@@ -5,11 +5,11 @@
- The nginx-vhosts template language is now [sigil](https://github.com/gliderlabs/sigil) - The nginx-vhosts template language is now [sigil](https://github.com/gliderlabs/sigil)
- No need to escape literal `$` characters (or other "bash-isms") - No need to escape literal `$` characters (or other "bash-isms")
- Template variables are represented as {{ .VARIABLE_NAME }} - Template variables are represented as {{ .VARIABLE_NAME }}
- A detailed list of template variables can be found [here](/dokku/nginx#available-template-variables) - A detailed list of template variables can be found [here](/dokku/configuration/nginx/#available-template-variables)
- A custom nginx-vhosts template must be named `nginx.conf.sigil` - A custom nginx-vhosts template must be named `nginx.conf.sigil`
- The default path for this custom template is the root of your repo (i.e. `/app` in the container or `WORKDIR` if defined in a dockerfile app) - The default path for this custom template is the root of your repo (i.e. `/app` in the container or `WORKDIR` if defined in a dockerfile app)
- Dokku no longer looks for this file in `/home/dokku/myapp` on the dokku server - Dokku no longer looks for this file in `/home/dokku/myapp` on the dokku server
- Check out an example template [here](/dokku/nginx/) - Check out an example template [here](/dokku/configuration/nginx/)
- Support for server-wide SSL certs have been dropped in favor of using the `certs` plugin - Support for server-wide SSL certs have been dropped in favor of using the `certs` plugin
- `dokku certs:add myapp < certs.tar` - `dokku certs:add myapp < certs.tar`
- All domains for an SSL-enabled app will be redirected to https by default - All domains for an SSL-enabled app will be redirected to https by default
@@ -22,4 +22,4 @@
- Dockerfiles with `EXPOSE` clauses will get [all **tcp** ports proxied by default](/dokku/deployment/dockerfiles/#exposed-ports) - Dockerfiles with `EXPOSE` clauses will get [all **tcp** ports proxied by default](/dokku/deployment/dockerfiles/#exposed-ports)
- Note that nginx will proxy the same port numbers to listen publicly - Note that nginx will proxy the same port numbers to listen publicly
- UDP ports can be exposed by disabling the [nginx proxy](/dokku/proxy/) with `dokku proxy:disable myapp` - UDP ports can be exposed by disabling the [nginx proxy](/dokku/advanced-usage/proxy-management/) with `dokku proxy:disable myapp`
+10 -10
View File
@@ -7,26 +7,26 @@
- `DOKKU_CHECKS_ENABLED` has been migrated to `DOKKU_CHECKS_SKIPPED` - `DOKKU_CHECKS_ENABLED` has been migrated to `DOKKU_CHECKS_SKIPPED`
- `DOKKU_CHECKS_DISABLED` is now a thing - `DOKKU_CHECKS_DISABLED` is now a thing
- The values for the above can be a comma-separated list of process-types or the literal string `_all_` - The values for the above can be a comma-separated list of process-types or the literal string `_all_`
- See the [updated `checks`](/dokku/checks-examples/) docs for more info - See the [updated `checks`](/dokku/deployment/zero-downtime-deploys/) docs for more info
## proxy port mapping ## proxy port mapping
- You can now configure host -> container proxy port mappings - You can now configure host -> container proxy port mappings
- The UI is handled by the [proxy](/dokku/proxy/) interface plugin by setting the `DOKKU_PROXY_PORT_MAP` config variable in the format of `scheme:host-port:container-port`. The default `nginx-vhosts` proxy plugin supports both the `http` and `https` schemes. - The UI is handled by the [proxy](/dokku/advanced-usage/proxy-management/) interface plugin by setting the `DOKKU_PROXY_PORT_MAP` config variable in the format of `scheme:host-port:container-port`. The default `nginx-vhosts` proxy plugin supports both the `http` and `https` schemes.
- Default port mappings - Default port mappings
- buildpack apps will be set to `http:80:5000` and will also include `https:443:5000` if SSL is enabled. - buildpack apps will be set to `http:80:5000` and will also include `https:443:5000` if SSL is enabled.
- dockerfile apps with explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on each exposed port that proxies to the same port of the deployed application container. - dockerfile apps with explicitly exposed ports (i.e. using the `EXPOSE` directive) will be configured with a listener on each exposed port that proxies to the same port of the deployed application container.
- You may override this behavior with the [`proxy:ports-*` commands](/dokku/proxy/) or by directly setting `DOKKU_PROXY_PORT_MAP` with the `config:set` command - You may override this behavior with the [`proxy:ports-*` commands](/dokku/advanced-usage/proxy-management/) or by directly setting `DOKKU_PROXY_PORT_MAP` with the `config:set` command
- dockerfile apps without explicitly exposed ports will behave the same as a buildpack app - dockerfile apps without explicitly exposed ports will behave the same as a buildpack app
- NOTE: These defaults **are not** automatically changed on subsequent pushes and must be manipulated with the aforementioned commands - NOTE: These defaults **are not** automatically changed on subsequent pushes and must be manipulated with the aforementioned commands
## calling the dokku binary ## calling the dokku binary
- Plugins should *not* call the dokku binary directly. Clients using the `--app` argument are potentially broken, amongst others, when doing so. Instead, please source the `functions` file for a given plugin when attempting to call dokku internal functions. As a result, the following dokku commands are no longer publicly exposed: - Plugins should *not* call the dokku binary directly. Clients using the `--app` argument are potentially broken, amongst others, when doing so. Instead, please source the `functions` file for a given plugin when attempting to call dokku internal functions. As a result, the following dokku commands are no longer publicly exposed:
- dokku build - `dokku build`
- dokku receive - `dokku receive`
- dokku release - `dokku release`
- dokku tar:build - `dokku tar:build`
- dokku tar:build-locked - `dokku tar:build-locked`
- dokku git:build - `dokku git:build`
- dokku git:build-locked - `dokku git:build-locked`
+33
View File
@@ -282,6 +282,39 @@ a.list-group-item {
.markdown-body h1 + h2 { .markdown-body h1 + h2 {
margin-top: 1em; margin-top: 1em;
} }
.highlight-show-language {
position: relative;
}
.highlight-show-language-label {
color: black;
background-color: #CFCFCF;
display: inline-block;
position: absolute;
bottom: auto;
left: auto;
top: 0;
right: 0;
width: auto;
height: auto;
font-size: 0.9em;
border-radius: 0 0 0 5px;
padding: 0 0.5em;
text-shadow: none;
z-index: 1;
-webkit-box-shadow: none;
-moz-box-shadow: none;
box-shadow: none;
-webkit-transform: none;
-moz-transform: none;
-ms-transform: none;
-o-transform: none;
transform: none;
}
.highlight-output pre {
color: #fff;
background-color: #000;
padding: 10px;
}
code { code {
padding: 0; padding: 0;
padding-top: 0.2em; padding-top: 0.2em;
-45
View File
@@ -1,45 +0,0 @@
# Backup and Recovery
> The backup plugin was deprecated in 0.4.x, below are backup recommendations for 0.5.x and later.
## Backup and Migration Tutorial
Because Dokku is git based, rebuilding a deployed app is as easy as pushing from git. You can push to a new server by updating the dokku remote in you local app's repo.
```
$ git remote rm dokku
$ git remote add dokku dokku@[dokku.me:dokku.me]
$ git push dokku [master]
```
## Databases
Some plugins, like the official [dokku-postgres] plugin, have built-in commands that allow non-volatile data be exported and imported.
For [dokku-postgres], use:
```
dokku postgres:export [db_name] > [db_name].dump
dokku postgres:import [db_name] < [db_name].dump
```
## Volumes and Static Assets
Dokku doesn't enforce a [300mb] limit on apps, but it's best practice to keep binary assets outside of git. Since containers are considered volatile in Dokku, external stores like s3 or storage mounts should be used for non-volatile items like user uploads. The dokku storage core plugin can be used to mount local directories / volumes inside the docker 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:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
```
## Disaster Recovery
The best plan for disaster recovery is to always keep multiple (remote) copies of your local repo, static assets and periodic database dumps. In case of an emergency when your git repo and backups are completely lost, you can recover the last pushed copy from your remote dokku server (assuming you still have the ssh key).
```
mkdir [app-name] ; cd !$
git init && git remote add dokku dokku@[dokku.me:app-name]
git pull dokku/master && git checkout dokku/master
```
[dokku-postgres]: <https://github.com/dokku/dokku-postgres>
[300mb]: <https://devcenter.heroku.com/articles/slug-compiler#slug-size>
@@ -26,7 +26,7 @@ dokku plugins-install
## Creating your own plugin ## Creating your own plugin
[See the full documentation](/dokku/development/plugin-creation). [See the full documentation](/dokku/development/plugin-creation/).
## Official Plugins (Beta) ## Official Plugins (Beta)
@@ -86,6 +86,8 @@ Note: The following plugins have been supplied by our community and may not have
[hughfletcher]: https://github.com/hughfletcher [hughfletcher]: https://github.com/hughfletcher
[iamale]: https://github.com/iamale [iamale]: https://github.com/iamale
[ignlg]: https://github.com/ignlg [ignlg]: https://github.com/ignlg
[iloveitaly]: https://github.com/iloveitaly
[investtools]: https://github.com/investtools
[iskandar]: https://github.com/iskandar [iskandar]: https://github.com/iskandar
[jagandecapri]: https://github.com/jagandecapri [jagandecapri]: https://github.com/jagandecapri
[jeffutter]: https://github.com/jeffutter [jeffutter]: https://github.com/jeffutter
-8
View File
@@ -1,8 +0,0 @@
# Components
* [Docker](https://github.com/dotcloud/docker) - Container runtime and manager
* [Herokuish](https://github.com/gliderlabs/herokuish) - Buildpack builder
* [plugn](https://github.com/dokku/plugn) - Shell based plugins and hooks
* [sshcommand](https://github.com/dokku/sshcommand) - Fixed commands over SSH
Looking to keep codebase as simple and hackable as possible, so try to keep your line count down.
+1 -1
View File
@@ -70,7 +70,7 @@ If everything is working correctly, you should also be able to query for any oth
If they all return your IP address, you have set DNS up properly for dokku. You should also be able to `ssh root@myserver.example.tld` and access your server. If they all return your IP address, you have set DNS up properly for dokku. You should also be able to `ssh root@myserver.example.tld` and access your server.
Proceed with the setup instructions in the [README](https://github.com/dokku/dokku/blob/master/README.md) Proceed with the setup instructions in the [installation documentation](/dokku/getting-started/installation/)
#### Using the root of your domain (myapp.example.tld) #### Using the root of your domain (myapp.example.tld)
@@ -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
@@ -71,7 +71,7 @@ dokku domains:remove myapp example.com
By default, dokku will route any received request with an unknown HOST header value to the lexicographically first site in the nginx config stack. If this is not the desired behavior, you may want to add the following configuration to the global nginx configuration. This will catch all unknown HOST header values and return a `410 Gone` response. You can replace the `return 410;` with `return 444;` which will cause nginx to not respond to requests that do not match known domains (connection refused). By default, dokku will route any received request with an unknown HOST header value to the lexicographically first site in the nginx config stack. If this is not the desired behavior, you may want to add the following configuration to the global nginx configuration. This will catch all unknown HOST header values and return a `410 Gone` response. You can replace the `return 410;` with `return 444;` which will cause nginx to not respond to requests that do not match known domains (connection refused).
``` ```nginx
server { server {
listen 80 default_server; listen 80 default_server;
listen [::]:80 default_server; listen [::]:80 default_server;
@@ -84,7 +84,7 @@ server {
You may also wish to use a separate vhost in your `/etc/nginx/sites-enabled` directory. To do so, create the vhost in that directory as `/etc/nginx/sites-enabled/00-default.conf`. You will also need to change two lines in the main `nginx.conf`: You may also wish to use a separate vhost in your `/etc/nginx/sites-enabled` directory. To do so, create the vhost in that directory as `/etc/nginx/sites-enabled/00-default.conf`. You will also need to change two lines in the main `nginx.conf`:
``` ```nginx
# Swap both conf.d include line and the sites-enabled include line. From: # Swap both conf.d include line and the sites-enabled include line. From:
include /etc/nginx/conf.d/*.conf; include /etc/nginx/conf.d/*.conf;
include /etc/nginx/sites-enabled/*; include /etc/nginx/sites-enabled/*;
File renamed without changes.
+20 -16
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
@@ -24,7 +24,8 @@ Dokku uses a templating library by the name of [sigil](https://github.com/glider
### Example Custom Template ### Example Custom Template
Use case: add an `X-Served-By` header to requests Use case: add an `X-Served-By` header to requests
```
```go
server { server {
listen [::]:{{ .NGINX_PORT }}; listen [::]:{{ .NGINX_PORT }};
listen {{ .NGINX_PORT }}; listen {{ .NGINX_PORT }};
@@ -64,6 +65,7 @@ upstream {{ .APP }} {
``` ```
### Available template variables ### Available template variables
``` ```
{{ .APP }} Application name {{ .APP }} Application name
{{ .APP_SSL_PATH }} Path to SSL certificate and key {{ .APP_SSL_PATH }} Path to SSL certificate and key
@@ -84,7 +86,8 @@ upstream {{ .APP }} {
### Example HTTP to HTTPS Custom Template ### Example HTTP to HTTPS Custom Template
Use case: a simple dockerfile app that includes `EXPOSE 80` Use case: a simple dockerfile app that includes `EXPOSE 80`
```
```go
server { server {
listen [::]:80; listen [::]:80;
listen 80; listen 80;
@@ -130,7 +133,8 @@ upstream {{ .APP }} {
``` ```
### Example using new proxy port mapping ### Example using new proxy port mapping
```
```go
{{ range $port_map := .PROXY_PORT_MAP | split " " }} {{ range $port_map := .PROXY_PORT_MAP | split " " }}
{{ $port_map_list := $port_map | split ":" }} {{ $port_map_list := $port_map | split ":" }}
{{ $scheme := index $port_map_list 0 }} {{ $scheme := index $port_map_list 0 }}
@@ -181,7 +185,7 @@ upstream {{ $.APP }}-{{ $upstream_port }} {
The default nginx.conf template will include everything from your apps `nginx.conf.d/` subdirectory in the main `server {}` block (see above): The default nginx.conf template will include everything from your apps `nginx.conf.d/` subdirectory in the main `server {}` block (see above):
``` ```go
include {{ .DOKKU_ROOT }}/{{ .APP }}/nginx.conf.d/*.conf; include {{ .DOKKU_ROOT }}/{{ .APP }}/nginx.conf.d/*.conf;
``` ```
@@ -198,36 +202,36 @@ The example above uses additional configuration files directly on the dokku host
## Domains plugin ## Domains plugin
See the [domain-configuration documentation](/dokku/deployment/domain-configuration/). See the [domain configuration documentation](/dokku/configuration/domains/).
## Customizing hostnames ## Customizing hostnames
See the [customizing hostnames documentation](/dokku/deployment/domain-configuration/#customizing-hostnames). See the [customizing hostnames documentation](/dokku/configuration/domains/#customizing-hostnames).
## Disabling VHOSTS ## Disabling VHOSTS
See the [disabling vhosts documentation](/dokku/deployment/domain-configuration/#disabling-vhosts). See the [disabling vhosts documentation](/dokku/configuration/domains/#disabling-vhosts).
## Default site ## Default site
See the [default site documentation](/dokku/deployment/domain-configuration/#default-site). See the [default site documentation](/dokku/configuration/domains/#default-site).
## Running behind a load balancer ## Running behind a load balancer
See the [load balancer documentation](/dokku/deployment/ssl-configuration/#running-behind-a-load-balancer). See the [load balancer documentation](/dokku/configuration/ssl/#running-behind-a-load-balancer).
## HSTS Header ## HSTS Header
See the [HSTS documentation](/dokku/deployment/ssl-configuration/#hsts-header). See the [HSTS documentation](/dokku/configuration/ssl/#hsts-header).
## SSL Configuration ## SSL Configuration
See the [ssl documentation](/dokku/deployment/ssl-configuration/). See the [ssl documentation](/dokku/configuration/ssl/).
## Disabling Nginx ## Disabling Nginx
See the [proxy documentation](/dokku/proxy/). See the [proxy documentation](/dokku/advanced-usage/proxy-management/).
## Managing Proxy Port mappings ## Managing Proxy Port mappings
See the [proxy documentation](/dokku/proxy/#proxy-port-mapping). See the [proxy documentation](/dokku/advanced-usage/proxy-management/#proxy-port-mapping).
@@ -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
``` ```
@@ -37,9 +39,9 @@ cat yourdomain_com.crt yourdomain_com.ca-bundle > server.crt
#### SSL and Multiple Domains #### SSL and Multiple Domains
When an SSL certificate is associated to an application, the certificate will be associated with *all* domains currently associated with said application. Your certificate _should_ be associated with all of those domains, otherwise accessing the application will result in SSL errors. If you wish to remove one of the domains from the application, refer to the [domain configuration documentation](/dokku/deployment/domain-configuration/). When an SSL certificate is associated to an application, the certificate will be associated with *all* domains currently associated with said application. Your certificate _should_ be associated with all of those domains, otherwise accessing the application will result in SSL errors. If you wish to remove one of the domains from the application, refer to the [domain configuration documentation](/dokku/configuration/domains/).
Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/dokku/nginx/). Note that with the default nginx template, requests will be redirected to the `https` version of the domain. If this is not the desired state of request resolution, you may customize the nginx template in use. For more details, see the [nginx documentation](/dokku/configuration/nginx/).
### Certificate generation ### Certificate generation
@@ -53,8 +55,11 @@ If you decide to obtain a CA signed certficate, you can import that certificate
The `certs:info` command will simply inspect the install SSL cert and print out details. NOTE: The server-wide certificate will be inspect if installed and no app-specific certificate exists. The `certs:info` command will simply inspect the install SSL cert and print out details. NOTE: The server-wide certificate will be inspect if installed and no app-specific certificate exists.
```shell
dokku certs:info node-js-app
```
``` ```
$ dokku certs:info node-js-app
-----> Fetching SSL Endpoint info for node-js-app... -----> Fetching SSL Endpoint info for node-js-app...
-----> Certificate details: -----> Certificate details:
=====> Common Name(s): =====> Common Name(s):
@@ -81,9 +86,9 @@ Beware that if you enable the header and a subsequent deploy of your application
Your application has access to the HTTP headers `X-Forwarded-Proto`, `X-Forwarded-For` and `X-Forwarded-Port`. These headers indicate the protocol of the original request (HTTP or HTTPS), the port number, and the IP address of the client making the request, respectively. The default configuration is for Nginx to set these headers. Your application has access to the HTTP headers `X-Forwarded-Proto`, `X-Forwarded-For` and `X-Forwarded-Port`. These headers indicate the protocol of the original request (HTTP or HTTPS), the port number, and the IP address of the client making the request, respectively. The default configuration is for Nginx to set these headers.
If your server runs behind an HTTP/S load balancer, then Nginx will see all requests as coming from the load balancer. If your load balancer sets the `X-Forwarded-` headers, you can tell Nginx to pass these headers from load balancer to your application by using the following [nginx custom template](/dokku/nginx/#customizing-the-nginx-configuration) If your server runs behind an HTTP/S load balancer, then Nginx will see all requests as coming from the load balancer. If your load balancer sets the `X-Forwarded-` headers, you can tell Nginx to pass these headers from load balancer to your application by using the following [nginx custom template](/dokku/configuration/nginx/#customizing-the-nginx-configuration)
```shell ```go
server { server {
listen [::]:{{ .NGINX_PORT }}; listen [::]:{{ .NGINX_PORT }};
listen {{ .NGINX_PORT }}; listen {{ .NGINX_PORT }};
@@ -20,7 +20,7 @@ dokku apps:create ruby-rails-sample
### Create the backing services ### Create the backing services
When you create a new app, Dokku by default *does not* provide any datastores such as MySQL or PostgreSQL. You will need to install plugins to handle that, but fortunately [Dokku has official plugins](/dokku/plugins/#official-plugins-beta) for common datastores. Our sample app requires a PostgreSQL service: When you create a new app, Dokku by default *does not* provide any datastores such as MySQL or PostgreSQL. You will need to install plugins to handle that, but fortunately [Dokku has official plugins](/dokku/community/plugins/#official-plugins-beta) for common datastores. Our sample app requires a PostgreSQL service:
```shell ```shell
# on your dokku host # on your dokku host
@@ -56,8 +56,6 @@ git remote add dokku dokku@dokku.me:ruby-rails-sample
git push dokku master git push dokku master
``` ```
You should see output similar to the following:
``` ```
Counting objects: 231, done. Counting objects: 231, done.
Delta compression using up to 8 threads. Delta compression using up to 8 threads.
@@ -78,15 +76,13 @@ Total 231 (delta 93), reused 147 (delta 53)
Using rake 10.4.2 Using rake 10.4.2
... ...
```
When the deploy finishes, the application's URL will be shown.
```shell
=====> Application deployed: =====> Application deployed:
http://ruby-rails-sample.dokku.me http://ruby-rails-sample.dokku.me
``` ```
When the deploy finishes, the application's URL will be shown as seen above.
Dokku supports deploying applications via [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) with [Herokuish](https://github.com/gliderlabs/herokuish#buildpacks) or using a project's [dockerfile](https://docs.docker.com/reference/builder/). Dokku supports deploying applications via [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) with [Herokuish](https://github.com/gliderlabs/herokuish#buildpacks) or using a project's [dockerfile](https://docs.docker.com/reference/builder/).
### Removing a deployed app ### Removing a deployed app
@@ -152,28 +148,34 @@ Note that if the buildpack or dockerfile build process require ssh key access fo
The name of remote repository is used as the name of application to be deployed, as for example above: The name of remote repository is used as the name of application to be deployed, as for example above:
$ git remote add dokku dokku@dokku.me:ruby-rails-sample ```shell
$ git push dokku master git remote add dokku dokku@dokku.me:ruby-rails-sample
git push dokku master
```
Is deployed to, ```
remote: -----> Application deployed:
remote: -----> Application deployed: remote: http://ruby-rails-sample.dokku.me
remote: http://ruby-rails-sample.dokku.me ```
You can also specify fully qualified names, say `app.dokku.me`, as You can also specify fully qualified names, say `app.dokku.me`, as
$ git remote add dokku dokku@dokku.me:app.dokku.me ```shell
$ git push dokku master git remote add dokku dokku@dokku.me:app.dokku.me
git push dokku master
```
So, after deployment the application will be available at, ```
remote: -----> Application deployed:
remote: -----> Application deployed: remote: http://app.dokku.me
remote: http://app.dokku.me ```
This is in particular useful, then you want to deploy to root domain, as This is in particular useful, then you want to deploy to root domain, as
$ git remote add dokku dokku@dokku.me:dokku.me ```shell
$ git push dokku master git remote add dokku dokku@dokku.me:dokku.me
git push dokku master
```
... deployment ... ... deployment ...
@@ -192,7 +194,7 @@ See the [user management documentation](/dokku/deployment/user-management).
## Default vhost ## Default vhost
See the [nginx documentation](/dokku/nginx/#default-site). See the [nginx documentation](/dokku/configuration/nginx/#default-site).
## Dockerfile deployment ## Dockerfile deployment
@@ -204,8 +206,8 @@ See the [buildpack documentation](/dokku/deployment/buildpacks/).
## Image tagging ## Image tagging
See the [image tagging documentation](/dokku/deployment/images). See the [image tagging documentation](/dokku/deployment/images/).
## Zero downtime deploy ## Zero downtime deploy
See the [zero-downtime deploy documentation](/dokku/checks-examples/). See the [zero-downtime deploy documentation](/dokku/deployment/zero-downtime-deploys/).
+4 -4
View File
@@ -4,7 +4,7 @@ Dokku normally defaults to using [heroku buildpacks](https://devcenter.heroku.co
- Use `dokku config:set` to set the `BUILDPACK_URL` environment variable. - Use `dokku config:set` to set the `BUILDPACK_URL` environment variable.
- Add `BUILDPACK_URL` to a committed `.env` file in the root of your repository. - Add `BUILDPACK_URL` to a committed `.env` file in the root of your repository.
- See the [environment variable documentation](/dokku/configuration-management/) for more details. - See the [environment variable documentation](/dokku/configuration/environment-variables/) for more details.
- Create a `.buildpacks` file in the root of your repository. - Create a `.buildpacks` file in the root of your repository.
## Specifying a custom buildpack ## Specifying a custom buildpack
@@ -59,7 +59,7 @@ dokku config:set APP BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-no
## Specifying commands via Procfile ## Specifying commands via Procfile
While many buildpacks have a default command that is run when a detected repository is pushed, it is possible to override this command via a Procfile. A Procfile can also be used to specify multiple commands, each of which is subject to process scaling. See the [process scaling documentation](/dokku/process-management/) for more details around scaling individual processes. While many buildpacks have a default command that is run when a detected repository is pushed, it is possible to override this command via a Procfile. A Procfile can also be used to specify multiple commands, each of which is subject to process scaling. See the [process scaling documentation](/dokku/deployment/process-management/) for more details around scaling individual processes.
A Procfile is a file named `Procfile`. It should be named `Procfile` exactly, and not anything else. For example, `Procfile.txt` is not valid. The file should be a simple text file. A Procfile is a file named `Procfile`. It should be named `Procfile` exactly, and not anything else. For example, `Procfile.txt` is not valid. The file should be a simple text file.
@@ -75,12 +75,12 @@ The syntax for declaring a `Procfile` is as follows. Note that the format is one
If, for example, you have multiple queue workers and wish to scale them separately, the following would be a valid way to work around the requirement of not duplicating process types: If, for example, you have multiple queue workers and wish to scale them separately, the following would be a valid way to work around the requirement of not duplicating process types:
``` ```Procfile
worker: env QUEUE=* bundle exec rake resque:work worker: env QUEUE=* bundle exec rake resque:work
importantworker: env QUEUE=important bundle exec rake resque:work importantworker: env QUEUE=important bundle exec rake resque:work
``` ```
The `web` process type holds some significance in that it is the only process type that is automatically scaled to `1` on the initial application deploy. See the [process scaling documentation](/dokku/process-management/) for more details around scaling individual processes. The `web` process type holds some significance in that it is the only process type that is automatically scaled to `1` on the initial application deploy. See the [process scaling documentation](/dokku/deployment/process-management/) for more details around scaling individual processes.
## Clearing buildpack cache ## Clearing buildpack cache
+5 -5
View File
@@ -21,19 +21,19 @@ Dokku will extract all tcp ports exposed using the `EXPOSE` directive (one port
If you do not explicitly `EXPOSE` a port in your `Dockerfile`, dokku will configure the nginx proxy to listen on port 80 (and 443 for TLS) and forward traffic to your app listening on port 5000 inside the container. Just like buildpack apps, you can also use the `$PORT` environment variable in your app to maintain portability. If you do not explicitly `EXPOSE` a port in your `Dockerfile`, dokku will configure the nginx proxy to listen on port 80 (and 443 for TLS) and forward traffic to your app listening on port 5000 inside the container. Just like buildpack apps, you can also use the `$PORT` environment variable in your app to maintain portability.
When ports are exposed through the default nginx proxy, they are proxied externally as HTTP ports. At this time, in no case do we proxy plain TCP or UDP ports. If you'd like to investigate alternative proxy methods, please refer to our [proxy documentation](/dokku/proxy/). When ports are exposed through the default nginx proxy, they are proxied externally as HTTP ports. At this time, in no case do we proxy plain TCP or UDP ports. If you'd like to investigate alternative proxy methods, please refer to our [proxy management documentation](/dokku/advanced-usage/proxy-management/).
## Customizing the run command ## Customizing the run command
By default no arguments are passed to `docker run` when deploying the container and the `CMD` or `ENTRYPOINT` defined in the `Dockerfile` are executed. You can take advantage of docker ability of overriding the `CMD` or passing parameters to your `ENTRYPOINT` setting `$DOKKU_DOCKERFILE_START_CMD`. Let's say for example you are deploying a base nodejs image, with the following `ENTRYPOINT`: By default no arguments are passed to `docker run` when deploying the container and the `CMD` or `ENTRYPOINT` defined in the `Dockerfile` are executed. You can take advantage of docker ability of overriding the `CMD` or passing parameters to your `ENTRYPOINT` setting `$DOKKU_DOCKERFILE_START_CMD`. Let's say for example you are deploying a base nodejs image, with the following `ENTRYPOINT`:
``` ```Dockerfile
ENTRYPOINT ["node"] ENTRYPOINT ["node"]
``` ```
You can do: You can do:
``` ```shell
dokku config:set APP DOKKU_DOCKERFILE_START_CMD="--harmony server.js" dokku config:set APP DOKKU_DOCKERFILE_START_CMD="--harmony server.js"
``` ```
@@ -52,14 +52,14 @@ When you deploy your app a Docker image will be built, the `Procfile` will be ex
(it must be in the folder defined in your `Dockerfile` as `WORKDIR` or `/app`) and the commands (it must be in the folder defined in your `Dockerfile` as `WORKDIR` or `/app`) and the commands
in it will be passed to `docker run` to start your process(es). Here's an example `Procfile`: in it will be passed to `docker run` to start your process(es). Here's an example `Procfile`:
``` ```Procfile
web: bin/run-prod.sh web: bin/run-prod.sh
worker: bin/run-worker.sh worker: bin/run-worker.sh
``` ```
And `Dockerfile`: And `Dockerfile`:
``` ```Dockerfile
FROM debian:jessie FROM debian:jessie
WORKDIR /app WORKDIR /app
COPY . ./ COPY . ./
+38 -15
View File
@@ -5,35 +5,59 @@
The dokku tags plugin allows you to add docker image tags to the currently deployed app image for versioning and subsequent deployment. The dokku tags plugin allows you to add docker image tags to the currently deployed app image for versioning and subsequent deployment.
``` ```
tags <app> List all app image tags tags <app> # List all app image tags
tags:create <app> <tag> Add tag to latest running app image tags:create <app> <tag> # Add tag to latest running app image
tags:deploy <app> <tag> Deploy tagged app image tags:deploy <app> <tag> # Deploy tagged app image
tags:destroy <app> <tag> Remove app image tag tags:destroy <app> <tag> # Remove app image tag
``` ```
Example: For exampple, you can list all tags for a given application:
```shell
dokku tags node-js-app
```
``` ```
$ dokku tags node-js-app
=====> Image tags for dokku/node-js-app =====> Image tags for dokku/node-js-app
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
dokku/node-js-app latest 936a42f25901 About a minute ago 1.025 GB dokku/node-js-app latest 936a42f25901 About a minute ago 1.025 GB
```
$ dokku tags:create node-js-app v0.9.0 You can also create new tags for that app using the `tags:create` function. Tags should conform to the docker tagging specification for your docker version. As of 1.10, that specification is available [here](https://github.com/docker/docker/blob/master/image/spec/v1.1.md), while users of older versions can check the documentation [here](https://github.com/docker/docker/blob/master/image/spec/v1.md).
=====> Added v0.9.0 tag to dokku/node-js-app
$ dokku tags node-js-app ```shell
dokku tags:create node-js-app v1
```
```
=====> Added v1 tag to dokku/node-js-app
```
Once the tag is created, you can see the output by running the `tags` command again.
```shell
dokku tags node-js-app
```
```
=====> Image tags for dokku/node-js-app =====> Image tags for dokku/node-js-app
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
dokku/node-js-app latest 936a42f25901 About a minute ago 1.025 GB dokku/node-js-app latest 936a42f25901 About a minute ago 1.025 GB
dokku/node-js-app v0.9.0 936a42f25901 About a minute ago 1.025 GB dokku/node-js-app v1 936a42f25901 About a minute ago 1.025 GB
```
$ dokku tags:deploy node-js-app v0.9.0 Finally, you can also deploy a local image using the `tags:deploy` command.
-----> Releasing node-js-app (dokku/node-js-app:v0.9.0)...
-----> Deploying node-js-app (dokku/node-js-app:v0.9.0)... ```shell
dokku tags:deploy node-js-app v1
```
```
-----> Releasing node-js-app (dokku/node-js-app:v1)...
-----> Deploying node-js-app (dokku/node-js-app:v1)...
-----> Running pre-flight checks -----> Running pre-flight checks
For more efficient zero downtime deployments, create a file CHECKS. For more efficient zero downtime deployments, create a file CHECKS.
See http://dokku.viewdocs.io/dokku/checks-examples.md for examples See http://dokku.viewdocs.io/dokku/deployment/zero-downtime-deploys/ for examples
CHECKS file not found in container: Running simple container check... CHECKS file not found in container: Running simple container check...
-----> Waiting for 10 seconds ... -----> Waiting for 10 seconds ...
-----> Default container check successful! -----> Default container check successful!
@@ -53,7 +77,6 @@ $ dokku tags:deploy node-js-app v0.9.0
=====> 025eec3fa3b442fded90933d58d8ed8422901f0449f5ea0c23d00515af5d3137 =====> 025eec3fa3b442fded90933d58d8ed8422901f0449f5ea0c23d00515af5d3137
=====> Application deployed: =====> Application deployed:
http://node-js-app.dokku.me http://node-js-app.dokku.me
``` ```
## Deploying from a Docker Registry ## Deploying from a Docker Registry
+2 -2
View File
@@ -95,7 +95,7 @@ dokku enter node-js-app web python script/background-worker.py
Your procfile can have the following entry: Your procfile can have the following entry:
``` ```Procfile
cron: sleep infinity cron: sleep infinity
``` ```
@@ -138,7 +138,7 @@ Regularly scheduled tasks can be a bit of a pain with dokku. The following are g
The following is a sample cronfile that you can use for your applications: The following is a sample cronfile that you can use for your applications:
``` ```cron
# server cron jobs # server cron jobs
MAILTO="mail@example.com" MAILTO="mail@example.com"
PATH=/usr/local/bin:/usr/bin:/bin PATH=/usr/local/bin:/usr/bin:/bin
@@ -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
@@ -24,7 +24,8 @@ Dokku allows you to run multiple process types at different container counts. Fo
You can optionally create a `DOKKU_SCALE` file in the root of your repository. Dokku expects this file to contain one line for every process defined in your Procfile. You can optionally create a `DOKKU_SCALE` file in the root of your repository. Dokku expects this file to contain one line for every process defined in your Procfile.
Example: Example:
```
```Procfile
web=1 web=1
worker=2 worker=2
``` ```
@@ -33,7 +34,7 @@ worker=2
Dokku can also manage scaling itself via the `ps:scale` command. This command can be used to scale multiple process types at the same time. Dokku can also manage scaling itself via the `ps:scale` command. This command can be used to scale multiple process types at the same time.
``` ```shell
dokku ps:scale app_name web=1 worker=2 dokku ps:scale app_name web=1 worker=2
``` ```
@@ -4,9 +4,9 @@ Dokku commands can be run over ssh. Anywhere you would run `dokku <command>`, ju
The `-t` is used to request a pty. It is highly recommended to do so. The `-t` is used to request a pty. It is highly recommended to do so.
To avoid the need to type the `-t` option each time, simply create/modify a section in the `.ssh/config` on the client side, as follows: To avoid the need to type the `-t` option each time, simply create/modify a section in the `.ssh/config` on the client side, as follows:
``` ```ini
Host dokku.me Host dokku.me
RequestTTY yes RequestTTY yes
``` ```
## Behavioral modifiers ## Behavioral modifiers
@@ -14,7 +14,7 @@ RequestTTY yes
Dokku also supports certain command-line arguments that augment it's behavior. If using these over ssh, you must use the form `ssh -t dokku@dokku.me -- <command>` Dokku also supports certain command-line arguments that augment it's behavior. If using these over ssh, you must use the form `ssh -t dokku@dokku.me -- <command>`
in order to avoid ssh interpretting dokku arguments for itself. in order to avoid ssh interpretting dokku arguments for itself.
```shell ```
--quiet suppress output headers --quiet suppress output headers
--trace enable DOKKU_TRACE for current execution only --trace enable DOKKU_TRACE for current execution only
--rm|--rm-container remove docker container after successful dokku run <app> <command> --rm|--rm-container remove docker container after successful dokku run <app> <command>
+2 -2
View File
@@ -33,13 +33,13 @@ At it's base, the `sshcommand` *must* be run under a user with sudo access, as i
For instance, if you stored your public key at `~/.ssh/id_rsa.pub-open` and are deploying to EC2 where the default root-enabled user is `ubuntu`, you can run the following command to add your key under the `superuser` username: For instance, if you stored your public key at `~/.ssh/id_rsa.pub-open` and are deploying to EC2 where the default root-enabled user is `ubuntu`, you can run the following command to add your key under the `superuser` username:
``` ```shell
cat ~/.ssh/id_rsa.pub-open | ssh ubuntu@dokku.me "sudo sshcommand acl-add dokku superuser" cat ~/.ssh/id_rsa.pub-open | ssh ubuntu@dokku.me "sudo sshcommand acl-add dokku superuser"
``` ```
If you are using the vagrant installation, you can also use the `make vagrant-acl-add` target to add your public key to dokku (it will use your host username as the `USER`): If you are using the vagrant installation, you can also use the `make vagrant-acl-add` target to add your public key to dokku (it will use your host username as the `USER`):
``` ```shell
cat ~/.ssh/id_rsa.pub | make vagrant-acl-add cat ~/.ssh/id_rsa.pub | make vagrant-acl-add
``` ```
@@ -3,41 +3,44 @@
> 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:
```shell ```shell
dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30 dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30
dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=30 dokku config:set node-js-app DOKKU_DEFAULT_CHECKS_WAIT=30
``` ```
You can also choose to skip checks or disable zero-downtime completely on a per-application/per-process basis: You can also choose to skip checks or disable zero-downtime completely on a per-application/per-process basis
```shell
dokku checks:skip <app> worker,web
```
```shell
dokku checks:disable <app> worker,web
```
> Note that `checks:disable` will now (as of 0.6.0) cause downtime for that process-type during deployments. > Note that `checks:disable` will now (as of 0.6.0) cause downtime for that process-type during deployments.
Additionally, any given process can only be configured to skip OR disable zero-downtime. example:
```shell ```shell
$ dokku checks:skip testapp worker,web dokku checks:skip node-js-app worker,web
-----> Skipping zero downtime for app's (testapp) proctypes (worker,web) ```
-----> Unsetting testapp
```
-----> Skipping zero downtime for app's (node-js-app) proctypes (worker,web)
-----> Unsetting node-js-app
-----> Unsetting DOKKU_CHECKS_DISABLED -----> Unsetting DOKKU_CHECKS_DISABLED
-----> Setting config vars -----> Setting config vars
DOKKU_CHECKS_SKIPPED: worker,web DOKKU_CHECKS_SKIPPED: worker,web
$ dokku checks:disable testapp worker ```
-----> Disabling zero downtime for app's (testapp) proctypes (worker)
Additionally, any given process can only be configured to disable zero-downtime. example:
```shell
dokku checks:disable node-js-app worker
```
```
-----> Disabling zero downtime for app's (node-js-app) proctypes (worker)
-----> Setting config vars -----> Setting config vars
DOKKU_CHECKS_DISABLED: worker DOKKU_CHECKS_DISABLED: worker
-----> Setting config vars -----> Setting config vars
@@ -61,10 +64,10 @@ Checks are run against the detected `web` process from your application's `Procf
To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain: To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain:
* Check instructions * Check instructions
* Settings (NAME=VALUE) * Settings (NAME=VALUE)
* Comments (lines starting with #) * Comments (lines starting with #)
* Empty lines * Empty lines
> For dockerfile-based deploys, the file *must* be in `/app/CHECKS` within the container. `/app` is used by default as the root container directory for buildpack-based deploys. > For dockerfile-based deploys, the file *must* be in `/app/CHECKS` within the container. `/app` is used by default as the root container directory for buildpack-based deploys.
@@ -127,31 +130,41 @@ If your application runs multiple processes (a background worker configured in y
dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=0 dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=0
``` ```
### Configuring docker stop timeout
[By default](https://docs.docker.com/engine/reference/commandline/stop/), docker will wait 10 seconds from the time the `stop` command is passed to a container before it attempts to kill said container. This timeout can be configured on a per-app basis in dokku by setting the `DOKKU_DOCKER_STOP_TIMEOUT` configuration variable. This timeout applies to normal zero-downtime deployments as well as the `ps:stop` and `apps:destroy` commands.
```shell
dokku config:set $APP DOKKU_DOCKER_STOP_TIMEOUT=20
```
## Example: Successful Rails Deployment ## Example: Successful Rails Deployment
In this example, a Rails application is successfully deployed to dokku. The initial round of checks fails while the server is starting, but once it starts they succeed and the deployment is successful. `WAIT` is set to `10` because our application takes a while to boot up. `ATTEMPTS` is set to `6`, but the third attempt succeeds. In this example, a Rails application is successfully deployed to dokku. The initial round of checks fails while the server is starting, but once it starts they succeed and the deployment is successful. `WAIT` is set to `10` because our application takes a while to boot up. `ATTEMPTS` is set to `6`, but the third attempt succeeds.
### CHECKS file ### CHECKS file
```` ```
WAIT=10 WAIT=10
ATTEMPTS=6 ATTEMPTS=6
/check.txt simple_check /check.txt simple_check
```` ```
For this check to work, we've added a line to `config/routes.rb` that simply returns a string: For this check to work, we've added a line to `config/routes.rb` that simply returns a string:
```` ```
get '/check.txt', to: proc {[200, {}, ['simple_check']]} get '/check.txt', to: proc {[200, {}, ['simple_check']]}
```` ```
### Deploy Output ### Deploy Output
> Note: The output has been trimmed for brevity > Note: The output has been trimmed for brevity
```` ```shell
git push dokku master git push dokku master
```
```
-----> Cleaning up... -----> Cleaning up...
-----> Building myapp from herokuish... -----> Building myapp from herokuish...
-----> Adding BUILD_ENV to build environment... -----> Adding BUILD_ENV to build environment...
@@ -199,7 +212,7 @@ curl: (7) Failed to connect to 172.17.0.155 port 5000: Connection refused
-----> Shutting down old container in 60 seconds -----> Shutting down old container in 60 seconds
=====> Application deployed: =====> Application deployed:
http://myapp.dokku.example.com http://myapp.dokku.example.com
```` ```
## Example: Failing Rails Deployment ## Example: Failing Rails Deployment
@@ -209,11 +222,11 @@ Once the attempts have been exceeded, the deployment fails and we see the contai
### CHECKS file ### CHECKS file
```` ```
WAIT=10 WAIT=10
ATTEMPTS=6 ATTEMPTS=6
/ /
```` ```
> The check to the root url '/' would normally access the database. > The check to the root url '/' would normally access the database.
@@ -221,9 +234,11 @@ ATTEMPTS=6
> Note: The output has been trimmed for brevity > Note: The output has been trimmed for brevity
```` ```shell
git push dokku master git push dokku master
```
```
-----> Cleaning up... -----> Cleaning up...
-----> Building myapp from herokuish... -----> Building myapp from herokuish...
-----> Adding BUILD_ENV to build environment... -----> Adding BUILD_ENV to build environment...
@@ -301,11 +316,4 @@ Could not start due to 1 failed checks.
To dokku@dokku.example.com:myapp To dokku@dokku.example.com:myapp
! [remote rejected] dokku -> master (pre-receive hook declined) ! [remote rejected] dokku -> master (pre-receive hook declined)
error: failed to push some refs to 'dokku@dokku.example.com:myapp' error: failed to push some refs to 'dokku@dokku.example.com:myapp'
````
### Configuring docker stop timeout
[By default](https://docs.docker.com/engine/reference/commandline/stop/), docker will wait 10 seconds from the time the `stop` command is passed to a container before it attempts to kill said container. This timeout can be configured on a per-app basis in dokku by setting the `DOKKU_DOCKER_STOP_TIMEOUT` configuration variable. This timeout applies to normal zero-downtime deployments as well as the `ps:stop` and `apps:destroy` commands.
```
$ dokku config:set $APP DOKKU_DOCKER_STOP_TIMEOUT=20
``` ```
+2 -2
View File
@@ -5,7 +5,7 @@ If you create your own plugin:
1. Take a look at the plugins shipped with dokku and hack away! 1. Take a look at the plugins shipped with dokku and hack away!
2. Check out the [list of triggers](/dokku/development/plugin-triggers) your plugin can implement. 2. Check out the [list of triggers](/dokku/development/plugin-triggers) your plugin can implement.
3. Upload your plugin to github with a repository name in form of `dokku-<name>` (e.g. `dokku-mariadb`) 3. Upload your plugin to github with a repository name in form of `dokku-<name>` (e.g. `dokku-mariadb`)
4. Edit [this page](/dokku/plugins) and add a link to it. 4. Edit [this page](/dokku/community/plugins/) and add a link to it.
5. Subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases 5. Subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases
@@ -110,7 +110,7 @@ esac
Each plugin requires a `plugin.toml` descriptor file with the following required fields: Each plugin requires a `plugin.toml` descriptor file with the following required fields:
```shell ```toml
[plugin] [plugin]
description = "dokku hello plugin" description = "dokku hello plugin"
version = "0.1.0" version = "0.1.0"
+16 -9
View File
@@ -18,15 +18,22 @@ Example apps can be found here:
- Test setup and execution - Test setup and execution
```shell ```shell
$ vagrant ssh vagrant ssh
$ sudo su - sudo su -
$ cd ~/dokku cd ~/dokku
$ make ci-dependencies setup-deploy-tests make ci-dependencies setup-deploy-tests
$ make test # execute the entire test suite (linter, bats tests, and app deployment tests)
$ # execute the entire test suite (linter, bats tests, and app deployment tests)
$ make lint copyfiles # run linter & update vagrant dokku install from local git clone make test
$ make unit-tests # execute all bats tests
$ make deploy-tests # execute all app deployment tests # run linter & update vagrant dokku install from local git clone
make lint copyfiles
# execute all bats tests
make unit-tests
# execute all app deployment tests
make deploy-tests
``` ```
- Additionally you may run a specific app deployment tests with a target similar to: - Additionally you may run a specific app deployment tests with a target similar to:
@@ -52,7 +52,7 @@ Once dokku is installed, if you are not using the web-installer, you'll want to
Set up a domain and a wildcard domain pointing to that host. Make sure `/home/dokku/VHOST` is set to this domain. By default it's set to whatever hostname the host has. This file is only created if the hostname can be resolved by dig (`dig +short $(hostname -f)`). Otherwise you have to create the file manually and set it to your preferred domain. If this file still is not present when you push your app, dokku will publish the app with a port number (i.e. `http://example.com:49154` - note the missing subdomain). Set up a domain and a wildcard domain pointing to that host. Make sure `/home/dokku/VHOST` is set to this domain. By default it's set to whatever hostname the host has. This file is only created if the hostname can be resolved by dig (`dig +short $(hostname -f)`). Otherwise you have to create the file manually and set it to your preferred domain. If this file still is not present when you push your app, dokku will publish the app with a port number (i.e. `http://example.com:49154` - note the missing subdomain).
Follow the [user management documentation](/dokku/deployment/user-management) in order to add users to dokku. Follow the [user management documentation](/dokku/deployment/user-management/) in order to add users to dokku.
That's it! That's it!
+6 -4
View File
@@ -24,9 +24,11 @@ __Warning__: These steps will delete *everything* on your Linode.
5. SSH into your Linode as root and run the following commands: 5. SSH into your Linode as root and run the following commands:
apt-get update ```shell
apt-get -qq upgrade apt-get update
apt-get -qq install linux-image-virtual linux-image-extra-virtual apt-get -qq upgrade
apt-get -qq install linux-image-virtual linux-image-extra-virtual
```
6. When prompted, install Grub onto the first hard drive. 6. When prompted, install Grub onto the first hard drive.
@@ -36,4 +38,4 @@ __Warning__: These steps will delete *everything* on your Linode.
9. Lastly, reboot the Linode. 9. Lastly, reboot the Linode.
Once your server comes back online, you'll be running Ubuntu's default kernel. You can now follow Dokku's [normal installation instructions](/dokku/installation) and `bootstrap.sh` will take care of everything else. Once your server comes back online, you'll be running Ubuntu's default kernel. You can now follow Dokku's [normal installation instructions](/dokku/getting-started/installation/) and `bootstrap.sh` will take care of everything else.
+4 -3
View File
@@ -4,12 +4,13 @@
- Download and install [Vagrant](http://www.vagrantup.com/downloads.html) - Download and install [Vagrant](http://www.vagrantup.com/downloads.html)
- Clone Dokku - Clone Dokku
``` ```shell
git clone https://github.com/dokku/dokku.git git clone https://github.com/dokku/dokku.git
``` ```
- Create VM - Create VM
```
```shell
# Optional ENV arguments: # Optional ENV arguments:
# - `BOX_NAME` # - `BOX_NAME`
# - `BOX_URI` # - `BOX_URI`
@@ -22,7 +23,7 @@
``` ```
- Setup SSH Config in `~/.ssh/config`. The port listed here is usually correct, though you may want to verify that it is the same as the one listed in the output of `vagrant ssh-config dokku` - Setup SSH Config in `~/.ssh/config`. The port listed here is usually correct, though you may want to verify that it is the same as the one listed in the output of `vagrant ssh-config dokku`
``` ```ini
Host dokku.me Host dokku.me
Port 22 Port 22
``` ```
@@ -46,11 +46,11 @@ For various reasons, certain hosting providers may have other steps that should
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](/dokku/getting-started/install/debian) - [Debian Package Installation Notes](/dokku/getting-started/install/debian/)
- [Vagrant Installation Notes](/dokku/getting-started/install/vagrant) - [Vagrant Installation Notes](/dokku/getting-started/install/vagrant/)
- [Advanced Install Customization](/dokku/advanced-installation) - [Advanced Install Customization](/dokku/getting-started/advanced-installation/)
--- ---
- <sup>[1]: To check whether your system has an fqdn set, run `sudo hostname -f`</sup> - <sup>[1]: To check whether your system has an fqdn set, run `sudo hostname -f`</sup>
- <sup>[2]: If your system has less than 1GB of memory, you can use [this workaround](/dokku/advanced-installation/#vms-with-less-than-1gb-of-memory).</sup> - <sup>[2]: If your system has less than 1GB of memory, you can use [this workaround](/dokku/getting-started/advanced-installation/#vms-with-less-than-1gb-of-memory).</sup>
@@ -6,14 +6,14 @@ __Solution:__
Most of the time it's caused by some defaults newer versions of nginx set. To make sure that's the issue you're having run the following: Most of the time it's caused by some defaults newer versions of nginx set. To make sure that's the issue you're having run the following:
``` ```shell
$ nginx -t nginx -t
nginx: [emerg] could not build the server_names_hash, you should increase server_names_hash_bucket_size: 32 ## 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 { http {
(... existing content ...) (... existing content ...)
server_names_hash_bucket_size 64; server_names_hash_bucket_size 64;
@@ -26,11 +26,11 @@ A value of 64 would allow domains with up to 64 characters. Set it to 128 if you
Save the file and try stopping nginx and starting it again: Save the file and try stopping nginx and starting it again:
``` ```shell
$ /etc/init.d/nginx stop /etc/init.d/nginx stop
* Stopping nginx nginx [ OK ] ## * Stopping nginx nginx [ OK ]
$ /etc/init.d/nginx start /etc/init.d/nginx start
* Starting nginx nginx [ OK ] ## * Starting nginx nginx [ OK ]
``` ```
*** ***
@@ -45,12 +45,16 @@ The `remote rejected` error does not give enough information. Anything could hav
To enable dokku tracing, simply run the following command: To enable dokku tracing, simply run the following command:
# Since 0.3.9 ```shell
dokku trace on # since 0.3.9
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 :
export DOKKU_TRACE=1 ```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.
@@ -64,28 +68,28 @@ __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 docker ps -a | grep build
94d9515e6d93 077581956a92 "/build" 29 minutes ago Exited (0) 25 minutes ago cocky_bell ## 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 docker run -ti 077581956a92 /bin/bash
root@9763ab86e1b4:/# curl -s -S icanhazip.com curl -s -S icanhazip.com
192.168.0.1 ## 192.168.0.1
curl http://s3pository.heroku.com/node/v0.10.30/node-v0.10.30-linux-x64.tar.gz -o node-v0.10.30-linux-x64.tar.gz curl http://s3pository.heroku.com/node/v0.10.30/node-v0.10.30-linux-x64.tar.gz -o node-v0.10.30-linux-x64.tar.gz
tar tzf node-v0.10.30-linux-x64.tar.gz tar tzf node-v0.10.30-linux-x64.tar.gz
... ## ...
``` ```
Sometimes (especially on DO) deploying again seems to get past these seemingly transient issues 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 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 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
@@ -102,8 +106,10 @@ You get asked for a password because your ssh secret key can't be found. This ma
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`:
Host DOKKU_HOSTNAME ```ini
IdentityFile "~/.ssh/KEYNAME" 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)
@@ -117,7 +123,9 @@ In many cases the application will require the a `process.env.PORT` port opposed
When specifying your port you may want to use something similar to: When specifying your port you may want to use something similar to:
var port = process.env.PORT || 3000 ```javascript
var port = process.env.PORT || 3000
```
Please see https://github.com/dokku/dokku/issues/282 Please see https://github.com/dokku/dokku/issues/282
@@ -145,6 +153,4 @@ dokku config:set --global CURL_TIMEOUT=600
dokku config:set --global CURL_CONNECT_TIMEOUT=30 dokku config:set --global CURL_CONNECT_TIMEOUT=30
``` ```
References Please see https://github.com/dokku/dokku/issues/509
* https://github.com/dokku/dokku/issues/509
* https://github.com/dokku-alt/dokku-alt/issues/169
@@ -1,6 +1,6 @@
# Upgrading # Upgrading
If your version of dokku is pre 0.3.0 (check with `dokku version`), we recommend [a fresh install](/dokku/installation) on a new server. If your version of dokku is pre 0.3.0 (check with `dokku version`), we recommend [a fresh install](/dokku/getting-started/installation/) on a new server.
## Migration Guides ## Migration Guides
+2 -2
View File
@@ -4,7 +4,7 @@ If you’re stuck, there are a number of places you can get help:
## The Official Dokku Website ## The Official Dokku Website
[http://dokku.viewdocs.io/dokku](/dokku) - [http://dokku.viewdocs.io/dokku/](/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 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.
@@ -17,6 +17,6 @@ If you’re stumped, give us a holler in the Dokku IRC or Slack channels. Someon
## Stack Overflow ## Stack Overflow
http://stackoverflow.com/ - [https://stackoverflow.com/questions/tagged/dokku](https://stackoverflow.com/questions/tagged/dokku)
Tag your questions with `dokku` to enable existing users of Stack Overflow to find your questions. Tag your questions with `dokku` to enable existing users of Stack Overflow to find your questions.
+3 -3
View File
@@ -44,7 +44,7 @@
<div class="row"> <div class="row">
<div> <div>
<h1 class="heading navbar-brand"> <h1 class="heading navbar-brand">
<a href="http://dokku.viewdocs.io/dokku/">Dokku</a> <a href="/{{NAME}}/">Dokku</a>
</h1> </h1>
<ul class="nav nav-pills pull-xs-right"> <ul class="nav nav-pills pull-xs-right">
<li class="nav-item"> <li class="nav-item">
@@ -54,7 +54,7 @@
<a class="nav-link" href="https://github.com/dokku/dokku/">Code</a> <a class="nav-link" href="https://github.com/dokku/dokku/">Code</a>
</li> </li>
<li class="nav-item"> <li class="nav-item">
<a class="nav-link" href="/{{NAME}}/installation/">Docs</a> <a class="nav-link" href="/{{NAME}}/getting-started/installation/">Docs</a>
</li> </li>
<li class="nav-item"> <li class="nav-item">
<a class="nav-link" href="https://webchat.freenode.net/?channels=dokku">IRC</a> <a class="nav-link" href="https://webchat.freenode.net/?channels=dokku">IRC</a>
@@ -74,7 +74,7 @@
<h2>The smallest PaaS implementation you've ever seen</h2> <h2>The smallest PaaS implementation you've ever seen</h2>
<p>Docker powered mini-Heroku in around 200 lines of Bash</p> <p>Docker powered mini-Heroku in around 200 lines of Bash</p>
<div class="blurb-buttons"> <div class="blurb-buttons">
<a class="btn btn-lg btn-warning" href="/dokku/installation/">View Documentation</a> <a class="btn btn-lg btn-warning" href="/{{NAME}}/getting-started/installation/">View Documentation</a>
</div> </div>
</div> </div>
</div> </div>
+162 -52
View File
@@ -47,6 +47,39 @@
<!-- <link href="/dokku/docs/assets/style.css" rel="stylesheet"> --> <!-- <link href="/dokku/docs/assets/style.css" rel="stylesheet"> -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet"> <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet">
<style> <style>
.highlight-show-language {
position: relative;
}
.highlight-show-language-label {
color: black;
background-color: #CFCFCF;
display: inline-block;
position: absolute;
bottom: auto;
left: auto;
top: 0;
right: 0;
width: auto;
height: auto;
font-size: 0.9em;
border-radius: 0 0 0 5px;
padding: 0 0.5em;
text-shadow: none;
z-index: 1;
-webkit-box-shadow: none;
-moz-box-shadow: none;
box-shadow: none;
-webkit-transform: none;
-moz-transform: none;
-ms-transform: none;
-o-transform: none;
transform: none;
}
.highlight-output pre {
color: #fff;
background-color: #000;
padding: 10px;
}
</style> </style>
</head> </head>
<body> <body>
@@ -58,7 +91,7 @@
<div class="row"> <div class="row">
<div class="col-md-offset-2"> <div class="col-md-offset-2">
<h1 class="heading navbar-brand"> <h1 class="heading navbar-brand">
<a href="http://dokku.viewdocs.io/dokku/">Dokku</a> <a href="/{{NAME}}/">Dokku</a>
</h1> </h1>
<ul class="nav nav-pills pull-xs-right col-md-offset-right-2"> <ul class="nav nav-pills pull-xs-right col-md-offset-right-2">
<li class="nav-item"> <li class="nav-item">
@@ -68,7 +101,7 @@
<a class="nav-link" href="https://github.com/dokku/dokku/">Code</a> <a class="nav-link" href="https://github.com/dokku/dokku/">Code</a>
</li> </li>
<li class="nav-item"> <li class="nav-item">
<a class="nav-link" href="/{{NAME}}/installation/">Docs</a> <a class="nav-link" href="/{{NAME}}/getting-started/installation/">Docs</a>
</li> </li>
<li class="nav-item"> <li class="nav-item">
<a class="nav-link" href="https://webchat.freenode.net/?channels=dokku">IRC</a> <a class="nav-link" href="https://webchat.freenode.net/?channels=dokku">IRC</a>
@@ -90,51 +123,51 @@
<div class="col-xs-4 col-md-2 col-md-pull-6 col-md-offset-2" style="padding-top:16px"> <div class="col-xs-4 col-md-2 col-md-pull-6 col-md-offset-2" style="padding-top:16px">
<div class="list-group"> <div class="list-group">
<a href="#" class="list-group-item disabled">Getting Started</a> <a href="#" class="list-group-item disabled">Getting Started</a>
<a href="/dokku/installation/" class="list-group-item">Getting Started with Dokku</a> <a href="/{{NAME}}/getting-started/installation/" class="list-group-item">Getting Started with Dokku</a>
<a href="/dokku/upgrading/" class="list-group-item">Upgrading Dokku</a> <a href="/{{NAME}}/getting-started/upgrading/" class="list-group-item">Upgrading Dokku</a>
<a href="/dokku/troubleshooting/" class="list-group-item">Troubleshooting</a> <a href="/{{NAME}}/getting-started/troubleshooting/" class="list-group-item">Troubleshooting</a>
<a href="/dokku/getting-started/where-to-get-help/" class="list-group-item">Getting Help</a> <a href="/{{NAME}}/getting-started/where-to-get-help/" class="list-group-item">Getting Help</a>
<a href="#" class="list-group-item disabled">Deployment</a> <a href="#" class="list-group-item disabled">Deployment</a>
<a href="/dokku/application-deployment/" class="list-group-item">Deploying an Application</a> <a href="/{{NAME}}/deployment/application-deployment/" class="list-group-item">Deploying an Application</a>
<a href="/dokku/deployment/buildpacks/" class="list-group-item">Buildpack Deployment</a> <a href="/{{NAME}}/deployment/buildpacks/" class="list-group-item">Buildpack Deployment</a>
<a href="/dokku/deployment/dockerfiles/" class="list-group-item">Dockerfile Deployment</a> <a href="/{{NAME}}/deployment/dockerfiles/" class="list-group-item">Dockerfile Deployment</a>
<a href="/dokku/deployment/images/" class="list-group-item">Image Tagging</a> <a href="/{{NAME}}/deployment/images/" class="list-group-item">Image Tagging</a>
<a href="/dokku/remote-commands/" class="list-group-item">Remote Commands</a> <a href="/{{NAME}}/deployment/remote-commands/" class="list-group-item">Remote Commands</a>
<a href="/dokku/deployment/one-off-processes/" class="list-group-item">One Off Processes/Cron</a> <a href="/{{NAME}}/deployment/one-off-processes/" class="list-group-item">One Off Processes/Cron</a>
<a href="/dokku/process-management/" class="list-group-item">Scaling Apps</a> <a href="/{{NAME}}/deployment/process-management/" class="list-group-item">Scaling Apps</a>
<a href="/dokku/deployment/user-management/" class="list-group-item">User Management</a> <a href="/{{NAME}}/deployment/user-management/" class="list-group-item">User Management</a>
<a href="/dokku/checks-examples/" class="list-group-item">Zero Downtime Deploy Checks</a> <a href="/{{NAME}}/deployment/zero-downtime-deploys/" class="list-group-item">Zero Downtime Deploy Checks</a>
<a href="#" class="list-group-item disabled">Configuration</a> <a href="#" class="list-group-item disabled">Configuration</a>
<a href="/dokku/configuration-management/" class="list-group-item">Environment Variables</a> <a href="/{{NAME}}/configuration/environment-variables/" class="list-group-item">Environment Variables</a>
<a href="/dokku/dns/" class="list-group-item">DNS Configuration</a> <a href="/{{NAME}}/configuration/dns/" class="list-group-item">DNS Configuration</a>
<a href="/dokku/deployment/domain-configuration/" class="list-group-item">Domain Configuration</a> <a href="/{{NAME}}/configuration/domains/" class="list-group-item">Domain Configuration</a>
<a href="/dokku/nginx/" class="list-group-item">Nginx Configuration</a> <a href="/{{NAME}}/configuration/nginx/" class="list-group-item">Nginx Configuration</a>
<a href="/dokku/deployment/ssl-configuration/" class="list-group-item">SSL Configuration</a> <a href="/{{NAME}}/configuration/ssl/" class="list-group-item">SSL Configuration</a>
<a href="/dokku/dokku-events-logs/" class="list-group-item">Dokku Event Logs</a>
<a href="#" class="list-group-item disabled">Advanced Usage</a> <a href="#" class="list-group-item disabled">Advanced Usage</a>
<a href="/dokku/backup-recovery/" class="list-group-item">Backup and Recovery</a> <a href="/{{NAME}}/advanced-usage/backup-recovery/" class="list-group-item">Backup and Recovery</a>
<a href="/dokku/deployment/deployment-tasks/" class="list-group-item">Deployment Tasks</a> <a href="/{{NAME}}/advanced-usage/deployment-tasks/" class="list-group-item">Deployment Tasks</a>
<a href="/dokku/docker-options/" class="list-group-item">Docker Container Options</a> <a href="/{{NAME}}/advanced-usage/docker-options/" class="list-group-item">Docker Container Options</a>
<a href="/dokku/dokku-storage/" class="list-group-item">Persistent Storage</a> <a href="/{{NAME}}/advanced-usage/event-logs/" class="list-group-item">Event Logs</a>
<a href="/dokku/proxy/" class="list-group-item">Proxy Management</a> <a href="/{{NAME}}/advanced-usage/persistent-storage/" class="list-group-item">Persistent Storage</a>
<a href="/{{NAME}}/advanced-usage/proxy-management/" class="list-group-item">Proxy Management</a>
<a href="#" class="list-group-item disabled">Community Contributions</a> <a href="#" class="list-group-item disabled">Community Contributions</a>
<a href="/dokku/community/clients/" class="list-group-item">Clients</a> <a href="/{{NAME}}/community/clients/" class="list-group-item">Clients</a>
<a href="/dokku/plugins/" class="list-group-item">Plugins</a> <a href="/{{NAME}}/community/plugins/" class="list-group-item">Plugins</a>
<a href="#" class="list-group-item disabled">Development</a> <a href="#" class="list-group-item disabled">Development</a>
<a href="/dokku/development/plugin-creation/" class="list-group-item">Plugin Creation</a> <a href="/{{NAME}}/development/plugin-creation/" class="list-group-item">Plugin Creation</a>
<a href="/dokku/development/plugin-triggers/" class="list-group-item">Plugin Triggers</a> <a href="/{{NAME}}/development/plugin-triggers/" class="list-group-item">Plugin Triggers</a>
<a href="/dokku/development/testing/" class="list-group-item">Running Tests</a> <a href="/{{NAME}}/development/testing/" class="list-group-item">Running Tests</a>
<a href="/dokku/development/release-process/" class="list-group-item">Release Process</a> <a href="/{{NAME}}/development/release-process/" class="list-group-item">Release Process</a>
</div> </div>
</div> </div>
</div> </div>
@@ -172,6 +205,35 @@
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/1.3.0/anchor.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/1.3.0/anchor.js"></script>
<script> <script>
// Source: https://github.com/Alhadis/Snippets/blob/master/js/polyfills/IE8-child-elements.js
if (!('nextElementSibling' in document.documentElement)) {
Object.defineProperty(Element.prototype, 'nextElementSibling', {
get: function () {
var e = this.nextSibling;
while (e && 1 !== e.nodeType) {
e = e.nextSibling;
}
return e;
}
});
}
// Source: https://jonlabelle.com/snippets/view/javascript/wrap-an-html-element-in-javascript
HTMLElement.prototype.wrap = function (elms) {
if (!elms.length) elms = [elms];
for (var i = elms.length - 1; i >= 0; i--) {
var child = (i > 0) ? this.cloneNode(true) : this;
var el = elms[i];
var parent = el.parentNode;
var sibling = el.nextSibling;
child.appendChild(el);
if (sibling) {
parent.insertBefore(child, sibling);
} else {
parent.appendChild(child);
}
}
};
document.addEventListener('DOMContentLoaded', function (e) { document.addEventListener('DOMContentLoaded', function (e) {
var markdownBody = document.querySelectorAll('.markdown-body')[0], var markdownBody = document.querySelectorAll('.markdown-body')[0],
isRedirect = markdownBody.innerHTML.trim().indexOf('<p>See the <a href=') === 0; isRedirect = markdownBody.innerHTML.trim().indexOf('<p>See the <a href=') === 0;
@@ -191,7 +253,7 @@
pageHeader = document.querySelectorAll('.markdown-body p')[0], pageHeader = document.querySelectorAll('.markdown-body p')[0],
headers = document.querySelectorAll('h2, h3, h4'), headers = document.querySelectorAll('h2, h3, h4'),
classNames = ['table', 'table-striped', 'table-hover', 'table-condensed'], classNames = ['table', 'table-striped', 'table-hover', 'table-condensed'],
localPath = location.pathname.split('/').splice(2).join("/"), localPath = location.pathname.split('/').splice(2).join('/'),
addClass = function (el, className) { addClass = function (el, className) {
if (el.classList) { if (el.classList) {
el.classList.add(className); el.classList.add(className);
@@ -203,37 +265,56 @@
if (elem.addEventListener) { if (elem.addEventListener) {
elem.addEventListener(type, fn, false); elem.addEventListener(type, fn, false);
} else if (elem.attachEvent) { } else if (elem.attachEvent) {
elem.attachEvent("on" + type, function() { elem.attachEvent('on' + type, function() {
return fn.call(elem, window.event); return fn.call(elem, window.event);
}); });
} else { } else {
elem["on" + type] = fn; elem['on' + type] = fn;
} }
}, },
hasClass = function(el, className) { hasClass = function (el, className) {
if (el.classList) { if (el.classList) {
return el.classList.contains(className); return el.classList.contains(className);
} else { } else {
return new RegExp('(^| )' + className + '( |$)', 'gi').test(el.className); return new RegExp('(^| )' + className + '( |$)', 'gi').test(el.className);
} }
}, },
removeClass = function(el, className) { removeClass = function (el, className) {
if (el.classList) { if (el.classList) {
el.classList.remove(className); el.classList.remove(className);
} else { } else {
el.className = el.className.replace(new RegExp('(^|\\b)' + className.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');; el.className = el.className.replace(new RegExp('(^|\\b)' + className.split(' ').join('|') + '(\\b|$)', 'gi'), ' ');;
} }
},
languageClass = function (el) {
if (!hasClass(el, 'highlight')) {
return;
}
var classes = [];
if (el.classList) {
classes = el.classList.value.split(/\s+/);
} else {
classes = el.className.split(/\s+/);
}
var language = null;
for (i = 0; i < classes.length; i++) {
if (classes[i].lastIndexOf('highlight-source-', 0) === 0) {
language = classes[i].replace('highlight-source-', '');
break;
}
}
return language;
}; };
var ls2 = { var ls2 = {
save : function(key, jsonData, expirationMS) { save : function (key, jsonData, expirationMS) {
if (typeof (Storage) == "undefined") { return false; } if (typeof (Storage) === 'undefined') { return false; }
var record = {value: JSON.stringify(jsonData), timestamp: new Date().getTime()/1000 + expirationMS} var record = {value: JSON.stringify(jsonData), timestamp: new Date().getTime()/1000 + expirationMS}
localStorage.setItem(key, JSON.stringify(record)); localStorage.setItem(key, JSON.stringify(record));
return jsonData; return jsonData;
}, },
load : function(key) { load : function (key) {
if (typeof (Storage) == "undefined") { return false; } if (typeof (Storage) === 'undefined') { return false; }
var record = JSON.parse(localStorage.getItem(key)); var record = JSON.parse(localStorage.getItem(key));
if (!record){return false;} if (!record){return false;}
return (new Date().getTime()/1000 < record.timestamp && JSON.parse(record.value)); return (new Date().getTime()/1000 < record.timestamp && JSON.parse(record.value));
@@ -241,22 +322,22 @@
}; };
var ToC = var ToC =
"<nav role='navigation' class='table-of-contents'>" + '<nav role="navigation" class="table-of-contents">' +
"<ul>"; '<ul>';
var newLine, el, title, link, currentDepth, count = 0, lastNodeDepth = null; var newLine, el, title, link, currentDepth, count = 0, lastNodeDepth = null;
Array.prototype.forEach.call(headers, function (el, i) { Array.prototype.forEach.call(headers, function (el, i) {
count++; count++;
title = el.innerText || element.textContent; title = el.innerText || element.textContent;
link = "#" + el.getAttribute('id'); link = '#' + el.getAttribute('id');
currentDepth = parseInt(el.nodeName.replace('H', ''), 10); currentDepth = parseInt(el.nodeName.replace('H', ''), 10);
newLine = newLine =
"<li>" + '<li>' +
"<a href='" + link + "' class='current-depth-" + currentDepth + "'>" + '<a href="' + link + '" class="current-depth-' + currentDepth + '">' +
title + title +
"</a>" + '</a>' +
"</li>"; '</li>';
if (currentDepth === lastNodeDepth || lastNodeDepth === null) { if (currentDepth === lastNodeDepth || lastNodeDepth === null) {
} else if (currentDepth > lastNodeDepth) { } else if (currentDepth > lastNodeDepth) {
@@ -268,7 +349,7 @@
lastNodeDepth = currentDepth; lastNodeDepth = currentDepth;
}); });
ToC += "</ul></nav>"; ToC += '</ul></nav>';
if (count > 1) { if (count > 1) {
var navItems = document.querySelectorAll('.list-group-item'); var navItems = document.querySelectorAll('.list-group-item');
@@ -279,7 +360,6 @@
}); });
} }
Array.prototype.forEach.call(blockquotes, function (el, i) { Array.prototype.forEach.call(blockquotes, function (el, i) {
if (el.innerHTML.toLowerCase().indexOf('new as of') !== -1) { if (el.innerHTML.toLowerCase().indexOf('new as of') !== -1) {
addClass(el, 'new-as-of'); addClass(el, 'new-as-of');
@@ -293,6 +373,36 @@
}); });
}); });
var addLanguageLabel = function (el, language) {
var labelWrapper = document.createElement('div'),
label = document.createElement('div');
labelWrapper.setAttribute('class', 'highlight-show-language');
label.setAttribute('class', 'highlight-show-language-label');
label.appendChild(document.createTextNode(language));
labelWrapper.appendChild(label);
el.insertBefore(labelWrapper, el.firstChild);
};
var highlightElements = document.querySelectorAll('pre');
Array.prototype.forEach.call(highlightElements, function(el, i) {
var language = languageClass(el.parentElement);
if (typeof (language) === 'undefined') {
return;
}
addLanguageLabel(el.parentElement, language);
var nextEl = el.parentElement.nextElementSibling;
if (nextEl !== null && nextEl.nodeName.toLowerCase() === 'pre') {
var wrapper = document.createElement('div');
wrapper.setAttribute('class', 'highlight-output');
wrapper.wrap(nextEl);
addLanguageLabel(wrapper, 'output');
addClass(el, 'highlight-has-output');
}
});
addListener(currentVersionEl, 'click', function() { addListener(currentVersionEl, 'click', function() {
if (hasClass(versionContainer, 'shift-up')) { if (hasClass(versionContainer, 'shift-up')) {
removeClass(versionContainer, 'shift-up'); removeClass(versionContainer, 'shift-up');
@@ -330,7 +440,7 @@
versionName = 'master'; versionName = 'master';
} }
a.setAttribute('href', "/" + ref + "/" + localPath); a.setAttribute('href', '/' + ref + '/' + localPath);
a.appendChild(document.createTextNode(versionName)); a.appendChild(document.createTextNode(versionName));
if (versionName == currentVersion) { if (versionName == currentVersion) {
var strong = document.createElement('strong'); var strong = document.createElement('strong');
@@ -369,7 +479,7 @@
if (!data) { if (!data) {
var request = new XMLHttpRequest(); var request = new XMLHttpRequest();
request.open('GET', '/dokku/assets/versions.json', true); request.open('GET', '/dokku/assets/versions.json', true);
request.setRequestHeader("Cache-Control", "no-cache, no-store"); request.setRequestHeader('Cache-Control', 'no-cache, no-store');
request.onload = function() { request.onload = function() {
if (request.status >= 200 && request.status < 400) { if (request.status >= 200 && request.status < 400) {
+26
View File
@@ -0,0 +1,26 @@
{
"redirects": {
"advanced-installation": "getting-started/advanced-installation",
"troubleshooting": "getting-started/troubleshooting",
"upgrading": "getting-started/upgrading",
"application-deployment": "deployment/application-deployment",
"checks-examples": "deployment/zero-downtime-deploys/",
"process-management": "deployment/process-management/",
"remote-commands": "deployment/remote-commands/",
"configuration-management": "configuration/environment-variables/",
"deployment/ssl-configuration": "configuration/ssl/",
"dns": "configuration/dns/",
"nginx": "configuration/nginx/",
"backup-recovery": "advanced-usage/backup-recovery/",
"deployment-tasks": "advanced-usage/deployment-tasks/",
"docker-options": "advanced-usage/docker-options/",
"dokku-events-logs": "advanced-usage/event-logs/",
"dokku-storage": "advanced-usage/persistent-storage/",
"proxy": "advanced-usage/proxy-management/",
"plugins": "community/plugins/"
}
}
+1 -1
View File
@@ -95,7 +95,7 @@ checks_check_deploy() {
# We allow custom check for web instances only # We allow custom check for web instances only
if [[ "$DOKKU_APP_CONTAINER_TYPE" == "web" ]]; then if [[ "$DOKKU_APP_CONTAINER_TYPE" == "web" ]]; then
dokku_log_verbose "For more efficient zero downtime deployments, create a file CHECKS." dokku_log_verbose "For more efficient zero downtime deployments, create a file CHECKS."
dokku_log_verbose "See http://dokku.viewdocs.io/dokku/checks-examples.md for examples" dokku_log_verbose "See http://dokku.viewdocs.io/dokku/deployment/zero-downtime-deploys/ for examples"
dokku_log_verbose "CHECKS file not found in container: Running simple container check..." dokku_log_verbose "CHECKS file not found in container: Running simple container check..."
else else
dokku_log_verbose "Non web container detected: Running default container check..." dokku_log_verbose "Non web container detected: Running default container check..."