docs

VLog Documentation

Quick Start

New to VLog? Start here:

1. DEPLOYMENT.md - Installation and setup (start with "Development Setup")
2. CONFIGURATION.md - Environment variables and settings
3. ADMIN_UI_GUIDE.md - Using the admin interface

---

By Audience

Administrators

Document	Description
ADMIN_UI_GUIDE.md	Admin interface walkthrough (all 9 tabs, workflows, keyboard shortcuts)
AUTHENTICATION.md	Multi-user auth, RBAC roles, OIDC, API keys
CONFIGURATION.md	All environment variables and database-backed settings
UPGRADING.md	Version upgrade procedures and breaking changes

DevOps / Operations

Document	Description
DEPLOYMENT.md	Production setup: systemd, nginx, Kubernetes, CDN, backups
MONITORING.md	Prometheus metrics, alerting rules, Grafana dashboards
TROUBLESHOOTING.md	Common issues and solutions by symptom
CONFIGURATION.md	All environment variables with defaults and ranges

Developers

Document	Description
ARCHITECTURE.md	System architecture, component overview, data flows
API.md	Complete API reference (Public, Admin, Worker APIs)
DATABASE.md	Full database schema with all tables and relationships
TRANSCODING_ARCHITECTURE.md	Video processing state machine, job lifecycle, edge cases
EXCEPTION_HANDLING.md	Error handling patterns and anti-patterns

---

All Documents

Document	Description
ADMIN_UI_GUIDE.md	Admin interface user guide
API.md	Complete API reference
ARCHITECTURE.md	System architecture and data flows
AUTHENTICATION.md	User authentication and RBAC
CONFIGURATION.md	Configuration options
DATABASE.md	Database schema documentation
DEPLOYMENT.md	Production deployment guide
EXCEPTION_HANDLING.md	Error handling patterns
MONITORING.md	Prometheus metrics and observability
TRANSCODING_ARCHITECTURE.md	Job lifecycle and state machine
TROUBLESHOOTING.md	Common issues and solutions
UPGRADING.md	Version upgrade procedures