From: Andy Allan Date: Wed, 24 Feb 2016 16:58:29 +0000 (+0000) Subject: Add more cookbook READMEs X-Git-Url: https://git.openstreetmap.org/chef.git/commitdiff_plain/c1065e169334f4868777ca1e0b0ae6ba2fc35706 Add more cookbook READMEs --- diff --git a/cookbooks/rsyncd/README.md b/cookbooks/rsyncd/README.md index 205739199..3bd9dab61 100644 --- a/cookbooks/rsyncd/README.md +++ b/cookbooks/rsyncd/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Rsyncd 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 configures the rsync service. The specific permissions, +paths and allowed hosts are configured using role attributes. diff --git a/cookbooks/serverinfo/README.md b/cookbooks/serverinfo/README.md index 205739199..64239b18f 100644 --- a/cookbooks/serverinfo/README.md +++ b/cookbooks/serverinfo/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Serverinfo 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 configures the hardware details website found at +[hardware.openstreetmap.org](https://hardware.openstreetmap.org). The code for +the website itself is available at [github.com/gravitystorm/osmf-server-info](https://github.com/gravitystorm/osmf-server-info). diff --git a/cookbooks/snmpd/README.md b/cookbooks/snmpd/README.md index 205739199..42cc0aff3 100644 --- a/cookbooks/snmpd/README.md +++ b/cookbooks/snmpd/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# snmpd 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 installs and configures the SNMP (Simple Network Management + Protocol) daemon. It is used for remote monitoring of servers. diff --git a/cookbooks/spamassassin/README.md b/cookbooks/spamassassin/README.md index 205739199..6d1a44ff9 100644 --- a/cookbooks/spamassassin/README.md +++ b/cookbooks/spamassassin/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# SpamAssassin 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 installs and configures the SpamAssassin spam filtering software +for use on the mail relays. diff --git a/cookbooks/squid/README.md b/cookbooks/squid/README.md index 205739199..4946af474 100644 --- a/cookbooks/squid/README.md +++ b/cookbooks/squid/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Squid 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 installs the Squid caching proxy service and configures it for use +as a tile cache. diff --git a/cookbooks/ssl/README.md b/cookbooks/ssl/README.md index 205739199..816774253 100644 --- a/cookbooks/ssl/README.md +++ b/cookbooks/ssl/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# SSL 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 configures the OpenStreetMap SSL certificates. Role attributes +control which certificates should be installed, while the private keys for each +certificate is stored in a chef data_bag. diff --git a/cookbooks/stateofthemap/README.md b/cookbooks/stateofthemap/README.md index 205739199..ba6d99a47 100644 --- a/cookbooks/stateofthemap/README.md +++ b/cookbooks/stateofthemap/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# StateOfTheMap 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 installs and configures the various annual State Of The Map +conference websites. Each year the website is run by the SOTM Working Group and +so each year has a different set of software and configuration. diff --git a/cookbooks/stats/README.md b/cookbooks/stats/README.md index 205739199..1090469a3 100644 --- a/cookbooks/stats/README.md +++ b/cookbooks/stats/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Stats 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 installs and configures awstats for generating statistics from +log files. This is used for the [stats.openstreetmap.org](http://stats.openstreetmap.org/) website. diff --git a/cookbooks/subversion/README.md b/cookbooks/subversion/README.md index 205739199..c2828ebd9 100644 --- a/cookbooks/subversion/README.md +++ b/cookbooks/subversion/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Subversion 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 installs and configures the subversion revision control system +that powers svn.openstreetmap.org diff --git a/cookbooks/supybot/README.md b/cookbooks/supybot/README.md index 205739199..370d28a41 100644 --- a/cookbooks/supybot/README.md +++ b/cookbooks/supybot/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Subybot 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 installs and configures the Supybot IRC bot software. It powers +'osmbot' on the #osm-dev IRC channel, and the bot posts to the channel when +commits to various git repositories are made.