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: add configuration details

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

19
README.md
View file

@ -1,13 +1,24 @@
# rsync
A simple rsync server that runs inside Docker. It is intended to be used as a volume and shared among containers where
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:
```$ docker run stefda/rsync -p 873:873```
```bash
$ docker run stefda/rsync -p 873:873
```
The command above will spin up a container that listens on port 873 for rsync connections. To push files into the
container, you may use `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:
```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"
```