this post was submitted on 28 Jul 2023
138 points (95.4% liked)

Selfhosted

59935 readers
256 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.

  3. Posts here are to be centered around self-hosting. Please ensure it is clear in your post how it relates to self-hosting.

  4. Don't duplicate the full text of your blog or git here. Just post the link for folks to click.

  5. Submission headline should match the article title.

  6. No trolling.

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
138
What do you use to document your home lab? (lemmy.procrastinati.org)
submitted 2 years ago* (last edited 2 years ago) by SeeJayEmm@lemmy.procrastinati.org to c/selfhosted@lemmy.world
116 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
[–] rickdgray@lemmy.world 3 points 2 years ago (1 children)

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

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

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

[–] Deebster@lemmyrs.org 3 points 2 years ago* (last edited 2 years ago) (2 children)

I love Mermaid, although I don't think you can currently do network diagrams. I've seen Kroki recommended here for doing that, which supports Mermaid plus many similar markup-based diagrammers.

[Edit: added link and more info]

[–] shertson@lemmy.world 2 points 2 years ago

This is the first I've heard of Kroki. A quick glance at their site and wow! So many options for markup. I'll be trying this out for sure

[–] med@sh.itjust.works 2 points 2 years ago

I would not consider Mermaid complete enough for network diagramming. The very basics are possible, but try to describe anything more complicated throws off the placement and makes the pathing whacky.

Straight flow charts are the closest you can get to a network diagram, so if you try to draw a link that travels back up the chart, it breaks mermaid’s brain trying to figure out the order of decision points (network devices).

The allure of text based diagrams is so tantalizing - but if you need them to be functional, it’s not going to happen

There’s an issue tracking the need a new diagram type to handle it.