Update documentation to reflect non-local hosting environment

This commit is contained in:
2026-01-05 20:47:35 +01:00
parent e7e06ea875
commit 7f9ebc6bc2
2 changed files with 18 additions and 1 deletions

View File

@@ -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. - **Overlay:** Located in `src/app/overlay/[token]`. Publicly accessible but requires a valid token. Renders with a transparent background.
## Deployment ## 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.

View File

@@ -71,6 +71,12 @@ src/
- **Library:** `tmi.js` (client-side execution). - **Library:** `tmi.js` (client-side execution).
- **Cost:** Zero server-side WebSocket processing. - **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 ## Implementation Phases
1. **Project Initialization:** Scaffolding Next.js, Tailwind, and Supabase client. 1. **Project Initialization:** Scaffolding Next.js, Tailwind, and Supabase client.
2. **Authentication:** Implementing NextAuth with Twitch. 2. **Authentication:** Implementing NextAuth with Twitch.