Documentation Commit

This adds the README and TODO files to the project.
This commit is contained in:
Gary Larizza 2011-06-17 14:01:15 -07:00
parent 98f1cd9b79
commit 670bc6ed36
2 changed files with 34 additions and 0 deletions

27
README.markdown Normal file
View File

@ -0,0 +1,27 @@
# Puppet Dashboard Module
Gary Larizza <gary@puppetlabs.com>
This module manages and installs the Puppet Dashboard.
# Quick Start
To install the Puppet Dashboard and configure it with sane defaults, include the following in your site.pp file:
node default {
class {'dashboard':
dashboard_ensure => 'present',
dashboard_user => 'dashboard',
dashboard_password => 'changeme',
dashboard_db => 'dashboard_db',
dashboard_charset => 'utf8',
}
}
# Feature Requests
* Include the ability to run Puppet Dashboard under Passenger.
* Sqlite support.
* Integration with Puppet module to set puppet.conf settings.

7
TODO Normal file
View File

@ -0,0 +1,7 @@
Need to set a variable for /var/lib/mysql in the mysql module
Do we need to set the hostname or data in Apache?
Update puppet.conf if master == true? Something to get the report URL set.
Decide how to integrate Passenger (init script, mainly)
- Require apache, Passenger (which requires gcc and ruby)
- Restart Passenger by touching ./project/restart.txt or...
- If passenger, kill the init script and notify Apache when we need Puppet Dashboard to restart.