Cup

Important

The following guide assumes you've used my reverse proxy setup, if not you can find it here

Cup is a monitoring solution for tracking container updates. This guide will help you set up Cup in your homelab.

Setup Directory Structure

Create a folder to store all Cup configuration files:

mkdir cup
cd cup

Configuration Files

1. Docker Compose Configuration

Create a compose.yaml file with the following content:

compose.yaml

services:
    cup:
        command: '-c /config/cup.json serve -p 9000'
        image: ghcr.io/sergi0g/cup
        volumes:
            - '/var/run/docker.sock:/var/run/docker.sock'
            - ./cup.json:/config/cup.json
        networks:
            - proxy-net
        labels:
            traefik.enable: true
            traefik.http.routers.cup.entrypoints: web,websecure
            traefik.http.routers.cup.tls: true
            traefik.http.routers.cup.tls.certresolver: production
            traefik.http.routers.cup.rule: Host(`cup.example.com`)
            traefik.http.services.cup.loadbalancer.server.port: 9000

networks:
    proxy-net:
        name: proxy-network
        external: true

Domain Configuration

In compose.yaml , replace cup.example.com with your own domain.

compose.yaml

4 collapsed lines
...
            traefik.http.routers.cup.entrypoints: web,websecure
            traefik.http.routers.cup.tls: true
            traefik.http.routers.cup.tls.certresolver: production
            traefik.http.routers.cup.rule: Host(`cup.example.com`)
4 collapsed lines
            traefik.http.services.cup.loadbalancer.server.port: 9000

networks:
...

2. Cup Configuration

Create a cup.json file with the following content:

cup.json

{
    "$schema": "https://raw.githubusercontent.com/sergi0g/cup/main/cup.schema.json",
    "version": 3,
    "theme": "blue",
    "refresh_interval": "0 0 */12 * * *"
}

Configuration Help

For detailed configuration options and advanced settings, refer to the official Cup documentation .

Deployment

Your final folder structure should look like this:

• Directorycup/

  • …
• compose.yaml
• cup.json

Once all configuration files are in place, start Cup with the following command:

docker compose up -d

First Startup

The application may take a few seconds to initialize. Wait before accessing the dashboard.

Accessing the Dashboard

After a few seconds, you should be able to access the Cup dashboard at:

https://cup.example.com

Make sure to replace cup.example.com with your actual domain configured in compose.yaml.