Files
docker-compose/Oracle Homelab/readme.md
Preston Hunter 2d5926c7c1 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.
2025-12-25 13:46:35 -05:00

38 lines
1.7 KiB
Markdown

# Oracle Homelab Repository
This repository contains the configuration and deployment files for my **Oracle Cloud Infrastructure (OCI) Homelab**. Leveraging OCI's "Always Free" tier, this setup hosts a variety of services focused on identity management, monitoring, and utility.
## 🚀 Services
This lab runs the following services:
* **[Authentik](https://goauthentik.io/):** An open-source Identity Provider, managing authentication and authorization for the lab.
* **[Vaultwarden](https://github.com/dani-garcia/vaultwarden):** An unofficial Bitwarden compatible server written in Rust, providing secure password management.
* **[Swarmpit](https://swarmpit.io/):** A lightweight Docker Swarm management UI.
* **[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 Connector Primary:** Primary connector for secure network routing.
* **Pangolin Connector Secondary:** Secondary connector for secure network routing.
## 📁 Structure
Each service is organized into its own directory containing a `compose.yml` (or `docker-compose.yml`) file and associated configuration:
```text
Oracle Homelab/
├── authentik/
├── kasm/
├── openspeedtest/
├── pangolin-connector-primary/
├── pangolin-connector-secondary/
├── swarmpit/
├── thelounge/
└── vaultwarden/
```
## 🔗 Links
* **Repository:** [Oracle Homelab](https://git.prestonhunter.space/phunter/docker-compose/Oracle-Homelab)
* **Local Counterpart:** [Local Homelab](../Local%20Homelab)