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

Selfhosted

39937 readers
358 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 1 year ago
MODERATORS
ruud@lemmy.world
Loki@lemmy.world
CannaVet@lemmy.world
devve@lemmy.world
HybridSarcasm@lemmy.world
HybridSarcasm@lemmy.hybridsarcasm.xyz
99
What do you use to document your home lab? (lemmy.procrastinati.org)
submitted 1 year ago* (last edited 1 year ago) by SeeJayEmm@lemmy.procrastinati.org to c/selfhosted@lemmy.world
119 comments fedilink hide all child comments
 

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.

you are viewing a single comment's thread
view the rest of the comments
[–] stardustsystem@lemmy.world 21 points 1 year ago (2 children)

I've been using Obsidian for a lot of other purposes for a couple years now, so I was comfortable adding my documentation into my existing vault there. I made a couple templates that I fill out for any hardware/software/networking equipment.

Since the app's selling point is storing all your notes in plain text I wouldn't put anything security-related in there without some encrypted container. I use KeePass for that part, and keep the file it generates in the same folder as Obsidian so I can link to it within notes. Click the link in the note, KeePass opens the vault and asks for its password.

[–] rickdgray@lemmy.world 3 points 1 year ago (1 children)

I use obsidian too. It supports mermaid too so you can make your network diagram with it.

[–] SeeJayEmm@lemmy.procrastinati.org 1 points 1 year ago (1 children)

This is the 2nd ref I've seen to mermaid. I need to check that out.

[–] Deebster@lemmyrs.org 1 points 1 year ago

I love Mermaid, although I don't think you can currently do network diagrams. I've seen Kroki recommended here for doing that, which I believe is the same idea (mark-up to image) but has some extra capabilities.

[–] Gutless2615@ttrpg.network 2 points 1 year ago (1 children)

Mind sharing your template?

[–] stardustsystem@lemmy.world 7 points 1 year ago (1 children)

Sure.

I left everything in, so no doubt there's stuff in there specific to my vault you won't need like metadata - adjust these to your needs or use them as a starting point for something new. There's no network device template, I usually use the hardware one and just delete the irrelevant bits.