readme-vars.yml

---

# project information
project_name: resilio-sync
project_url: "https://www.resilio.com/individuals/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/resilio-sync-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) (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."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Where resilio-sync should store its config file."}
  - {vol_path: "/downloads", vol_host_path: "/path/to/downloads", desc: "Folder for downloads/cache."}
  - {vol_path: "/sync", vol_host_path: "/path/to/data", desc: "Sync folders root."}
param_usage_include_ports: true
param_ports:
  - {external_port: "8888", internal_port: "8888", port_desc: "WebUI"}
  - {external_port: "55555", internal_port: "55555", port_desc: "Sync Port."}
cap_add_param: false
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  * Webui is at `<your-ip>:8888`, for account creation and configuration.
  * More info on setup at [Resilio Sync]({{ project_url }})
# init diagram
init_diagram: |
  "resilio-sync:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-crontab-config -> init-config-end
    init-resilio-sync-config -> init-config-end
    init-config -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    base -> init-migrations
    init-config-end -> init-mods
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-config -> init-resilio-sync-config
    init-custom-files -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-resilio-sync
    svc-resilio-sync -> legacy-services
  }
  Base Images: {
    "baseimage-ubuntu:noble"
  }
  "resilio-sync:latest" <- Base Images
# changelog
changelogs:
  - {date: "21.08.24:", desc: "Rebase to Noble."}
  - {date: "03.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "14.12.22:", desc: "Rebase to Jammy, migrate to s6v3."}
  - {date: "03.10.21:", desc: "Use upstream apt repo to install. Rebase to focal."}
  - {date: "20.01.21:", desc: "Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information."}
  - {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
  - {date: "11.02.19:", desc: "Rebase to bionic, add pipeline logic and multi arch."}
  - {date: "05.02.18:", desc: "Add downloads volume mount."}
  - {date: "28.01.18:", desc: "Add /sync to dir whitelist."}
  - {date: "26.01.18:", desc: "Use variable for arch to bring in line with armhf arch repo."}
  - {date: "15.12.17:", desc: "Fix continuation lines."}
  - {date: "02.06.17:", desc: "Rebase to ubuntu xenial, alpine linux no longer works with resilio."}
  - {date: "22.05.17:", desc: "Add variable for user defined umask."}
  - {date: "14.05.17:", desc: "Use fixed version instead of latest, while 2.5.0 is broken on non glibc (alpine)."}
  - {date: "08.02.17:", desc: "Rebase to alpine 3.5."}
  - {date: "02.11.16:", desc: "Initial Release."}