{"id":13550432,"url":"https://github.com/bt-sync/sync-docker","last_synced_at":"2025-04-03T00:33:57.728Z","repository":{"id":51193432,"uuid":"56844582","full_name":"bt-sync/sync-docker","owner":"bt-sync","description":"Resilio Sync docker image","archived":false,"fork":false,"pushed_at":"2024-06-03T18:30:15.000Z","size":50,"stargazers_count":185,"open_issues_count":8,"forks_count":62,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-11-03T20:36:52.622Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.resilio.com","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bt-sync.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-22T09:39:04.000Z","updated_at":"2024-11-03T10:14:14.000Z","dependencies_parsed_at":"2024-08-01T12:18:06.040Z","dependency_job_id":null,"html_url":"https://github.com/bt-sync/sync-docker","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bt-sync%2Fsync-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bt-sync%2Fsync-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bt-sync%2Fsync-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bt-sync%2Fsync-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bt-sync","download_url":"https://codeload.github.com/bt-sync/sync-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246916733,"owners_count":20854511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:01:32.970Z","updated_at":"2025-04-03T00:33:57.060Z","avatar_url":"https://github.com/bt-sync.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile","others"],"sub_categories":[],"readme":"## Resilio Sync\n\nhttps://www.resilio.com\n\nSync uses peer-to-peer technology to provide fast, private file sharing for teams and individuals. By skipping the cloud, transfers can be significantly faster because files take the shortest path between devices. Sync does not store your information on servers in the cloud, avoiding cloud privacy concerns.\n\n### Usage\n\n```\n# path to folder on the host to be mounted to container as Sync storage folder\nDATA_FOLDER=/path/to/data/folder/on/the/host\nmkdir -p $DATA_FOLDER\n\n# port to access the webui on the host\nWEBUI_PORT=8888\n\n# ensure you have the latest image locally\ndocker pull resilio/sync\n\n# run container from downloaded image\ndocker run -d --name Sync \\\n           -p 127.0.0.1:$WEBUI_PORT:8888 \\\n           -p 55555/tcp \\\n           -p 55555/udp \\\n           -v $DATA_FOLDER:/mnt/sync \\\n           -v /etc/localtime:/etc/localtime:ro \\\n           --restart always \\\n           resilio/sync\n```\nNote 1: we need to mount `/etc/localtime` from host OS to container to ensure container's time is synced with the host's time.\n\nNote 2: you can use our official Docker image `resilio/sync` hosted on https://hub.docker.com/u/resilio or build image manually:\n```\ngit clone git@github.com:bt-sync/sync-docker.git\ncd sync-docker\ndocker build -t resilio/sync .\n```\n\nBe sure to always run docker container with `--restart` parameter to allow Docker daemon to handle Sync container (launch at startup as well as restart it in case of failure).\n\nGo to `http://localhost:$WEBUI_PORT` in a web browser to access the web UI.\n\nIf you need to run Sync under specific user inside your container - use `--user` [parameter](https://docs.docker.com/engine/reference/run/#user) or [set](https://www.linuxserver.io/docs/puid-pgid/) `PUID` and `PGID` env vars for container.\n\nRunning Sync in docker container via [docker-compose](https://docs.docker.com/compose/) is described [here](https://github.com/bt-sync/sync-docker/tree/master/docker-compose).\n\n### Volumes\n\n* `/mnt/sync` - folder inside the container that contains the [storage folder](https://help.resilio.com/hc/en-us/articles/206664690-Sync-Storage-folder), [configuration file](https://help.resilio.com/hc/en-us/articles/206178884) and default download folder\n\n* `/etc/localtime` - file (symlink) that [configures](https://unix.stackexchange.com/questions/85925/how-can-i-examine-the-contents-of-etc-localtime) the system-wide timezone of the local system that is used by applications for presentation to the user\n\n### Ports\n\n* `8888` - Webui port\n* `55555` - Listening port (both TCP and UDP) for Sync traffic (you can change it, but in this case change it in Sync [settings](https://help.resilio.com/hc/en-us/articles/204762669-Sync-Preferences) as well)\n\nFind more info [here](https://help.resilio.com/hc/en-us/articles/204754759-What-ports-and-protocols-are-used-by-Sync-) about ports used by Sync.\n\n#### LAN access\n\nIf you do not want to limit the access to the webui - do not specify `localhost` address in `-p` parameter, \nin this case every person in your LAN will be able to access web UI via `http://\u003cyour_ip_address\u003e:\u003cWEBUI_PORT\u003e`:\n\n```\nWEBUI_PORT=8888\n\ndocker run -d --name Sync \\\n           -p $WEBUI_PORT:8888 \\\n           -p 55555/tcp \\\n           -p 55555/udp \\\n           -v $DATA_FOLDER:/mnt/sync \\\n           -v /etc/localtime:/etc/localtime:ro \\\n           --restart always \\\n           resilio/sync\n```\n\nYou can also force web UI to work over https instead of http. To do this you need to add `force_https` parameter in \nconfig file in `webui` section with `true` value. More info about config file parameters is [here](https://help.resilio.com/hc/en-us/articles/206178884-Running-Sync-in-configuration-mode).\n\n#### Extra directories\n\nIf you need to mount extra directories, mount them in `/mnt/mounted_folders`:\n\n```\nOTHER_DIR=/path/to/some/dir/on/host\nOTHER_DIR2=/path/to/some/another/dir/on/host\n\ndocker run -d --name Sync \\\n           -p 127.0.0.1:$WEBUI_PORT:8888 \\\n           -p 55555/tcp \\\n           -p 55555/udp \\\n           -v $DATA_FOLDER:/mnt/sync \\\n           -v $OTHER_DIR:/mnt/mounted_folders/DIR_NAME \\\n           -v $OTHER_DIR2:/mnt/mounted_folders/DIR_NAME2 \\\n           -v /etc/localtime:/etc/localtime:ro \\\n           --restart always \\\n           resilio/sync\n```\n\nNote: do not create directories at the root of `/mnt/mounted_folders` from the Sync web UI since they will not be mounted to the host. You need to mount those first as described above and then add them in Sync via web UI.\n\n### Miscellaneous\n\n- Additional info and various Sync guides can be found in our [help center](https://help.resilio.com)\n- If you have any questions left, please contact us via [support page](https://help.resilio.com/hc/en-us/requests/new?ticket_form_id=91563) or visit our forum at [https://forum.resilio.com](https://forum.resilio.com)\n- Read our [official blog](https://www.resilio.com/blog/)\n- Docker [hub](https://hub.docker.com/r/resilio/sync/)\n- Discover our [other products](https://www.resilio.com/sync-vs-connect/)\n- Learn [legal information](https://www.resilio.com/legal/privacy/)\n- If you found some security vulnerability in our product - please follow [this article](https://help.resilio.com/hc/en-us/articles/360000294599-How-to-Report-Security-Vulnerabilities-to-Resilio-Inc-)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbt-sync%2Fsync-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbt-sync%2Fsync-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbt-sync%2Fsync-docker/lists"}