Skip to content

Configuration

Configuration for Dokku Pro is contained in the /etc/default/dokku-pro file. The contents are configured in the format key=value as shown below:

API_JWT_ACCESSSECRET=asdfghjklzxc
API_JWT_REFRESHSECRET=qwertyuiopzxcvbnmas
ROOT_TOKEN=password
LICENSE_KEY=CONTENTS_OF_LICENSE_KEY

The configuration keys and potential values are described below.

General

DATABASE_LOCATION

  • Type: string
  • Default: /var/lib/dokku/data/pro/db
  • Description: A full path to the dokku-pro database location. All parent directories should exist, or dokku-pro will fail to start.

LOG_TTL

  • Default: 10080 (7 days)
  • Description: Number of minutes to store log messages for
  • Type: int minutes

API

API_JWT_ACCESSSECRET

  • default: empty string
  • description: An access secret value for use with the jwt token
  • required: true
  • type: string

API_JWT_REFRESHSECRET

  • default: empty string
  • description: An access secret value for use with the jwt token
  • required: true
  • type: string

Apps

APPS_FILTER

New as of 1.2

  • default: empty list
  • description: A list of apps to filter from showing in the admin and api for cosmetic reasons.
  • required: false
  • type: list of strings (comma-delimited)

Auth

ROOT_TOKEN

  • default: empty string
  • description: A token to use for basic auth login, disables auth otherwise
  • required: true
  • type: string

ROOT_USERNAME

New as of 1.2

If this value is changed and team management is enabled, the username must be manually added to the global admin team.

  • default: root
  • description: The username to use as the "root" system user.
  • required: true
  • type: string

License

LICENSE_KEY

  • default: empty string
  • description: License key for the service
  • type: string

LICENSE_KEY_FILE

  • default: empty string
  • description: Path to file containing license key
  • type: string

Server

SERVER_PUBLIC_URL

  • default: https://admin.dokku.me
  • description: The domain name to use for your dokku pro installation, including schema. Used by the CLI to construct urls to the app.
  • type: string

SERVER_READ_TIMEOUT

  • default: 10
  • description: The maximum duration for reading the entire request, including the body. A zero or negative value means there will be no timeout.
  • type: int seconds

SERVER_WRITE_TIMEOUT

  • default: 20
  • description: The maximum duration before timing out writes of the response.It is reset whenever a new request's header is read. Like ReadTimeout, it does not let Handlers make decisions on a per-request basis. A zero or negative value means there will be no timeout.
  • type: int seconds

SERVER_NETWORK

  • default: tcp
  • description: The local network address to listen to.
  • options: [tcp, tcp4, tcp6]
  • type: string

PORT

  • default: 5000
  • description: The port to listen on
  • type: int

PUBLIC_URL

  • default: https://admin.dokku.me
  • description: The base URL at which Dokku Pro is hosted at. This base URL will be used by Dokku Pro to construct URLs in the CLI, such as generating password reset links.
  • type: string