Greetings Lemmings,

I realize that self-hosting for many is just a hobby. Something they do for fun. And the topic of today is usually a “not-so-fun” part of the IT industry.

Jump Scare Warning

Documentation

I have for so long just let my lab grow organically. And months down the road an issue pops up with a service, and I have no idea how I set something up, and may not have documented it. Whether that be comments inside of configuration files, or via other means.

I have gotten marginally better at documenting within the config files or code that I am writing. However, I don’t want just that as an option. So I spun myself up a Bookstack container.

I am slowly going through and creating what would amount to a full blown wiki for my setup. Doubly I can use this as part of my resume.

So I ask of you; what ways do you prefer to document? How do you keep yourself honest, and actually stick to it.

Edit: I created bash scripts that are run by a systemd service and timer. At least for my docker box.

  • hellmo_luciferrari@lemmy.zipOPEnglish
    2·
    5 hours ago

    I am taking a similar philosophical approach.

    I’m lazy too, so I am working on havinf most docker documentation automated…

    If I have to do it more than once, automated.

    • curbstickle@anarchist.nexusMEnglish
      1·
      3 hours ago

      For docker, use compose, and map it all to one spot with subdirectories, and also map the config for the service to a spot on your disk/nas.

      I put them in one spot on my NAS under services, so it looks like:

      /services/service_name/docker-compose.yml /services/service_name/config/

      Easy peasy lemon squeezy.

      • hellmo_luciferrari@lemmy.zipOPEnglish
        2·
        2 hours ago

        I have it setup similarly currently /root_compose_dir/stack_name/compose.yml

        But I’m taking a step further, ans using labels to generate README files. And will automate putting it into my bookstack