https://github.com/x1unix/springboard

Simple and configurable services dashboard
https://github.com/x1unix/springboard

dashboard-page homelab raspberry-pi

Last synced: about 1 year ago
JSON representation

Simple and configurable services dashboard

• Host: GitHub
• URL: https://github.com/x1unix/springboard
• Owner: x1unix
• Created: 2022-05-07T08:21:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T03:32:39.000Z (about 2 years ago)
• Last Synced: 2025-02-06T07:34:42.176Z (over 1 year ago)
• Topics: dashboard-page, homelab, raspberry-pi
• Language: TypeScript
• Homepage:
• Size: 1.85 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Springboard

[![Docker Hub](https://img.shields.io/docker/pulls/x1unix/springboard.svg)](https://hub.docker.com/r/x1unix/springboard)

[![Docker Hub](https://img.shields.io/docker/v/x1unix/springboard.svg?sort=semver)](https://hub.docker.com/r/x1unix/springboard)

[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

Simple and configurable services dashboard for server and IoT infrastructure.

![preview](docs/screenshot.png)

## Usage

### Docker

Project provides a simple HTTP server based on [static-file-server](https://hub.docker.com/r/halverneus/static-file-server/) Docker image.

Just create a new config from [example](public/config/config.example.json) and mount it as `/var/www/config/config.json`.

```yaml

services:

  dashboard:

    image: x1unix/springboard # or ghcr.io/x1unix/springboard/springboard:latest

    volumes:

      ./config:/var/www/config

    ports:

      - '8080:8080'

```

### Standalone

This project can be easily served as a directory via any other HTTP server.

* Grab the latest release from [here](https://github.com/x1unix/springboard/releases/latest).

* Copy and edit default config file (see [docs](docs/config.md)).

* Serve the folder contents using your favorite web server (e.g. Nginx).