Lab Dash

This is an open-source user interface designed to be your internally/externally hosted homepage for your homelab/server.

Features

Lab Dash features a customizable grid layout where you can add various widgets:

• Links to your tools/services
• System information
• Service health checks
• Custom widgets and more

Customization

You can easily customize your dashboard by:

• Dragging and reordering widgets
• Changing the background image
• Adding custom search providers
• Importing/exporting configurations

Privacy & Data Control

You have complete control over your data and dashboard configuration.

• All data is stored locally on your own server
• Only administrator accounts can make changes
• Configurations can be easily backed up and restored

Installation

This only requires docker to be installed. Install Docker. Run using docker compose

---
services:
  lab-dash:
      container_name: lab-dash
      image: ghcr.io/anthonygress/lab-dash:latest
      privileged: true
      ports:
        - 2022:2022
      environment:
        - SECRET=YOUR_SECRET_KEY # any random string for jwt encryption
      volumes:
        - /sys:/sys:ro
        - /docker/lab-dash/config:/config
        - /docker/lab-dash/uploads:/app/public/uploads
        - /var/run/docker.sock:/var/run/docker.sock
      restart: unless-stopped
      labels:
        - "com.centurylinklabs.watchtower.enable=true"

Usage

Lab Dash can aslo be accessed from any web browser via http://localhost:2022 or 192.168.x.x:2022 which should be your servers local IP address or yout hosted url www.your-homepage.com.

Lab Dash can aslo be installed as an app on your computer/phone as a PWA (Progressive Web App):

• Using Google Chrome on Mac/Windows/Android/Linux
• Using Safari on iOS/iPad OS via the share menu > add to homscreen

Important

You should assign a static IP address for you server so any LAN/WAN device can access the Lab Dash instance.

Simply copy/download the docker-compose.yml or add it to an existing docker-compose file.

Running Docker compose file

docker compose up -d

This docker container will restart automatically after reboots unless it was manually stopped. This is designed to be run on your hosting server.

Stopping this docker container

1. Navigate to the directory that this docker compose file is in
2. Run: docker compose down

Local Development

npm install
npm run dev

Updating

Portainer

• Navigate to stacks
• Click on the lab-dash stack
• Click Editor tab at the top
• Click Update the stack
• Enable Re-pull image and redploy toggle
• Click Update

Docker CLI:

• cd /directory_of_compose_yaml
• docker compose down
• docker compose pull
• docker compose up -d

Disclaimer

This code is provided for informational and educational purposes only. I am not associated with any of the services/applications mentioned in this project.