Add more cookbook READMEs
authorAndy Allan <andy@gravitystorm.co.uk>
Wed, 24 Feb 2016 16:58:29 +0000 (16:58 +0000)
committerAndy Allan <andy@gravitystorm.co.uk>
Wed, 24 Feb 2016 16:58:29 +0000 (16:58 +0000)
cookbooks/rsyncd/README.md
cookbooks/serverinfo/README.md
cookbooks/snmpd/README.md
cookbooks/spamassassin/README.md
cookbooks/squid/README.md
cookbooks/ssl/README.md
cookbooks/stateofthemap/README.md
cookbooks/stats/README.md
cookbooks/subversion/README.md
cookbooks/supybot/README.md

index 205739199955017d846700bb599100dae9f89479..3bd9dab6135cbc9da4125c6b6b031e55d63675c6 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..64239b18f6d93da650b7ee088992128e5bafe9d3 100644 (file)
@@ -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).
index 205739199955017d846700bb599100dae9f89479..42cc0aff3a110560d7f456a699f067b638661bfc 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..6d1a44ff9805f417ae3ebbd9b309e7ce7041b8d6 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..4946af474049dc63cf11a37bbb18908abd1fcc7b 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..816774253b3a9834a6da8b34987634044b323db8 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..ba6d99a47754e1b31d2527afb580300ea416c218 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..1090469a3f630331d9f3e8ab929e6a8515c87260 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..c2828ebd9cede218a8388857003c4d9e7cf31fac 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..370d28a41efd24ac50b642aa05e39546402a83ec 100644 (file)
@@ -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.