Skip to main content

Django app to show system status

Project description

statusboard
===========

`|Build Status| <https://travis-ci.org/edigiacomo/django-statusboard>`_
`|Pypi| <https://pypi.python.org/pypi/django-statusboard/>`_

Status page application.

Installation
------------

Install the package

::

pip install django-statusboard

Add the following applications to your Django projects

::

INSTALLED_APPS += [
'django.contrib.humanize',
'rest_framework',
'statusboard',
]

Update your urlconf:

::

# myproject/urls.py
urlpatterns += [
url(r'^statusboard/$', include('statusboard.urls')),
]

Update your database

::

./manage migrate

Customize pages
---------------

The following blocks are customizable in ``statusboard/base.html``:

- ``title``: title of the page
- ``branding``: branding in fixed navbar
- ``bootstrap_theme``: bootstrap theme
- ``header``: header of the page
- ``userlinks``: links in the header
- ``footer``: footer div
- ``style``: ``CSS`` files
- ``script``: JavaScript files

Example: change branding and title
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Django 1.8
^^^^^^^^^^

Copy ``statusboard/templates/statusboard/base.html`` in one of your
templates dir and edit the file.

Django >= 1.9
^^^^^^^^^^^^^

In Django >= 1.9, the templates can be extended recursively (see
https://docs.djangoproject.com/en/1.10/releases/1.9/).

Create a ``statusboard/base.html`` in one of your templates dir:

::

{% extends `statusboard/base.html %}

{% block title %}
ACME, Inc.
{% endblock %}

{% block branding %}
<a class="navbar-brand" href="{% url 'statusboard:index' %}">ACME status</a>
{% endblock %}

.. |Build
Status| image:: https://travis-ci.org/edigiacomo/django-statusboard.svg?branch=master
.. |Pypi| image:: https://img.shields.io/pypi/v/django-statusboard.svg

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-statusboard-0.3.18.tar.gz (204.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page