|
|
@@ -1,8 +1,7 @@
|
|
|
# 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.
|
|
|
+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.
|
|
|
@@ -10,23 +9,16 @@ If you run a home lab, you belong here.
|
|
|
|
|
|
[](https://discord.gg/egXRPdesee) [](https://timmoth.github.io/RackPeek/) [](https://hub.docker.com/r/aptacode/rackpeek/)
|
|
|
|
|
|
-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.
|
|
|
-
|
|
|
-[](https://forms.gle/KKA4bqfGAeRYvGxT6)
|
|
|
+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!
|
|
|
|
|
|
-## Philosophy
|
|
|
-RackPeek treats infrastructure documentation as living reference data rather than static paperwork.
|
|
|
+[](https://www.virtualizationhowto.com/2026/02/im-documenting-my-entire-home-lab-as-code-with-rackpeek/)
|
|
|
|
|
|
-You should be able to document your environment as you build it, explore relationships between systems, and quickly understand how everything fits together, without drowning in unnecessary metadata or process.
|
|
|
|
|
|
[](./rpk-demo.gif)
|
|
|
[](./rpk-webui-demo.gif)
|
|
|
|
|
|
-
|
|
|
## Running RackPeek with Docker
|
|
|
```text
|
|
|
-
|
|
|
# Named volume
|
|
|
docker volume create rackpeek-config
|
|
|
docker run -d \
|
|
|
@@ -134,6 +126,11 @@ The project is optimized for home labs and self-hosted environments, not enterpr
|
|
|
[ ] 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.
|
|
|
+
|
|
|
+[](https://forms.gle/KKA4bqfGAeRYvGxT6)
|
|
|
+
|
|
|
## Command Tree
|
|
|
|
|
|
- [rpk](Commands.md#rpk)
|