Selfhosted

61003 readers

439 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

Be civil.
No spam.
Posts are to be related to self-hosting.
Don't duplicate the full text of your blog or readme if you're providing a link.
Submission headline should match the article title.
No trolling.
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.
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:

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 3 years ago

MODERATORS

curbstickle@anarchist.nexus

curbstickle_lw@lemmy.world

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

[–] luftruessel@feddit.org 5 points 6 days ago (3 children)

I know that feeling. Broke something in my reverse proxy and setting it back up again was painful. I know that certain things had needed special treatment, but how/what/where? Lost 🥲 Going to migrate to infrastructure as code for my documentation now

[–] pageflight@piefed.social 3 points 6 days ago

I learned Ansible for this purpose, so all the modified configs live in a git repo. I still get lazy and modify some things directly (looking at you Minecraft plugins) but a lot of it is pretty easy to set up via IaC.

[–] CallMeAl@piefed.zip 1 points 5 days ago

Going to migrate to infrastructure as code for my documentation

This is the way to do it. Using basic config management and never handjamming anything. I use the git commit log to make notes. That way, later I can check when a file was added or changed and see the explanation for it.

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

I am leaning that way too. Although I do want to maintain a wiki that I can host.

So I settled on using a script that runs as a service on a timer, and can beanually triggered to generate README.md files that get synced with my git repo of docker containers

This will be huge for me, as most of what I run are containers.

The next step will be using Bookstack's API to push these README.md files into books on my bookstack container.

I'll go a step further and setup automated exports of these documents.