this post was submitted on 21 Jul 2026
42 points (97.7% liked)

Selfhosted

61003 readers
419 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:

Detailed Rules Post

  1. Be civil.

  2. No spam.

  3. Posts are to be related to self-hosting.

  4. Don't duplicate the full text of your blog or readme if you're providing a link.

  5. Submission headline should match the article title.

  6. No trolling.

  7. Promotion posts require active participation, with an account that is at least 30 days old. F/LOSS without a paywall has exceptions, with requirements. See the rules link for details. Tags [CBH] or [AIP] are required, see the links in Rule 8 for details.

  8. AI-related discussions and AI-involved promotional posts have additional requirements for tagging, as noted in Rule 7 and the AI & Promotional Post Expanded Rules post, and find example disclosures here.

Resources:

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

Questions? DM the mods!

founded 3 years ago
MODERATORS
ruud@lemmy.world
Loki@lemmy.world
CannaVet@lemmy.world
devve@lemmy.world
ayyy@sh.itjust.works
curbstickle@anarchist.nexus
curbstickle_lw@lemmy.world
42
Homelab Documentation (lemmy.zip)
submitted 1 week ago* (last edited 6 days ago) by hellmo_luciferrari@lemmy.zip to c/selfhosted@lemmy.world
27 comments fedilink hide all child comments
 

Greetings Lemmings,

I realize that self-hosting for many is just a hobby. Something they do for fun. And the topic of today is usually a "not-so-fun" part of the IT industry.

Jump Scare Warning

Documentation

I have for so long just let my lab grow organically. And months down the road an issue pops up with a service, and I have no idea how I set something up, and may not have documented it. Whether that be comments inside of configuration files, or via other means.

I have gotten marginally better at documenting within the config files or code that I am writing. However, I don't want just that as an option. So I spun myself up a Bookstack container.

I am slowly going through and creating what would amount to a full blown wiki for my setup. Doubly I can use this as part of my resume.

So I ask of you; what ways do you prefer to document? How do you keep yourself honest, and actually stick to it.

Edit: I created bash scripts that are run by a systemd service and timer. At least for my docker box.

you are viewing a single comment's thread
view the rest of the comments
[–] hellmo_luciferrari@lemmy.zip 2 points 6 days ago (1 children)

I am taking a similar philosophical approach.

I'm lazy too, so I am working on havinf most docker documentation automated...

If I have to do it more than once, automated.

[–] curbstickle@anarchist.nexus 1 points 6 days ago (1 children)

For docker, use compose, and map it all to one spot with subdirectories, and also map the config for the service to a spot on your disk/nas.

I put them in one spot on my NAS under services, so it looks like:

/services/service_name/docker-compose.yml /services/service_name/config/

Easy peasy lemon squeezy.

[–] hellmo_luciferrari@lemmy.zip 2 points 6 days ago

I have it setup similarly currently /root_compose_dir/stack_name/compose.yml

But I'm taking a step further, ans using labels to generate README files. And will automate putting it into my bookstack