dokku/docs/getting-started/installation.md

Getting Started with 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.

System Requirements

To start using Dokku, you'll need a system that meets the following minimum requirements:

• A fresh installation of any of the following operating systems:
  • Ubuntu 18.04/20.04 x64
  • Debian 9+ x64
  • CentOS 7 x64 (experimental)
• A server with one of the following architectures
  • AMD64 (alternatively known as x86_64), commonly used for Intel cloud servers
  • ARMV7 (alternatively known as armhf), commonly used for Raspberry PI

To avoid memory pressure during builds or runtime of your applications, we suggest the following:

• At least 1 GB of system memory
  • If your system has less than 1GB of memory, you can use this workaround.

Finally, we recommend attaching at least one domain name to your server. This is not required, but using a domain name will make app access easier. When connecting a domain, either a single domain or a wildcard may be associated to the server's IP.

• Wildcard domain (*.domain.tld A Record): will allow access to apps via $APP.domain.tld.
• Single domain (domain.tld A or CNAME Record): will result in apps being accessed via domain.tld:$RANDOM_PORT.

Please see the dns documentation and domains documentation for more details.

Installing the latest stable version

This is the simple method of installing Dokku. For alternative methods of installation, see the advanced install guide.

1. Install Dokku

To install the latest stable version of Dokku, you can run the following shell commands:

# for debian systems, installs Dokku via apt-get
wget https://raw.githubusercontent.com/dokku/dokku/v0.27.1/bootstrap.sh;
sudo DOKKU_TAG=v0.27.1 bash bootstrap.sh

The installation process takes about 5-10 minutes, depending upon internet connection speed.

2. Setup SSH key and Virtualhost Settings

Once the installation is complete, you should configure an ssh key and set your global domain.

# usually your key is already available under the current user's `~/.ssh/authorized_keys` file
cat ~/.ssh/authorized_keys | dokku ssh-keys:add admin

# you can use any domain you already have access to
# this domain should have an A record or CNAME pointing at your server's IP
dokku domains:set-global dokku.me

# you can also use the ip of your server
dokku domains:set-global 10.0.0.2

# finally, you can use sslip.io to get subdomain support
# as you would with a regular domain name
# this would be done by appending `.sslip.io` to your ip address
dokku domains:set-global 10.0.0.2.sslip.io

See the user management and domains documentation for more information.

3. Deploy your first application

At this point, you should be able to deploy to the Dokku installation.