mirror of
https://github.com/sergi0g/cup.git
synced 2025-11-19 18:33:43 -05:00
V3
Many many many changes, honestly just read the release notes
This commit is contained in:
87
cup.schema.json
Normal file
87
cup.schema.json
Normal file
@@ -0,0 +1,87 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"$id": "https://raw.githubusercontent.com/sergi0g/cup/main/cup.schema.json",
|
||||
"title": "Cup",
|
||||
"description": "A schema for Cup's config file",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": {
|
||||
"type": "integer",
|
||||
"minimum": 3,
|
||||
"maximum": 3
|
||||
},
|
||||
"agent": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to enable agent mode. When agent mode is enabled, the server only exposes the API and the web interface is unavailable."
|
||||
},
|
||||
"images": {
|
||||
"type": "object",
|
||||
"description": "Configuration options for specific images",
|
||||
"properties": {
|
||||
"extra": {
|
||||
"type": "array",
|
||||
"description": "Extra image references you want Cup to check",
|
||||
"minItems": 1
|
||||
},
|
||||
"exclude": {
|
||||
"type": "array",
|
||||
"description": "Image references that should be excluded from the check",
|
||||
"minItems": 1,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"refresh_interval": {
|
||||
"type": "string",
|
||||
"description": "The interval at which Cup should check for updates. Must be a valid cron expression. Reference: https://github.com/Hexagon/croner-rust#pattern",
|
||||
"minLength": 11
|
||||
},
|
||||
"registries": {
|
||||
"type": "object",
|
||||
"description": "Configuration options for specific registries",
|
||||
"additionalProperties": {
|
||||
"authentication": {
|
||||
"description": "An authentication token provided by the registry",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"insecure": {
|
||||
"description": "Whether Cup should connect to the registry insecurely (HTTP) or not. Enable this only if you really need to.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ignore": {
|
||||
"description": "Whether or not the registry should be ignored when running Cup",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"socket": {
|
||||
"description": "The path to the unix socket you would like Cup to use for communication with the Docker daemon. Useful if you're trying to use Cup with Podman.",
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"servers": {
|
||||
"type": "object",
|
||||
"description": "Additional servers to connect to and fetch update data from",
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"minProperties": 1
|
||||
},
|
||||
"theme": {
|
||||
"description": "The theme used by the web UI",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"default",
|
||||
"blue"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"version"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user