112
How do you document your setup? (piefed.social)
submitted 7 months ago by to c/selfhosted@lemmy.world
86 comments fedilink hide all child comments
 

Like soup-to-nuts. I know I need to document what I'm doing and I've started several times, but then I never go back and make updates. I don't know if it's just the ADHD or if I'm just going about it or thinking about it in the wrong way.

So I'm curious about:

  • what you use for your documentation
  • how you organize it
  • what information you include
  • how you work documentation into your changes/tinkering flow

Edit: Dang, folks! You all have given me a lot to read through, think about, and explore. Thank you!

you are viewing a single comment's thread
view the rest of the comments
[–] 14 points 7 months ago (5 children)

All my computers (including servers) share the same NixOS Flake. So my documentation consists of:

  1. The Nix code itself
  2. The commit messages for each change I make
  3. Inline comments in the Nix code
  4. A few readme.md files to explain the contents of certain directories
  • permalink
  • fedilink
  • source
  • hideshow 5 child comments
    •
  • [–] 1 point 7 months ago (4 children)

    In only have one server with NixOS. I don’t use flakes, just plain nix files. It still works great as documentation.

    The only thing it is missing is why something is setup in a certain way.

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 4 child comments
    •
  • [–] 2 points 7 months ago (3 children)

    Do you use git? That basically forces you to do some documentation as you go. Multi-line commit messages are often helpful too. (When I first learned git, I only committed using git commit -m which is a bit restrictive in terms of how much you can fit in commit messages)

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 3 child comments
    •
  • [–] 1 point 7 months ago (2 children)

    Where do you push to? I have some secrets in my nix files (passwords). While I will get around to move them away from my nix files soon^TM^, I don't want to push those to a public repo.

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 2 child comments
    •
  • [–] 1 point 7 months ago (1 child)

    I currently push to a private GitHub repository (planning on moving to a self-hosted Forgejo instance soon).

    Although making my nix configuration public would be safe anyway since I use sops-nix which encrypts all my passwords in the repo using a key derived from my SSH key. During nixos-rebuild it decrypts them and puts them each in their own text file at /run/secrets, with permissions set so you need sudo to view them. (The permissions can be tweaked as needed)

    It was a pain in the neck to get started with initially (like NixOS itself), but it was very much worth it. (Basically a necessity since putting secrets even in a private repo is considered bad practice)

  • permalink
  • fedilink
  • source
  • parent
  • hideshow 1 child comment
    •
  • [–] 1 point 7 months ago

    I was considering putting the secrets somewhere not in /etc/nixos/ and just point to them. Then I could push my nix files without worry. My plan was to use my other server as a remote with just git and ssh, but that server is not responding and is ~6 by car away from me (I don't own a car). It will be traveling here soon so I can configure it and send it back though.

    Thanks for the link to sops-nix, I will check it out. As you said, NixOS is great when you have it running. I can't see myself going back to debian now.

  • permalink
  • fedilink
  • source
  • parent