Free · Open source · MIT
Install in one line.
Paste this into the Terminal on your Mac or Linux machine. Safe to run again: it keeps your settings and only fills in what is missing.
curl -fsSL https://raw.githubusercontent.com/theappfoundryco/personal-homelab-server/main/get.sh | bash
Prefer to look first? Read the code, or clone it and run
./install.sh yourself.
Requirements
What you'll need.
-
A Mac or a Linux machine
macOS on Apple silicon or Intel, or a common Linux (Ubuntu, Debian, Fedora, Arch). Windows through WSL2 is planned.
-
Docker
If it is missing, the installer sets it up for you and says what it is doing.
-
About 5 GB free
More if you add local AI: a model needs another 3 to 20 GB.
Installing
Three steps, then you're in.
- 01
Run the one line
It downloads the project with git into ~/personal-homelab-server, so updates work later.
- 02
Answer a few questions
Your name and time zone. Required pieces are installed for you; extras are offered as a choice.
- 03
Open the dashboard
Your browser opens it at the end. The setup wizard picks up from there.
Updating
One command, with an undo.
homelab update It shows what changed and asks first. Then it takes a snapshot, moves to the new version, checks it is healthy, and goes back to the old one on its own if anything fails. Your settings and data are never touched.
Stable (the default) follows releases. Edge follows every change as it lands:
homelab update --channel edge Just looking? homelab update --check tells you if there is something new and changes nothing.
Removing
Leaves cleanly.
homelab uninstall Stops and removes the containers. Your data stays in ~/.homelab in case you come back. It shows the full list before it removes anything.
homelab uninstall --purge Also deletes your data and the Homebrew packages it installed. Take a homelab backup first if you might want it later.
Everyday
The homelab command.
homelab status What is running, and anything that needs your attention.
homelab doctor Checks the whole setup and tells you how to fix what it finds.
homelab backup A snapshot of your data. homelab restore puts one back.
homelab logs What the assistant has been doing, for when something looks off.
Help
Stuck, or have an idea?
Run homelab doctor first. If that does not fix it, open an issue with what it printed. Remove anything personal before you post.