GitHub-Mirror/docker-rsync
2
0
Fork 0
mirror of https://github.com/Fishwaldo/docker-rsync.git synced 2025-03-15 19:42:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: remove new lines to fix broken docker hub docs rendering

Browse source
This commit is contained in:
David Stefan 2017-05-02 23:12:20 +01:00
parent 5830ae22d2
commit a78d353f28
1 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,23 +1,19 @@
# rsync
A minimalist image with rsync daemon. It is intended to be used as a volume and shared among containers where
standard volume sharing results in poor read performance.
A minimalist image with rsync daemon. It is intended to be used as a volume and shared among containers where standard volume sharing results in poor read performance.
# Usage
The simplest use case is to run the image and map its 873 port:
```bash
$ docker run stefda/rsync -p 873:873
```
The command above spins up a container that will listen on port 873 for connections over the native rsync protocol.
Syncing files is then as easy as `rsync -rtR <file-or-directory> rsync://<docker-host-ip>:873/volume`.
The command above spins up a container that will listen on port 873 for connections over the native rsync protocol. Syncing files is then as easy as `rsync -rtR <file-or-directory> rsync://<docker-host-ip>:873/volume`.
# Configuration
The module path, owning user, group and allowed hosts are all configurable via environmental variables. Launch fully
customised container like so:
The module path, owning user, group and allowed hosts are all configurable via environmental variables. Launch fully customised container like so:
```bash
$ docker run stefda/rsync -p 873:873 -e VOLUME=/my/volume -e USER=www-data -e GROUP=www-data -e ALLOW="192.168.0.0/16 10.0.0.0/16"