aa-healthcheck 0.1.0

No project description provided

AA Healthcheck

A healthcheck/heartbeat app for Alliance Auth

Features

Ping healthcheck.io every 5 minutes, which will alert when a ping isn't received.

Future Features

• uptime kuma support

Installation

• healthcheck is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official Alliance Auth installation guide for details)

pip install aa-healthcheck

• Create a healthcheck.io account and associated check, copy the given ping URL

Configure your Auth settings (local.py) as follows:

• Add 'healthcheck' to INSTALLED_APPS
• Add the following lines to your settings file:

HEALTHCHECK_URL = "https://hc-ping.com/"  # Replace with your healthchek.io url
if "healthcheck" in INSTALLED_APPS:
    # Run every 5 minutes
    CELERYBEAT_SCHEDULE["Healthcheck :: Heartbeat"] = {
        "task": "skyhooks.tasks.update_skyhooks",
        "schedule": crontab(minute="*/5"),
    }

There are curently no migrations or static files

• Restart your supervisor services for Auth