Merge pull request #34 from akumria/some-docs

document recently added vhost params and add a README

README.md

@@ -0,0 +1,70 @@
+Puppetlabs module for Apache
+============================
+
+Apache is widely-used web server and this module will allow to configure
+various modules and setup virtual hosts with minimal effort
+
+Basic usage
+-----------
+
+To install Apache
+
+    class {'apache':  }
+
+To install the Apache PHP module
+
+    class {'apache::php': }
+
+Configure a virtual host
+------------------------
+
+You can easily configure many parameters of a virtual host. A minimal
+example is:
+
+    apache::vhost { 'www.example.com':
+        priority        => '10',
+        ipaddr          => '192.0.2.1',
+        port            => '80',
+    }
+
+A slightly more complicated example, which move the docroot and
+logfile to alternate location, might be:
+
+    apache::vhost { 'www.example.com':
+        priority        => '10',
+        ipaddr          => '192.0.2.1',
+        port            => '80',
+        docroot         => '/home/www.example.com/docroot/',
+        logroot         => '/srv/www.example.com/logroot/',
+        serveradmin     => 'webmaster@example.com',
+        serveraliases   => ['example.com',],
+    }
+
+Notes
+-----
+
+Nothing of note.
+
+Contributors
+------------
+
+ * A cast of hundreds, hopefully you too soon
+
+Copyright and License
+---------------------
+
+Copyright (C) 2012 Puppet Labs Inc
+
+Puppet Labs can be contacted at: info@puppetlabs.com
+
+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.

manifests/vhost.pp

@@ -5,15 +5,18 @@
 # Parameters:
 # - The $port to configure the host on
 # - The $docroot provides the DocumentationRoot variable
-# - The $ssl option is set true or false to enable SSL for this Virtual Host
+# - The $serveradmin will specify an email address for Apache that it will display when it renders one of it's error pages
 # - The $configure_firewall option is set to true or false to specify if
 #   a firewall should be configured.
+# - The $ssl option is set true or false to enable SSL for this Virtual Host
 # - The $template option specifies whether to use the default template or
 #   override
 # - The $priority of the site
+# - The $servername is the primary name of the virtual host
 # - The $serveraliases of the site
 # - The $options for the given vhost
 # - The $vhost_name for name based virtualhosting, defaulting to *
+# - The $logroot specifies the location of the virtual hosts logfiles, default to /var/log/<apache log location>/
 #
 # Actions:
 # - Install Apache Virtual Hosts