Skip to content

Latest commit

 

History

History
107 lines (65 loc) · 4.69 KB

README.md

File metadata and controls

107 lines (65 loc) · 4.69 KB
Raw

ssvp: the server statistics viewer project

GitHub release (with filter) GitHub GitHub code size in bytes Static Badge

SSVP is a lean, efficient status dashboard and uptime tracker for servers and services. It provides:

  • A clean, easy-to-understand interface for your users to understand uptime metrics.
  • A lightweight data collection platform supporting your existing back-end stack.
  • An easy-to-interact-with API for more advanced data analysis.
  • Support for tracking through a wide variety of methods, getting around any hurdles your stack creates.
  • (WIP) Alerts for developers and users to stay on top of your platform.

You can view a live version run by the project owner at https://status.amyip.net.

The main thing that differs SSVP from other status pages is that it's designed for users first. It's AGPLv3-licensed and will always be free-as-in-freedom software, unlike many alternatives. It's also designed to be run externally, open to users; you don't have to expose any data you don't have to, which can help prevent side-channeling attacks.

Installation

Full installation guide: https://ssvp.docs.amyip.net/installing.html

You need to initialize a database software - either mysql, postgres, or sqlite (can be done by the installer).

NixOS (23.11/unstable or later)

Read the NixOS section of the documentation.

RPM-based (Fedora, Alma, Rocky, CentOS, RHEL, etc)

Enterprise Linux distributions require you manually install some of the necessary dependencies:

dnf install python3-pip
pip3 install pyopenssl mysql-connector-python Flask gunicorn

To install, read the RPM section of the documentation. Sub-instructions also exist for SUSE, see the SUSE guide (you can skip the RPM building instructions) for assistance.

Other Distributions

  • Clone the repostiory:
git clone --depth=1 https://github.com/amyipdev/ssvp

Run the installer:

cd ssvp
./install.sh

Configuration

Full configuration guide: https://ssvp.docs.amyip.net/configuration.html

WSGI Server

If you're setting up a low-usage instance, you can use the dev/Werkezurg instance at srv/app.py. However, in production, we recommend using Gunicorn (srv/gunicorn.sh)

SSL

There are three options for SSL (when directly running):

  1. No SSL: set ssl to null
  2. Self-signed Certificate: set ssl to "adhoc" (unsupported on gunicorn)
  3. Existing Certificate: set ssl to ["/path/to/cert.pem", "/path/to/key.pem"]

To learn how to generate a widely-accepted certificate, visit EFF Certbot. You should select "other" when selecting the server software if running directly. Please note that we don't recommend using Certbot via snapd, check if your package manager has a native certbot package.

Ports

You should specify the port for SSVP to run on. If you don't specify a port, it'll run on 80 (non-ssl) or 443 (ssl).

We don't currently support an http-redirect-to-https implementation, use a reverse proxy for that functionality.

Contributing

Please view our contributer guide: https://ssvp.docs.amyip.net/contributing.html

Limitations and Future Features

A list of planned features is available here; if there's something you want included that isn't yet available, feel free to develop it and submit a PR!

Licensing

This project was made by Amy Parker/amyipdev.

Copyright 2023 Amy Parker, amy@amyip.net.

SSVP is licensed under the AGPLv3. You can view the license in the LICENSE file.

Inspiration

The project draws heavy inspiration from the design and setup of https://discordstatus.com, which runs on Atlassian Statuspage.

It also draws inspiration from Uptime Kuma. Uptime Kuma is great as an internal status page, and I would highly recommend it if the main intention of your status page is to be used internally instead of externally.

I wanted to work on a project which would give me a chance to do some web design, something I generally hate, and learn frameworks like Bootstrap and TypeScript.