Documentation
Welcome to the VideoCMS Beta documentation. VideoCMS is a high-performance, self-hosted video management system designed for hardware efficiency and ease of use.
STATUS: BETA (v0.1.x)
VideoCMS uses one service for the API and frontend on port 3000, with durable background jobs and provider-neutral media storage built in.
🚀 Essentials
Everything you need to get your instance up and running.
- Getting Started Install VideoCMS in under 5 minutes using Docker Compose.
- v0.0.9 to v0.1.0 Migration Moving from the old multi-container Alpha setup to the unified Beta service.
- Upgrade Guide How to keep your instance up to date with the latest Beta releases.
- Configuration Reference Complete list of environment variables for storage, security, and limits.
🛠️ User Guides
Learn how to manage your content and users effectively.
- Upload & Video Management Visual guide to uploading, folders, and content management.
- Encoding & Transcoding Configure resolutions, bitrates, and hardware acceleration settings.
- User Management Manage roles, permissions, and registration settings.
- Customization Publish supporting Markdown or HTML pages directly from the dashboard.
- Subtitles (PGS Support) Enabling high-quality image-based subtitle rendering.
🛡️ Operations & Security
Hardening and maintaining your production instance.
- Production Deployment Setting up Reverse Proxies (Caddy/Nginx) with SSL termination.
- Storage Pools Add S3-compatible or SFTP mounts, route uploads, migrate existing videos, and reconnect storage.
- Backup & Restore Ensuring data safety with SQLite WAL-mode consistency.
- Security Best Practices JWT secret rotation, IP identification, and firewall rules.
- Cloudflare Setup Proxying traffic and handling large uploads through the Cloudflare WAF.
- Webhooks Automate notifications to Discord or custom endpoints.
🔍 Reference & Development
Deep dives for power users and contributors.
- Architecture Overview Understanding the internal transcode pipeline and storage structure.
- API Reference REST API documentation for custom integrations.
- CLI Reference Administrative tools for database and server management.
- Developer Guide Setting up the Go and Nuxt development environment.
- Changelog Live version tracking and recent commit history.
Need Help?
If you can't find what you're looking for, check the Troubleshooting page or join our Discord community.