{ "schema_version": "0.5.0", "kind": "proxmenux.oci-template", "id": "image-backrest", "status": "generated-unvalidated", "catalog_ui": { "title": { "en_US": "Backrest" }, "tagline": { "en_US": "Web UI and scheduler for restic backups." }, "description": { "en_US": "Manage restic repositories, scheduled backup plans, snapshots and restores from a self-hosted web interface. Restic is included and can be installed automatically; no database or Redis service is required." }, "category": "backup", "category_label": "Backup & Recovery", "author": "Gareth George", "developer": "Gareth George", "icon": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/backrest.webp", "thumbnail": null, "screenshots": [], "architectures": [ "amd64", "arm64" ], "launch": { "scheme": "http", "port": 9898, "path": "/" }, "website": "https://garethgeorge.github.io/backrest/", "documentation": "https://docs.garethgeorge.com/backrest/latest/", "repository": "https://github.com/garethgeorge/backrest", "tips": [ "The first visit prompts you to create a username and password. Configure a restic repository and backup plan in the Web UI.", "To back up files on the Proxmox host or a NAS, use Advanced installation to add host directories at /userdata and, for local repositories, /repos. These host binds are not included in Proxmox backups." ], "mini_changelog": [], "display_version": null, "updated_at": null }, "source": { "provider": "Gareth George", "repository": "https://github.com/garethgeorge/backrest", "revision": "148ba12c12a7a4fef6d3c6c8e675ca2c5e7d3635", "image_repository_url": "https://github.com/orgs/garethgeorge/packages/container/package/backrest", "readme_pushed_at": "", "compose_sha256": "8d03bebf20a065ee3055ebe98e02a1c75e07c92b659f98151ab38dce4e0a29db", "generated_at": "2026-10-26T00:29:07+00:00", "readme_raw_url": "https://raw.githubusercontent.com/garethgeorge/backrest/main/README.md" }, "container_contract": { "service_name": "backrest", "container_name": "backrest", "image": { "reference": "ghcr.io/garethgeorge/backrest:v1.14.1", "registry": "ghcr.io", "repository": "ghcr.io/garethgeorge/backrest", "tag": "v1.14.1", "digest": null, "pull_policy": "resolve-written-reference-to-architecture-digest-at-install" }, "environment": [ { "name": "BACKREST_DATA", "example": "/data", "required": true, "sensitive": false, "source": "docker-compose" }, { "name": "BACKREST_CONFIG", "example": "/config/config.json", "required": true, "sensitive": false, "source": "docker-compose" }, { "name": "XDG_CACHE_HOME", "example": "/cache", "required": true, "sensitive": false, "source": "docker-compose" } ], "volumes": [ { "id": "volume-0", "container_path": "/data", "compose_source_example": "backrest-data", "read_only": false, "required": true, "installation_choice": [ "managed-volume", "host-bind" ], "default": "managed-volume", "managed_volume": { "backup": true, "default_size_gb": 8 } }, { "id": "volume-1", "container_path": "/config", "compose_source_example": "backrest-config", "read_only": false, "required": true, "installation_choice": [ "managed-volume", "host-bind" ], "default": "managed-volume", "managed_volume": { "backup": true, "default_size_gb": 4 } }, { "id": "volume-2", "container_path": "/cache", "compose_source_example": "backrest-cache", "read_only": false, "required": true, "installation_choice": [ "managed-volume", "host-bind" ], "default": "managed-volume", "managed_volume": { "backup": true, "default_size_gb": 8 } }, { "id": "volume-3", "container_path": "/userdata", "compose_source_example": "/path/to/backup/data", "read_only": false, "required": false, "installation_choice": [ "host-bind", "skip" ], "default": "skip", "managed_volume": { "backup": false, "default_size_gb": 8 } }, { "id": "volume-4", "container_path": "/repos", "compose_source_example": "/path/to/local/repos", "read_only": false, "required": false, "installation_choice": [ "host-bind", "skip" ], "default": "skip", "managed_volume": { "backup": false, "default_size_gb": 8 } } ], "ports": [ { "container_port": 9898, "published_example": 9898, "protocol": "tcp", "required": true, "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat" } ], "related_services": [], "restart": "unless-stopped", "stop_grace_period": null, "original_compose": "services:\n backrest:\n image: ghcr.io/garethgeorge/backrest:v1.14.1\n container_name: backrest\n hostname: backrest\n restart: unless-stopped\n ports:\n - 9898:9898\n volumes:\n - backrest-data:/data\n - backrest-config:/config\n - backrest-cache:/cache\n - /path/to/backup/data:/userdata\n - /path/to/local/repos:/repos\n environment:\n BACKREST_DATA: /data\n BACKREST_CONFIG: /config/config.json\n XDG_CACHE_HOME: /cache\nvolumes:\n backrest-data: null\n backrest-config: null\n backrest-cache: null\n" }, "compose_stack": { "project_name": "backrest", "deployment_model": "one-native-oci-lxc-per-compose-service", "user_experience": "single-application-install", "main_service": "backrest", "service_count": 1, "services": [ { "name": "backrest", "image": "ghcr.io/garethgeorge/backrest:v1.14.1", "is_main": true, "role": "frontend", "vmid_offset": 0, "depends_on": [], "frontend_network": true, "private_network": false, "compose": { "image": "ghcr.io/garethgeorge/backrest:v1.14.1", "container_name": "backrest", "hostname": "backrest", "restart": "unless-stopped", "ports": [ "9898:9898" ], "volumes": [ "backrest-data:/data", "backrest-config:/config", "backrest-cache:/cache", "/path/to/backup/data:/userdata", "/path/to/local/repos:/repos" ], "environment": { "BACKREST_DATA": "/data", "BACKREST_CONFIG": "/config/config.json", "XDG_CACHE_HOME": "/cache" } } } ], "top_level": { "volumes": { "backrest-data": null, "backrest-config": null, "backrest-cache": null } }, "networking": { "frontend": "selected-proxmox-bridge", "private_required": false, "private_creation": "automatic-create-if-missing", "private_address_allocation": "automatic-static-address-per-service", "service_discovery": "private-addresses-with-compose-service-host-aliases", "dependency_external_access": "disabled-unless-service-publishes-ports", "prompt_user_for_private_network": false }, "storage": [ { "id": "backrest-data", "service": "backrest", "container_path": "/data", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null }, { "id": "backrest-config", "service": "backrest", "container_path": "/config", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null }, { "id": "backrest-cache", "service": "backrest", "container_path": "/cache", "mode": "managed-volume", "user_selectable": false, "backup": true, "shared_with_other_lxc": false, "source_path": null, "source_path_prompt": null }, { "id": "backrest-userdata", "service": "backrest", "container_path": "/userdata", "mode": "user-selectable", "user_selectable": true, "backup": false, "shared_with_other_lxc": true, "default": "skip", "installation_choice": [ "host-bind", "skip" ], "source_path": null, "source_path_prompt": "Optional host directory whose files Backrest should be able to back up." }, { "id": "backrest-repos", "service": "backrest", "container_path": "/repos", "mode": "user-selectable", "user_selectable": true, "backup": false, "shared_with_other_lxc": true, "default": "skip", "installation_choice": [ "host-bind", "skip" ], "source_path": null, "source_path_prompt": "Optional host directory for local restic repositories." } ], "orchestration": { "reserve_vmids_atomically": 1, "start_order": [ "backrest" ], "stop_order": [ "backrest" ], "dependency_readiness": "compose-healthcheck-then-port-or-process-fallback", "rollback_on_failure": "remove-new-rootfs-preserve-created-persistent-volumes" }, "installer_inputs": { "prompted": [ "stack_name", "base_vmid", "rootfs_storage", "persistent_data_destinations", "frontend_bridge", "frontend_ipv4_mode" ], "automatic": [ "dependent_vmids", "private_bridge", "private_subnet", "private_service_addresses", "compose_service_aliases", "generated_secrets", "dependency_start_and_stop_order" ], "generated_secrets": [] } }, "first_run": { "endpoints": [ { "label": "Backrest", "scheme": "http", "port": 9898, "path": "/", "source": "upstream-documentation" } ], "credentials": [] }, "proxmox": { "runtime": "native-oci-lxc", "technology_status": "proxmox-technology-preview", "defaults": { "unprivileged": true, "ostype": "auto-from-image", "cores": 2, "memory_mb": 1024, "swap_mb": 512, "rootfs_size_gb": 8, "rootfs_storage": "local-lvm", "volume_storage": "local-lvm", "template_storage": "local", "bridge": "vmbr0", "ipv4": "dhcp", "firewall": true, "host_managed_network": true, "onboot": false, "features": [ "nesting=1" ], "shutdown_timeout_seconds": 30 }, "image_metadata_policy": { "entrypoint": "import-from-oci-image", "cmd": "import-from-oci-image", "environment": "import-image-env-then-apply-compose-overrides", "user": "import-from-oci-image", "working_dir": "import-from-oci-image", "stop_signal": "import-from-oci-image" }, "installer_profile": { "runtime": { "hostname": "backrest" }, "volume_preparations": [ { "container_path": "/data", "remove_lost_found": true, "owner_strategy": "mapped-root", "only_when_mount_type": "managed-volume" }, { "container_path": "/config", "remove_lost_found": true, "owner_strategy": "mapped-root", "only_when_mount_type": "managed-volume" }, { "container_path": "/cache", "remove_lost_found": true, "owner_strategy": "mapped-root", "only_when_mount_type": "managed-volume" }, { "container_path": "/repos", "remove_lost_found": true, "owner_strategy": "mapped-root", "only_when_mount_type": "managed-volume" } ], "startup_healthcheck": { "scheme": "http", "port": 9898, "path": "/", "timeout_seconds": 180, "request_timeout_seconds": 10, "stability_seconds": 4, "verify_tls": true } }, "adaptations": [ { "id": "imported-compose-source", "upstream_behavior": "The source definition deploys the complete Docker Compose application model.", "native_lxc_behavior": "The source model is preserved and remains blocked until every service option has a reviewed native Proxmox mapping.", "reason": "Catalog import must not imply runtime compatibility.", "behavioral_impact": "No automatic installation before review.", "validation": "pending-per-application" }, { "id": "rolling-latest-image", "upstream_behavior": "A discovered Compose may pin a release tag or digest.", "native_lxc_behavior": "ProxMenux selects the same image repository with the latest tag for catalog installations.", "reason": "The automatic catalog intentionally offers rolling latest images; pinned versions belong to the future manual installer.", "behavioral_impact": "The installed release can be newer than the discovered Compose revision.", "validation": "pending-per-application" }, { "id": "dedicated-lxc-network", "upstream_behavior": "Docker publishes selected container ports on the Docker host.", "native_lxc_behavior": "A reviewed native application will listen on its original container ports at a dedicated LXC address.", "reason": "A native LXC has its own address and does not require Docker port NAT.", "behavioral_impact": "Published ports are metadata; ProxMenux URLs use the matching container target port.", "validation": "pending-per-application" }, { "id": "compose-shm-size", "upstream_behavior": "Compose sets the size of the container /dev/shm tmpfs.", "native_lxc_behavior": "ProxMenux mounts a native LXC tmpfs at /dev/shm with the same requested capacity.", "reason": "The OCI image runs directly as an LXC and therefore needs the equivalent Proxmox mount entry.", "behavioral_impact": "None expected.", "validation": "not-requested-by-compose" }, { "id": "compose-command", "upstream_behavior": "Compose replaces the image Cmd while retaining its Entrypoint.", "native_lxc_behavior": "ProxMenux reads the official OCI Entrypoint and combines it with the Compose command as the native LXC init command.", "reason": "Proxmox stores the effective OCI process as one entrypoint string.", "behavioral_impact": "None expected.", "validation": "not-requested-by-compose" }, { "id": "compose-privileged-mode", "upstream_behavior": "Compose selects whether the container runs in privileged mode.", "native_lxc_behavior": "ProxMenux keeps the LXC unprivileged by default and exposes the broad Compose privilege request only as an explicit compatibility option.", "reason": "A Compose privilege request is source metadata, not proof that the image technically requires a privileged LXC.", "behavioral_impact": "A privileged LXC has weaker isolation from the Proxmox host.", "validation": "native-equivalent" }, { "id": "compose-process-runtime", "upstream_behavior": "Compose can replace Entrypoint, User and WorkingDir and request an init process or interactive terminal.", "native_lxc_behavior": "ProxMenux applies the process overrides through native LXC init directives; lxc-init provides PID 1 supervision and the CT console provides terminal access.", "reason": "The OCI process must start with the same identity, command and working directory without Docker.", "behavioral_impact": "Compose stdin_open and tty become access through the Proxmox LXC console.", "validation": "not-requested-by-compose" }, { "id": "compose-healthcheck", "upstream_behavior": "Docker periodically executes the declared container healthcheck.", "native_lxc_behavior": "For a single-service LXC, ProxMenux translates HTTP localhost checks into a mandatory first-start service check.", "reason": "Proxmox has no persistent Docker health state, while the installer still must detect a failed first boot.", "behavioral_impact": "The check runs during installation rather than continuously after installation.", "validation": "not-requested-by-compose" }, { "id": "compose-cpu-priority", "upstream_behavior": "Docker cpu_shares sets a relative scheduling weight with 1024 as its neutral value.", "native_lxc_behavior": "ProxMenux converts the relative weight to Proxmox cpuunits with 100 as its neutral value and lets the user review it.", "reason": "Both settings express relative CPU priority on different scales.", "behavioral_impact": "Rounding and Proxmox minimum limits can slightly change very low weights.", "validation": "not-requested-by-compose" }, { "id": "compose-resource-limits", "upstream_behavior": "mem_limit sets the memory ceiling; ulimits sets process soft/hard resource limits.", "native_lxc_behavior": "mem_limit supplies the editable Proxmox memory default, rounded up to MiB; ulimits maps to lxc.prlimit with -1 represented as unlimited.", "reason": "Use native Proxmox memory and LXC prlimits, without a wrapper or changing the host kernel configuration.", "behavioral_impact": "User-selected memory overrides Compose. Swap is a separate choice. Kernel restrictions still apply; nproc counts processes by real UID, not by container.", "validation": "not-requested-by-compose" }, { "id": "compose-network-identity", "upstream_behavior": "Compose can set hostname, MAC address, extra hosts and attach a service to Docker networks.", "native_lxc_behavior": "ProxMenux applies hostname and MAC to net0, writes additional host aliases into the LXC and uses its dedicated bridge connection for single-service networks.", "reason": "A dedicated LXC has its own network namespace and does not need a Docker bridge per service.", "behavioral_impact": "host-gateway resolves to the IPv4 address of the selected Proxmox bridge.", "validation": "pending-per-application" }, { "id": "compose-network-mode", "upstream_behavior": "Docker host mode removes Docker network isolation; bridge and default use a Docker-managed network.", "native_lxc_behavior": "The OCI process uses the dedicated LXC network namespace directly, so host, bridge and default all listen on the LXC address without Docker NAT.", "reason": "The LXC is the application host and already has its own address and port namespace.", "behavioral_impact": "host means the LXC host, never the Proxmox host; this preserves Proxmox network isolation.", "validation": "not-requested-by-compose" }, { "id": "compose-capabilities-and-sysctls", "upstream_behavior": "Compose can add Linux capabilities and set kernel parameters in the container network namespace.", "native_lxc_behavior": "ProxMenux validates requested capabilities against the native LXC capability set and writes namespaced network settings as lxc.sysctl directives.", "reason": "A native OCI-LXC already starts with the namespaced capability set; lxc.cap.keep would incorrectly discard unrelated required capabilities.", "behavioral_impact": "Host-global capabilities such as SYS_MODULE remain blocked until their host prerequisite is explicitly adapted.", "validation": "not-requested-by-compose" }, { "id": "docker-engine-metadata", "upstream_behavior": "Compose labels annotate Docker objects and the json-file logging driver rotates Docker-managed logs.", "native_lxc_behavior": "Labels remain source metadata; Docker json-file settings are not applied because the OCI process runs directly under LXC.", "reason": "There is no Docker object or Docker json-file log behind a native OCI-LXC application.", "behavioral_impact": "Docker-only label consumers and Docker log-driver rotation do not exist in the native deployment.", "validation": "not-requested-by-compose" }, { "id": "compose-device-passthrough", "upstream_behavior": "Compose passes host character devices or requests an NVIDIA runtime GPU.", "native_lxc_behavior": "ProxMenux converts recognized device declarations to native Proxmox dev resources; NVIDIA profiles also inject compatible host driver libraries read-only.", "reason": "Native OCI-LXC does not execute Docker device or NVIDIA runtime hooks.", "behavioral_impact": "Hardware is exposed only after explicit user confirmation and host-path validation.", "validation": "not-requested-by-compose" }, { "id": "compose-host-ipc", "upstream_behavior": "ipc: host shares the Docker host IPC namespace, commonly to avoid Docker's small default shared-memory allocation.", "native_lxc_behavior": "The application keeps the LXC IPC namespace and receives a configurable 1 GiB /dev/shm instead of sharing Proxmox host IPC.", "reason": "Processes in a single native LXC already share one IPC namespace; retaining isolation is safer than exposing host IPC.", "behavioral_impact": "The application cannot exchange IPC objects with processes on the Proxmox host.", "validation": "not-requested-by-compose" }, { "id": "optional-backup-paths", "upstream_behavior": "The upstream Compose example optionally bind-mounts local backup inputs at /userdata and local repositories at /repos.", "native_lxc_behavior": "The profile leaves both paths skipped by default and lets Advanced installation bind host directories at those paths.", "reason": "The right sources and local repository locations differ by Proxmox host.", "behavioral_impact": "Without these host binds, use a remote restic repository and paths available inside the LXC; host binds are outside vzdump backups.", "validation": "pending-per-application" } ] }, "compatibility": { "automatic_install_candidate": true, "validated": false, "supported_compose_keys": [ "cap_add", "command", "container_name", "cpu_shares", "deploy", "devices", "entrypoint", "environment", "extra_hosts", "group_add", "healthcheck", "hostname", "image", "init", "ipc", "labels", "logging", "mac_address", "mem_limit", "network_mode", "networks", "ports", "privileged", "restart", "runtime", "security_opt", "shm_size", "stdin_open", "stop_grace_period", "sysctls", "tty", "ulimits", "user", "volumes", "working_dir" ], "untranslated_blockers": [], "policy": "Single-image definitions are installable when every declared Compose option has a native Proxmox translation. Multi-image and unsupported runtime features remain blocked until their orchestrator or mapping is available." }, "validation": { "schema": "not-yet-validated", "clean_install": "pending", "service_health": "pending", "restart_persistence": "pending", "backup_restore": "pending", "update_preserves_data": "pending" }, "lifecycle": { "update_strategy": "resolve-latest-image-then-apply-reviewed-native-lxc-update", "registry_state": { "resolved_architecture": null, "resolved_digest": null, "image_version_label": null, "image_created": null }, "change_detection": "compare-compose-sha256-and-resolved-latest-image-digest", "automatic_unattended_updates": false } }