Skip to content

Commit 181450a

Browse files
author
jtimberman
committed
Actually add the readmes
1 parent 01c13c0 commit 181450a

6 files changed

Lines changed: 284 additions & 0 deletions

File tree

‎apparmor/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
DESCRIPTION
2+
===========
3+
4+
Stops and disables the apparmor service on Ubuntu.
5+
6+
LICENSE AND AUTHOR
7+
==================
8+
9+
Author:: Joshua Timberman (<joshua@opscode.com>)
10+
11+
Copyright 2009, Opscode, Inc.
12+
13+
Licensed under the Apache License, Version 2.0 (the "License");
14+
you may not use this file except in compliance with the License.
15+
You may obtain a copy of the License at
16+
17+
http://www.apache.org/licenses/LICENSE-2.0
18+
19+
Unless required by applicable law or agreed to in writing, software
20+
distributed under the License is distributed on an "AS IS" BASIS,
21+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22+
See the License for the specific language governing permissions and
23+
limitations under the License.

‎apt/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
DESCRIPTION
2+
===========
3+
4+
Configures various APT components on Debian-like systems.
5+
6+
RECIPES
7+
=======
8+
9+
default
10+
-------
11+
12+
The default recipe runs apt-get update during the Compile Phase of the Chef run to ensure that the system's package cache is updated with the latest. It is recommended that this recipe appear first in a node's run list (directly or through a role) to ensure that when installing packages, Chef will be able to download the latest version available on the remote APT repository.
13+
14+
This recipe also sets up a local cache directory for preseeding packages.
15+
16+
cacher
17+
------
18+
19+
Installs the apt-cacher package and service so the system can be an APT cache.
20+
21+
proxy
22+
-----
23+
24+
Installs the apt-proxy package and service so the system can be an APT proxy.
25+
26+
LICENSE AND AUTHOR
27+
==================
28+
29+
Author:: Joshua Timberman (<joshua@opscode.com>)
30+
31+
Copyright 2009, Opscode, Inc.
32+
33+
Licensed under the Apache License, Version 2.0 (the "License");
34+
you may not use this file except in compliance with the License.
35+
You may obtain a copy of the License at
36+
37+
http://www.apache.org/licenses/LICENSE-2.0
38+
39+
Unless required by applicable law or agreed to in writing, software
40+
distributed under the License is distributed on an "AS IS" BASIS,
41+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
42+
See the License for the specific language governing permissions and
43+
limitations under the License.
44+

‎build-essential/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
DESCRIPTION
2+
===========
3+
4+
Installs packages required for compiling C software from source.
5+
6+
LICENSE AND AUTHOR
7+
==================
8+
9+
Author:: Joshua Timberman (<joshua@opscode.com>)
10+
11+
Copyright 2009, Opscode, Inc.
12+
13+
Licensed under the Apache License, Version 2.0 (the "License");
14+
you may not use this file except in compliance with the License.
15+
You may obtain a copy of the License at
16+
17+
http://www.apache.org/licenses/LICENSE-2.0
18+
19+
Unless required by applicable law or agreed to in writing, software
20+
distributed under the License is distributed on an "AS IS" BASIS,
21+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22+
See the License for the specific language governing permissions and
23+
limitations under the License.

‎capistrano/README.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
DESCRIPTION
2+
===========
3+
4+
Installs capistrano RubyGem and provides a definition to set up directory structure to perform capistrano deployment.
5+
6+
This cookbook is not necessary when using the Opscode application cookbook.
7+
8+
RECIPES
9+
=======
10+
11+
The default recipe merely installs the capistrano RubyGem.
12+
13+
DEFINITIONS
14+
===========
15+
16+
cap_setup
17+
---------
18+
19+
The `cap_setup` definition will create the deployment directory structure for deploying applications with capistrano. For example to use the definition:
20+
21+
cap_setup "my_app" do
22+
path "/srv/my_app"
23+
owner "nobody"
24+
group "nogroup"
25+
appowner "nobody"
26+
end
27+
28+
This will create the following directory structure:
29+
30+
/srv/my_app
31+
/srv/my_app/releases
32+
/srv/my_app/shared
33+
/srv/my_app/shared/log
34+
/srv/my_app/shared/system
35+
36+
LICENSE AND AUTHOR
37+
==================
38+
39+
Author:: Joshua Timberman (<joshua@opscode.com>)
40+
41+
Copyright 2009, Opscode, Inc.
42+
43+
Licensed under the Apache License, Version 2.0 (the "License");
44+
you may not use this file except in compliance with the License.
45+
You may obtain a copy of the License at
46+
47+
http://www.apache.org/licenses/LICENSE-2.0
48+
49+
Unless required by applicable law or agreed to in writing, software
50+
distributed under the License is distributed on an "AS IS" BASIS,
51+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
52+
See the License for the specific language governing permissions and
53+
limitations under the License.

