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,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](../)