ProxMenux/oci/catalog/apps/resilio-sync.json

{
  "schema_version": "0.3.0",
  "kind": "proxmenux.oci-template",
  "id": "linuxserver-resilio-sync",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Resilio Sync"
    },
    "tagline": {
      "en_US": "Resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes."
    },
    "description": {
      "en_US": "Resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes."
    },
    "category": "misc",
    "category_label": "Miscellaneous",
    "author": "LinuxServer.io",
    "developer": null,
    "icon": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/resilio-sync-icon.png",
    "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/resilio-sync-banner.png",
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": 8888,
      "path": "/"
    },
    "website": "https://www.resilio.com/individuals/",
    "documentation": "https://docs.linuxserver.io/images/docker-resilio-sync/",
    "repository": "https://github.com/linuxserver/docker-resilio-sync",
    "tips": [],
    "mini_changelog": [
      {
        "date": "2024-08-21",
        "note": "Rebase to Noble."
      },
      {
        "date": "2023-07-03",
        "note": "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"
      },
      {
        "date": "2022-12-14",
        "note": "Rebase to Jammy, migrate to s6v3."
      },
      {
        "date": "2021-10-03",
        "note": "Use upstream apt repo to install. Rebase to focal."
      },
      {
        "date": "2021-01-20",
        "note": "Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information."
      }
    ],
    "display_version": null,
    "updated_at": "2024-08-21"
  },
  "source": {
    "provider": "linuxserver.io",
    "repository": "https://github.com/linuxserver/docker-resilio-sync",
    "default_branch": "master",
    "revision": "9a73b51684b714454bfa560745a258351b159fa9",
    "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-resilio-sync/9a73b51684b714454bfa560745a258351b159fa9/README.md",
    "readme_pushed_at": "2026-09-08T01:30:09Z",
    "compose_sha256": "4a343c66a57cf259cf4d1f09da41e4cf01b1c77abf9cfe5674e39f56468377ad",
    "generated_at": "2026-09-12T14:37:35+00:00"
  },
  "container_contract": {
    "service_name": "resilio-sync",
    "container_name": "resilio-sync",
    "image": {
      "reference": "lscr.io/linuxserver/resilio-sync:latest",
      "registry": "lscr.io",
      "repository": "lscr.io/linuxserver/resilio-sync",
      "tag": "latest",
      "digest": null,
      "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install"
    },
    "environment": [
      {
        "name": "PUID",
        "example": "1000",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "PGID",
        "example": "1000",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "TZ",
        "example": "Etc/UTC",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      }
    ],
    "volumes": [
      {
        "id": "volume-0",
        "container_path": "/config",
        "compose_source_example": "/path/to/resilio-sync/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-1",
        "container_path": "/downloads",
        "compose_source_example": "/path/to/downloads",
        "read_only": false,
        "required": true,
        "installation_choice": [
          "managed-volume",
          "host-bind"
        ],
        "default": "managed-volume",
        "managed_volume": {
          "backup": true,
          "default_size_gb": 8
        }
      },
      {
        "id": "volume-2",
        "container_path": "/sync",
        "compose_source_example": "/path/to/data",
        "read_only": false,
        "required": true,
        "installation_choice": [
          "managed-volume",
          "host-bind"
        ],
        "default": "managed-volume",
        "managed_volume": {
          "backup": true,
          "default_size_gb": 8
        }
      }
    ],
    "ports": [
      {
        "container_port": 8888,
        "published_example": 8888,
        "protocol": "tcp",
        "required": true,
        "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
      },
      {
        "container_port": 55555,
        "published_example": 55555,
        "protocol": "tcp",
        "required": true,
        "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
      }
    ],
    "related_services": [],
    "restart": "unless-stopped",
    "stop_grace_period": null,
    "original_compose": "---\nservices:\n  resilio-sync:\n    image: lscr.io/linuxserver/resilio-sync:latest\n    container_name: resilio-sync\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n    volumes:\n      - /path/to/resilio-sync/config:/config\n      - /path/to/downloads:/downloads\n      - /path/to/data:/sync\n    ports:\n      - 8888:8888\n      - 55555:55555\n    restart: unless-stopped\n"
  },
  "first_run": {
    "endpoints": [
      {
        "label": "Web UI",
        "scheme": "http",
        "port": 8888,
        "path": "/",
        "source": "compose-first-tcp-port-fallback"
      }
    ],
    "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"
    },
    "adaptations": [
      {
        "id": "dedicated-lxc-network",
        "upstream_behavior": "Docker publishes selected container ports on the Docker host.",
        "native_lxc_behavior": "The application listens on the same container ports at its dedicated LXC address.",
        "reason": "A native LXC has its own address and does not require Docker port NAT.",
        "behavioral_impact": "Users open the LXC address instead of the Proxmox host address.",
        "validation": "pending-per-application"
      },
      {
        "id": "compose-environment-overlay",
        "upstream_behavior": "Compose environment values override OCI image environment values.",
        "native_lxc_behavior": "ProxMenux merges the same values into lxc.environment.runtime while the CT is stopped.",
        "reason": "PVE imports image Env automatically; Compose values still need to override it.",
        "behavioral_impact": "None expected.",
        "validation": "pending-per-application"
      },
      {
        "id": "stop-grace-period",
        "upstream_behavior": "Docker waits for Compose stop_grace_period before forcing termination.",
        "native_lxc_behavior": "ProxMenux records the same timeout for its pct shutdown lifecycle operations.",
        "reason": "Proxmox has no equivalent per-CT persistent restart-policy field; startup.down is not a shutdown timeout.",
        "behavioral_impact": "Normal Proxmox node shutdown remains governed by the node-wide shutdown policy.",
        "validation": "not-requested-by-compose"
      }
    ]
  },
  "compatibility": {
    "automatic_install_candidate": true,
    "validated": false,
    "supported_compose_keys": [
      "container_name",
      "environment",
      "image",
      "ports",
      "restart",
      "stop_grace_period",
      "volumes"
    ],
    "untranslated_blockers": [],
    "policy": "A generated template is never promoted to validated without install, health, restart and persistence tests."
  },
  "validation": {
    "schema": "passed-at-generation",
    "clean_install": "pending",
    "service_health": "pending",
    "restart_persistence": "pending",
    "backup_restore": "pending",
    "update_preserves_data": "pending"
  },
  "lifecycle": {
    "update_strategy": "replace-rootfs-from-new-oci-image-preserve-managed-volumes",
    "registry_state": {
      "resolved_architecture": null,
      "resolved_digest": null,
      "image_version_label": null,
      "image_created": null
    },
    "change_detection": "compare-resolved-architecture-digest",
    "automatic_unattended_updates": false
  }
}