lsp/webserver: Add links to the index page (#1914)

charlieegan3 · web-flow · commit 1716e13b022a · 2026-03-30T17:43:27.000Z
In case a user ends up here not knowing what the page is.

Signed-off-by: Charlie Egan &lt;charlie_egan@apple.com&gt;
diff --git a/internal/web/index.html b/internal/web/index.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Regal Language Server</title>
+    <link rel="stylesheet" href="/style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>Regal Language Server</h1>
+        <p>
+            <a href="https://www.openpolicyagent.org/projects/regal">Regal Website</a>
+            - Project documentation
+        </p>
+        <p>
+            <a href="https://www.openpolicyagent.org/projects/regal/editor-support">Editor Support</a>
+            - Instructions to configure your editor for Regal
+        </p>
+        <p>
+            Start server with <code>REGAL_DEBUG</code> or <code>REGAL_DEBUG_PPROF</code> set to enable pprof endpoints
+        </p>
+    </div>
+</body>
+</html>
diff --git a/internal/web/server.go b/internal/web/server.go
@@ -2,6 +2,7 @@ package web
 
 import (
 	"context"
+	"embed"
 	"fmt"
 	"net"
 	"net/http"
@@ -14,6 +15,9 @@ import (
 	"github.com/open-policy-agent/regal/internal/util"
 )
 
+//go:embed index.html style.css
+var content embed.FS
+
 type Server struct {
 	log     *log.Logger
 	baseURL string
@@ -54,23 +58,7 @@ func (s *Server) Start(context.Context) {
 	}
 
 	// root handler for those looking for what the server is
-	mux.HandleFunc("/", func(w http.ResponseWriter, _ *http.Request) {
-		body := `
-<h1>Regal Language Server</h1>
-<ul>`
-
-		if pprofEndpoints {
-			body += `<li><a href="/debug/pprof/">pprof</a></li>
-<li><a href="/debug/statsviz">statsviz</a></li>
-</ul>`
-		} else {
-			body += `Start server with REGAL_DEBUG or REGAL_DEBUG_PPROF set to enable pprof endpoints`
-		}
-
-		if _, err := w.Write([]byte(body)); err != nil {
-			s.log.Message("failed to write response: %v", err)
-		}
-	})
+	mux.Handle("/", http.FileServerFS(content))
 
 	freePort, err := util.FreePort(5052, 5053, 5054)
 	if err != nil {
diff --git a/internal/web/style.css b/internal/web/style.css
@@ -0,0 +1,13 @@
+body {
+    font-family: system-ui, sans-serif;
+    line-height: 1.6;
+    color: #333;
+}
+.container {
+    max-width: 50rem;
+    margin: 0 auto;
+    padding: 1.25rem;
+}
+a {
+    color: #0066cc;
+}
