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 will hopefully be moved to the configuration file soon.

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

Here's a full example:

{
    "authentication": {
        "ghcr.io": "<YOUR_TOKEN_HERE>",
        "registry-1.docker.io": "<YOUR_TOKEN_HERE>"
    },
    "theme": "blue",
    "insecure_registries": ["localhost:5000", "my-insecure-registry.example.com"]
}

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