this post was submitted on 26 Nov 2025
106 points (97.3% liked)

Selfhosted

53285 readers
1240 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules:

  1. Be civil: we're here to support and learn from one another. Insults won't be tolerated. Flame wars are frowned upon.

  2. No spam posting.

  3. Posts have to be centered around self-hosting. There are other communities for discussing hardware or home computing. If it's not obvious why your post topic revolves around selfhosting, please include details to make it clear.

  4. Don't duplicate the full text of your blog or github here. Just post the link for folks to click.

  5. Submission headline should match the article title (don’t cherry-pick information from the title to fit your agenda).

  6. No trolling.

Resources:

Any issues on the community? Report it using the report flag.

Questions? DM the mods!

founded 2 years ago
MODERATORS
 

Reading earlier comments in this community made me consider documenting the workings of my homelab to some extent, ie. docker configuration, credentials, ports and links of my services. I've tried to make it consistent and organised but it still feels half baked and insufficient. Everyone suggests documenting everything you do in your homelab but don't state how. Since I've hardly had experience running my own server, I would really appreciate observing the blueprint of some other fellow selfhoster for copying or taking inspiration from rather than considering documentation to be 'left as an exercise for the reader'.

Edit: I already have a note-taking solution with me. What I wish to ask is to know what needs to be documented and what the structure of the documentation should be to accommodate the information.

you are viewing a single comment's thread
view the rest of the comments
[–] dbtng@eviltoast.org 3 points 6 days ago* (last edited 6 days ago) (4 children)

I'm not real clear what exactly you need to document.
Infrastructure documentation starts with an IPAM.
A good IPAM can help you document all kinds of stuff.

I use NetBox.
https://github.com/netbox-community/netbox?tab=readme-ov-file#getting-started

I'm running it as a Docker container on a Linux VM.
I just looked at their latest screenshots, and it appears they've done quite a bit with it since I stood up my copy.
It does even more now. I'll have to upgrade.

[–] philpo@feddit.org 2 points 5 days ago (3 children)

Yeah,Netbox is also my main solution, combined with forgejo repo.

Works very well.

[–] dbtng@eviltoast.org 1 points 10 hours ago (2 children)

Netbox is a hell of a package, of which I've essentially only touched the IPAM, and I don't even use it programmatically. I just use the web console to keep track of 4 subnets and about 50 IPs.

It's got a whole virtualization section that I haven't touched, although that would make my device mapping more sensible. I just treat em like they are all real, and only map the physical nics on the hypervisor hosts.

I do keep text notes in Netbox entries, but that's sort of a backup. If its something I'm likely to need to know, I'll have a note in Proxmox. Usually login links for apps hosted there and the like. And of course I've got a folder full of text files with all my deepest secrets.

[–] philpo@feddit.org 2 points 4 hours ago (1 children)

Netbox,especially when combinded with Plugins is so incredibly good and might,that's it's almost funny how good it is. What I do Plugin wise:

  • Documents: not implemented yet by me,but one could store manuals,etc. directly within netbox.

  • Lifecycle and Inventory: While it's not as good as snipe-it (tbh, inventory is imho one of the worst plugins) it does the job for my small deployment

  • Slurp it to scan automatically

  • QR Code for obvious reasons

  • Floorplan as well

Of course that sounds overkill for a small deployment, but I simply forget too many things after a few months otherwise and it's something my family (wife is in IT and far more qualified than me) would need if something happens to me,so a proper documentation would be essential for that as well.

[–] dbtng@eviltoast.org 2 points 4 hours ago* (last edited 4 hours ago)

Alright already! I'll work on my upgrade.
I'm wondering if I should just build a new docker and then migrate the data instead of upgrading in place. I bet that's the easier thing to do in the end. Sounds safer too. I got backups and all, but ...