docs: Add service READMEs and update homelab overview documentation

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:
2025-12-25 13:46:35 -05:00
parent fc44fccc10
commit 2d5926c7c1
16 changed files with 215 additions and 8 deletions

View File

@@ -0,0 +1,13 @@
# AI Browser
Web-based browser with AI capabilities.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

View File

@@ -0,0 +1,13 @@
# Home Assistant
[Home Assistant](https://www.home-assistant.io/) is an open-source home automation platform that puts local control and privacy first.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `docker-compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

View File

@@ -0,0 +1,13 @@
# Monitoring
Tools for keeping an eye on the health and performance of my systems.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `docker-compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

View File

@@ -0,0 +1,13 @@
# Ollama
[Ollama](https://ollama.com/) allows you to run open-source large language models, such as Llama 3, locally.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

View File

@@ -0,0 +1,13 @@
# Pangolin Transport
Secure network routing and transport.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

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)

View File

@@ -0,0 +1,13 @@
# Teslamate
[Teslamate](https://github.com/adriankumpf/teslamate) is a self-hosted data logger for your Tesla.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `docker-compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Local Homelab](../)

View File

@@ -0,0 +1,14 @@
# Authentik
[Authentik](https://goauthentik.io/) is an open-source Identity Provider, managing authentication and authorization for the lab.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
- `compose/.env`: Environment variables.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,13 @@
# Kasm
[Kasm Workspaces](https://www.kasmweb.com/) is a container streaming platform for delivering browser-based workloads to the edge.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yaml`: Docker Compose configuration.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,13 @@
# OpenSpeedTest
[OpenSpeedTest](https://openspeedtest.com/) is a self-hosted HTML5 network speed test server.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yaml`: Docker Compose configuration.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,13 @@
# Pangolin Connector Primary
Primary connector for secure network routing.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,13 @@
# Pangolin Connector Secondary
Secondary connector for secure network routing.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yml`: Docker Compose configuration.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -12,7 +12,8 @@ This lab runs the following services:
* **[TheLounge](https://thelounge.chat/):** A modern, self-hosted web IRC client.
* **[OpenSpeedTest](https://openspeedtest.com/):** A self-hosted HTML5 network speed test server.
* **[Kasm](https://www.kasmweb.com/):** A container streaming platform for delivering browser-based workloads to the edge.
* **Pangolin Connectors:** Primary and secondary connectors for secure network routing.
* **Pangolin Connector Primary:** Primary connector for secure network routing.
* **Pangolin Connector Secondary:** Secondary connector for secure network routing.
## 📁 Structure

View File

@@ -0,0 +1,14 @@
# Swarmpit
[Swarmpit](https://swarmpit.io/) is a lightweight Docker Swarm management UI.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/docker-compose.yml`: Docker Compose configuration.
- `compose/swarmpit/README.md`: Original Swarmpit README.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,13 @@
# TheLounge
[TheLounge](https://thelounge.chat/) is a modern, self-hosted web IRC client.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yaml`: Docker Compose configuration.
## 🔗 Links
- [Oracle Homelab](../)

View File

@@ -0,0 +1,14 @@
# Vaultwarden
[Vaultwarden](https://github.com/dani-garcia/vaultwarden) is an unofficial Bitwarden compatible server written in Rust, providing secure password management.
## 🚀 Deployment
This service is deployed using Docker Compose.
### Files
- `compose/compose.yaml`: Docker Compose configuration.
- `compose/.env`: Environment variables.
## 🔗 Links
- [Oracle Homelab](../)