No results
1
White Labeling
Codex edited this page 2026-05-27 10:03:26 -07:00
Table of Contents
White Labeling
The dashboard can be renamed and branded for any homelab, organization, or customer deployment.
Admin Fields
Open:
/admin
Use the White Label card to set:
| Field | Purpose | Example |
|---|---|---|
Header title |
Main dashboard name shown in the header and login screen. | Smith Family Lab |
Header subtitle |
Short description shown under the title. | Storage, media, network, and service health |
Header eyebrow |
Small text above the title. | Private infrastructure |
Logo URL |
Local or HTTPS image URL for the header mark. | /logo.svg |
Wiki base URL |
Base URL used by Wiki setup links in admin module cards. |
https://forgejo.example.com/YOUR-USER/homelab-dashboard/wiki |
After editing the fields, use the main settings Save settings button.
Logo Guidance
Recommended logo formats:
- SVG for crisp scaling.
- PNG when using a rendered mark or photo-style logo.
- Square or near-square image.
- Transparent background when possible.
Local logo paths are relative to the dashboard web root:
/logo.svg
/favicon.svg
/brands/custom.svg
HTTPS logo URLs are also accepted:
https://assets.example.com/dashboard-logo.svg
Only use trusted HTTPS image URLs. Avoid third-party image hosts that might change or log every dashboard visit.
Documentation Links
The Wiki base URL controls admin Wiki setup buttons. The dashboard app appends each module page name to that base URL.
Example:
Wiki base URL:
https://forgejo.example.com/alex/homelab-dashboard/wiki
Storage Health link:
https://forgejo.example.com/alex/homelab-dashboard/wiki/Storage-Health
If you fork the project, update this field to your fork's wiki or documentation site.
Deployment Notes
- Keep examples generic in public documentation.
- Use placeholder hostnames such as
proxmox.example.lanandregistry.example.com/YOUR-USER/homelab-dashboard. - Do not publish real hostnames, IP addresses, tokens, webhook URLs, SNMP community strings, serial numbers, or screenshots that expose private details.