Docker¶
The docker block, and the blocks nested inside it.
DockerConfig ¶
Docker container scanning and updating, the docker block
allow_restart ¶
Allow updates to recreate the container with docker compose up
git_repo_roots ¶
Directories that local build git repos have to be inside, e.g. ["/home/containers"]. Any path set on a container is accepted while this is empty
trust_image_settings ¶
Images trusted to supply any setting through their own labels or env, e.g. ones you build yourself. Plain image refs only, as written in the compose file, with or without a tag, e.g. ["ghcr.io/me/myapp"]. Wildcards and patterns are refused
remove_old_image ¶
Remove the previous image once a container has been recreated with the new one, from U2M_REMOVE_OLD_IMAGE
max_concurrent_updates ¶
Updates run in parallel up to this limit, further ones queue for a free slot, from U2M_MAX_CONCURRENT_UPDATES
default_entity_picture_url ¶
Picture for update entities with no package logo
discover_metadata ¶
discover_metadata: dict[str, MetadataSourceConfig] = field(
default_factory=lambda: {
"linuxserver.io": MetadataSourceConfig(
enabled=True
),
"hotio.dev": MetadataSourceConfig(enabled=True),
}
)
Online catalogues of image metadata, keyed by name
registry ¶
Registry client and caching
default_api_backoff ¶
Seconds to back off a registry API after it throttles
image_ref_select ¶
Image refs to publish
version_select ¶
Latest versions to publish
version_policy ¶
Default version policy for all containers
registry_select ¶
Registries, by index name, to look up latest versions in
container_select ¶
Container names to ignore completely, e.g. exclude ["^lab_", "^beta_"], as regular expressions
portainer ¶
Portainer API access, for stacks managed by Portainer
cooldown ¶
How long a release has to be known before it’s eligible to update, e.g. 72h, 3d, 1w, or 0 for none. Observe only for now, reported in the update attributes, see RFC 0002
Registry¶
RegistryConfig ¶
Container registry lookups, the docker.registry block
mutable_cache_ttl ¶
Seconds to cache responses that can change, such as tag lookups
immutable_cache_ttl ¶
Seconds to cache responses addressed by digest, which can’t change
token_cache_ttl ¶
Seconds to cache registry auth tokens, or None to follow the registry’s own expiry
strict ¶
Refuse registry data that can’t be verified, rather than trusting the registry, for the OCI clients. For now, checks the digest the registry reports for a tag against the manifest it serves. More checks, such as image signatures, will be added under this setting, see RFC 0002
RegistryAPI ¶
Selection¶
Selector ¶
VersionPolicy ¶
How the installed and latest versions are described
Metadata Catalogues¶
MetadataSourceConfig ¶
Portainer¶
See Portainer.
PortainerConfig ¶
Portainer API access, used to redeploy stacks whose compose files live in Portainer’s data volume