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.

  • NewDataEngineer@lemmy.worldEnglish
    4·
    1 year 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?

    • Human Crayon@sh.itjust.worksEnglish
      1·
      1 year ago

      I will second trilium. I use their sync server in a VM (which is backed up with the rest of my VM’s so its easy to drop back down should something happen). The app appeals to me, even after using Obisdian for the past 6 months (i’m a fan of markdown as well).