Permalink
Browse files

Actually add the readmes

  • Loading branch information...
jtimberman committed Jun 26, 2010
1 parent 8d43937 commit d41601cd57fa47e8c41381686b1af2a6f5b4720c
Showing with 61 additions and 0 deletions.
  1. +61 −0 README.md
View
@@ -0,0 +1,61 @@
+DESCRIPTION
+===========
+
+REQUIREMENTS
+============
+
+Requires a platform that can install Erlang from distribution packages.
+
+Platform
+--------
+
+Works on Debian 5+, Ubuntu 8.10+, OpenBSD and FreeBSD.
+
+Also works on Red Hat, CentOS and Fedora, requires the EPEL yum repository.
+
+Cookbooks
+---------
+
+Requires the erlang cookbook so erlang can be installed.
+
+ATTRIBUTES
+==========
+
+Cookbook attributes are named under the `couch_db` keyspace. The attributes specified in the cookbook are used in the `couchdb::source` recipe only.
+
+* `node[:couch_db][:src_checksum]` - sha256sum of the default version of couchdb to download
+* `node[:couch_db][:src_version]` - default version of couchdb to download, used in the full URL to download.
+* `node[:couch_db][:src_mirror]` - full URL to download.
+
+RECIPES
+=======
+
+default
+-------
+
+Installs the couchdb package, creates the data directory and starts the couchdb service.
+
+source
+------
+
+Downloads the CouchDB source from the Apache project site, plus development dependencies. Then builds the binaries for installation, creates a user and directories, then sets up the couchdb service. Uses the init script provided in the cookbook.
+
+LICENSE AND AUTHOR
+==================
+
+Author:: Joshua Timberman (<joshua@opscode.com>)
+
+Copyright 2009, Opscode, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

0 comments on commit d41601c

Please sign in to comment.