暂无描述

James f6fce9a47f Fixed laptop commands to make them uniform and added GB to all add drives commands 5 月之前
.github 2e82af6068 Git workflow added and generate_commands_markdown.sh made to be more platform agnostic 5 月之前
.idea 1154a08e04 Added blazor wasm demo 5 月之前
.run 6de3c52626 Refactored project 5 月之前
RackPeek 8561f0a2ed Fix config path resolution and improve CLI error messages 5 月之前
RackPeek.Domain 3e3ff3db29 Added homepage spacing 5 月之前
RackPeek.Web c7c1ec1513 Embedded docs into webapp 5 月之前
RackPeek.Web.Viewer c7c1ec1513 Embedded docs into webapp 5 月之前
Shared.Rcl f6fce9a47f Fixed laptop commands to make them uniform and added GB to all add drives commands 5 月之前
Tests 3228620447 Added Tags 5 月之前
config 2e82af6068 Git workflow added and generate_commands_markdown.sh made to be more platform agnostic 5 月之前
docs c7c1ec1513 Embedded docs into webapp 5 月之前
vhs ff983fd07a Fixed permissions issue in dockerfile 5 月之前
.DS_Store 64510509cc Highlight input field backgrounds 5 月之前
.dockerignore 8515ffa681 Added resource cards 6 月之前
.gitignore f1d0198417 Include config dir in wwwroot 5 月之前
LICENSE 600d2707cc Initial commit 6 月之前
README.md c7c1ec1513 Embedded docs into webapp 5 月之前
RackPeek.sln 1154a08e04 Added blazor wasm demo 5 月之前
generate-docs.sh c7c1ec1513 Embedded docs into webapp 5 月之前
notes.md c7c1ec1513 Embedded docs into webapp 5 月之前
servers.yaml 29997eebf2 Added command markdown script 6 月之前

README.md

RackPeek

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.

Join our Discord Live Demo Docker Hub

Brandon Lee recently posted an article on how / why to use RackPeek, if you're interested in the project make sure to check it out!

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

# 1. 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

# 2. Make the binary executable

chmod +x rackpeek

# 3. Move RackPeek into your PATH

sudo mv rackpeek /usr/local/bin/rpk

# 4. 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

# 5. Create the empty `config.yaml`

sudo touch /usr/local/bin/config/config.yaml

# 6. Test the installation

rpk --help

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.

Release Status

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

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