暂无描述

David Walshe 0e1a4e7eb4 Added spec for feature addition 1 月之前
.github ce4921752c Update default version in publish-docker.yaml 1 月之前
RackPeek 48761546ca Ignore ide / local files 1 月之前
RackPeek.Domain 777964589c Added v1 json schema 1 月之前
RackPeek.Web 9f9e4375ad Remove ARG APP_UID and set it as ENV 1 月之前
RackPeek.Web.Viewer 5dc546881b Ran cleanup 1 月之前
Shared.Rcl 777964589c Added v1 json schema 1 月之前
Tests 777964589c Added v1 json schema 1 月之前
Tests.E2e 6c4f294228 Added comma seperated tags 1 月之前
assets 11e5ac1fa4 Added readme banner 1 月之前
config 2e82af6068 Git workflow added and generate_commands_markdown.sh made to be more platform agnostic 1 月之前
docs 698eb77539 Added Justfile for developer productivity and dev-setup guide on required software/packages for development activities 1 月之前
openspec 0e1a4e7eb4 Added spec for feature addition 1 月之前
schemas 777964589c Added v1 json schema 1 月之前
vhs 48761546ca Ignore ide / local files 1 月之前
.dockerignore 8515ffa681 Added resource cards 2 月之前
.gitignore 48761546ca Ignore ide / local files 1 月之前
LICENSE 600d2707cc Initial commit 2 月之前
README.md ba8f089c12 Removed accidental addition from README.md 1 月之前
RackPeek.sln 2f2671241f Added E2E webui tests 1 月之前
generate-docs.sh 65a3916b0d Fixed links in md 1 月之前
justfile 698eb77539 Added Justfile for developer productivity and dev-setup guide on required software/packages for development activities 1 月之前

README.md

RackPeek demo

Join our Discord Live Demo Docker Hub

RackPeek is a lightweight, opinionated CLI tool / webui for documenting and managing home lab and small-scale IT infrastructure.

It helps you track hardware, services, networks, and their relationships in a clear, scriptable, and reusable way without enterprise bloat or proprietary lock-in or drowning in unnecessary metadata or process.

RackPeek is open source and community-driven. Code, docs, ideas, bug reports, and real-world usage feedback are all massively appreciated. If you run a home lab, you belong here.

RackPeek demo RackPeek demo

Running RackPeek with Docker

# Named volume
docker volume create rackpeek-config
docker run -d \
  --name rackpeek \
  -p 8080:8080 \
  -v rackpeek-config:/app/config \
  aptacode/rackpeek:latest

# Bind mount
docker run -d \
  --name rackpeek \
  -p 8080:8080 \
  -v $(pwd)/config:/app/config \
  aptacode/rackpeek:latest

# Note - RackPeek stores its state in YAML
config/
└── config.yaml

Or Docker compose

version: "3.9"

services:
  rackpeek:
    image: aptacode/rackpeek:latest
    container_name: rackpeek
    ports:
      - "8080:8080"
    volumes:
      - rackpeek-config:/app/config
    restart: unless-stopped

volumes:
  rackpeek-config:

docker compose up -d

Installing on Linux

# Download the RackPeek binary
wget https://github.com/Timmoth/RackPeek/releases/download/RackPeek-0.0.3/rackpeek_0_0_3_linux-x64 -O rackpeek

# Or with curl:
curl -L https://github.com/Timmoth/RackPeek/releases/download/RackPeek-0.0.3/rackpeek_0_0_3_linux-x64 -o rackpeek

# Make the binary executable
chmod +x rackpeek

# Move RackPeek into your PATH
sudo mv rackpeek /usr/local/bin/rpk

# Create the global config directory
# RackPeek expects a `config` folder **next to the binary**, so create it in `/usr/local/bin`:
sudo mkdir -p /usr/local/bin/config

# Create the empty `config.yaml`
sudo touch /usr/local/bin/config/config.yaml

# Test the installation
rpk --help

Release Status

[x] Ideation
[x] Development
[x] Alpha Release
[~] Beta Release
[ ] v1.0.0 Release

POST V1.0.0 Roadmap

  • Support for IoT and networked devices
  • Enhanced networking and port mapping
  • Git integration (version-controlled, shared configuration)
  • Diagramming tools
  • Ansible inventory generator

    The roadmap for the next wave of features is actively being discussed, please make your voice heard!

Contribution Guide

We are now gearing up for the full v1.0.0 release, so development focus is on stability / bug fixes / essential core missing features. Please raise any suggestions / bugs / feedback in the Github issues.

Questionnaire

We’re gathering feedback from homelabbers to validate direction and prioritize features.
Answer whichever questions stand out to you, your input directly shapes the project.

User Questionnaire

Core Values

Simplicity
RackPeek focuses on clarity and usefulness. Its scope is intentionally kept narrow to avoid unnecessary abstraction and feature creep.

Ease of Deployment
The tool exists to reduce operational complexity. Installation, upgrades, and day-to-day usage should be straightforward and low-friction.

Openness
RackPeek uses open, non-proprietary data formats. You fully own your data and should be free to easily inspect, migrate, or reuse it however you choose.

Community
Contributors of all experience levels are welcome. Knowledge sharing, mentorship, and collaboration are core to the project’s culture.

Privacy & Security
No telemetry, no ads, no tracking, and no artificial restrictions. What runs on your infrastructure stays on your infrastructure.

Dogfooding
RackPeek is built to solve real problems we actively have. If a feature isn’t useful in practice, it doesn’t belong.

Opinionated
The project is optimized for home labs and self-hosted environments, not enterprise CMDBs or corporate documentation workflows.

Development Docs