exozyme/status
3
2
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Status Page in Go https://status.exozy.me
100 commits 2 branches 0 tags 473 KiB
Go 85.5%
CSS 7.9%
HTML 4.7%
Shell 1.9%
Go to file
Locria Cyber 55d28230cc
Add support for plain text and curl
2023-10-20 08:25:18 +00:00
core Delete old checkpoints 2023-10-08 09:54:36 +00:00
proto Add database stub 2023-10-03 12:45:33 +00:00
public Add message to footer <3 2023-10-01 11:48:34 -04:00
scanner minor cleanup 2023-10-04 09:58:14 +00:00
templates Display site properly on mobile 2023-10-10 23:55:40 +03: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
main.go Add support for plain text and curl 2023-10-20 08:25:18 +00:00
readme.md Add support for plain text and curl 2023-10-20 08:25:18 +00:00
util.go Add Matrix notification 2023-10-07 08:24:49 +00:00

readme.md

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 historic 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. @exozymebot76397:matrix.orgg
  • MAUTRIX_ACCESS_TOKEN: Matrix access token
  • MAUTRIX_ROOM_ID: Matrix room ID, optional, e.g. #room-name:matrix.org