Containerized Homelab

This project provides a collection of Docker-compose files and configurations for running various services in a home lab environment.

Prerequisites

• Root access
• Time
• Patience
• Server running Ubuntu Server 22.04.3 LTS¹

Installation

• Clone this repository:

$ git clone https://github.com/wbreiler/homelab-docker.git

• Navigate to the project directory:

$ cd homelab-docker

• Customize the files in /containers²

• Run the setup script, and follow the prompts:

$ sh scripts/setup.sh

• If you wish to only run a specific container³, or don't want to install Cockpit⁴:

$ cd containers

$ docker compose -f [compose file] up -d

Services

Below is a few of the services that are contained in containers/

• dashboard.yml is a dashboard for all of the services, so you don't have to remember all the IPs and ports. GitHub
• gitea.yml is a locally hosted Git instance, similar to GitHub or GitLab. GitHub Website
• uptimekuma.yml is a self-hosted uptime monitor, with support for Discord, Slack, and SMS notifications. GitHub

Contributing

Contributions are welcome! Please fork this repository and submit a pull request with your changes.

License

This project is licensed under the MIT License.

Notes

¹: setup.sh is written with Debian-based distros in mind. Therefore, it should work with Debian, Ubuntu, and their variants. If you wish to create a PR or fork with support for other distros, go for it!
²: Some of the docker-compose files in ./containers assume that there's a /mnt/dockerdata directory. If you either don't have that directory, or it's under a different location/name, update the file(s) accordingly.
³: If you wish to run multiple containers, you have to pass them each as their own -f [FileName.yml] option, otherwise Docker Compose will error out.
⁴: Right now, if you select "no" on any of the installation prompts in setup.sh, it closes the script out. If you're aware of a way to make it just skip that installer and move on, create a PR!