You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-19Lines changed: 21 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
##Resilio Sync
1
+
# Resilio Sync
2
2
3
-
https://www.resilio.com
3
+
<https://www.resilio.com>
4
4
5
5
Sync 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.
6
6
7
-
###Usage
7
+
## Usage
8
8
9
-
```
9
+
```bash
10
10
# path to folder on the host to be mounted to container as Sync storage folder
11
11
DATA_FOLDER=/path/to/data/folder/on/the/host
12
12
mkdir -p $DATA_FOLDER
@@ -27,10 +27,12 @@ docker run -d --name Sync \
27
27
--restart always \
28
28
resilio/sync
29
29
```
30
+
30
31
Note 1: we need to mount `/etc/localtime` from host OS to container to ensure container's time is synced with the host's time.
31
32
32
-
Note 2: you can use our official Docker image `resilio/sync` hosted on https://hub.docker.com/u/resilio or build image manually:
33
-
```
33
+
Note 2: you can use our official Docker image `resilio/sync` hosted on <https://hub.docker.com/u/resilio> or build image manually:
@@ -44,25 +46,25 @@ If you need to run Sync under specific user inside your container - use `--user`
44
46
45
47
Running 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).
46
48
47
-
###Volumes
49
+
## Volumes
48
50
49
-
*`/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
51
+
-`/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
50
52
51
-
*`/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
53
+
-`/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
52
54
53
-
###Ports
55
+
## Ports
54
56
55
-
*`8888` - Webui port
56
-
*`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)
57
+
-`8888` - Webui port
58
+
-`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)
57
59
58
60
Find 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.
59
61
60
-
####LAN access
62
+
### LAN access
61
63
62
-
If you do not want to limit the access to the webui - do not specify `localhost` address in `-p` parameter,
64
+
If you do not want to limit the access to the webui - do not specify `localhost` address in `-p` parameter,
63
65
in this case every person in your LAN will be able to access web UI via `http://<your_ip_address>:<WEBUI_PORT>`:
64
66
65
-
```
67
+
```bash
66
68
WEBUI_PORT=8888
67
69
68
70
docker run -d --name Sync \
@@ -75,14 +77,14 @@ docker run -d --name Sync \
75
77
resilio/sync
76
78
```
77
79
78
-
You can also force web UI to work over https instead of http. To do this you need to add `force_https` parameter in
80
+
You can also force web UI to work over https instead of http. To do this you need to add `force_https` parameter in
79
81
config 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).
80
82
81
-
####Extra directories
83
+
### Extra directories
82
84
83
85
If you need to mount extra directories, mount them in `/mnt/mounted_folders`:
84
86
85
-
```
87
+
```bash
86
88
OTHER_DIR=/path/to/some/dir/on/host
87
89
OTHER_DIR2=/path/to/some/another/dir/on/host
88
90
@@ -100,7 +102,7 @@ docker run -d --name Sync \
100
102
101
103
Note: 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.
102
104
103
-
###Miscellaneous
105
+
## Miscellaneous
104
106
105
107
- Additional info and various Sync guides can be found in our [help center](https://help.resilio.com)
106
108
- 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)
0 commit comments