Skip to main content

Installation

Binary​

Download the latest release for your OS and architecture from Github and unpack it. Alternatively, you can copy the gickup binary to a directory from your $PATH variable, to use it globally.

Linux/Mac​

./gickup conf.yml

Windows​

gickup.exe conf.yml

Docker​

You can grab the latest version of gickup from Github or Docker.

Pure Docker​

docker pull buddyspencer/gickup # or ghcr.io/cooperspencer/gickup
docker run -d -v /path/to/conf.yml:/gickup/conf.yml buddyspencer/gickup # or ghcr.io/cooperspencer/gickup

Docker Compose​

If you prefer to use docker compose, grab the docker-compose.yml from the repository.

docker compose up -d

Compile it yourself​

If you want to use the latest version of the main branch, you can also compile it yourself.

Prerequisits:

git clone https://github.com/cooperspencer/gickup
cd gickup
go build .