a web server that will check BirdsiteLIVE instances and report back their status

Go to file

Paul Wilde f661a71fb3 Update 'instances.json'		2022-12-21 11:59:05 +00:00
public	added offline reason note	2022-12-09 09:41:18 +00:00
src	added offline reason note	2022-12-09 09:41:18 +00:00
.gitignore	added gitignore	2022-11-08 12:21:16 +00:00
bsl-checks.service	added systemd service	2022-11-08 12:42:18 +00:00
bsl_checks.nimble	working async	2022-11-12 12:41:19 +00:00
instances.json	Update 'instances.json'	2022-12-21 11:59:05 +00:00
license.md	added license	2022-11-08 12:17:50 +00:00
nim.cfg	first commit for full web app	2022-11-08 12:13:11 +00:00
readme.md	Update 'readme.md'	2022-11-23 12:27:43 +00:00
todo.md	add todos	2022-11-12 14:07:07 +00:00

readme.md

BSL Checks

A web service to display details of known BirdsiteLIVE instances.

Features

A Basic table of known BSL instances showing their url, owner, and saturation
It will check each instance every 15 minutes and report back the information - new saturation, if it's online, etc.
Ownership details are as follows:
- bsl_url - your BirdsiteLIVE URL
- owner - your name (ideally your Fediverse/Mastodon username (first part))
- fedi_url - your fediverse home url i.e. fosstodon.org, mstdn.social, etc.
- if the owner field is not entered, then the web service will get the contact email from the instance /nodeinfo/2.0.json output
written in Nim _{... (a fact, not a feature... see Features of anything written in Rust or Go to realise why this is here)}

Usage

This is designed to be simply run on any web server (with a reverse proxy to port 5000 and SSL)
Simply clone the repo and run

nimble run

Want your instance listed?

If you run an BirdsiteLIVE instance and want it listed in this database, please create an issue in this repo (or a pull request with an adjusted "instances.json" if you prefer)

Acknowledgements

@kev - for Simple.css - the main layout of the page
@birdsiteLIVE - for creating BirdsiteLIVE in the first place
All those who run their own BirdsiteLIVE instance for the community
Nim - a wonderful programming language