diff --git a/README.rst b/README.rst index c990d82..dd80a9d 100644 --- a/README.rst +++ b/README.rst @@ -151,7 +151,7 @@ and then install the requirements through: .. code-block:: bash - $ pip install -r requirements.txt + $ pip install -r requirements-test.txt You're advised to do this inside a virtualenv specifically created to work on Puppetboard as to not pollute your global Python installation. @@ -241,6 +241,21 @@ Other settings that might be interesting in no particular order: * ``OFFLINE_MODE``: If set to ``True`` load static assets (jquery, semantic-ui, etc) from the local web server instead of a CDN. Defaults to ``False``. +* ``DAILY_REPORTS_CHART_ENABLED``: Enable the use of daily chart graphs when + looking at dashboard and node view. +* ``DAILY_REPORTS_CHART_DAYS``: Number of days to show history for on the daily + report graphs. +* ``DISPLAYED_METRICS``: Metrics to show when displying node summary. Example: + ``'resources.total'``, ``'events.noop'``. +* ``TABLE_COUNT_SELECTOR``: Configure the dropdown to limit number of hosts to + show per page. +* ``LITTLE_TABLE_COUNT``: Default number of reports to show when when looking at a node. +* ``NORMAL_TABLE_COUNT``: Default number of nodes to show when displaying reports + and catalog nodes. +* ``LOCALISE_TIMESTAMP``: Normalize time based on localserver time. +* ``DEV_LISTEN_HOST``: For use with `dev.py` for development. Default is localhost +* ``DEV_LISTEN_PORT``: For use with `dev.py` for development. Default is 5000 + .. _pypuppetdb documentation: http://pypuppetdb.readthedocs.org/en/v0.1.0/quickstart.html#ssl .. _Flask documentation: http://flask.pocoo.org/docs/0.10/quickstart/#sessions @@ -285,6 +300,14 @@ scenarios: If you deploy Puppetboard through a different setup we'd welcome a pull request that adds the instructions to this section. +Installation On Linux Distros +^^^^^^^^^^^^^^^^^^^^^^^^ + +`Debian Jessie Install`_. + +.. _Debian Jessie Install: docs/Debian-Jessie.md + + Apache + mod_wsgi ^^^^^^^^^^^^^^^^^ diff --git a/docs/Debian-Jessie.md b/docs/Debian-Jessie.md new file mode 100644 index 0000000..4ecbd21 --- /dev/null +++ b/docs/Debian-Jessie.md @@ -0,0 +1,62 @@ +# Install Using debian jessie + +``` +$ apt-get install python-pip git + +$ mkdir /opt/voxpupuli-puppetboard/ +$ cd /opt/voxpupuli-puppetboard/ +$ git clone https://github.com/voxpupuli/puppetboard +$ cd /opt/voxpupuli-puppetboard/puppetboard +$ pip install puppetboard + +``` + +* /etc/apache2/sites-available/voxpupuli-puppetboard.conf + +``` + + ServerName puppetboard.my.domain + WSGIDaemonProcess puppetboard user=www-data group=www-data threads=5 python-path=/usr/local/lib/python2.7/dist-packages/puppetboard:python-home=/opt/voxpupuli-puppetboard/puppetboard:/opt/voxpupuli-puppetboard/puppetboard/puppetboard:/usr/local/lib/python2.7/dist-packages/puppetboard/static + WSGIScriptAlias / /opt/voxpupuli-puppetboard/puppetboard/wsgi.py + ErrorLog /var/log/apache2/puppetboard.error.log + CustomLog /var/log/apache2/puppetboard.access.log combined + + + + Order deny,allow + Allow from all + Require all granted + + + + Alias /static /usr/local/lib/python2.7/dist-packages/puppetboard/static + + Satisfy Any + Allow from all + Require all granted + + + + WSGIProcessGroup puppetboard + WSGIApplicationGroup %{GLOBAL} + Order deny,allow + Allow from all + Require all granted + + +``` + +``` +$ a2ensite voxpupuli-puppetboard.conf +``` + +* /opt/voxpupuli-puppetboard/puppetboard/wsgi.py +``` +from __future__ import absolute_import +import os + +import sys +sys.path.append('/opt/voxpupuli-puppetboard/puppetboard') + +from puppetboard.app import app as application +```