ProxMenux/oci/catalog/curated/restic-rest-server.json

{
  "schema_version": "0.5.0",
  "kind": "proxmenux.oci-template",
  "id": "image-restic-rest-server",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Restic REST Server",
      "es_ES": "Restic REST Server"
    },
    "tagline": {
      "en_US": "A REST backend for restic backups; it has no web interface.",
      "es_ES": "Un backend REST para copias de Restic, sin interfaz web."
    },
    "description": {
      "en_US": "The official rest-server image provides an authenticated HTTP REST backend for restic clients, with persistent repositories and bcrypt-protected user accounts. It exposes an API, not a browser-based application.",
      "es_ES": "La imagen oficial rest-server ofrece un backend HTTP REST autenticado para clientes Restic, con repositorios persistentes y cuentas protegidas con bcrypt. Expone una API, no una aplicación web."
    },
    "category": "backup",
    "category_label": "Backup & Recovery",
    "author": "restic",
    "developer": "restic",
    "icon": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/restic.webp",
    "thumbnail": null,
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": null,
      "path": "/"
    },
    "website": "https://github.com/restic/rest-server",
    "documentation": "https://github.com/restic/rest-server",
    "repository": "https://github.com/restic/rest-server",
    "tips": [
      "Authentication stays enabled. Before connecting any backup client, open the container console and run create_user <username>; enter the password at the hidden prompt. Do not pass the password as a command-line argument. The image stores the bcrypt hash in /data/.htpasswd.",
      "The API has no web interface. Use a restic client with a repository URL that includes the username-specific path, for example rest:http://USER@HOST:8000/USER when private repositories are enabled.",
      "The upstream default uses HTTP, which sends Basic Authentication credentials in clear text. Use a trusted LAN or route clients through an HTTPS reverse proxy before remote access.",
      "With --private-repos enabled, each user can access only a matching repository subdirectory. Keep /data persistent; it contains both backups and the authentication file.",
      "The upstream endpoint uses HTTP. Use an HTTPS reverse proxy for remote clients; the example API URL shown in this entry is HTTP.",
      "El endpoint original usa HTTP. Para clientes remotos, coloca un proxy HTTPS delante; la URL de ejemplo de esta ficha usa HTTP."
    ],
    "mini_changelog": [],
    "display_version": null,
    "updated_at": null
  },
  "source": {
    "provider": "restic",
    "repository": "https://github.com/restic/rest-server",
    "revision": "cfcf3fea23edb404c860e8708e39306717fe3e85",
    "image_repository_url": "https://hub.docker.com/r/restic/rest-server",
    "readme_pushed_at": "",
    "compose_sha256": "f346e67428e1c6e8e265d607401fe5d5289b5c7ad478170abb4984fa8dcb01ad",
    "generated_at": "2026-10-26T06:50:27+00:00",
    "readme_raw_url": "https://github.com/restic/rest-server"
  },
  "container_contract": {
    "service_name": "restic-rest-server",
    "container_name": "restic-rest-server",
    "image": {
      "reference": "restic/rest-server:latest",
      "registry": "docker.io",
      "repository": "restic/rest-server",
      "tag": "latest",
      "digest": null,
      "pull_policy": "resolve-written-reference-to-architecture-digest-at-install"
    },
    "environment": [
      {
        "name": "OPTIONS",
        "example": "--private-repos",
        "required": true,
        "sensitive": false,
        "source": "official-rest-server-documentation",
        "prompt_user": false
      }
    ],
    "volumes": [
      {
        "id": "volume-0",
        "container_path": "/data",
        "compose_source_example": "restic-data",
        "read_only": false,
        "required": true,
        "installation_choice": [
          "managed-volume",
          "host-bind"
        ],
        "default": "managed-volume",
        "managed_volume": {
          "backup": true,
          "default_size_gb": 16
        }
      }
    ],
    "ports": [
      {
        "container_port": 8000,
        "published_example": 8000,
        "protocol": "tcp",
        "required": true,
        "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
      }
    ],
    "related_services": [],
    "restart": "unless-stopped",
    "stop_grace_period": null,
    "original_compose": "{\n  \"name\": \"restic-rest-server\",\n  \"services\": {\n    \"restic-rest-server\": {\n      \"image\": \"restic/rest-server:latest\",\n      \"container_name\": \"restic-rest-server\",\n      \"restart\": \"unless-stopped\",\n      \"ports\": [\n        \"8000:8000/tcp\"\n      ],\n      \"volumes\": [\n        \"restic-data:/data\"\n      ],\n      \"environment\": {\n        \"OPTIONS\": \"--private-repos\"\n      }\n    }\n  },\n  \"volumes\": {\n    \"restic-data\": {}\n  }\n}\n"
  },
  "compose_stack": {
    "project_name": "restic-rest-server",
    "deployment_model": "one-native-oci-lxc-per-compose-service",
    "user_experience": "single-application-install",
    "main_service": "restic-rest-server",
    "service_count": 1,
    "services": [
      {
        "name": "restic-rest-server",
        "image": "restic/rest-server:latest",
        "is_main": true,
        "role": "frontend",
        "vmid_offset": 0,
        "depends_on": [],
        "frontend_network": true,
        "private_network": false,
        "compose": {
          "image": "restic/rest-server:latest",
          "container_name": "restic-rest-server",
          "restart": "unless-stopped",
          "ports": [
            "8000:8000/tcp"
          ],
          "volumes": [
            "restic-data:/data"
          ],
          "environment": {
            "OPTIONS": "--private-repos"
          }
        }
      }
    ],
    "top_level": {
      "name": "restic-rest-server",
      "volumes": {
        "restic-data": {}
      }
    },
    "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": "restic-rest-server-volume-0",
        "service": "restic-rest-server",
        "container_path": "/data",
        "mode": "managed-volume",
        "user_selectable": true,
        "backup": true,
        "shared_with_other_lxc": false,
        "source_path": null,
        "source_path_prompt": null
      }
    ],
    "orchestration": {
      "reserve_vmids_atomically": 1,
      "start_order": [
        "restic-rest-server"
      ],
      "stop_order": [
        "restic-rest-server"
      ],
      "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": [],
    "credentials": [
      {
        "label": "REST API Basic Authentication user",
        "username": "Create with create_user in the container console",
        "password": null,
        "change_required": false,
        "source": "official-rest-server-documentation",
        "retrieval": null
      }
    ]
  },
  "proxmox": {
    "runtime": "native-oci-lxc",
    "technology_status": "proxmox-technology-preview",
    "defaults": {
      "unprivileged": true,
      "ostype": "auto-from-image",
      "cores": 1,
      "memory_mb": 512,
      "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": 120
    },
    "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"
    },
    "adaptations": [
      {
        "id": "dedicated-lxc-network",
        "upstream_behavior": "The Compose definition publishes service ports on its Docker host.",
        "native_lxc_behavior": "ProxMenux keeps the image service ports and exposes them on this LXC address without Docker port NAT.",
        "reason": "The application runs in its own Proxmox LXC network namespace.",
        "behavioral_impact": "Connect to the LXC address and the service port shown in the install summary.",
        "validation": "pending-per-application"
      },
      {
        "id": "compose-command",
        "upstream_behavior": "Compose provides the command that starts the service.",
        "native_lxc_behavior": "ProxMenux imports the image entrypoint and applies the reviewed command as the native OCI process.",
        "reason": "The image runs directly as a native OCI LXC process.",
        "behavioral_impact": "The process starts with the upstream server command.",
        "validation": "pending-per-application"
      }
    ],
    "installer_profile": {
      "startup_healthcheck": {
        "scheme": "http",
        "port": 8000,
        "path": "/",
        "timeout_seconds": 120,
        "request_timeout_seconds": 10,
        "stability_seconds": 3,
        "verify_tls": false,
        "accept_any_status": true
      }
    }
  },
  "compatibility": {
    "automatic_install_candidate": true,
    "validated": false,
    "supported_compose_keys": [
      "command",
      "container_name",
      "environment",
      "hostname",
      "image",
      "ports",
      "restart",
      "volumes"
    ],
    "untranslated_blockers": [],
    "policy": "The single upstream image runs as a native Proxmox OCI LXC. Only the documented image command, environment, ports and persistent paths are translated."
  },
  "validation": {
    "schema": "passed-at-generation",
    "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
  }
}