From 2d5926c7c15253729e51057a4bc28456d21a04ab Mon Sep 17 00:00:00 2001 From: Preston Hunter Date: Thu, 25 Dec 2025 13:46:35 -0500 Subject: [PATCH] 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. --- Local Homelab/ai-browser/readme.md | 13 +++++++ Local Homelab/homeassistant/readme.md | 13 +++++++ Local Homelab/monitoring/readme.md | 13 +++++++ Local Homelab/ollama/readme.md | 13 +++++++ Local Homelab/pangolin-transport/readme.md | 13 +++++++ Local Homelab/readme.md | 35 +++++++++++++++---- Local Homelab/teslamate/readme.md | 13 +++++++ Oracle Homelab/authentik/readme.md | 14 ++++++++ Oracle Homelab/kasm/readme.md | 13 +++++++ Oracle Homelab/openspeedtest/readme.md | 13 +++++++ .../pangolin-connector-primary/readme.md | 13 +++++++ .../pangolin-connector-secondary/readme.md | 13 +++++++ Oracle Homelab/readme.md | 3 +- Oracle Homelab/swarmpit/readme.md | 14 ++++++++ Oracle Homelab/thelounge/readme.md | 13 +++++++ Oracle Homelab/vaultwarden/readme.md | 14 ++++++++ 16 files changed, 215 insertions(+), 8 deletions(-) create mode 100644 Local Homelab/ai-browser/readme.md create mode 100644 Local Homelab/homeassistant/readme.md create mode 100644 Local Homelab/monitoring/readme.md create mode 100644 Local Homelab/ollama/readme.md create mode 100644 Local Homelab/pangolin-transport/readme.md create mode 100644 Local Homelab/teslamate/readme.md create mode 100644 Oracle Homelab/authentik/readme.md create mode 100644 Oracle Homelab/kasm/readme.md create mode 100644 Oracle Homelab/openspeedtest/readme.md create mode 100644 Oracle Homelab/pangolin-connector-primary/readme.md create mode 100644 Oracle Homelab/pangolin-connector-secondary/readme.md create mode 100644 Oracle Homelab/swarmpit/readme.md create mode 100644 Oracle Homelab/thelounge/readme.md create mode 100644 Oracle Homelab/vaultwarden/readme.md diff --git a/Local Homelab/ai-browser/readme.md b/Local Homelab/ai-browser/readme.md new file mode 100644 index 0000000..77d070c --- /dev/null +++ b/Local Homelab/ai-browser/readme.md @@ -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](../) diff --git a/Local Homelab/homeassistant/readme.md b/Local Homelab/homeassistant/readme.md new file mode 100644 index 0000000..9366065 --- /dev/null +++ b/Local Homelab/homeassistant/readme.md @@ -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](../) diff --git a/Local Homelab/monitoring/readme.md b/Local Homelab/monitoring/readme.md new file mode 100644 index 0000000..f534c38 --- /dev/null +++ b/Local Homelab/monitoring/readme.md @@ -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](../) diff --git a/Local Homelab/ollama/readme.md b/Local Homelab/ollama/readme.md new file mode 100644 index 0000000..0d10a62 --- /dev/null +++ b/Local Homelab/ollama/readme.md @@ -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](../) diff --git a/Local Homelab/pangolin-transport/readme.md b/Local Homelab/pangolin-transport/readme.md new file mode 100644 index 0000000..d4bfae3 --- /dev/null +++ b/Local Homelab/pangolin-transport/readme.md @@ -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](../) diff --git a/Local Homelab/readme.md b/Local Homelab/readme.md index 4413938..642a83a 100644 --- a/Local Homelab/readme.md +++ b/Local Homelab/readme.md @@ -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) diff --git a/Local Homelab/teslamate/readme.md b/Local Homelab/teslamate/readme.md new file mode 100644 index 0000000..f5cb263 --- /dev/null +++ b/Local Homelab/teslamate/readme.md @@ -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](../) diff --git a/Oracle Homelab/authentik/readme.md b/Oracle Homelab/authentik/readme.md new file mode 100644 index 0000000..25c487a --- /dev/null +++ b/Oracle Homelab/authentik/readme.md @@ -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](../) diff --git a/Oracle Homelab/kasm/readme.md b/Oracle Homelab/kasm/readme.md new file mode 100644 index 0000000..5dd7199 --- /dev/null +++ b/Oracle Homelab/kasm/readme.md @@ -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](../) diff --git a/Oracle Homelab/openspeedtest/readme.md b/Oracle Homelab/openspeedtest/readme.md new file mode 100644 index 0000000..6fc87c9 --- /dev/null +++ b/Oracle Homelab/openspeedtest/readme.md @@ -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](../) diff --git a/Oracle Homelab/pangolin-connector-primary/readme.md b/Oracle Homelab/pangolin-connector-primary/readme.md new file mode 100644 index 0000000..1c8a27c --- /dev/null +++ b/Oracle Homelab/pangolin-connector-primary/readme.md @@ -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](../) diff --git a/Oracle Homelab/pangolin-connector-secondary/readme.md b/Oracle Homelab/pangolin-connector-secondary/readme.md new file mode 100644 index 0000000..57e07af --- /dev/null +++ b/Oracle Homelab/pangolin-connector-secondary/readme.md @@ -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](../) diff --git a/Oracle Homelab/readme.md b/Oracle Homelab/readme.md index f8a31d9..3840132 100644 --- a/Oracle Homelab/readme.md +++ b/Oracle Homelab/readme.md @@ -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 diff --git a/Oracle Homelab/swarmpit/readme.md b/Oracle Homelab/swarmpit/readme.md new file mode 100644 index 0000000..2f0141f --- /dev/null +++ b/Oracle Homelab/swarmpit/readme.md @@ -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](../) diff --git a/Oracle Homelab/thelounge/readme.md b/Oracle Homelab/thelounge/readme.md new file mode 100644 index 0000000..32858fc --- /dev/null +++ b/Oracle Homelab/thelounge/readme.md @@ -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](../) diff --git a/Oracle Homelab/vaultwarden/readme.md b/Oracle Homelab/vaultwarden/readme.md new file mode 100644 index 0000000..b41a2e6 --- /dev/null +++ b/Oracle Homelab/vaultwarden/readme.md @@ -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](../)