Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lento234/homelab
Personal homelab setup
https://github.com/lento234/homelab
ansible debian devops homelab raspberry-pi
Last synced: about 5 hours ago
JSON representation
Personal homelab setup
- Host: GitHub
- URL: https://github.com/lento234/homelab
- Owner: lento234
- License: mit
- Created: 2022-01-25T17:17:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T19:46:04.000Z (6 months ago)
- Last Synced: 2024-08-02T15:34:24.941Z (3 months ago)
- Topics: ansible, debian, devops, homelab, raspberry-pi
- Language: Jinja
- Homepage:
- Size: 820 KB
- Stars: 34
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](#license)
***`Ansible`-based personal homelab setup.***
## Description
The project contains a set of ansible playbooks use to setup (and manage) a
personal homelab infrastructure. The homelab runs on a Raspberry Pi 4 running
on Debian.
## Setup
1. Setup virtual environment using [uv](https://github.com/astral-sh/uv):
```bash
uv venv
source .venv/bin/activate
```
2. Install python dependencies (incl. ansible):
```bash
uv pip install -r requirement.txt
```
3. Use the `make` command runner to setup the homelab:
```bash
$ make
dry-run Dry-run default playbook
ping Ping all hosts
pre-commit Run pre-commit on all files
run Run default playbook run
vault-create Create the secret vault file vault
vault Edit the secret vault file vault
```
4. Add hosts into the `hosts.ini` file (example):
```
[homelab]
heimdall ansible_python_interpreter=/usr/libexec/platform-python
```
5. Modify group vars file `group_vars/all/vars.yml`
6. Create and edit vault secrets:
```bash
$ make vault-create
```
7. Run `dry-run` or `run` to deploy the infrastructure.
```bash
$ make dry-run
```
## Hosted services
**Server management**
* [x] [homer](https://github.com/bastienwirtz/homer) - A very simple static homepage for your server.
* [x] [portainer.io](https://docs.portainer.io/v/ce-2.11/) - A centralized service delivery platform for containerized apps.
* [x] [Watchtower](https://containrrr.dev/watchtower) - A container-based solution for automating Docker container base image updates.
* [ ] [Wireguard](https://github.com/linuxserver/docker-wireguard) - Self-hosted VPN (*optional:* or use alternative service, e.g. (OpenVPN)) or [Tailscale](https://tailscale.com/).
* [ ] [healthchecks](https://github.com/healthchecks/healthchecks) - A cron monitoring tool written in Python & Django.
* [ ] [rdiff](https://rdiff-backup.net/) - Reverse differential backup tool, over a network or locally (*or use similar ideas*).
**Monitoring**
* [x] [Glances](https://nicolargo.github.io/glances) - An *Eye* on your system.
* [x] Munin
**Media**
* [x] [plex media server](https://hub.docker.com/r/linuxserver/plex) - Organizes video, music and photos from personal media libraries.
* [x] [FreshRSS](https://www.freshrss.org/) - A free, self-hostable RSS feed aggregator.
**File storage & Sharing**
* [x] [nextcloud](https://github.com/nextcloud/server) - :cloud: cloud Nextcloud server, a safe home for all your data.
* [x] [photoprism](https://github.com/photoprism/photoprism) - Photos App powered by Go and Google TensorFlow :rainbow: :sparkles:.
* [ ] [vaultwarden](https://github.com/dani-garcia/vaultwarden) - Alternative implementation of the Bitwarden server.
**Automation**
* [x] [home assistant](https://github.com/khuedoan/homelab) - My self-hosting infrastructure, fully automated from empty disk to operating services.
* [ ] [grocy](https://github.com/linuxserver/docker-grocy) - Grocy is a web-based self-hosted groceries & household management solution for your home.
## Hardware / software stack
* [x] Raspberry Pi 4 Model B 8GB: [OKdo](https://www.okdo.com/p/okdo-raspberry-pi-4-8gb-model-b-starter-kit/)
* [x] OS: Debian bookworm (12)
* [x] Storage - (primary) Sandisk microSDXC 128GB (`/`, `ext4`)
* [x] Storage - (data) ZFS pool ~40 TB (`/mnt/store/`)
## References
### Homelab / Self-hosted
* [geerlingguy/ansible-for-devops](https://github.com/geerlingguy/ansible-for-devops) - Ansible for DevOps examples.
* [davestephens/ansible-nas](https://github.com/davestephens/ansible-nas) - Build a full-featured home server or NAS replacement with an Ubuntu box and this playbook.
* [notthebee/infra](https://github.com/notthebee/infra) - IaC for my Linux/Unix machines
* [awesome-selfhosted/awesome-selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted) - A list of Free Software network services and web applications which can be hosted on your own servers
* [khuedoan/homelab](https://github.com/khuedoan/homelab) - Small and power efficient self-hosting infrastructure. Fully automated from empty disk to operating services
* [abhilesh/self-hosted_docker_setups](https://github.com/abhilesh/self-hosted_docker_setups) - A collection of my docker-compose files used to setup self-hosted services on Raspberry Pi 4 running 64-bit Raspberry Pi OS
### Home automation / IOT
* [HQarroum/awesome-iot](https://github.com/HQarroum/awesome-iot) - :robot: A curated list of awesome Internet of Things projects and resources.
* [pfalcon/awesome-smarthome](https://github.com/pfalcon/awesome-smarthome) - Curated list of awesome SmartHome/Home Automation things (open and leaving users in control)
* [microsoft/IoT-For-Beginners](https://github.com/microsoft/IoT-For-Beginners) - 12 Weeks, 24 Lessons, IoT for All!
* [frenck/awesome-home-assistant](https://github.com/frenck/awesome-home-assistant) - A curated list of amazingly awesome Home Assistant resources.
* [Hypfer/Valetudo](https://github.com/Hypfer/Valetudo) - Cloud-free control webinterface for vacuum robots