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.

  • @[email protected]English
    2•11 months ago

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

    • ZebraGoose
      English
      2•11 months ago

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

      • @[email protected]English
        2•11 months 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!

      • @[email protected]English
        2•11 months 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.