statusphere

module
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2024 License: MIT

README

Statusphere logo

GitHub stars GitHub forks GitHub issues GitHub pull requests GitHub license GitHub contributors GitHub last commit

An open-source api-first status page aggregator.

If your looking for the official hosted version, head here.

Architecture

Statusphere is made up of 3 main components:

  1. The scrapers
  2. The database
  3. The api servers

They're orchestrated in the following way:

Statusphere logo

Usage

Scraper

The scrapers need to be started with the following environment variables:

STATUSPHERE_POSTGRES_HOST=...
STATUSPHERE_POSTGRES_PORT=...
STATUSPHERE_POSTGRES_USER=...
STATUSPHERE_POSTGRES_PASSWORD=...
STATUSPHERE_POSTGRES_DATABASE=...

API

The api needs to be started with the following environment variables:

STATUSPHERE_POSTGRES_HOST=...
STATUSPHERE_POSTGRES_PORT=...
STATUSPHERE_POSTGRES_USER=...
STATUSPHERE_POSTGRES_PASSWORD=...
STATUSPHERE_POSTGRES_DATABASE=...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL