Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edigiacomo/django-statusboard
A django based status page.
https://github.com/edigiacomo/django-statusboard
django python web
Last synced: 3 months ago
JSON representation
A django based status page.
- Host: GitHub
- URL: https://github.com/edigiacomo/django-statusboard
- Owner: edigiacomo
- License: gpl-2.0
- Created: 2017-01-12T18:35:32.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T11:14:47.000Z (3 months ago)
- Last Synced: 2024-04-04T04:45:37.378Z (3 months ago)
- Topics: django, python, web
- Language: Python
- Size: 1.69 MB
- Stars: 32
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-status-pages - django-statusboard - Django status page application with browser and REST interface. (Opensource)
README
# statusboard
[](https://github.com/edigiacomo/django-statusboard/actions/workflows/build.yml)
[](https://pypi.python.org/pypi/django-statusboard/)
[](https://codecov.io/gh/edigiacomo/django-statusboard)
[](https://django-statusboard.readthedocs.io/en/stable/?badge=stable)
Status page application with browser and REST API interface.
## Installation
Install the package
```sh
pip install django-statusboard
```
Add the following applications to your Django projects
```python
INSTALLED_APPS += [
'django.contrib.humanize',
'django.contrib.staticfiles',
'rest_framework',
'statusboard',
]
```
Update your urlconf:
```python
# myproject/urls.py
urlpatterns += [
url(r'^statusboard/$', include('statusboard.urls')),
]
```
Update your database
```sh
./manage migrate
```
## Configuration
You can configure the app using the dict `STATUSBOARD` in `settings.py`:
```python
from django.templatetags.static import static
STATUSBOARD = {
"INCIDENT_DAYS_IN_INDEX": 7,
"OPEN_INCIDENT_IN_INDEX": True,
"AUTO_REFRESH_INDEX_SECONDS": 0,
"FAVICON_DEFAULT": static('statusboard/images/statusboard-icon-default.png'),
"FAVICON_INDEX_DICT": {
0: static('statusboard/images/statusboard-icon-operational.png'),
1: static('statusboard/images/statusboard-icon-performance.png'),
2: static('statusboard/images/statusboard-icon-partial.png'),
3: static('statusboard/images/statusboard-icon-major.png'),
},
}
```
* `INCIDENT_DAYS_IN_INDEX`: number of days to show in index (1 = today).
* `OPEN_INCIDENT_IN_INDEX`: show not fixed incidents in index, whether or not
the incident is older than `INCIDENT_DAYS_IN_INDEX`.
* `AUTO_REFRESH_INDEX_SECONDS`: auto refresh home page every N seconds (0 = disabled).
* `FAVICON_DEFAULT`: default favicon.
* `FAVICON_INDEX_DICT`: favicon for index, based on the worst status (default:
`FAVICON_DEFAULT`). The keys `(0, 1, 2, 3)` are the status values (see `SERVICE_STATUSES` in `statusboard/models.py`).
## 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
To customize the default style, create the file `statusboard/base.html` that
extends the original base template and customize some blocks, e.g.:
```
{% extends "statusboard/base.html" %}
{% load static %}
{% block title %}
A.C.M.E. statuspage
{% endblock %}
{% block branding %}
{% endblock %}
{% block bootstrap_theme %}
{% endblock %}
```
### Example: change branding and title
Create a `statusboard/base.html` in one of your templates dir:
```
{% extends `statusboard/base.html %}
{% block title %}
ACME, Inc.
{% endblock %}
{% block branding %}
ACME status
{% endblock %}
```
## Notifications
`django-statusboard` doesn't provide an out-of-the-box notification system, but
it's easy to implement using [django signals](https://docs.djangoproject.com/en/dev/topics/signals/) or you can use [django-statusboard-notify](https://github.com/edigiacomo/django-statusboard-notify) that provides some builtin notifications (e.g. email, Telegram).
Moreover, `django-statusboard` tracks the previous status of a service
(`Service._status`).
```python
from django.dispatch import receiver
from django.db.models.signals import post_save
from django.core.mail import mail_admins
from statusboard import Service
@receiver(post_save, sender=Service)
def notify_service_update(sender, instance, **kwargs):
# Send an email to admins if the service is getting worse, otherwise do nothing.
if instance.status > instance._status:
mail_admins("Alert", "Service {} is {}".format(instance.name, instance.get_status_display()))
```
## REST API
`django-statusboard` comes with a set of REST API to manage its models, based on [Django REST Framework](https://www.django-rest-framework.org/) `ModelViewSet`:
* `/api/v0.1/servicegroup/`
* `/api/v0.1/service/`
* `/api/v0.1/incident/`
* `/api/v0.1/incidentupdate/`
* `/api/v0.1/maintenance/`
## Development
### Running tests
```
$ DJANGO_SETTINGS_MODULE=tests.test_settings python manage.py test
```
### Update i18n
```
$ cd statusboard && django-admin makemessages -l LOCALE
```
## Contact and copyright information
Copyright (C) 2019-2023 Emanuele Di Giacomo
django-statusboard is licensed under GPLv2+.