feat: add webpage on / to give context for Alexandria

Signed-off-by: Xe Iaso <me@xeiaso.net>

Author: Xe

README.md

@@ -42,5 +42,5 @@ Please note that opting out will limit Techaro's ability to support your
 installation of Anubis or other software.
 
 For users, you can opt out by running Anubis with the
-`ANUBIS_LOG_SUBMISSION=i-want-to-make-it-harder-to-get-help` environment
+`ALEXANDRIA_LOG_SUBMISSION=i-want-to-make-it-harder-to-get-help` environment
 variable set.

SECURITY.md

@@ -4,10 +4,14 @@ Techaro follows the [Semver 2.0 scheme](https://semver.org/).
 
 ## Supported Versions
 
-Techaro strives to support the two most recent minor versions of published software. Patches to those versions will be published as patch releases.
+Techaro strives to support the two most recent minor versions of published
+software. Patches to those versions will be published as patch releases.
 
 ## Reporting a Vulnerability
 
-Email security@techaro.lol with details on the vulnerability and reproduction steps. You will get a response as soon as possible.
+Email security@techaro.lol with details on the vulnerability and reproduction
+steps. You will get a response as soon as possible.
 
-Please take care to send your email as a mixed plaintext and HTML message. Messages with GPG signatures or that are plaintext only may be blocked by the spam filter.
+Please take care to send your email as a mixed plaintext and HTML message.
+Messages with GPG signatures or that are plaintext only may be blocked by the
+spam filter.

alexandria/writerwrapper_enabled.go

@@ -20,7 +20,7 @@ func Writer(kind string, logID string, next io.Writer) *WriterWrapper {
 		AddSource: true,
 	}))
 
-	if val, ok := os.LookupEnv("ANUBIS_LOG_SUBMISSION"); ok && val == loggingDifficultyMessage {
+	if val, ok := os.LookupEnv("ALEXANDRIA_LOG_SUBMISSION"); ok && val == loggingDifficultyMessage {
 		lg.Info("Logging to Alexandria has been disabled by the environment variable ANUBIS_LOG_SUBMISSION. Your ability to recieve support is limited.", "docs", "https://anubis.techaro.lol/docs/admin/alexandria")
 		return &WriterWrapper{
 			next: next,

cmd/alexandria/main.go

@@ -8,6 +8,9 @@ import (
 	"log/slog"
 	"net/http"
 
+	"github.com/TecharoHQ/alexandria/web"
+	"github.com/TecharoHQ/alexandria/web/xess"
+	"github.com/a-h/templ"
 	"github.com/aws/aws-sdk-go-v2/config"
 	"github.com/aws/aws-sdk-go-v2/service/s3"
 	"github.com/facebookgo/flagenv"
@@ -47,6 +50,17 @@ func main() {
 
 	mux.Handle("PUT /upload/{kind}/{logID}", http.MaxBytesHandler(http.HandlerFunc(s.Upload), maxLogSize))
 
+	xess.Mount(mux)
+
+	mux.HandleFunc("/{$}", func(w http.ResponseWriter, r *http.Request) {
+		templ.Handler(
+			xess.Simple("Not found: "+r.URL.Path, web.Index()),
+			templ.WithStatus(http.StatusTeapot),
+		)
+	})
+
+	mux.HandleFunc("/", xess.NotFound)
+
 	slog.Info("listening over HTTP", "bind", *bind)
 	log.Fatal(http.ListenAndServe(*bind, mux))
 }

cmd/alexandria/server.go

@@ -23,6 +23,8 @@ type Server struct {
 	s3c *s3.Client
 }
 
+func (s *Server) Index(w http.ResponseWriter, r *http.Request) {}
+
 func (s *Server) Upload(w http.ResponseWriter, r *http.Request) {
 	kind := r.PathValue("kind")
 	logID := r.PathValue("logID")

package.json

@@ -4,7 +4,7 @@
   "description": "Techaro's log aggregation pipeline",
   "main": "index.js",
   "scripts": {
-    "dev": "npm run generate && go run ./cmd/web",
+    "dev": "npm run generate && go run ./cmd/alexandria",
     "format": "npx prettier -w . && go tool goimports -w .",
     "generate": "go generate ./... && npm run format",
     "prepare": "husky",

web/generate.go

@@ -0,0 +1,3 @@
+package web
+
+//go:generate go tool templ generate

web/web.templ

@@ -0,0 +1,8 @@
+package web
+
+templ Index() {
+	<p>This is a log aggregation service for Anubis and other services like it. Any logs submitted to this service are security stored for one week (seven days) and then deleted. These logs are used in support or other such tasks.</p>
+	<h2>How do I opt out of this?</h2>
+	<p>For package maintainers, you can opt out by building Anubis with the <code>limitedsupportability</code> <a href="https://www.digitalocean.com/community/tutorials/customizing-go-binaries-with-build-tags">build tag</a>. Please note that opting out will limit the ability to support your installation of Anubis or other software.</p>
+	<p>For users, you can opt out by running Anubis with the <code>ALEXANDRIA_LOG_SUBMISSION=i-want-to-make-it-harder-to-get-help</code> environment variable set.</p>
+}

web/web_templ.go

@@ -0,0 +1 @@
+node_modules