Launchpad

#################### ARCHIVED ####################

I moved over to a go-only approach (SPEED!) and created a new project:

https://github.com/flohoss/godash

#################### ARCHIVED ####################

A blazing fast start-page for your services written with Nuxt3 and Go.

https://hub.docker.com/r/unjxde/launchpad

Dark Mode

Light Mode

Lighthouse speed test

Emulated Moto G4 with Lighthouse 9.6.6, using headless chromium 102.0.5005.115:

How to use

Use the docker-compose to spin up the service. The Weather is fetched over a Current Weather Api Call with environment variables for the needed parameters. If you don't want to see the weather, do not provide a key as environment variable. Please refer to the available options as shown in the docker-compose example.

Example of the bookmarks.json

All Bookmarks are read from a file called bookmarks.json located inside the ./storage folder. The application will create a default file at startup and will automatically look for changes inside the file. Changes are printed in stdout when running with LOG_LEVEL=trace.

You can specify an icon of a bookmark either by using a link or by using the name of the file located inside the ./storage/icons folder that is mounted via the docker compose file. The name and related link can be provided as well.

[
  {
    "NAME": "Github",
    "ICON": "https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png",
    "URL": "https://github.com"
  },
  {
    "NAME": "Jenkins",
    "ICON": "jenkins.webp",
    "URL": "https://www.jenkins.io/"
  }
]

Available environment variables with default values

PORT = 4000
ALLOWED_HOSTS = "http://localhost:4000"
SWAGGER = false

LOG_LEVEL = "info"

LOCATION_LATITUDE = 48.780331609463815
LOCATION_LONGITUDE = 9.177968320179422
OPEN_WEATHER_KEY = ""
OPEN_WEATHER_UNITS = "metric"
OPEN_WEATHER_LANG = "en"

LIVE_SYSTEM = true

A docker-compose example:

version: '3.9'

services:

  launchpad:
    image: unjxde/launchpad:latest
    container_name: launchpad
    restart: unless-stopped
    environment:
      # https://docs.linuxserver.io/general/understanding-puid-and-pgid
      - PUID=1000
      - PGID=1000
      # can be multiple hosts, comma separated, no spaces
      - ALLOWED_HOSTS=https://home.example.com
      # available log-levels: trace,debug,info,warn,error,fatal,panic
      - LOG_LEVEL=info
      # create account here to get free key:
      # https://home.openweathermap.org/users/sign_up
      # remove to disable weather
      - OPEN_WEATHER_KEY=thisIsNoFunctioningKey
      # standard, metric or imperial
      - OPEN_WEATHER_UNITS=metric
      # https://openweathermap.org/current#multi
      - OPEN_WEATHER_LANG=en
      # location is needed for weather
      - LOCATION_LATITUDE=48.644929601442485
      - LOCATION_LONGITUDE=9.349618464869025
      # live system graph can be turned off
      - LIVE_SYSTEM=true
      # If you want to protect the dashboard with authentication
      # provide a password and a secret.
      # The secret will be randomly generated if not provided
      - AUTH_PASSWORD=SuperSecurePassword
      - AUTH_SECRET=SuperSecureSecret
    volumes:
      # to mount the bookmarks.json and the icons folder on the system
      - ./storage:/app/storage
    ports:
      - "127.0.0.1:4000:4000"