Selfhosted

53179 readers

700 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:

Be civil: we're here to support and learn from one another. Insults won't be tolerated. Flame wars are frowned upon.
No spam posting.
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.
Don't duplicate the full text of your blog or github here. Just post the link for folks to click.
Submission headline should match the article title (don’t cherry-pick information from the title to fit your agenda).
No trolling.

Resources:

selfh.st Newsletter and index of selfhosted software and apps
awesome-selfhosted software
awesome-sysadmin resources
Self-Hosted Podcast from Jupiter Broadcasting

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

Questions? DM the mods!

founded 2 years ago

MODERATORS

HybridSarcasm@lemmy.world

HybridSarcasm@lemmy.hybridsarcasm.xyz

How should I properly document my homelab? (sopuli.xyz)

submitted 1 day ago* (last edited 1 day ago) by enchantedgoldapple@sopuli.xyz to c/selfhosted@lemmy.world

37 comments fedilink hide all child comments

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

[–] wersooth@lemmy.world 6 points 1 day ago* (last edited 1 day ago)

I have a repo for the infra files (compose files and terraform files just for playing). I store the docs in the same repo in MD files. As for the secrets, I'm using docker swarm, so I can store the needed passwords there. otherwise Vaulwarden is my go to, self hosted, lightweight password manager, compatible with bitwarden clients I'm a little paranoid if the note-service got db corruptions, I might loose too much info, so git is the way (personal opinion).

edit: add the related MD file next to the compose file, one folder per service, the source and the doc will be coupled in one place.