phunter/docker-compose
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add service READMEs and update homelab overview documentation

Browse Source 
This commit introduces dedicated `readme.md` files for individual services
within both the `Local Homelab` and `Oracle Homelab` directories.

Each service-specific README provides a brief description of the service,
its deployment method (Docker Compose), and references relevant
configuration files.

Additionally, the main `Local Homelab/readme.md` was updated to
enumerate all deployed services, describe the repository's structure,
and include pertinent links.

This change aims to significantly improve the clarity, organization,
and discoverability of information across the homelab setups.
This commit is contained in:
Preston Hunter
2025-12-25 13:46:35 -05:00
parent fc44fccc10
commit 2d5926c7c1
16 changed files with 215 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
Local Homelab/readme.md
View File

@@ -1,12 +1,33 @@
# Local Homelab Repository
This Git repository is exclusively for my Local Homelab setup.
This repository contains the configuration and deployment files for my **Local Homelab** setup.
## Contents
## 🚀 Services
This repository contains `docker-compose.yml` files for various services that I run in my homelab, including:
* **Home Assistant:** For smart home automation.
* **Monitoring Tools:** For keeping an eye on the health and performance of my systems.
* **Teslamate:** For logging data from my Tesla.
This lab runs the following services:
You can find the repository here: [Local Homelab Repository](https://git.prestonhunter.space/phunter/docker-compose/Local-Homelab)
* **AI Browser:** Web-based browser with AI capabilities.
* **[Home Assistant](https://www.home-assistant.io/):** For smart home automation.
* **Monitoring:** Tools for keeping an eye on the health and performance of my systems.
* **[Ollama](https://ollama.com/):** For running large language models locally.
* **Pangolin Transport:** Secure network routing and transport.
* **[Teslamate](https://github.com/adriankumpf/teslamate):** A self-hosted data logger for your Tesla.
## 📁 Structure
Each service is organized into its own directory containing a `compose.yml` (or `docker-compose.yml`) file and associated configuration:
```text
Local Homelab/
├── ai-browser/
├── homeassistant/
├── monitoring/
├── ollama/
├── pangolin-transport/
└── teslamate/
```
## 🔗 Links
* **Repository:** [Local Homelab Repository](https://git.prestonhunter.space/phunter/docker-compose/Local-Homelab)
* **Oracle Counterpart:** [Oracle Homelab](../Oracle%20Homelab)