blob: 55c13f82393ce3bcdc9f27fff2369b217a6e98b0 [file] [log] [blame]
Ales Komarekf933a5c2014-04-02 11:13:37 +02001
Ales Komarek2b92f5e2018-01-30 22:03:01 +01002=============
3rsync Formula
4=============
Ales Komarekf933a5c2014-04-02 11:13:37 +02005
Ales Komarek2b92f5e2018-01-30 22:03:01 +01006rsync is an open source utility that provides fast incremental file transfer.
Ales Komarek5bda67a2014-04-02 17:02:01 +02007
Ales Komarek2b92f5e2018-01-30 22:03:01 +01008
9Sample Metadata
10===============
11
12.. code-block:: yaml
Ales Komarekf933a5c2014-04-02 11:13:37 +020013
14 rsync:
15 server:
16 enabled: true
Ales Komarek7bb7cc62014-04-02 20:26:56 +020017 bind:
18 address: 0.0.0.0
Filip Pytloun2939fa92016-03-31 19:13:57 +020019 module:
20 name:
21 max_connections: 2
22 path: /srv/rsync
23 read_only: False
Petr Michalece01aff72017-01-20 15:57:00 +010024 timeout: 300
Ales Komarekf933a5c2014-04-02 11:13:37 +020025
Ales Komarek2b92f5e2018-01-30 22:03:01 +010026
27References
28==========
Ales Komarek9f5c0072014-04-02 14:33:40 +020029
Ales Komarek5bda67a2014-04-02 17:02:01 +020030* http://rsync.samba.org/
Filip Pytloun2939fa92016-03-31 19:13:57 +020031* http://www.togaware.com/linux/survivor/Rsync_Server.html
Filip Pytlounc3484742017-02-02 13:02:03 +010032
Ales Komarek2b92f5e2018-01-30 22:03:01 +010033
Filip Pytlounc3484742017-02-02 13:02:03 +010034Documentation and Bugs
35======================
36
37To learn how to install and update salt-formulas, consult the documentation
38available online at:
39
40 http://salt-formulas.readthedocs.io/
41
42In the unfortunate event that bugs are discovered, they should be reported to
43the appropriate issue tracker. Use Github issue tracker for specific salt
44formula:
45
46 https://github.com/salt-formulas/salt-formula-rsync/issues
47
48For feature requests, bug reports or blueprints affecting entire ecosystem,
49use Launchpad salt-formulas project:
50
51 https://launchpad.net/salt-formulas
52
53You can also join salt-formulas-users team and subscribe to mailing list:
54
55 https://launchpad.net/~salt-formulas-users
56
57Developers wishing to work on the salt-formulas projects should always base
58their work on master branch and submit pull request against specific formula.
59
60 https://github.com/salt-formulas/salt-formula-rsync
61
62Any questions or feedback is always welcome so feel free to join our IRC
63channel:
64
65 #salt-formulas @ irc.freenode.net