Skip to content

m-de-graaff/rackstar

Repository files navigation

Rackstar

Cross-platform rack management system for Raspberry Pi and beyond.

Quick Install

Linux / macOS / Raspberry Pi

curl -sSL https://rackstar.markdegraaff.com/linux | bash

Windows (PowerShell)

irm https://rackstar.markdegraaff.com/windows | iex

Then run the setup wizard:

rackstar install

Supported Platforms

Platform Architecture Status
Windows x86_64 ✅ Supported
Linux x86_64 ✅ Supported
Linux ARM64 (aarch64) ✅ Supported
Linux ARM32 (armv7) ✅ Supported
macOS x86_64 ✅ Supported
macOS ARM64 (Apple Silicon) ✅ Supported
Raspberry Pi OS (64-bit) ARM64 ✅ Supported
Raspberry Pi OS (32-bit) ARM32 ✅ Supported
Raspberry Pi OS Lite ARM64/ARM32 ✅ Supported

Features

  • Single Binary Distribution - One CLI tool that handles everything
  • Cross-Platform - Works on Windows, Linux, macOS, and Raspberry Pi
  • Easy Installation - Simple curl command to install
  • Embedded Database - Uses SQLite by default, no setup required
  • WebSocket Support - Real-time updates
  • Modern Web UI - React-based dashboard

Architecture

┌─────────────────────────────────────────────────────────────┐
│                    Browser (React)                          │
│                      :8080                                  │
└─────────────────────────────────────────────────────────────┘
                              │
                    Rackstar CLI (serves static files)
                              │
        ┌─────────────────────┼─────────────────────┐
        │                     │                     │
        ▼                     ▼                     ▼
  ┌───────────┐        ┌───────────┐        ┌───────────┐
  │   Auth    │        │    API    │        │ WebSocket │
  │  :3001    │        │   :8000   │        │   :8000   │
  │  (Bun)    │        │ (Python)  │        │ (Python)  │
  └───────────┘        └───────────┘        └───────────┘
        │                     │                     │
        └─────────────────────┼─────────────────────┘
                              │
                              ▼
                    ┌───────────────┐
                    │   Database    │
                    │ (SQLite/PG)   │
                    └───────────────┘

Commands

rackstar install      # Run the setup wizard
rackstar start        # Start all services
rackstar stop         # Stop all services
rackstar restart      # Restart services
rackstar status       # Show service status
rackstar logs -f      # View logs (follow mode)
rackstar update       # Update to latest version
rackstar uninstall    # Remove Rackstar
rackstar info         # Show system information
rackstar config show  # View configuration

Documentation

See the docs/ folder for detailed documentation:

Development

Prerequisites

Setup

# Clone repository
git clone https://github.com/m-de-graaff/rackstar.git
cd rackstar

# Install dependencies
pnpm install

# Start database
pnpm db:up

# Start all services (development mode)
pnpm dev:all

Building

# Build CLI
cd cli && cargo build --release

# Build web UI
pnpm build

# Build standalone binaries (see .github/workflows/release.yml)

Project Structure

rackstar/
├── apps/
│   ├── api/           # Python FastAPI backend
│   ├── auth/          # TypeScript auth service
│   └── web/           # React frontend
├── cli/               # Rust CLI tool
├── docs/              # Documentation
├── deploy/            # Legacy deployment scripts
├── .github/
│   └── workflows/     # GitHub Actions for releases
├── install.sh         # Linux/macOS installer
├── install.ps1        # Windows installer
└── docker-compose.yml # Development database

License

MIT