docs: basic usage info

This commit is contained in:
David Stefan 2017-04-30 13:41:50 +01:00
parent 5af6da03df
commit 3afe09955c

View file

@ -1,2 +1,12 @@
# rsync
A small Docker image with a simplistic rsync server. It is intended to be used as a volume image and shared across containers where standard volume sharing results in poor performance.
A simple rsync server that runs inside Docker. 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```
The command above will spin up a container that listens on port 873 for rsync connections.