Skip to content

Installation

Jump to bottom
Farukk57 edited this page Apr 19, 2026 · 1 revision

Installation

Prerequisites

Option A — Pull from Docker Hub (recommended)

This is the easiest way to get started. You don't need to clone the repository.

1. Create the directory structure

mkdir -p release-notifier/config release-notifier/data
cd release-notifier

2. Download the example files

curl -O https://raw.githubusercontent.com/Farukk57/release-notifier/main/docker-compose.hub.yml
curl -O https://raw.githubusercontent.com/Farukk57/release-notifier/main/env.example
curl -O https://raw.githubusercontent.com/Farukk57/release-notifier/main/config/containers.yml.example

3. Configure

cp env.example .env
cp config/containers.yml.example config/containers.yml

nano .env                  # add your API keys
nano config/containers.yml # add your containers

See Configuration for a full explanation of all options.

4. Start the container

docker compose -f docker-compose.hub.yml up -d

5. Verify

docker logs release-notifier
curl http://localhost:8080/api/health

The health endpoint should return "status": "ok".

Option B — Build from source

Use this if you want to modify the code.

1. Clone the repository

git clone https://github.com/Farukk57/release-notifier.git
cd release-notifier

2. Configure

cp env.example .env
cp config/containers.yml.example config/containers.yml

nano .env
nano config/containers.yml

3. Build and start

docker compose up -d --build

Using a reverse proxy (Traefik)

Remove the ports block from docker-compose.hub.yml and add your Traefik labels:

services:
  release-notifier:
    image: 57faruk57/release-notifier:latest
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.release-notifier.rule=Host(`releases.yourdomain.com`)"
      - "traefik.http.routers.release-notifier.entrypoints=websecure"
      - "traefik.http.routers.release-notifier.tls=true"
      - "traefik.http.services.release-notifier.loadbalancer.server.port=8080"

Updating

# Pull latest image
docker compose -f docker-compose.hub.yml pull

# Restart with new image
docker compose -f docker-compose.hub.yml up -d

No configuration changes are needed between minor version updates unless the release notes say otherwise.

Clone this wiki locally