- 1 Post
- 8 Comments
CapitalNumbers@lemm.eeto Selfhosted@lemmy.world•How do you document your Homelab?English1·8 hours agoi second this
i haven’t gotten around to looking into something like terraform/ansible yet, and currently rely on a series of setup.sh scripts and docker-compose files
i have a single master setup.sh at the root of my homelab which basically just outlines which scripts i need to run and in what order in order to get things back up and running from zero
i only user my README.md for any non scriptable stuff (such as external services i rely on such as cloudflare/vpn providers, etc)
CapitalNumbers@lemm.eeto Selfhosted@lemmy.world•How do you document your Homelab?English1·8 hours agoi mean charitably you could say that your code / architecture should be self documenting, versus having to rely on READMEs / wikis
in effect, if you change the code you are by definition also changing the documentation, since the file names/function names/hierarchy is clear and unambiguous
CapitalNumbers@lemm.eeto Selfhosted@lemmy.world•How do you document your Homelab?English1·8 hours agowhile security might be compromised if an attacker found your documentation, it could equally be compromised by having zero documentation
the easier it is for you to get things back up and running in the event of a data loss / corrupted hard drive / new machine / etc, the less likely you are to forget any crucial steps (eg setting up iptables or ufw)
CapitalNumbers@lemm.eeto Selfhosted@lemmy.world•How do you document your Homelab?English2·8 hours agothis is basically what i ended up doing to - glad to see my approach verified somewhat ha ha!
but yeah, in general whenever i make a change / add new service, i always try and add those steps to some sort of setup.sh / docker-compose
CapitalNumbers@lemm.eeto Selfhosted@lemmy.world•Best option for hosting ebooks and audiobooks?English1·8 hours agosupports podcasts too? what tool are you using to download those? and does ABS handle the sorting/meta data the same way it does for audio books?
maybe silly question but does tailscale tunnel operate in a similar fashion to a cloud flare tunnel? as in you can remotely access your internal service over https?
i have nginx proxy manager set up all as well, but haven’t worked out the SSL part yet, so all my internal docker services are still on http
out of interest, how did you set up https with npm?
Here’s my approach to documentation. It’s about habits as much as it’s about actually writing anything down:
Never setup anything important via naked terminal commands that you will forget you did
Always wrap important commands in some kind of “setup-xyz.sh” script and then run that script to see if your install worked.
If you need to make a change to your service, ensure you update your script and so it can be re-run without braking anything
Get into the habit of this and you are documenting as you go