this post was submitted on 02 Apr 2026
70 points (98.6% liked)

Selfhosted

60533 readers
480 users here now

A place to share alternatives to popular online services that can be self-hosted without giving up privacy or locking you into a service you don't control.

Rules:

Detailed Rules Post

  1. Be civil.

  2. No spam.

  3. Posts are to be related to self-hosting.

  4. Don't duplicate the full text of your blog or readme if you're providing a link.

  5. Submission headline should match the article title.

  6. No trolling.

  7. Promotion posts require active participation, with an account that is at least 30 days old. F/LOSS without a paywall has exceptions, with requirements. See the rules link for details.

  8. AI-related discussions and AI-involved promotional posts have additional requirements for tagging, as noted in Rule 7 and the AI & Promotional Post Expanded Rules post.

Resources:

Any issues on the community? Report it using the report flag.

Questions? DM the mods!

founded 3 years ago
MODERATORS
ruud@lemmy.world
Loki@lemmy.world
CannaVet@lemmy.world
devve@lemmy.world
ayyy@sh.itjust.works
curbstickle@anarchist.nexus
curbstickle_lw@lemmy.world
70
How do you document your setup? (piefed.social)
submitted 3 months ago* (last edited 3 months ago) by BruisedMoose@piefed.social to c/selfhosted@lemmy.world
88 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
[–] shrek_is_love@lemmy.ml 9 points 3 months ago (1 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
[–] captcha_incorrect@lemmy.world 1 points 3 months ago (1 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.

[–] shrek_is_love@lemmy.ml 0 points 3 months ago (1 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)

[–] captcha_incorrect@lemmy.world 1 points 3 months ago (1 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.

[–] shrek_is_love@lemmy.ml 1 points 3 months ago

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)