Repository navigation
feat(Homedex): add Homedex, a read-only homelab inventory - #1068
Open
HarshShah0203 wants to merge 1 commit into
Open
HarshShah0203 wants to merge 1 commit into
HarshShah0203 wants to merge 1 commit into
Conversation
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Homedex, a read-only inventory for a homelab: it records the services, hosts, ports, routes, certificates, domains and changes it discovers from Docker, Proxmox VE, Tailscale and reverse proxies, and never starts, stops or reconfigures anything.
io.github.harshshah0203.homedexghcr.io/harshshah0203/homedex:0.2.1(amd64, arm64, arm/v7)/DATA/AppData/$AppID/dataWhat changed
Apps/Homedex/docker-compose.yml,icon.png,screenshot-1.pngtoscreenshot-5.png.category-list.json,recommend-list.jsonorfeatured-apps.json.Docker socket
Unlike the existing Docker-aware apps, Homedex never receives the raw socket. A
tecnativa/docker-socket-proxysidecar alone mounts it read only, allows GET on containers, images, networks, info and version, rejects every write (POST=0), sits on aninternal: truenetwork shared only with Homedex, and publishes no port. Homedex runs as UID 65532 with a read-only root filesystem and all capabilities dropped; a one-shothomedex-initcontainer (same pattern as OpenClaw) hands the data folder, created by CasaOS as root, to that user.Validation
validate_compose.py --app-path Homedex: success, 0 issues../scripts/build_dist.sh:OK io.github.harshshah0203.homedex, images pinned for amd64, arm64 and arm,min_memory80 MiB.docker compose up --waitlocally: all services healthy, admin password applied fromHOMEDEX_ADMIN_PASSWORD, Docker source throughtcp://docker-socket-proxy:2375validates, a write through the proxy is refused with 403.First-run notes
Set
HOMEDEX_ADMIN_PASSWORD(12 or more characters) in the install settings: Homedex stores only its Argon2id hash on first start and ignores it afterwards, so the Web UI is never open for whoever reaches it first. Then sign in and keep the prefilled Docker endpointtcp://docker-socket-proxy:2375.