Skip to content

javidahmed64592/pi-dashboard

Repository files navigation

Python FastAPI Next.js CI Build Docs Docker License: MIT

Pi Dashboard

A FastAPI-based dashboard for monitoring on a Raspberry Pi.

Table of Contents

Prerequisites

  • Docker and Docker Compose installed
  • Linux system

Quick Start

Installation

Download the latest release from GitHub Releases.

Configuration

Rename .env.example to .env and edit it to configure the server.

  • HOST: Server host address (default: localhost)
  • PORT: Server port (default: 443)
  • API_TOKEN_HASH: Leave blank to auto-generate on first run, or provide your own token hash

Managing the Container

# Start the container
docker compose up -d

# Stop the container
docker compose down

# Update to the latest version
docker compose pull && docker compose up -d

# View the logs
docker compose logs -f pi-dashboard

Note: You may need to add your user to the Docker group and log out/in for permission changes to take effect:

sudo usermod -aG docker ${USER}

License

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

About

A FastAPI-based Raspberry Pi dashboard.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors