Files
dokku/docs/getting-started/advanced-installation.md
T
Jose Diaz-Gonzalez fe155f6fc9 feat: modernize bootstrap script output
The bootstrap script now shows each install step in the style of Dokku's log output, with a live view of the running step when run in a terminal, per-step timings, a timestamped log file under `/var/log/dokku`, and a summary at the end. A failed step prints its full output. After installing, it adds root's SSH keys and sets the server's IP as the global domain when those are not already configured. `DOKKU_VERBOSE=1` streams all command output, and `NO_COLOR=1` disables colors.
2026-10-28 23:44:38 -04:00

6.6 KiB

Advanced installation

Installing via other methods

For various reasons, certain hosting providers may have other steps that should be preferred to the above. If hosted on any of the following popular hosts, please follow the linked to instructions:

As well, you may wish to customize your installation in some other fashion. or experiment with Vagrant. The guides below should get you started:

Installing from Source

You can always install Dokku straight from the latest - potentially unstable - master branch via the following Bash command:

# using a branch results in installing from source
wget -NP . https://dokku.com/install/master/bootstrap.sh;
sudo DOKKU_BRANCH=master bash bootstrap.sh

Development

If you plan on developing Dokku, the easiest way to install from your own repository is cloning the repository and calling the install script. Example:

git clone https://github.com/yourusername/dokku.git
cd dokku
sudo make install

The Makefile allows source URLs to be overridden to include customizations from your own repositories. The DOCKER_URL, PLUGN_URL, SSHCOMMAND_URL and STACK_URL environment variables may be set to override the defaults (see the Makefile for how these apply). Example:

sudo SSHCOMMAND_URL=https://raw.githubusercontent.com/yourusername/sshcommand/master/sshcommand make install

Bootstrap a server from your own repository

The bootstrap script allows the Dokku repository URL to be overridden to bootstrap a host from your own clone of Dokku using the DOKKU_REPO environment variable. Example:

wget -NP . https://dokku.com/install/master/bootstrap.sh;
chmod +x bootstrap.sh
sudo DOKKU_REPO=https://github.com/yourusername/dokku.git DOKKU_BRANCH=master ./bootstrap.sh

Bootstrap script output and logs

When run from a terminal, the bootstrap script shows each install step with a spinner and the last few lines of output from the running step. When the output is not a terminal - such as in CI, Vagrant, or when piping to a file - it prints one line when each step starts and one when it finishes.

All command output is written to a log file at /var/log/dokku/install-<timestamp>.log, with a timestamp on every line. If a step fails, the full output of the failed step is printed along with the path to the full log.

The following environment variables change the output:

  • DOKKU_VERBOSE=1: Stream the full output of every command instead of the condensed view.
  • TRACE=1: Same as DOKKU_VERBOSE=1, and also enables set -x.
  • NO_COLOR=1: Disable colors.
sudo DOKKU_TAG=v0.38.32 DOKKU_VERBOSE=1 bash bootstrap.sh

Automatic configuration by the bootstrap script

After installing, the bootstrap script fills in configuration that is still missing:

  • SSH keys: If no SSH keys have been added to Dokku, DOKKU_SKIP_KEY_FILE is not true, and /root/.ssh/authorized_keys contains keys, each key is added via dokku ssh-keys:add. The first key is named admin, and any others are named admin-2, admin-3, and so on.
  • Global domain: If no global domain is set, it is set to the server's primary IPv4 address via dokku domains:set-global. On a server behind NAT, this is the private address.

Anything already configured - for example via the DOKKU_KEY_FILE or DOKKU_HOSTNAME debconf settings - is left as is. The summary at the end of the install shows what was configured, along with the commands to configure anything that was not.

Custom Herokuish build

Dokku ships with a pre-built version of the Herokuish component by default. If you want to build your own version you can specify that with an environment variable.

git clone https://github.com/dokku/dokku.git
cd dokku
sudo BUILD_STACK=true STACK_URL=https://github.com/gliderlabs/herokuish.git make install

Skipping Herokuish installation

The Herokuish package is recommended but not required if not using Heroku buildpacks for deployment. Debian-based OS users can run the bootstrap installer via sudo DOKKU_NO_INSTALL_RECOMMENDS=" --no-install-recommends " bash bootstrap.sh to skip the dependency. Please note that this will also skip installation of other recommended dependencies.

Configuring an unattended installation

Once Dokku is installed, you'll want to configure the virtualhost setup as well as the push user. If you do not, your installation will be considered incomplete and you will not be able to deploy applications.

For Debian, unattended installation is described Debian installation guide.

Set up a domain using your preferred vendor and a wildcard domain pointing to the host running Dokku. You can manage this global domain using the domains plugin.

Follow the user management documentation in order to add SSH keys for users to Dokku, or to give other Unix accounts access to Dokku.

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.

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 resize the swap file of a 512 MB machine to 1 GB, follow these steps while in SSH within your machine:

cd /var
touch swap.img
chmod 600 swap.img

swapoff /var/swap.img
dd if=/dev/zero of=/var/swap.img bs=1024k count=1000
mkswap /var/swap.img
swapon /var/swap.img
free

echo "/var/swap.img    none    swap    sw    0    0" >> /etc/fstab

Note: it may be necessary to call swapoff, mkswap and swapon explicitly: sudo /sbin/swapoff /var/swap.img, etc.

Reference

Add'l Reference