‎couchdb/README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
DESCRIPTION
2+
===========
3+
4+
REQUIREMENTS
5+
============
6+
7+
Requires a platform that can install Erlang from distribution packages.
8+
9+
Platform
10+
--------
11+
12+
Works on Debian 5+, Ubuntu 8.10+, OpenBSD and FreeBSD.
13+
14+
Also works on Red Hat, CentOS and Fedora, requires the EPEL yum repository.
15+
16+
Cookbooks
17+
---------
18+
19+
Requires the erlang cookbook so erlang can be installed.
20+
21+
ATTRIBUTES
22+
==========
23+
24+
Cookbook attributes are named under the `couch_db` keyspace. The attributes specified in the cookbook are used in the `couchdb::source` recipe only.
25+
26+
* `node[:couch_db][:src_checksum]` - sha256sum of the default version of couchdb to download
27+
* `node[:couch_db][:src_version]` - default version of couchdb to download, used in the full URL to download.
28+
* `node[:couch_db][:src_mirror]` - full URL to download.
29+
30+
RECIPES
31+
=======
32+
33+
default
34+
-------
35+
36+
Installs the couchdb package, creates the data directory and starts the couchdb service.
37+
38+
source
39+
------
40+
41+
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.
42+
43+
LICENSE AND AUTHOR
44+
==================
45+
46+
Author:: Joshua Timberman (<joshua@opscode.com>)
47+
48+
Copyright 2009, Opscode, Inc.
49+
50+
Licensed under the Apache License, Version 2.0 (the "License");
51+
you may not use this file except in compliance with the License.
52+
You may obtain a copy of the License at
53+
54+
http://www.apache.org/licenses/LICENSE-2.0
55+
56+
Unless required by applicable law or agreed to in writing, software
57+
distributed under the License is distributed on an "AS IS" BASIS,
58+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
59+
See the License for the specific language governing permissions and
60+
limitations under the License.
61+

‎djbdns/README.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
DESCRIPTION
2+
===========
3+
4+
Installs and configures Dan Bernstein's DNS tinydns, aka djbdns. Services are configured to start up under runit.
5+
6+
REQUIREMENTS
7+
============
8+
9+
Platform
10+
--------
11+
12+
Known to work on Debian, Ubuntu, Red Hat and CentOS.
13+
14+
Cookbooks
15+
---------
16+
17+
* build-essential - for compiling the source.
18+
* runit - for setting up the services.
19+
20+
ATTRIBUTES
21+
==========
22+
23+
* `node[:djbdns][:tinydns_ipaddress]` - listen address for public facing tinydns server
24+
* `node[:djbdns][:tinydns_internal_ipaddress]` - listen address for internal tinydns server
25+
* `node[:djbdns][:public_dnscache_ipaddress]` - listen address for public DNS cache
26+
* `node[:djbdns][:axfrdns_ipaddress]` - listen address for axfrdns
27+
* `node[:djbdns][:public_dnscache_allowed_networks]` - subnets that are allowed to talk to the dnscache.
28+
* `node[:djbdns][:tinydns_internal_resolved_domain]` - default domain this tinydns serves
29+
* `node[:djbdns][:bin_dir]` - default location where binaries will be stored.
30+
* `node[:djbdns][:axfrdns_uid]` - default uid for the axfrdns user
31+
* `node[:djbdns][:dnscache_uid]` - default uid for the dnscache user
32+
* `node[:djbdns][:dnslog_uid]` - default uid for the dnslog user
33+
* `node[:djbdns][:tinydns_uid]` - default uid for the tinydns user
34+
35+
RECIPES
36+
=======
37+
38+
default
39+
-------
40+
41+
The default recipe installs djbdns software from package where available, otherwise installs from source. It also sets up the users that will run the djbdns services using the UID's specified by the attributes above.
42+
43+
axfr
44+
----
45+
46+
Creates the axfrdns user and sets up the axfrdns service.
47+
48+
cache
49+
-----
50+
51+
Sets up a local DNS caching server.
52+
53+
internal_server
54+
---------------
55+
56+
Sets up a server to be an internal nameserver. To modify resource records in the environment, modify the tinydns-internal-data.erb template.
57+
58+
server
59+
------
60+
61+
Sets up a server to be a public nameserver. To modify resource records in the environment, modify the tinydns-data.erb template.
62+
63+
LICENSE AND AUTHOR
64+
==================
65+
66+
Author:: Joshua Timberman (<joshua@opscode.com>)
67+
68+
Copyright 2009, Opscode, Inc.
69+
70+
Licensed under the Apache License, Version 2.0 (the "License");
71+
you may not use this file except in compliance with the License.
72+
You may obtain a copy of the License at
73+
74+
http://www.apache.org/licenses/LICENSE-2.0
75+
76+
Unless required by applicable law or agreed to in writing, software
77+
distributed under the License is distributed on an "AS IS" BASIS,
78+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
79+
See the License for the specific language governing permissions and
80+
limitations under the License.

0 commit comments

Comments
 (0)