diff --git a/README.md b/README.md index dca9b2e..a435fbc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# homelab-docker-compose -All of my docker-compose files for my homelab! +# ๐Ÿงช Homelab Docker Compose Files +Welcome to my Homelab! This repository contains all my `docker-compose.yml` files used to manage various self-hosted services running in my local environment. + +## ๐Ÿ“ Structure +Each service is organized into its own subdirectory with its own `docker-compose.yml` file and any required configuration files. +``` +/ +โ”œโ”€โ”€ portainer/ +โ”œโ”€โ”€ immich/ +โ””โ”€โ”€ ... +``` + +## โ–ถ๏ธ Usage +To start any service, navigate into its directory and use `docker compose`: + +```bash +cd +docker compose up -d +``` + +> **Note:** Make sure Docker and Docker Compose are installed on your system. + +## โš™๏ธ Configuration +Most services use `.env` files for sensitive values like passwords, ports, or volume paths. These files are **not** included in the repo. If available, youโ€™ll find an `.env.example` to help you get started. + +## ๐Ÿ“ฆ Requirements +- [Docker](https://docs.docker.com/get-docker/) +- [Docker Compose](https://docs.docker.com/compose/) + +## ๐Ÿ” Security +- This repo contains **no secrets or passwords**. +- `.env` files and other sensitive configs are excluded via `.gitignore`. +--- + +> ๐Ÿ“ฌ Questions or feedback? Open an issue or reach out! \ No newline at end of file