Skip to main content
Version: v4

Installation

Running the binary​

Download the packaged archive for your platform from the downloads page and extract the package to a shared location in your drive, like /opt/local/bin.

Run Dkron with default setting: dkron agent --server --bootstrap-expect=1

Navigate to http://localhost:8080/ui

Installing the package​

Debian repo​

APT repository:

deb [trusted=yes] https://repo.distrib.works/apt/ /

Then install: sudo apt-get install dkron

YUM repo​

YUM repository:

[dkron]
name=Dkron Pro Private Repo
baseurl=https://repo.distrib.works/yum/
enabled=1
gpgcheck=0

Then install: sudo yum install dkron

This will start Dkron as a system service and the place example configuration file under /etc/dkron/dkron.yml

Running in Docker​

Dkron provides official Docker images via Docker Hub that can be used for deployment on any system running Docker.

info

If you only plan to use the build-in executors, http and shell you can use the Dkron Light edition that only includes a single binary as the plugins are build-in.

Launching Dkron as a new container​

Here’s a quick one-liner to get you off the ground (please note, we recommend further configuration for production deployments below):

docker run -d -p 8080:8080 --name dkron dkron/dkron agent --server --bootstrap-expect=1 --node-name=node1

This will launch a Dkron server on port 8080 by default. You can use docker logs -f dkron to follow the rest of the initialization progress. Once the Dkron startup completes you can access the app at localhost:8080

Since Docker containers have their own ports and we just map them to the system ports as needed it’s easy to move Dkron onto a different system port if you wish. For example running Dkron on port 12345:

docker run -d -p 12345:8080 --name dkron dkron/dkron agent --server --bootstrap-expect=1 --node-name=node1

Mounting a mapped file storage volume​

Dkron uses the local filesystem for storing the embedded database to store its own application data and the Raft protocol log. The end result is that your Dkron data will be on disk inside your container and lost if you ever remove the container.

To persist your data outside of the container and make it available for use between container launches we can mount a local path inside our container.

docker run -d -p 8080:8080 -v ~/dkron.data:/dkron.data --name dkron dkron/dkron agent --server --bootstrap-expect=1 --data-dir=/dkron.data

Now when you launch your container we are mounting that folder from our local filesystem into the container.