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.

  • johntash@eviltoast.org
    link
    fedilink
    English
    arrow-up
    5
    ·
    1 year ago

    I’m not very good at deciding on where to document things, so I have a mix of BookStack, Dokuwiki, and Obsidian currently.

    I really like Dokuwiki but I like the UI/UX of BookStack better so I’m working on a plugin to sync bookstack and obsidian. I’ll probably get rid of Dokuwiki after that.

    The main reason for syncing with obsidian is that I want documentation that isn’t stored on the thing it’s about, in case my servers completely die.

    In another thread, someone reminded me that TiddlyWiki still exists, it’s also a pretty cool little tool.