diff --git a/docs/src/content/docs/configuration/agent.mdx b/docs/src/content/docs/configuration/agent.mdx new file mode 100644 index 0000000..c6e87ac --- /dev/null +++ b/docs/src/content/docs/configuration/agent.mdx @@ -0,0 +1,12 @@ +# Agent mode + +If you'd like to have only the server API exposed without the dashboard, you can run Cup in agent mode. + +Modify your config like this: + +```jsonc +{ + "agent": true + // Other options +} +``` \ No newline at end of file diff --git a/docs/src/content/docs/configuration/automatic-refresh.mdx b/docs/src/content/docs/configuration/automatic-refresh.mdx new file mode 100644 index 0000000..b6efc35 --- /dev/null +++ b/docs/src/content/docs/configuration/automatic-refresh.mdx @@ -0,0 +1,12 @@ +# Automatic refresh + +Cup can automatically refresh the results when running in server mode. Simply add this to your config: + +```jsonc +{ + "refresh_interval": "0 0,30 * 0 0" // Check twice an hour + // Other options +} +``` + +You can use a cron expression to specify the refresh interval. The reference is [here](https://github.com/Hexagon/croner-rust#pattern) \ No newline at end of file diff --git a/docs/src/content/docs/configuration/ignore-registry.mdx b/docs/src/content/docs/configuration/ignore-registry.mdx new file mode 100644 index 0000000..3c93b6a --- /dev/null +++ b/docs/src/content/docs/configuration/ignore-registry.mdx @@ -0,0 +1,22 @@ +# Ignored registries + +If you want to skip checking images from some registries, you can modify your config like this: + +```jsonc +{ + "registries": { + "": { + "ignore": true + // Other options + }, + "" { + "ignore": false + // Other options + }, + // ... + } + // Other options +} +``` + +This configuration option is a bit redundant, since you can achieve the same with [this option](/docs/configuration/include-exclude-images). It's recommended to use that. diff --git a/docs/src/content/docs/configuration/include-exclude-images.mdx b/docs/src/content/docs/configuration/include-exclude-images.mdx new file mode 100644 index 0000000..ba73e1b --- /dev/null +++ b/docs/src/content/docs/configuration/include-exclude-images.mdx @@ -0,0 +1,35 @@ +# Include/Exclude images + +If you want to exclude some images (e.g. because they have too many tags and take too long to check), you can add the following to your config: + +```jsonc +{ + "images": { + "exclude": [ + "ghcr.io/immich-app/immich-machine-learning", + "postgres:15" + ] + // ... + } + // Other options +} +``` + +For an image to be excluded, it must start with one of the strings you specify above. That means you could use `ghcr.io` to exclude all images from ghcr.io or `ghcr.io/sergi0g` to exclude all my images (why would you do that?). + + +If you want Cup to always check some extra images that aren't available locally, you can modify your config like this: +```jsonc +{ + "images": { + "extra": [ + "mysql:8.0", + "nextcloud:30" + ] + // ... + } + // Other options +} +``` + +Note that you must specify images with version tags, otherwise Cup will exit with an error! \ No newline at end of file diff --git a/docs/src/content/docs/configuration/socket.mdx b/docs/src/content/docs/configuration/socket.mdx index 224278d..395dda6 100644 --- a/docs/src/content/docs/configuration/socket.mdx +++ b/docs/src/content/docs/configuration/socket.mdx @@ -1,4 +1,4 @@ -# Socket +# Custom socket If you need to specify a custom Docker socket (e.g. because you're using Podman), you can use the `socket` option. Here's an example: