mirror of
https://github.com/sergi0g/cup.git
synced 2025-11-16 00:53:47 -05:00
Add new docs pages
This commit is contained in:
12
docs/src/content/docs/configuration/agent.mdx
Normal file
12
docs/src/content/docs/configuration/agent.mdx
Normal file
@@ -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
|
||||||
|
}
|
||||||
|
```
|
||||||
12
docs/src/content/docs/configuration/automatic-refresh.mdx
Normal file
12
docs/src/content/docs/configuration/automatic-refresh.mdx
Normal file
@@ -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)
|
||||||
22
docs/src/content/docs/configuration/ignore-registry.mdx
Normal file
22
docs/src/content/docs/configuration/ignore-registry.mdx
Normal file
@@ -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": {
|
||||||
|
"<SOME_REGISTRY_DOMAIN_1>": {
|
||||||
|
"ignore": true
|
||||||
|
// Other options
|
||||||
|
},
|
||||||
|
"<SOME_REGISTRY_DOMAIN_2>" {
|
||||||
|
"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.
|
||||||
@@ -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!
|
||||||
@@ -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:
|
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:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user