Dashboard

Simple Dashboard (<3MB RAM) written in Go.

Inspired stylistically by mafl - great project but I wanted something much simpler and smaller.

Stack

The tech stack is inpired by gatus - another reat project with a simple go configuration file approach to Uptime Monitoring.

• go Http Server
• Server-side rendered HTML (html/template)
  • Hand-written CSS with light/dark themes
  • Iconify Icons (loaded from the Iconify CDN at view time)

The same binary can render the dashboard to a single self-contained HTML file — see Static build.

Deployment

Container Deployed to Github Container Repository: ghcr.io/ben-burwood/dashboard

Docker Compose

  dashboard:
    image: ghcr.io/ben-burwood/dashboard:latest
    ports:
      - 8080:8080
    environment:
      - DASHBOARD_CONFIG_PATH=/config
    volumes:
      - ./config:/config:ro

Configuration

The Configuration for the Homepage is defined in the config/ Yaml Files (Configurations can be split into multiple files and will be merged).

Configuration

Field	Type	YAML Key	Description
Title	string	title	Title of the dashboard
Tags	[]string (tag.Tags)	tags	List of tags
Services	[]*Service	services	List of service objects
Favicon	string	favicon	Page icon (optional)

The favicon accepts an Iconify name (e.g. mdi:view-dashboard, served from the Iconify SVG API), or a URL / path / data: URI.

Tags

Custom Tags can be defined (see example). The color for each tag must be one of: primary, secondary, accent, info, success, warning, error, neutral.

Services

Field	Type	YAML Key	Description
Link	string	link	Service link (URL)
Icon	Icon	icon	Icon - iconify (name, color)
Title	string	title	Service title
Description	string	description	Service description (optional)
Group	Group	group	Service group (optional)
Tags	[]string	tags	List of tags (optional)

Static build

As an alternative to running the server, the same binary can render the dashboard to a single self-contained build/index.html. It's the exact same output the server serves (icons via the Iconify CDN, dark-mode toggle), so no server or runtime fetch is needed.

# config path comes from DASHBOARD_CONFIG_PATH, defaulting to config/config.yml
go run . -build                          # -> build/index.html
# choose the output file
go run . -build -out build/index.html