Skip to content

Add Favicon to web pages #2858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kradalby merged 2 commits into from
Nov 12, 2025
+42 −7
Merged

Add Favicon to web pages #2858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac4e1e3
Added favicon to webpages
Nov 11, 2025
85d73e7
Merge branch 'main' into swagger-favicon
kradalby Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### Changes

- Add favicon to webpages
[#2858](https://github.com/juanfont/headscale/pull/2858)
- Reclaim IPs from the IP allocator when nodes are deleted
[#2831](https://github.com/juanfont/headscale/pull/2831)

Expand Down Expand Up @@ -138,7 +140,6 @@ the code base over time and make it more correct and efficient.
starting/ending with hyphen are rejected

### Changes

- **Database schema migration improvements for SQLite**
[#2617](https://github.com/juanfont/headscale/pull/2617)
- **IMPORTANT: Backup your SQLite database before upgrading**
Expand Down
4 changes: 2 additions & 2 deletions hscontrol/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,8 +476,8 @@ func (h *Headscale) createRouter(grpcMux *grpcRuntime.ServeMux) *mux.Router {
apiRouter := router.PathPrefix("/api").Subrouter()
apiRouter.Use(h.httpAuthenticationMiddleware)
apiRouter.PathPrefix("/v1/").HandlerFunc(grpcMux.ServeHTTP)

router.PathPrefix("/").HandlerFunc(notFoundHandler)
router.HandleFunc("/favicon.ico", FaviconHandler)
router.PathPrefix("/").HandlerFunc(BlankHandler)

return router
}
Expand Down
Binary file added hscontrol/assets/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 30 additions & 3 deletions hscontrol/handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
package hscontrol

import (
"bytes"
_ "embed"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"strconv"
"strings"
"time"

"github.com/chasefleming/elem-go/styles"
"github.com/gorilla/mux"
Expand Down Expand Up @@ -98,6 +101,7 @@ func (h *Headscale) handleVerifyRequest(

// Check if any node has the requested NodeKey
var nodeKeyFound bool

for _, node := range nodes.All() {
if node.NodeKey() == derpAdmitClientRequest.NodePublic {
nodeKeyFound = true
Expand Down Expand Up @@ -128,6 +132,7 @@ func (h *Headscale) VerifyHandler(
httpError(writer, err)
return
}

writer.Header().Set("Content-Type", "application/json")
}

Expand All @@ -149,6 +154,7 @@ func (h *Headscale) KeyHandler(
resp := tailcfg.OverTLSPublicKeyResponse{
PublicKey: h.noisePrivateKey.Public(),
}

writer.Header().Set("Content-Type", "application/json")
json.NewEncoder(writer).Encode(resp)

Expand All @@ -171,13 +177,14 @@ func (h *Headscale) HealthHandler(

if err != nil {
writer.WriteHeader(http.StatusInternalServerError)

res.Status = "fail"
}

json.NewEncoder(writer).Encode(res)
}

if err := h.state.PingDB(req.Context()); err != nil {
err := h.state.PingDB(req.Context())
if err != nil {
respond(err)

return
Expand All @@ -192,6 +199,7 @@ func (h *Headscale) RobotsHandler(
) {
writer.Header().Set("Content-Type", "text/plain")
writer.WriteHeader(http.StatusOK)

_, err := writer.Write([]byte("User-agent: *\nDisallow: /"))
if err != nil {
log.Error().
Expand All @@ -211,7 +219,8 @@ func (h *Headscale) VersionHandler(
writer.WriteHeader(http.StatusOK)

versionInfo := types.GetVersionInfo()
if err := json.NewEncoder(writer).Encode(versionInfo); err != nil {
err := json.NewEncoder(writer).Encode(versionInfo)
if err != nil {
log.Error().
Caller().
Err(err).
Expand Down Expand Up @@ -268,3 +277,21 @@ func (a *AuthProviderWeb) RegisterHandler(
writer.WriteHeader(http.StatusOK)
writer.Write([]byte(templates.RegisterWeb(registrationId).Render()))
}

//go:embed assets/favicon.png
var favicon []byte

func FaviconHandler(writer http.ResponseWriter, req *http.Request) {
writer.Header().Set("Content-Type", "image/png")
http.ServeContent(writer, req, "favicon.ico", time.Unix(0, 0), bytes.NewReader(favicon))
}

// Returns a blank page with favicon linked.
func BlankHandler(writer http.ResponseWriter, res *http.Request) {
writer.Header().Set("Content-Type", "text/html; charset=utf-8")
io.WriteString(writer, `
<!doctype html><html><head>
<link rel="icon" href="/favicon.ico">
</head><body></body></html>
`)
}
4 changes: 4 additions & 0 deletions hscontrol/templates/general.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ func HtmlStructure(head, body *elem.Element) *elem.Element {
attrs.Name: "viewport",
attrs.Content: "width=device-width, initial-scale=1.0",
}),
elem.Link(attrs.Props{
attrs.Rel: "icon",
attrs.Href: "/favicon.ico",
}),
head,
),
body,
Expand Down
5 changes: 4 additions & 1 deletion swagger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func SwaggerUI(
<html>
<head>
<link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@3/swagger-ui.css">

<link rel="icon" href="/favicon.ico">
<script src="https://unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js"></script>
<script src="https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js" charset="UTF-8"></script>
</head>
Expand Down Expand Up @@ -57,6 +57,7 @@ func SwaggerUI(

writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusInternalServerError)

_, err := writer.Write([]byte("Could not render Swagger"))
if err != nil {
log.Error().
Expand All @@ -70,6 +71,7 @@ func SwaggerUI(

writer.Header().Set("Content-Type", "text/html; charset=utf-8")
writer.WriteHeader(http.StatusOK)

_, err := writer.Write(payload.Bytes())
if err != nil {
log.Error().
Expand All @@ -85,6 +87,7 @@ func SwaggerAPIv1(
) {
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)

if _, err := writer.Write(apiV1JSON); err != nil {
log.Error().
Caller().
Expand Down
Loading