this post was submitted on 28 Jul 2023
99 points (94.6% liked)

Selfhosted

42619 readers
752 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
 

My home lab has a mild amount of complexity and I'd like practice some good habits about documenting it. Stuff like, what each system does, the OS, any notable software installed and, most importantly, any documentation around configuration or troubleshooting.

i.e. I have an internal SMTP relay that uses a letsencrypt SSL cert that I need to use the DNS challenge to renew. I've got the steps around that sitting in a Google Doc. I've got a couple more google docs like that.

I don't want to get super complicated but I'd like something a bit more structured than a folder full of google docs. I'd also like to pull it in-house.

Thanks

Edit: I appreciate all the feedback I've gotten on this post so far. There have been a lot of tools suggested and some great discussion about methods. This will probably be my weekend now.

(page 2) 46 comments
sorted by: hot top controversial new old
[–] ludw@lemmy.world 2 points 2 years ago

I'm using anytype.io, it's been pretty neat so far.

[–] btobolaski@threads.ruin.io 2 points 2 years ago

I use logseq to record any manual steps as well as any administrative actions that I take on a service. That being said, all of my homelan infrastructure is codified and stored in git in various ways so, it can be recreated as needed. There are very few manual steps in reconfiguring any of my services.

[–] Johnny5@lemm.ee 2 points 2 years ago* (last edited 2 years ago)

I run a local MediaWiki appliance from turnkeylinux, super easy to spin up in proxmox.

[–] kurt_propane@lemm.ee 2 points 2 years ago (2 children)

Why not push it up to GitHub? Then you also get a commit history to see your changes overtime.

Seems a lot of people are doing that.

[–] ZebraGoose@sh.itjust.works 1 points 2 years ago (2 children)

Wow that sounds convinient, where can i find a guide describing this? Has zero experience with git 😅

[–] cpo@lemmy.world 1 points 2 years ago

There are tons of tutorials around, but the basic gist is that you only use a couple of commands (or even a good frontend) in git, especially when it's a one (wo)man show.

I highly recommend it!

[–] kurt_propane@lemm.ee 1 points 2 years ago

Gotcha. Git is useful in so many way, but it can be confusing to learn. I don’t have a guide on hand but searching for ‘getting started with git’ will get you pretty far.

Another great way to do this that I just thought of this second is using Notion. It is in markdown.

[–] LunchEnjoyer@lemmy.world 1 points 2 years ago

I use the wonderful https://draw.io to sketch up my homelab and which device hosting what service. More fun when it's vidualized the way I want it 😊

[–] rentar42@kbin.social 1 points 2 years ago

I know that I would keep forgetting to update the docs, so my documentation are the ansible playbooks and docker-compose.yaml files that I use to set it all up.

That leaves anything that has to be done in some Ui undocumented, so I try to keep that to a minimum, which isn't always easy (I'm looking at you authentik!).

[–] NewDataEngineer@lemmy.world 1 points 2 years ago

I use trillium that gets backed up every hour to my pc.

I also do a lot of python development so my project ideas get written down there too.

I'm not a fan of code is documentation because what happens when you step away for a month and you need to figure something out? In trillium I have a search bar. What do you have in the code?

[–] ComptitiveSubset@lemmy.world 1 points 2 years ago (1 children)

I write down everything I built so for plus future plans in OneNote. This kind of defeats the purpose of self hosting but I want to keep a written copy complete off site in case if a complete loss. Plus I like OneNote. It’s actually a well designed product. Scripts, docker compose files and such are in GitHub.

I won't argue. I do think OneNote is a good product and I use it a lot for work.

[–] dr_robot@kbin.social 0 points 2 years ago (2 children)

I deploy as much as I possibly can via Ansible. Then the Ansible code serves as the documentation. I also keep the underlying OS the same on all machines to avoid different OS conventions. All my machines run Debian. The few things I cannot express in Ansible, such as network topology, I draw a diagram for in draw.io, but that's it.

Also, why not automate the certificate renewal with certbot? I have two reverse proxies and they renew their certificates themselves.

[–] ttk@feddit.de 0 points 2 years ago (1 children)
[–] Janis@feddit.de 0 points 2 years ago (1 children)

psssst. ansible is red hat.

red hat bad.

[–] SeeJayEmm@lemmy.procrastinati.org 0 points 2 years ago (1 children)

What alternative to you suggest?

[–] Janis@feddit.de 0 points 2 years ago (1 children)

i m all good with selfhosted wiki

I meant to replace Ansible automation. Pointing out it's RH is all well and good, but what's the alternative?

[–] SeeJayEmm@lemmy.procrastinati.org 0 points 2 years ago (1 children)

My reverse proxy can do automated renewal just fine. The SMTP relay requires a DNS challenge that is manual.

[–] dr_robot@kbin.social 2 points 2 years ago (1 children)

Why not have the reverse proxy also do renewal for the SMTP relay certificate and just rsync it to the relay? For a while I had one of my proxies do all the renewals and the other would rsync it.

It certainly wouldn't be because I've been doing it this way for so long that it never occurred to me. Nope. Certainly not that.


In fairness, I very recently switched from a cobbled together apache web server/rev proxy config I've been carrying along in some form for well over a decade (I remember converting the config to 2.4), to an NPM container. I had some initial trouble switching my certs over to NPM and haven't revisited that yet.

I'm in the middle of a major overhaul of my tech stack. Fixing certs is on my short list.

Thanks for pointing out where I was stuck in my ways.

[–] huojtkeg@lemmy.world 0 points 2 years ago (1 children)

The only thing I save in Google Drive are my notes just in case of disaster.

[–] nomadjoanne@lemmy.world 0 points 2 years ago (1 children)

Frankly the only thing I'd save in Google Docs are encrypted archives. Otherwise they'll profile the documents to send ads to you. But it is a good back up in case lightning strikes your home or something.

[–] huojtkeg@lemmy.world 1 points 2 years ago

I don't save all my documents. Just my self-hosting, servers infraestructure notes. I don't want to have the recovery intructions in the same machine I'm recovering

[–] haasie_237@kbin.social -1 points 2 years ago
load more comments
view more: ‹ prev next ›