docs: update readme for Oracle Homelab
Revised the documentation to provide a clearer overview of the OCI Homelab setup. This update adds a detailed list of hosted services (Authentik, Vaultwarden, etc.), describes the directory structure, and includes relevant links for better project navigation.
This commit is contained in:
@@ -1,9 +1,36 @@
|
|||||||
# Oracle Homelab Repository
|
# Oracle Homelab Repository
|
||||||
|
|
||||||
This Git repository is exclusively for my Oracle Homelab setup, hosted on Oracle Cloud Infrastructure (OCI).
|
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.
|
||||||
|
|
||||||
## Contents
|
## 🚀 Services
|
||||||
|
|
||||||
This repository contains `docker-compose.yml` files for various services that I run in my Oracle Cloud homelab.
|
This lab runs the following services:
|
||||||
|
|
||||||
You can find the repository here: [Oracle Homelab Repository](https://git.prestonhunter.space/phunter/docker-compose/Oracle-Homelab)
|
* **[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 Connectors:** Primary and secondary connectors 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)
|
||||||
|
|||||||
Reference in New Issue
Block a user