README.rst: Updating documentation with new configuration settings.
Adding documentation for new configuration settings that have been added since it was last updated.
This commit is contained in:
40
README.rst
40
README.rst
@@ -71,7 +71,7 @@ This will install Puppetboard and take care of the dependencies. If you
|
|||||||
do this Puppetboard will be installed in the so called site-packages or
|
do this Puppetboard will be installed in the so called site-packages or
|
||||||
dist-packages of your Python distribution.
|
dist-packages of your Python distribution.
|
||||||
|
|
||||||
The complete path on Debian and Ubuntu systems would be ``/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard`` and on Fedora would be ``/usr/lib/pythonX.Y/lib/site-packages/puppetboard``
|
The complete path on Debian and Ubuntu systems would be ``/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard`` and on Fedora would be ``/usr/lib/pythonX.Y/site-packages/puppetboard``
|
||||||
|
|
||||||
where X and Y are replaced by your major and minor python versions.
|
where X and Y are replaced by your major and minor python versions.
|
||||||
|
|
||||||
@@ -174,10 +174,11 @@ connect. Therefor you'll also have to supply the following settings:
|
|||||||
For information about how to generate the correct keys please refer to the
|
For information about how to generate the correct keys please refer to the
|
||||||
`pypuppetdb documentation`_.
|
`pypuppetdb documentation`_.
|
||||||
|
|
||||||
Other settings that might be interesting:
|
Other settings that might be interesting in no particular order:
|
||||||
|
|
||||||
* ``SECRET_KEY``: Refer to `Flask documentation`_, section sessions: How to
|
* ``SECRET_KEY``: Refer to `Flask documentation`_, section sessions: How to
|
||||||
generate good secret keys, to set the value.
|
generate good secret keys, to set the value. Defaults to a random 24-char
|
||||||
|
string generated by os.random(24)
|
||||||
* ``PUPPETDB_TIMEOUT``: Defaults to 20 seconds but you might need to increase
|
* ``PUPPETDB_TIMEOUT``: Defaults to 20 seconds but you might need to increase
|
||||||
this value. It depends on how big the results are when querying PuppetDB.
|
this value. It depends on how big the results are when querying PuppetDB.
|
||||||
This behaviour will change in a future release when pagination will be
|
This behaviour will change in a future release when pagination will be
|
||||||
@@ -190,6 +191,25 @@ Other settings that might be interesting:
|
|||||||
* ``ENABLE_QUERY``: Defaults to ``True`` causing a Query tab to show up in the
|
* ``ENABLE_QUERY``: Defaults to ``True`` causing a Query tab to show up in the
|
||||||
web interface allowing users to write and execute arbitrary queries against
|
web interface allowing users to write and execute arbitrary queries against
|
||||||
a set of endpoints in PuppetDB. Change this to ``False`` to disable this.
|
a set of endpoints in PuppetDB. Change this to ``False`` to disable this.
|
||||||
|
* ``GRAPH_FACTS``: A list of fact names to tell PuppetBoard to generate a
|
||||||
|
pie-chart on the fact page. With some fact values being unique per node,
|
||||||
|
like ipaddress, uuid, and serial number, as well as structured facts it was
|
||||||
|
no longer feasible to generate a graph for everything.
|
||||||
|
* ``INVENTORY_FACTS``: A list of tuples that serve as the column header and
|
||||||
|
the fact name to search for to create the inventory page. If a fact is not
|
||||||
|
found for a node then ``undef`` is printed.
|
||||||
|
* ``ENABLE_CATALOG``: If set to ``True`` allows the user to view a node's
|
||||||
|
latest catalog. This includes all managed resources, their file-system
|
||||||
|
locations and their relationships, if available. Defaults to ``False``.
|
||||||
|
* ``REFRESH_RATE``: Defaults to ``30`` the number of seconds to wait until
|
||||||
|
the index page is automatically refreshed.
|
||||||
|
* ``DEFAULT_ENVIRONMENT``: Defaults to ``'production'``, as the name
|
||||||
|
suggests, load all information filtered by this environment value.
|
||||||
|
* ``REPORTS_COUNT``: Defaults to ``10`` the limit of the number of reports
|
||||||
|
to load on the node or any reports page.
|
||||||
|
* ``OFFLINE_MODE``: If set to ``True`` load static assets (jquery,
|
||||||
|
semantic-ui, tablesorter, etc) from the local web server instead of a CDN.
|
||||||
|
Defaults to ``False``.
|
||||||
|
|
||||||
.. _pypuppetdb documentation: http://pypuppetdb.readthedocs.org/en/v0.1.0/quickstart.html#ssl
|
.. _pypuppetdb documentation: http://pypuppetdb.readthedocs.org/en/v0.1.0/quickstart.html#ssl
|
||||||
.. _Flask documentation: http://flask.pocoo.org/docs/0.10/quickstart/#sessions
|
.. _Flask documentation: http://flask.pocoo.org/docs/0.10/quickstart/#sessions
|
||||||
@@ -240,7 +260,7 @@ First we need to create the necessary directories:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
$ mkdir -p /var/www/puppetboard
|
$ mkdir -p /var/www/html/puppetboard
|
||||||
|
|
||||||
Copy Puppetboard's ``default_settings.py`` to the newly created puppetboard
|
Copy Puppetboard's ``default_settings.py`` to the newly created puppetboard
|
||||||
directory and name the file ``settings.py``. This file will be available
|
directory and name the file ``settings.py``. This file will be available
|
||||||
@@ -262,7 +282,7 @@ puppetboard directory:
|
|||||||
import os
|
import os
|
||||||
|
|
||||||
# Needed if a settings.py file exists
|
# Needed if a settings.py file exists
|
||||||
os.environ['PUPPETBOARD_SETTINGS'] = '/var/www/puppetboard/settings.py'
|
os.environ['PUPPETBOARD_SETTINGS'] = '/var/www/html/puppetboard/settings.py'
|
||||||
from puppetboard.app import app as application
|
from puppetboard.app import app as application
|
||||||
|
|
||||||
Make sure this file is readable by the user the webserver runs as.
|
Make sure this file is readable by the user the webserver runs as.
|
||||||
@@ -276,7 +296,7 @@ Here is a sample configuration for Debian and Ubuntu:
|
|||||||
<VirtualHost *:80>
|
<VirtualHost *:80>
|
||||||
ServerName puppetboard.example.tld
|
ServerName puppetboard.example.tld
|
||||||
WSGIDaemonProcess puppetboard user=www-data group=www-data threads=5
|
WSGIDaemonProcess puppetboard user=www-data group=www-data threads=5
|
||||||
WSGIScriptAlias / /var/www/puppetboard/wsgi.py
|
WSGIScriptAlias / /var/www/html/puppetboard/wsgi.py
|
||||||
ErrorLog /var/log/apache2/puppetboard.error.log
|
ErrorLog /var/log/apache2/puppetboard.error.log
|
||||||
CustomLog /var/log/apache2/puppetboard.access.log combined
|
CustomLog /var/log/apache2/puppetboard.access.log combined
|
||||||
|
|
||||||
@@ -301,11 +321,11 @@ Here is a sample configuration for Fedora:
|
|||||||
<VirtualHost *:80>
|
<VirtualHost *:80>
|
||||||
ServerName puppetboard.example.tld
|
ServerName puppetboard.example.tld
|
||||||
WSGIDaemonProcess puppetboard user=apache group=apache threads=5
|
WSGIDaemonProcess puppetboard user=apache group=apache threads=5
|
||||||
WSGIScriptAlias / /var/www/puppetboard/wsgi.py
|
WSGIScriptAlias / /var/www/html/puppetboard/wsgi.py
|
||||||
ErrorLog /var/log/httpd/puppetboard.error.log
|
ErrorLog logs/puppetboard-error_log
|
||||||
CustomLog /var/log/httpd/puppetboard.access.log combined
|
CustomLog logs/puppetboard-access_log combined
|
||||||
|
|
||||||
Alias /static /usr/local/lib/pythonX.Y/site-packages/puppetboard/static
|
Alias /static /usr/lib/pythonX.Y/site-packages/puppetboard/static
|
||||||
<Directory /usr/lib/python2.X/site-packages/puppetboard/static>
|
<Directory /usr/lib/python2.X/site-packages/puppetboard/static>
|
||||||
Satisfy Any
|
Satisfy Any
|
||||||
Allow from all
|
Allow from all
|
||||||
|
|||||||
Reference in New Issue
Block a user