Hey, I have to „draw“ or make notes of my selfhosting stuff. It runs so smooth that I sometimes really forget where a service is running or how to reach the web-Interface.
For sure I have a password- and link-manager, but I would like another independent note with the structure of my selfhosting.
Usually I use Joplin. Is there a plugin that shows me a kind of a map?
Or are there other apps - maybe wikis - that do it much easier/better than that?
How do you document your selfhosting?
I kinda just hold it all in my head and fix stuff when I notice it’s broken.
I still use Dia Diagram Editor for most things. I just wish it was still being updated.
Everything is deployed via ansible - including nameservices. So I already have the description of my infra in ansible, and rest is just a matter of writing scripts to pull it in a more readable form, and maybe add a few comment labels that also get extracted for easily forgettable admin URLs.
That sounds to complicate for me. I am still a beginner.
You should definitely figure out some infra as code system now while it’s manageable. Normally I’d recommend docker-compose as it’s very easy to learn and has a huge ecosystem, but since you’re using proxmox you might need to look at ansible like the other commenter said. Having IaC with git makes it so much easier to test new stuff, roll changes back, and all that good stuff, in addition to solving your original problem of forgetting what is running where.
Just find the simplest IaC solution possible. Unless you are gunning for a job in infrastructure you don’t need to go into kubernetes or terraform or anything like that, you just need something reproducible that you can easily understand and modify.
Unless you are gunning for a job in infrastructure you don’t need to go into kubernetes or terraform or anything like that,
Even then knowing when not to use k8s or similar things is often more valuable than having deep knowledge of those - a lot of stuff where I see k8s or similar stuff used doesn’t have the uptime requirements to warrant the complexity. If I have something that just should be up during working hours, and have reliable monitoring plus the ability to re-deploy it via ansible within 10 minutes if it goes poof maybe putting a few additional layers that can blow up in between isn’t the best idea.
I’ve used https://draw.io (apparently https://app.diagrams.net/ now) before for this exact purpose. I mapped out network, devices, and services.
Acronyms, initialisms, abbreviations, contractions, and other phrases which expand to something larger, that I’ve seen in this thread:
Fewer Letters More Letters Git Popular version control system, primarily for code NAS Network-Attached Storage NFS Network File System, a Unix-based file-sharing protocol known for performance and efficiency k8s Kubernetes container management package
4 acronyms in this thread; the most compressed thread commented on today has 15 acronyms.
[Thread #826 for this sub, first seen 23rd Jun 2024, 09:05] [FAQ] [Full list] [Contact] [Source code]
I use Netbox. It’s built by the team at Digital Ocean for managing their infrastructure. It can run in a docker container for easy management and compatibility. You can use as few or as many features as you need. There are a lot of native features and if there’s something missing you can extend functionality with plugins. I use the plugin netbox-topology-views to visualize my physical and logical network maps. This may be overkill for most home labs or home networks.
I like draw.io for process diagrams.
Draw.io is also totally open and is able to be integrated into many different tools - so chances are your tool of choice already has a plug in for it. For example, nextcloud does.
This is an intersting thread because I read through the lines the concerns that many have about losing parts of their homelab. Something I too am concerned about. While I have learnt to put my data securely on NAS with docker compose (I.e. docker image runs on VM while data i s stored on NAS and nas dataset is mounted via NFS on VM), in still not clear ho I save the config on the docker container. Basicalky, if I want to move that docker image to a new VM, how do I go about it?
As long as you have your config files and whatever data from the app (both should be mapped from the container to the host), just copy it to the new system and start your container.
I have all my config files on my nas, but too many of my apps run off dbs so I need to figure out a way to backup the local database folder so I can have the actual data on my nas as well as just the configs.
There’s no forgetting where I have something hosted. If I ssh to service.domain.tld I’m on the right server. My services are all in docker compose. All in a ~/docker/service folder, that contains all the volumes for the service. If there’s anything that needed doing, like setting up a docker network or adding a user in the cli, I have a readme file in the service’s root directory. If I need to remember literally anything about the server or service, there’s an appropriately named text file in the directory I would be in when I need to remember it.
If you just want a diagram or something, there are plenty of services online that will generate one in ASCII for you so you can make yourself a nice “network topology” readme to drop in your servers’ home directory.
This is the approach I try to also follow. It also makes the process of restoration from the backups or migrating to different server much easier.
Yeah, and I assume future me will be even dumber than present day me, so I try to make it really easy for him to find out what he needs to know.
Another good tip is to put timestamps and increase the length of your bash history. That way when I log in half a year from now I’ll know what I was up to.
