GoDash

goDash is a simple, customizable dashboard written in Go. It provides an overview of weather information, system status, and bookmarks with icons and links.

Table of Contents

• GoDash
• Table of Contents
  • Features
  • Screenshots
  • Configuration
    • Legend
  • Docker
    • run command
    • compose file
  • Example bookmarks.yaml
  • ✨ Star History
  • License
  • Contributing

Features

• Displays current weather information
• Shows system status and resource usage
• Provides quick access to bookmarks with icons and links
• Lightweight and easy to deploy with Docker

Screenshots

Configuration

goDash is configured using environment variables. Below is an example .env file:

TZ=Europe/Berlin
TITLE=My Dashboard
PUBLIC_URL=https://mydashboard.example.com
PORT=4000
LOCATION_LATITUDE=48.7803
LOCATION_LONGITUDE=9.1780
WEATHER_KEY=your_openweather_api_key
WEATHER_UNITS=metric
WEATHER_LANG=en
WEATHER_DIGITS=false

Legend

• TZ - Time zone (e.g., Europe/Berlin)
• TITLE - Title of the dashboard
• PUBLIC_URL - Publicly accessible URL
• PORT - Port on which the service runs
• LOCATION_LATITUDE / LOCATION_LONGITUDE - Coordinates for weather data
• WEATHER_KEY - API key for weather service
• WEATHER_UNITS - Units for weather (metric/imperial)
• WEATHER_LANG - Language for weather information
• WEATHER_DIGITS - Display digits in weather data (true/false)

Docker

run command

docker run -d \
  --name godash \
  --restart always \
  --env-file .env \
  -v ./storage:/app/storage \
  ghcr.io/flohoss/godash:latest

compose file

services:
  godash:
    restart: always
    image: ghcr.io/flohoss/godash:latest
    container_name: godash
    env_file:
      - ./.env
    volumes:
      - ./storage:/app/storage

Example bookmarks.yaml

The page is configured by a simple file. Icons can be stored in a folder called icons or downloaded from https://selfh.st/icons/ with the prefix sh/.

links:
  - category: "Code"
    entries:
      - name: "Github"
        url: "https://github.com"

applications:
  - category: "Code"
    entries:
    - name: "GitHub"
      icon: "sh/github"
      ignore_dark: true # does not use the light icon even though it exists in dark mode
      url: "https://github.com"
    - name: "Home Assistant"
      icon: "sh/home-assistant"
      url: "https://www.home-assistant.io/"`

✨ Star History

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Feel free to open issues or submit pull requests to improve goDash!