Skip to content

Commit a97597d

Browse files
committed
Fixed MD004, MD031, MD040 and MD041
1 parent efb6cb8 commit a97597d

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Resilio Sync
1+
# Resilio Sync
22

3-
https://www.resilio.com
3+
<https://www.resilio.com>
44

55
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.
66

7-
### Usage
7+
## Usage
88

9-
```
9+
```bash
1010
# path to folder on the host to be mounted to container as Sync storage folder
1111
DATA_FOLDER=/path/to/data/folder/on/the/host
1212
mkdir -p $DATA_FOLDER
@@ -27,10 +27,12 @@ docker run -d --name Sync \
2727
--restart always \
2828
resilio/sync
2929
```
30+
3031
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.
3132

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:
34+
35+
```bash
3436
git clone [email protected]:bt-sync/sync-docker.git
3537
cd sync-docker
3638
docker build -t resilio/sync .
@@ -44,25 +46,25 @@ If you need to run Sync under specific user inside your container - use `--user`
4446

4547
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).
4648

47-
### Volumes
49+
## Volumes
4850

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
5052

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
5254

53-
### Ports
55+
## Ports
5456

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)
5759

5860
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.
5961

60-
#### LAN access
62+
### LAN access
6163

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,
6365
in this case every person in your LAN will be able to access web UI via `http://<your_ip_address>:<WEBUI_PORT>`:
6466

65-
```
67+
```bash
6668
WEBUI_PORT=8888
6769

6870
docker run -d --name Sync \
@@ -75,14 +77,14 @@ docker run -d --name Sync \
7577
resilio/sync
7678
```
7779

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
7981
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).
8082

81-
#### Extra directories
83+
### Extra directories
8284

8385
If you need to mount extra directories, mount them in `/mnt/mounted_folders`:
8486

85-
```
87+
```bash
8688
OTHER_DIR=/path/to/some/dir/on/host
8789
OTHER_DIR2=/path/to/some/another/dir/on/host
8890

@@ -100,7 +102,7 @@ docker run -d --name Sync \
100102

101103
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.
102104

103-
### Miscellaneous
105+
## Miscellaneous
104106

105107
- Additional info and various Sync guides can be found in our [help center](https://help.resilio.com)
106108
- 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

Comments
 (0)