README.md

Obiente Cloud Documentation

Welcome to the Obiente Cloud documentation! This comprehensive guide will help you understand, deploy, and operate Obiente Cloud.

What is Obiente Cloud?

Obiente Cloud is a Platform-as-a-Service (PaaS) that allows you to deploy and manage applications across distributed infrastructure, similar to Vercel. Whether you're self-hosting at home or running a production cluster, Obiente Cloud makes it easy to deploy and scale your applications.

Quick Links

🚀 Getting Started

• Installation - Install Obiente Cloud
• Quick Start Guide - Get up and running in minutes
• Development Setup - Set up for local development

🏗️ Architecture

• Overview - System architecture overview
• Components - Detailed component descriptions (coming soon)
• Deployment Model - How deployments work (coming soon)

🚢 Deployment

• Deployment Methods - Overview of deployment options
• Docker Compose - Simple local deployment (coming soon)
• Docker Swarm - Distributed deployment
• High Availability - HA production setup (coming soon)

🏠 Self-Hosting

• Self-Hosting Guide - Introduction to self-hosting

📚 Guides

• Authentication - Setting up authentication with Zitadel
• Routing & Domains - Configuring domains and routing
• VPS Provisioning - Provision and manage VPS instances on Proxmox
• Proxmox SSH Setup - Configure SSH access for cloud-init snippets
• VPS Gateway Setup - Set up gateway service for DHCP and SSH proxying
• Monitoring - Setting up monitoring and alerts (coming soon)
• Troubleshooting - Common issues and solutions

📖 Reference

• Environment Variables - Complete environment variable reference
• Reference Index - API and CLI docs (coming soon)

Documentation Structure

This documentation is organized into several sections:

docs/
├── getting-started/      # Installation and setup guides
├── architecture/         # System design and components
├── deployment/           # Deployment methods and configurations
├── guides/               # Step-by-step guides for common tasks
├── self-hosting/         # Guides specific to self-hosting
└── reference/            # API docs, environment variables, etc.

Who is this for?

Self-Hosters

Looking to run Obiente Cloud at home? Start with:

1. Self-Hosting Guide
2. Requirements
3. Installation

Developers

Working on Obiente Cloud itself? Check out:

1. Development Setup
2. Architecture Overview
3. Reference docs: Reference Index

DevOps Engineers

Deploying in production? Start here:

1. Deployment Methods
2. High Availability Setup
3. Troubleshooting

Getting Help

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation Issues: Found an error? File an issue

License

GNU Affero General Public License v3.0

---

Last updated: [Current date]