Basics

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 Navigate to http://localhost:8080 By default dkron will start with a file based, embedded KV store called BoltDB, it is functional for a single node demo but does not offers clustering or HA. Installing the package Debian repo APT repository:

Developing plugins

Developing a Plugin **Advanced topic!** Plugin development is a highly advanced topic, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading the following section of the documentation. Developing a plugin is simple. The only knowledge necessary to write a plugin is basic command-line skills and basic knowledge of the Go programming language. Note: A common pitfall is not properly setting up a $GOPATH.

Getting started

Introduction Dkron nodes can work in two modes, agents or servers. A Dkron agent is a cluster member that can handle job executions, run your scripts and return the resulting output to the server. A Dkron server is also a cluster member that send job execution queries to agents or other servers, so servers can execute jobs too. The main distinction is that servers order job executions, can be used to schedule jobs, handles data storage and participate on leader election.

Configuration

Configuration sources Settings can be specified in three ways (in order of precedence): Command line arguments. Environment variables starting with DKRON_ dkron.json config file Config file example # Dkron example configuration file # backend: etcd # backend-machine: 127.0.0.1:2379 # server: false # log-level: debug # tags: # role: web # datacenter: east # keyspace: dkron # encrypt: a-valid-key-generated-with-dkron-keygen # join: # - 10.0.0.1 # - 10.0.0.2 # - 10.