docs: update markdownlint rules for better formatting

This commit is contained in:
Jose Diaz-Gonzalez
2023-08-19 13:29:12 -04:00
parent b87d619b23
commit 5dd78e2b86
44 changed files with 243 additions and 215 deletions

View File

@@ -8,3 +8,30 @@ MD013: false
# Inline HTML # Inline HTML
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033 # https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
MD033: false MD033: false
# List indentation
# 2 spaces breaks list formatting in mkdocs
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md007
MD007:
indent: 4
# Fenced code blocks should have a language specified
# We use a second, un-languaged code block to denote the output
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md040
MD040: false
# Blank line inside blockquote
# This is typically done when a section has a "New as of" or "Warning" in addition to a note
# May wish to take advantage of github-style admonitions
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md028
MD028: false
# No duplicate headers
# HISTORY.md has a ton of these
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024
MD024: false
# First line h1
# The issue template doesn't have one
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041
MD041: false

View File

@@ -27,12 +27,16 @@ jobs:
steps: steps:
- name: Clone - name: Clone
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Run markdown-lint - name: Setup node
uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb uses: actions/setup-node@v3
# v1.5.0 => 04d43ee9191307b50935a753da3b775ab695eceb
with: with:
config: '.github/linters/.markdown-lint.yml' node-version: '20'
args: './README.md' cache: 'npm'
cache-dependency-path: '.github/workflows/lint.yml'
- name: Install markdownlint-cli
run: npm install -g markdownlint-cli@0.35.0
- name: Run markdown-lint
run: markdownlint -c .github/linters/.markdown-lint.yml *.md **/*.md
packer: packer:
name: packer name: packer

1
.gitignore vendored
View File

@@ -11,3 +11,4 @@ test-results/
stack.tgz stack.tgz
tmp tmp
coverage.out coverage.out
site

View File

@@ -5099,7 +5099,7 @@ Thanks to all the contributors who helped with this release, and a special thank
## 0.5.8 ## 0.5.8
This release is the last release in the `0.5.x` series, and as such is mainly a bugfix release. Users are highly encouraged to upgrade to this release *before* moving to the upcoming `0.6.x` release, as we will be removing deprecated features at that point. This release is the last release in the `0.5.x` series, and as such is mainly a bugfix release. Users are highly encouraged to upgrade to this release _before_ moving to the upcoming `0.6.x` release, as we will be removing deprecated features at that point.
Thanks to all the contributors who helped with this release! Thanks to all the contributors who helped with this release!
@@ -5291,7 +5291,7 @@ That was quick! This is a bugfix release to fix issues in the packaging and rele
This is our largest, most feature-packed release in the history of the dokku project. Lots of delicious things, including: This is our largest, most feature-packed release in the history of the dokku project. Lots of delicious things, including:
- Support for docker 1.10/1.11. You *must* have docker 1.9.1+ to install dokku. - Support for docker 1.10/1.11. You _must_ have docker 1.9.1+ to install dokku.
- Revamped documentation website - Revamped documentation website
- [Deployment Tasks](https://dokku.com/docs/advanced-usage/deployment-tasks/) - [Deployment Tasks](https://dokku.com/docs/advanced-usage/deployment-tasks/)
- Heroku-style management of [dockerfile processes](https://dokku.com/docs/deployment/builders/dockerfiles/#procfiles-and-multiple-processes) - Heroku-style management of [dockerfile processes](https://dokku.com/docs/deployment/builders/dockerfiles/#procfiles-and-multiple-processes)
@@ -5390,7 +5390,7 @@ Thanks to all the contributors who helped with this release!
## 0.4.13 ## 0.4.13
We lied. *This* is the final 0.4.x release. This specific release fixes support for bash `4.2`, which may be the only bash version available for certain testing environments. We lied. _This_ is the final 0.4.x release. This specific release fixes support for bash `4.2`, which may be the only bash version available for certain testing environments.
Thanks to all the contributors who helped with this release! Thanks to all the contributors who helped with this release!
@@ -5444,7 +5444,7 @@ Thanks to all the contributors who helped with this release!
This release is mostly a bugfix release, though we have a few important changes: This release is mostly a bugfix release, though we have a few important changes:
- `dokku plugin:update` can now be used to update a specific plugin. Previously, this could potentially result in an error a user would have to manually resolve. - `dokku plugin:update` can now be used to update a specific plugin. Previously, this could potentially result in an error a user would have to manually resolve.
- We have started labeling all dokku-managed containers. In a future minor release, triggering a `dokku cleanup` will remove *only* exited containers that are managed by dokku. This change allows users to start containers outside of dokku and be assured that dokku would not inadvertently remove them. - We have started labeling all dokku-managed containers. In a future minor release, triggering a `dokku cleanup` will remove _only_ exited containers that are managed by dokku. This change allows users to start containers outside of dokku and be assured that dokku would not inadvertently remove them.
Thanks to all the contributors who helped with this release! Thanks to all the contributors who helped with this release!
@@ -5790,11 +5790,11 @@ One new feature is colorized logging output, which should make it easier to debu
This is our first minor release in almost a year. Many new features and removals have occurred, so here is a neat summary: This is our first minor release in almost a year. Many new features and removals have occurred, so here is a neat summary:
- Plugins are now triggered via `plugn`. Notably, you'll need add a `plugin.toml` to describe the plugin as well as use `plugn trigger` instead of `pluginhook` to trigger plugin callbacks. Please see the [plugin creation documentation](https://dokku.com/docs/development/plugin-creation/) for more details. - Plugins are now triggered via `plugn`. Notably, you'll need add a `plugin.toml` to describe the plugin as well as use `plugn trigger` instead of `pluginhook` to trigger plugin callbacks. Please see the [plugin creation documentation](https://dokku.com/docs/development/plugin-creation/) for more details.
- A few new official plugins have been added to the core, including [image tagging](https://dokku.com/docs/deployment/application-deployment/), [certificate management](https://dokku.com/docs/configuration/ssl/), a tar-based deploy solution, and much more. Check out the *New Features* section for more details. - A few new official plugins have been added to the core, including [image tagging](https://dokku.com/docs/deployment/application-deployment/), [certificate management](https://dokku.com/docs/configuration/ssl/), a tar-based deploy solution, and much more. Check out the _New Features_ section for more details.
- We've removed a few deprecated plugin callbacks. Please see the [plugin triggers documentation](https://dokku.com/docs/development/plugin-triggers/) to see what is available. - We've removed a few deprecated plugin callbacks. Please see the [plugin triggers documentation](https://dokku.com/docs/development/plugin-triggers/) to see what is available.
- [Official datastorage plugins](https://github.com/dokku) have been created for the most commonly used datastores. If you previously used/maintained a community contributed plugin, please check these out. We'll be adding more official plugins as time goes on. - [Official datastorage plugins](https://github.com/dokku) have been created for the most commonly used datastores. If you previously used/maintained a community contributed plugin, please check these out. We'll be adding more official plugins as time goes on.
Thanks to the *many* contributors for making this release our best release so far, and special thanks to both @michaelshobbs and @Flink for pushing along the `0.4.0` release! Thanks to the _many_ contributors for making this release our best release so far, and special thanks to both @michaelshobbs and @Flink for pushing along the `0.4.0` release!
### Deprecations and Removals ### Deprecations and Removals
@@ -6118,7 +6118,7 @@ This release pegs Dokku to Docker 1.6.2. Docker 1.7.0 introduced changes in `doc
- #1029: @assaf Added several enhancements for CHECKS file: - #1029: @assaf Added several enhancements for CHECKS file:
- Specify how long to wait before running first check - Specify how long to wait before running first check
- Specify timeout for each check - Specify timeout for each check
- Check specific hosts, e.g. http://signin.example.com - Check specific hosts, e.g. [http://signin.example.com](http://signin.example.com)
- Check both HTTP and HTTPS resources - Check both HTTP and HTTPS resources
- #1032: @cameron-martin Updated dokku-installer to use relative path - #1032: @cameron-martin Updated dokku-installer to use relative path
- #1035: @Flink [docs] Add dokku-http-auth to plugins - #1035: @Flink [docs] Add dokku-http-auth to plugins
@@ -6337,25 +6337,25 @@ This release pegs Dokku to Docker 1.6.2. Docker 1.7.0 introduced changes in `doc
## 0.2.0 (2013-11-24) ## 0.2.0 (2013-11-24)
* Added DOKKU_TRACE variable for verbose trace information - Added DOKKU_TRACE variable for verbose trace information
* Added an installer (for pre-built images) - Added an installer (for pre-built images)
* Application config (environment variable management) - Application config (environment variable management)
* Backup/import plugin - Backup/import plugin
* Basic hooks/plugin system - Basic hooks/plugin system
* Cache dir is preserved across builds - Cache dir is preserved across builds
* Command to delete an application - Command to delete an application
* Exposed commands over SSH using sshcommand - Exposed commands over SSH using sshcommand
* Git handling is moved to a plugin - Git handling is moved to a plugin
* Integration test coverage - Integration test coverage
* Pulled nginx vhosts out into plugin - Pulled nginx vhosts out into plugin
* Run command - Run command
* Separated dokku and buildstep more cleanly - Separated dokku and buildstep more cleanly
* Uses latest version of Docker again - Uses latest version of Docker again
## 0.1.0 (2013-06-15) ## 0.1.0 (2013-06-15)
* First release - First release
* Bootstrap script for Ubuntu system - Bootstrap script for Ubuntu system
* Basic push / deploy with git - Basic push / deploy with git
* Hostname support with Nginx - Hostname support with Nginx
* Support for Java, Ruby, Node.js buildpacks - Support for Java, Ruby, Node.js buildpacks

View File

@@ -59,7 +59,6 @@ When deploying a monorepo, it may be desirable to specify the specific path of t
For deploys via the `git:from-image` and `git:load-image` commands, the `app.json` is extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `app.json` extracted directly from the source code. Both cases will respect the configured `appjson-path` property value. For deploys via the `git:from-image` and `git:load-image` commands, the `app.json` is extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `app.json` extracted directly from the source code. Both cases will respect the configured `appjson-path` property value.
```shell ```shell
dokku app-json:set node-js-app appjson-path .dokku/app.json dokku app-json:set node-js-app appjson-path .dokku/app.json
``` ```

View File

@@ -27,7 +27,7 @@ Dokku deploys your application in multiple "phases" and the `docker-options` plu
Manipulation of docker options will not restart running containers. This enables multiple options to be set/unset before final application. As such, changing an app's docker options must be followed by a `dokku ps:rebuild` in order to take effect. Manipulation of docker options will not restart running containers. This enables multiple options to be set/unset before final application. As such, changing an app's docker options must be followed by a `dokku ps:rebuild` in order to take effect.
More information on supported Docker options can be found here: https://docs.docker.com/engine/reference/commandline/run/. More information on supported Docker options can be found [here](https://docs.docker.com/engine/reference/commandline/run/).
Container options configured via the `docker-options` plugin are not used to modify the process a container runs. Container options are the `[OPTIONS]` portion of the following, where `[CONTAINER_COMMAND]` and `[ARG]` are the process and the arguments passed to it that are launched in the created container: `docker run [OPTIONS] [CONTAINER_COMMAND] [ARG...]`. Please see the documentation for [customizing the run command](/docs/deployment/builders/dockerfiles.md#customizing-the-run-command) or use a [Procfile](/docs/deployment/builders/dockerfiles.md#procfiles-and-multiple-processes) to modify the command used by a Dockerfile-based container. Container options configured via the `docker-options` plugin are not used to modify the process a container runs. Container options are the `[OPTIONS]` portion of the following, where `[CONTAINER_COMMAND]` and `[ARG]` are the process and the arguments passed to it that are launched in the created container: `docker run [OPTIONS] [CONTAINER_COMMAND] [ARG...]`. Please see the documentation for [customizing the run command](/docs/deployment/builders/dockerfiles.md#customizing-the-run-command) or use a [Procfile](/docs/deployment/builders/dockerfiles.md#procfiles-and-multiple-processes) to modify the command used by a Dockerfile-based container.

View File

@@ -36,7 +36,6 @@ dokku storage:list node-js-app
The output format can also be set to `json` for programmatic access: The output format can also be set to `json` for programmatic access:
```shell ```shell
dokku storage:list node-js-app --format json dokku storage:list node-js-app --format json
``` ```

View File

@@ -4,10 +4,10 @@
By default, Dokku will ship a PCI Compliant nginx configuration. For developers whose users are on older browsers or mobile devices, you may need to ship a custom `nginx.conf.sigil` to enable ciphers for older browsers. By default, Dokku will ship a PCI Compliant nginx configuration. For developers whose users are on older browsers or mobile devices, you may need to ship a custom `nginx.conf.sigil` to enable ciphers for older browsers.
See the [nginx customization](/docs/networking/proxies/nginx/#customizing-the-nginx-configuration) docs for more details. See the [nginx customization](/docs/networking/proxies/nginx.md#customizing-the-nginx-configuration) docs for more details.
## Nginx Error Pages ## Nginx Error Pages
We now ship with nicer error pages by default. You are free to customize your Dokku installation via a custom `nginx.conf.sigil` to change what error pages are displayed in different circumstances. We now ship with nicer error pages by default. You are free to customize your Dokku installation via a custom `nginx.conf.sigil` to change what error pages are displayed in different circumstances.
See the [nginx customization](/docs/networking/proxies/nginx/#customizing-the-nginx-configuration) docs for more details. See the [nginx customization](/docs/networking/proxies/nginx.md#customizing-the-nginx-configuration) docs for more details.

View File

@@ -3,6 +3,7 @@
## Changes ## Changes
- Renaming an application will now only rename domains that are associated with global domains. As an example: - Renaming an application will now only rename domains that are associated with global domains. As an example:
```shell ```shell
dokku domains:set-global dokku.me dokku domains:set-global dokku.me
dokku apps:create node-js-app dokku apps:create node-js-app

View File

@@ -2,13 +2,13 @@
## Domain Management ## Domain Management
You can now set global and app domains via `domains:set` and `domains:set-global`. See the [domains documentation](/docs/configuration/domains/) for more details. You can now set global and app domains via `domains:set` and `domains:set-global`. See the [domains documentation](/docs/configuration/domains.md) for more details.
## Plugin Uninstallation ## Plugin Uninstallation
A new `uninstall` plugin trigger was introduced. This functionality may be in use for newer plugins, so be aware that older Dokku versions may require manual cleanup. A new `uninstall` plugin trigger was introduced. This functionality may be in use for newer plugins, so be aware that older Dokku versions may require manual cleanup.
See the [uninstall trigger documentation](/docs/development/plugin-triggers/#uninstall) for implementation instructions. See the [uninstall trigger documentation](/docs/development/plugin-triggers.md#uninstall) for implementation instructions.
## Deployment Tasks ## Deployment Tasks

View File

@@ -208,7 +208,7 @@ The following plugins have been removed as their functionality is now in Dokku C
| [Volume (persistent storage)](https://github.com/ohardy/dokku-volume) | [ohardy][] | v0.5.0 (storage plugin) | | [Volume (persistent storage)](https://github.com/ohardy/dokku-volume) | [ohardy][] | v0.5.0 (storage plugin) |
<sup>1</sup> Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration) <sup>1</sup> Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration)
<sup>2</sup> Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile) <sup>2</sup> Similar to the [heroku-labs feature](https://devcenter.heroku.com/articles/labs-user-env-compile)
### Unmaintained Plugins ### Unmaintained Plugins

View File

@@ -14,6 +14,7 @@ config:keys (<app>|--global) [--merged]
config:set [--encoded] [--no-restart] (<app>|--global) KEY1=VALUE1 [KEY2=VALUE2 ...] Set one or more config vars config:set [--encoded] [--no-restart] (<app>|--global) KEY1=VALUE1 [KEY2=VALUE2 ...] Set one or more config vars
config:unset [--no-restart] (<app>|--global) KEY1 [KEY2 ...] Unset one or more config vars config:unset [--no-restart] (<app>|--global) KEY1 [KEY2 ...] Unset one or more config vars
``` ```
> For security reasons - and as per [docker recommendations](https://github.com/docker/docker/issues/13490) - Dockerfile-based deploys have variables available _only_ during runtime, as noted in [this issue](https://github.com/dokku/dokku/issues/1860). Consider using [build arguments](/docs/deployment/builders/dockerfiles.md#build-time-configuration-variables) to expose variables during build-time for Dockerfile apps. > For security reasons - and as per [docker recommendations](https://github.com/docker/docker/issues/13490) - Dockerfile-based deploys have variables available _only_ during runtime, as noted in [this issue](https://github.com/dokku/dokku/issues/1860). Consider using [build arguments](/docs/deployment/builders/dockerfiles.md#build-time-configuration-variables) to expose variables during build-time for Dockerfile apps.
Environment variables are available both at run time and during the application build/compilation step for buildpack-based deploys. Environment variables are available both at run time and during the application build/compilation step for buildpack-based deploys.
@@ -28,7 +29,8 @@ You can set multiple environment variables at once:
dokku config:set node-js-app ENV=prod COMPILE_ASSETS=1 dokku config:set node-js-app ENV=prod COMPILE_ASSETS=1
``` ```
> Note: Whitespace and special characters get tricky. If you are using dokku locally you don't need to do any special escaping. If you are using dokku over ssh you will need to backslash-escape spaces: Whitespace and special characters get tricky. If you are using dokku locally you don't need to do any special escaping. If you are using dokku over ssh you will need to backslash-escape spaces:
```shell ```shell
dokku config:set node-js-app KEY="VAL\ WITH\ SPACES" dokku config:set node-js-app KEY="VAL\ WITH\ SPACES"
``` ```
@@ -58,8 +60,7 @@ dokku config:export node-js-app
eval $(dokku config:export node-js-app) eval $(dokku config:export node-js-app)
``` ```
You can control the format of the exported variables with the `--format` flag. You can control the format of the exported variables with the `--format` flag. `--format=shell` will output the variables in a single-line for usage in command-line utilities:
`--format=shell` will output the variables in a single-line for usage in command-line utilities:
```shell ```shell
dokku config:export --format shell node-js-app dokku config:export --format shell node-js-app

View File

@@ -42,9 +42,11 @@ As this functionality is highly experimental, there are a number of caveats. Ple
This builder will be auto-detected in either the following cases: This builder will be auto-detected in either the following cases:
- The `DOKKU_CNB_EXPERIMENTAL` app environment variable is set to `1`. - The `DOKKU_CNB_EXPERIMENTAL` app environment variable is set to `1`.
```shell ```shell
dokku config:set --no-restart node-js-app DOKKU_CNB_EXPERIMENTAL=1 dokku config:set --no-restart node-js-app DOKKU_CNB_EXPERIMENTAL=1
``` ```
- A `project.toml` file exists in the root of the app repository. - A `project.toml` file exists in the root of the app repository.
- This file is consumed by `pack-cli` and used to describe how the app is built. - This file is consumed by `pack-cli` and used to describe how the app is built.

View File

@@ -91,7 +91,7 @@ In addition, the following commands have special local side-effects:
#### Specifying a remote #### Specifying a remote
While many users will only ever push to a single dokku remote from a given repository, it may be useful to point the same repository at multiple remotes, especially in the case of pre-production environments. This can be done via the `remote` commands. These commands are _only_ available within the official remote client, and are not server-side commands. While many users will only ever push to a single dokku remote from a given repository, it may be useful to point the same repository at multiple remotes, especially in the case of pre-production environments. This can be done via the `remote` commands. These commands are *only* available within the official remote client, and are not server-side commands.
To see your currently configured remote, run `dokku remote`. This will respect the `--remote` flag. To see your currently configured remote, run `dokku remote`. This will respect the `--remote` flag.
@@ -101,7 +101,7 @@ To add a remote, run `dokku remote:add $REMOTE_NAME dokku@dokku.me:$APP_NAME`, r
To remove a remote, run `dokku remote:remove $REMOTE_NAME`. This is equivalent to running `git remote remove $REMOTE_NAME`. To remove a remote, run `dokku remote:remove $REMOTE_NAME`. This is equivalent to running `git remote remove $REMOTE_NAME`.
By default, the remote in use is `dokku`. To change the remote the client uses by default, run `dokku remote:set $REMOTE_NAME`, where `$REMOTE_NAME` is the name of your desired remote. This will not check the value specified, so that remote _must_ be available or errors will occur when running normal client commands. Note that specifying `--remote` when running dokku commands will override this configuration value. By default, the remote in use is `dokku`. To change the remote the client uses by default, run `dokku remote:set $REMOTE_NAME`, where `$REMOTE_NAME` is the name of your desired remote. This will not check the value specified, so that remote *must* be available or errors will occur when running normal client commands. Note that specifying `--remote` when running dokku commands will override this configuration value.
To clear the configured remote, run `dokku remote:unset`. The client will unset the configured remote, and will default back to `dokku`, or the value of `--remote` if specified. To clear the configured remote, run `dokku remote:unset`. The client will unset the configured remote, and will default back to `dokku`, or the value of `--remote` if specified.

View File

@@ -121,7 +121,6 @@ This plugin implements various functionality through `plugn` triggers to integra
- `ps:stop` - `ps:stop`
- `run` - `run`
### Logging support ### Logging support
App logs for the `logs` command are fetched from running containers via the `docker` cli. To persist logs across deployments, consider using Dokku's [vector integration](/docs/deployment/logs.md#vector-logging-shipping) to ship logs to another service or a third-party platform. App logs for the `logs` command are fetched from running containers via the `docker` cli. To persist logs across deployments, consider using Dokku's [vector integration](/docs/deployment/logs.md#vector-logging-shipping) to ship logs to another service or a third-party platform.

View File

@@ -82,7 +82,6 @@ echo "$CONTENTS_OF_YOUR_PUBLIC_SSH_KEY_HERE" | dokku ssh-keys:add KEY_NAME
SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc
``` ```
```shell ```shell
cat path/to/id_rsa.pub | dokku ssh-keys:add KEY_NAME cat path/to/id_rsa.pub | dokku ssh-keys:add KEY_NAME
``` ```
@@ -91,7 +90,6 @@ cat path/to/id_rsa.pub | dokku ssh-keys:add KEY_NAME
SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc SHA256:ABC123ABC123+abc123abc123Zabc123abcZ123abc
``` ```
Admin users and root can add keys remotely by specifying the `dokku` bin on their `ssh` command: Admin users and root can add keys remotely by specifying the `dokku` bin on their `ssh` command:
```shell ```shell

View File

@@ -163,7 +163,7 @@ A healthcheck entry takes the following properties:
- `attempts`: (default: `3` seconds) Number of retry attempts to perform on failure. - `attempts`: (default: `3` seconds) Number of retry attempts to perform on failure.
- `command`: (default `''` - empty string) Command to execute within container. - `command`: (default `''` - empty string) Command to execute within container.
- `content`: (default: `''` - empty string) Content to search in http path check output. - `content`: (default: `''` - empty string) Content to search in http path check output.
initialDelay default: 0, unit: seconds) Number of seconds to wait after a container has started before triggering the healthcheck. - `initialDelay`: (default: 0, unit: seconds) Number of seconds to wait after a container has started before triggering the healthcheck.
- `name`: (default: autogenerated) The name of the healthcheck. If unspecified, it will be autogenerated from the rest of the healthcheck information. - `name`: (default: autogenerated) The name of the healthcheck. If unspecified, it will be autogenerated from the rest of the healthcheck information.
- `path`: (default: `/` - for http checks): An http path to check. - `path`: (default: `/` - for http checks): An http path to check.
- `timeout`: (default: `5` seconds): Number of seconds to wait before timing out a healthcheck. - `timeout`: (default: `5` seconds): Number of seconds to wait before timing out a healthcheck.

View File

@@ -2052,6 +2052,7 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
# TODO # TODO
``` ```
### `ps-current-scale` ### `ps-current-scale`
- Description: Prints out the current scale contents (process-type=quantity) delimited by newlines. - Description: Prints out the current scale contents (process-type=quantity) delimited by newlines.

View File

@@ -78,7 +78,7 @@ Follow the [user management documentation](/docs/deployment/user-management.md)
## VMs with less than 1 GB of memory ## VMs with less than 1 GB of memory
Having less than 1 GB of system memory available for Dokku and its containers may result in unexpected errors, such as `! [remote rejected] master -> master (pre-receive hook declined)` during installation of NPM dependencies (https://github.com/npm/npm/issues/3867). Having less than 1 GB of system memory available for Dokku and its containers may result in unexpected errors, such as `! [remote rejected] master -> master (pre-receive hook declined)` [during installation of NPM dependencies](https://github.com/npm/npm/issues/3867).
To work around this issue, it might suffice to augment the Linux swap file size to a maximum of twice the physical memory size. To work around this issue, it might suffice to augment the Linux swap file size to a maximum of twice the physical memory size.

View File

@@ -1,10 +1,10 @@
# Getting Started with Dokku # Getting Started with Dokku
### What is Dokku? ## What is Dokku?
Dokku is an extensible, open source Platform as a Service that runs on a single server of your choice. Dokku supports building apps on the fly from a `git push` via either Dockerfile or by auto-detecting the language with Buildpacks, and then starts containers based on your built image. Using technologies such as nginx and cron, Web processes are automatically routed to, while background processes and automated cron tasks are also managed by Dokku. Dokku is an extensible, open source Platform as a Service that runs on a single server of your choice. Dokku supports building apps on the fly from a `git push` via either Dockerfile or by auto-detecting the language with Buildpacks, and then starts containers based on your built image. Using technologies such as nginx and cron, Web processes are automatically routed to, while background processes and automated cron tasks are also managed by Dokku.
### System Requirements ## System Requirements
To start using Dokku, you'll need a system that meets the following minimum requirements: To start using Dokku, you'll need a system that meets the following minimum requirements:
@@ -28,11 +28,11 @@ Finally, we recommend attaching at least one domain name to your server. This is
Please see the [dns documentation](/docs/networking/dns.md) and [domains documentation](/docs/configuration/domains.md) for more details. Please see the [dns documentation](/docs/networking/dns.md) and [domains documentation](/docs/configuration/domains.md) for more details.
### Installing the latest stable version ## Installing the latest stable version
This is the simple method of installing Dokku. For alternative methods of installation, see the [advanced install guide](/docs/getting-started/advanced-installation.md#configuring). This is the simple method of installing Dokku. For alternative methods of installation, see the [advanced install guide](/docs/getting-started/advanced-installation.md#configuring).
#### 1. Install Dokku ### 1. Install Dokku
To install the latest stable version of Dokku, you can run the following shell commands: To install the latest stable version of Dokku, you can run the following shell commands:
@@ -44,7 +44,7 @@ sudo DOKKU_TAG=v0.31.0 bash bootstrap.sh
The installation process takes about 5-10 minutes, depending upon internet connection speed. The installation process takes about 5-10 minutes, depending upon internet connection speed.
#### 2. Setup SSH key and Virtualhost Settings ### 2. Setup SSH key and Virtualhost Settings
Once the installation is complete, you should configure an ssh key and set your global domain. Once the installation is complete, you should configure an ssh key and set your global domain.
@@ -67,6 +67,6 @@ dokku domains:set-global 10.0.0.2.sslip.io
See the [user management](/docs/deployment/user-management.md#adding-ssh-keys) and [domains documentation](/docs/configuration/domains.md#customizing-hostnames) for more information. See the [user management](/docs/deployment/user-management.md#adding-ssh-keys) and [domains documentation](/docs/configuration/domains.md#customizing-hostnames) for more information.
#### 3. Deploy your first application ### 3. Deploy your first application
At this point, you should be able to [deploy to the Dokku installation](/docs/deployment/application-deployment.md). At this point, you should be able to [deploy to the Dokku installation](/docs/deployment/application-deployment.md).

View File

@@ -33,7 +33,7 @@ dokku trace:off
## Common Problems ## Common Problems
### I deployed my app but I am getting the default nginx page. ### I deployed my app but I am getting the default nginx page
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:
@@ -121,7 +121,7 @@ Sometimes (especially on DigitalOcean) deploying again seems to get past these s
resolvconf -u resolvconf -u
``` ```
Please see https://github.com/dokku/dokku/issues/841 and https://github.com/dokku/dokku/issues/649. Please see [#841](https://github.com/dokku/dokku/issues/841) and [#649](https://github.com/dokku/dokku/issues/649).
### After adding an SSH key, I am told I cannot read from the remote repository on push ### After adding an SSH key, I am told I cannot read from the remote repository on push
@@ -155,7 +155,7 @@ Host DOKKU_HOSTNAME
Also see [issue #116](https://github.com/dokku/dokku/issues/116). Also see [issue #116](https://github.com/dokku/dokku/issues/116).
### I successfully deployed my application with no deployment errors and receiving **Bad Gateway** when attempting to access the application. ### I successfully deployed my application with no deployment errors and receiving **Bad Gateway** when attempting to access the application
In many cases the application will require the a `process.env.PORT` port opposed to a specified port. In many cases the application will require the a `process.env.PORT` port opposed to a specified port.
@@ -171,7 +171,7 @@ Additionally, your application should listen/bind to all interfaces (`0.0.0.0`).
Please see [#5798](https://github.com/dokku/dokku/issues/5798). Please see [#5798](https://github.com/dokku/dokku/issues/5798).
### Deployment fails because of slow internet connection, messages shows `gzip: stdin: unexpected end of file`. ### Deployment fails because of slow internet connection, messages shows `gzip: stdin: unexpected end of file`
If you see output similar this when deploying: If you see output similar this when deploying:
@@ -191,11 +191,11 @@ dokku config:set --global CURL_TIMEOUT=1200
dokku config:set --global CURL_CONNECT_TIMEOUT=180 dokku config:set --global CURL_CONNECT_TIMEOUT=180
``` ```
Please see https://github.com/dokku/dokku/issues/509. Please see [#509](https://github.com/dokku/dokku/issues/509).
Another reason for this error (although it may respond immediately ruling out a timeout issue) may be because you've set the config setting `SSL_CERT_FILE`. Using a config setting with this key interferes with the buildpack's ability to download its dependencies, so you must rename the config setting to something else, e.g. `MY_APP_SSL_CERT_FILE`. Another reason for this error (although it may respond immediately ruling out a timeout issue) may be because you've set the config setting `SSL_CERT_FILE`. Using a config setting with this key interferes with the buildpack's ability to download its dependencies, so you must rename the config setting to something else, e.g. `MY_APP_SSL_CERT_FILE`.
### Build fails with `Killed` message. ### Build fails with `Killed` message
This generally occurs when the server runs out of memory. You can either add more RAM to your server or setup swap space. The follow script will create 2 GB of swap space. This generally occurs when the server runs out of memory. You can either add more RAM to your server or setup swap space. The follow script will create 2 GB of swap space.
@@ -209,7 +209,7 @@ sudo sysctl -w vm.swappiness=10
echo vm.swappiness = 10 | sudo tee -a /etc/sysctl.conf echo vm.swappiness = 10 | sudo tee -a /etc/sysctl.conf
``` ```
### I successfully deployed my application with no deployment errors but I'm receiving Connection Timeout when attempting to access the application. ### I successfully deployed my application with no deployment errors but I'm receiving Connection Timeout when attempting to access the application
This can occur if Dokku is running on a system with a firewall like UFW enabled (some OS versions like Ubuntu have this enabled by default). You can check if this is your case by running the following script: This can occur if Dokku is running on a system with a firewall like UFW enabled (some OS versions like Ubuntu have this enabled by default). You can check if this is your case by running the following script:
@@ -223,7 +223,7 @@ If the previous script returned `Status: active` and a list of ports, UFW is ena
sudo ufw disable sudo ufw disable
``` ```
### I can't connect to my application because the server is sending an invalid response, or can't provide a secure connection. ### I can't connect to my application because the server is sending an invalid response, or can't provide a secure connection
This isn't usually an issue with Dokku, but rather an app config problem. This can happen when your application is configured to enforce secure connections/HSTS, but you don't have SSL set up for the app. This isn't usually an issue with Dokku, but rather an app config problem. This can happen when your application is configured to enforce secure connections/HSTS, but you don't have SSL set up for the app.

View File

@@ -28,8 +28,7 @@ The proxy port scheme is as follows:
- `SCHEME:HOST_PORT:CONTAINER_PORT` - `SCHEME:HOST_PORT:CONTAINER_PORT`
The scheme metadata can be used by proxy implementations in order to properly handle proxying of requests. For example, the built-in `nginx-vhosts` proxy implementation supports the `http`, `https`, `grpc` and `grpcs` schemes. The scheme metadata can be used by proxy implementations in order to properly handle proxying of requests. For example, the built-in `nginx-vhosts` proxy implementation supports the `http`, `https`, `grpc` and `grpcs` schemes. For the `grpc` and `grpcs` see [nginx blog post on grpc](https://www.nginx.com/blog/nginx-1-13-10-grpc/).
For the `grpc` and `grpcs` see [nginx blog post on grpc](https://www.nginx.com/blog/nginx-1-13-10-grpc/).
Developers of proxy implementations are encouraged to use whatever schemes make the most sense, and ignore configurations which they do not support. For instance, a `udp` proxy implementation can safely ignore `http` and `https` port mappings. Developers of proxy implementations are encouraged to use whatever schemes make the most sense, and ignore configurations which they do not support. For instance, a `udp` proxy implementation can safely ignore `http` and `https` port mappings.

View File

@@ -107,7 +107,7 @@ Once the HSTS setting is disabled globally, it can be re-enabled on a per-app ba
dokku nginx:set node-js-app hsts true dokku nginx:set node-js-app hsts true
``` ```
### Running behind another proxy — configuring `X-Forwarded-*` headers: ### Running behind another proxy — configuring `X-Forwarded-*` headers
Dokku's default Nginx configuration passes the de-facto standard HTTP headers [`X-Forwarded-For`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For), [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto), and `X-Forwarded-Port` to your application. Dokku's default Nginx configuration passes the de-facto standard HTTP headers [`X-Forwarded-For`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For), [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto), and `X-Forwarded-Port` to your application.
These headers indicate the IP address of the original client making the request, the protocol of the original request (HTTP or HTTPS), and the port number of the original request, respectively. These headers indicate the IP address of the original client making the request, the protocol of the original request (HTTP or HTTPS), and the port number of the original request, respectively.
@@ -331,7 +331,6 @@ When deploying a monorepo, it may be desirable to specify the specific path of t
For deploys via the `git:from-image` and `git:load-image` commands, the `nginx.conf.sigil` is extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `nginx.conf.sigil` extracted directly from the source code. Both cases will respect the configured `nginx-conf-sigil-path` property value. For deploys via the `git:from-image` and `git:load-image` commands, the `nginx.conf.sigil` is extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `nginx.conf.sigil` extracted directly from the source code. Both cases will respect the configured `nginx-conf-sigil-path` property value.
```shell ```shell
dokku nginx:set node-js-app nginx-conf-sigil-path .dokku/nginx.conf.sigil dokku nginx:set node-js-app nginx-conf-sigil-path .dokku/nginx.conf.sigil
``` ```

View File

@@ -117,7 +117,7 @@ If the file exists, it should not be empty, as doing so may result in a failed d
The syntax for declaring a `Procfile` is as follows. Note that the format is one process type per line, with no duplicate process types. The syntax for declaring a `Procfile` is as follows. Note that the format is one process type per line, with no duplicate process types.
``` ```Procfile
<process type>: <command> <process type>: <command>
``` ```
@@ -206,7 +206,7 @@ dokku ps:scale --skip-deploy node-js-app web=1
Users can also configure scaling within the codebase itself to manage process scaling. The `formation` key should be specified as follows in the `app.json` file: Users can also configure scaling within the codebase itself to manage process scaling. The `formation` key should be specified as follows in the `app.json` file:
```Procfile ```json
{ {
"formation": { "formation": {
"web": { "web": {

View File

@@ -18,7 +18,7 @@ Dokku automates scheduled `dokku run` commands via it's `app.json` cron integrat
The `app.json` file for a given app can define a special `cron` key that contains a list of commands to run on given schedules. The following is a simple example `app.json` that effectively runs the command `dokku run $APP npm run send-email` once a day: The `app.json` file for a given app can define a special `cron` key that contains a list of commands to run on given schedules. The following is a simple example `app.json` that effectively runs the command `dokku run $APP npm run send-email` once a day:
``` ```json
{ {
"cron": [ "cron": [
{ {
@@ -169,7 +169,6 @@ Regularly scheduled tasks can be a bit of a pain with Dokku. The following are g
- Use the `dokku` user in your cron entry. - Use the `dokku` user in your cron entry.
- If you do not, the `dokku` binary will attempt to execute with `sudo`, and your cron run with fail with `sudo: no tty present and no askpass program specified`. - If you do not, the `dokku` binary will attempt to execute with `sudo`, and your cron run with fail with `sudo: no tty present and no askpass program specified`.
- Add a `MAILTO` environment variable to ship cron emails to yourself. - Add a `MAILTO` environment variable to ship cron emails to yourself.
- Add a `PATH` environment variable or specify the full path to binaries on the host. - Add a `PATH` environment variable or specify the full path to binaries on the host.
- Add a `SHELL` environment variable to specify Bash when running commands. - Add a `SHELL` environment variable to specify Bash when running commands.

View File

@@ -1,3 +1,3 @@
This is a sample application to test heroku buildpack multi for integrating with herokuish: https://github.com/gliderlabs/herokuish This is a sample application to test heroku buildpack multi for integrating with [herokuish](https://github.com/gliderlabs/herokuish)
I am choosing to use the python, nodejs, and ruby buildpacks to create a very simple flask app that performs a bower install and a simple grunt task using compass. I am choosing to use the python, nodejs, and ruby buildpacks to create a very simple flask app that performs a bower install and a simple grunt task using compass.

View File

@@ -9,10 +9,10 @@ This application support the [Getting Started with Scala on Heroku](https://devc
Make sure you have Scala and sbt installed. Also, install the [Heroku Toolbelt](https://toolbelt.heroku.com/). Make sure you have Scala and sbt installed. Also, install the [Heroku Toolbelt](https://toolbelt.heroku.com/).
```sh ```sh
$ git clone https://github.com/heroku/scala-getting-started.git git clone https://github.com/heroku/scala-getting-started.git
$ cd scala-getting-started cd scala-getting-started
$ sbt compile stage sbt compile stage
$ foreman start web foreman start web
``` ```
Your app should now be running on [localhost:5000](http://localhost:5000/). Your app should now be running on [localhost:5000](http://localhost:5000/).
@@ -20,9 +20,9 @@ Your app should now be running on [localhost:5000](http://localhost:5000/).
## Deploying to Heroku ## Deploying to Heroku
```sh ```sh
$ heroku create heroku create
$ git push heroku master git push heroku master
$ heroku open heroku open
``` ```
## Documentation ## Documentation
@@ -30,4 +30,3 @@ $ heroku open
For more information about using Scala on Heroku, see these Dev Center articles: For more information about using Scala on Heroku, see these Dev Center articles:
- [Scala on Heroku](https://devcenter.heroku.com/categories/scala) - [Scala on Heroku](https://devcenter.heroku.com/categories/scala)