From 7f9ebc6bc2e92af4fe3ca61f944ee77cd80133d0 Mon Sep 17 00:00:00 2001 From: ramforth Date: Mon, 5 Jan 2026 20:47:35 +0100 Subject: [PATCH] Update documentation to reflect non-local hosting environment --- DOCUMENTATION.md | 13 ++++++++++++- PLAN.md | 6 ++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 1b832c0..a9f1bc4 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -35,4 +35,15 @@ OpenChat Overlay is a lightweight, open-source Twitch chat overlay solution desi - **Overlay:** Located in `src/app/overlay/[token]`. Publicly accessible but requires a valid token. Renders with a transparent background. ## Deployment -(To be added: Instructions for building the Docker image and deploying to an LXC container.) + +### Infrastructure Overview +- **Development:** Conducted on local desktop (CachyOS). +- **Version Control:** Synced to `gitea.ramforth.net` under the `RamTech` organization. +- **Production Host:** Standalone Proxmox LXC container or VM. +- **Service URL:** Production will NOT be hosted on `localhost`. All external callbacks (Twitch Auth) must point to the production domain/IP. + +### Deployment Workflow +1. Push changes from local development machine to Gitea. +2. Pull changes on the production LXC/VM. +3. Build and run using Docker or as a systemd service. + diff --git a/PLAN.md b/PLAN.md index 0a2976a..464a97b 100644 --- a/PLAN.md +++ b/PLAN.md @@ -71,6 +71,12 @@ src/ - **Library:** `tmi.js` (client-side execution). - **Cost:** Zero server-side WebSocket processing. +## Hosting & Infrastructure +- **Target:** Proxmox LXC or VM (standalone). +- **Architecture:** Client-side processing via `tmi.js` to ensure the server handles only authentication and configuration serving. +- **Cost Efficiency:** Designed for "near-zero" server overhead to allow hosting on minimal hardware resources. +- **Environment:** The development machine is exclusively for coding; the service will never be hosted on the dev machine. + ## Implementation Phases 1. **Project Initialization:** Scaffolding Next.js, Tailwind, and Supabase client. 2. **Authentication:** Implementing NextAuth with Twitch.