Status Page in Go https://status.exozy.me
Go to file
2024-05-26 11:37:37 -05:00
core Global credentials for HTTP basic auth, can be overrided by per-service creds 2024-05-24 20:07:08 -05:00
proto Rearrange items in config.toml.in to match order in core/config.go 2024-05-24 20:10:02 -05:00
public HTTP basic auth, make website more configurable 2024-05-24 03:23:27 +00:00
scanner Global credentials for HTTP basic auth, can be overrided by per-service creds 2024-05-24 20:07:08 -05:00
templates Clean up a bit 2024-05-24 20:38:37 +00:00
.gitignore Clean up config loading code 2023-10-01 08:21:30 +00:00
dinit-service Add some sandboxing 2023-10-01 08:34:34 +00:00
go.mod Add support for plain text and curl 2023-10-20 08:25:18 +00:00
go.sum Add support for plain text and curl 2023-10-20 08:25:18 +00:00
LICENSE Add AGPL license 2024-05-24 03:24:26 +00:00
main.go Increase timeout to 5 seconds 2024-05-26 11:37:37 -05:00
readme.md fix typo 2024-05-24 19:47:12 +00:00
util.go Add Matrix notification 2023-10-07 08:24:49 +00:00

status

A status page written in Go. Join our Matrix room for development discussion.

TODO

Tech stack

  • HTTP Server - net/http
    • listen on unix socket PORT (if set)
  • Templating - {{mustache}}
  • spawn with dinit/systemd
  • Config file - load TOML config (1. /opt/status-config/config.toml 2. test config at proto/config.toml)
    • .socket_path (UNIX socket, string)
    • .service (array of services)
    • .matrix (Matrix-related settings, see below)
  • Auto deploy script (run as dinit service)

Check online methods

  • TCP Connect
  • HTTP 2xx
  • ICMP

Services

  • HTML page
    • Page Styling
    • show service type (tcp/http)
    • Increase constrast. Current RED/GREEN is contrast fail. Maybe don't show the border when service is up?
    • Bundle directory contents into executable in release mode. (not necessary)
    • show historical data
  • Status history, database note for integration: the dumb database code is in core/database.go. When integrating, you don't need to touch that code much.
    • store events
      • self boot up/shutdown
      • check service status every 5 minutes since boot
    • persist data on disk
    • clean up old checkpoints
  • Matrix notification
  • serves plain text to curl

Environment Variables

When config file is down, those variables will be made non-optional and load from config instead of envvar.

  • MAUTRIX_USER_ID: Matrix user ID, optional, e.g. @bot:exozy.me
  • MAUTRIX_ACCESS_TOKEN: Matrix access token
  • MAUTRIX_ROOM_ID: Matrix room ID, optional, e.g. #notifications:exozy.me