X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/45c45894797c49b6fbcb9af5b6ad8b8292d96415..600a5055b909a46e372c0bfe510bb412d2ccba34:/cookbooks/backup/README.md diff --git a/cookbooks/backup/README.md b/cookbooks/backup/README.md index 205739199..1636aea0a 100644 --- a/cookbooks/backup/README.md +++ b/cookbooks/backup/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Backup Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. - -Requirements ------------- -TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc. - -Attributes ----------- -TODO: List you cookbook attributes here. - -Usage ------ -TODO: Write usage instructions for each cookbook. - -Contributing ------------- -TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section. - -e.g. -1. Fork the repository on Github -2. Create a named feature branch (like `add_component_x`) -3. Write your change -4. Write tests for your change (if applicable) -5. Run the tests, ensuring they all pass -6. Submit a Pull Request using Github - -License and Authors -------------------- -Authors: TODO: List authors +This cookbook is run on the machine that stores the central backups. It creates +the store for the backups and manages their expiry. It also configures the rsync +daemon used by machines that send in their backups.