Configuration

Custom docker socket

Sometimes, there may be a need to specify a custom docker socket. Cup provides the -s option for this.

For example, if using Podman, you might do


$ cup -s /run/user/1000/podman/podman.sock check

This option is also available in the configuration file and it’s best to put it there.

Custom Docker socket

Configuration file

Cup has an option to be configured from a configuration file named cup.json.

Create the configuration file

Create a cup.json file somewhere on your system. For binary installs, a path like ~/.config/cup.json is recommended. If you’re running with Docker, you can create a cup.json in the directory you’re running Cup and mount it into the container. In the next section you will need to use the path where you mounted the file

Configure Cup from the configuration file

Follow the guides below to customize your cup.json

Authentication Insecure registries Theme Multiple servers

Here’s a full example:


{
  "$schema": "https://raw.githubusercontent.com/sergi0g/cup/main/cup.schema.json",
  "version": 3,
  "images": {
    "exclude": ["ghcr.io/immich-app/immich-machine-learning"],
    "extra": ["ghcr.io/sergi0g/cup:v3.0.0"]
  },
  "registries": {
    "myregistry.com": {
      "authentication": "<YOUR_TOKEN_HERE>"
    }
  },
  "servers": {
    "Raspberry Pi": "https://server.local:8000"
  },
  "theme": "blue"
}

💡

If you want autocompletions and error checking for your editor, there is a JSON schema available. Use it by adding a "$schema": "https://raw.githubusercontent.com/sergi0g/cup/main/cup.schema.json" entry in your cup.json file.

Run Cup with the new configuration file

To let Cup know that you’d like it to use a custom configuration file, you can use the -c flag, followed by the absolute path of the file.


$ cup -c /home/sergio/.config/cup.json check


$ docker run -tv /var/run/docker.sock:/var/run/docker.sock -v /home/sergio/.config/cup.json:/config/cup.json ghcr.io/sergi0g/cup -c /config/cup.json serve

Environment Variables

Want to make a quick change without editing your config.json? Cup also supports some configuration options from environment variables. Here are the ones currently available:

CUP_AGENT - Agent mode
CUP_IGNORE_UPDATE_TYPE - Ignoring specific update types
CUP_REFRESH_INTERVAL - Automatic refresh
CUP_SOCKET - Socket
CUP_THEME - Theme

Refer to the configuration page for more information on each of these.

Here’s an example of a Docker Compose file using them:


services:
  cup:
    image: ghcr.io/sergi0g/cup:latest
    command: serve
    ports:
      - 8000:8000
    environment:
      - CUP_AGENT: true
      - CUP_IGNORE_UPDATE_TYPE: major
      - CUP_REFRESH_INTERVAL: "0 */30 * * * *"
      - CUP_SOCKET: tcp://localhost:2375
      - CUP_THEME: blue

💡

Heads up! Any configuration option you set with environment variables always overrides anything in your cup.json.