Documentation

Everything you need to know about setting up and using TubeCMS.

Overview

TubeCMS is a self-hosted content management system designed specifically for YouTube creators. It automatically syncs your YouTube channel content into a beautiful, customisable website that you fully own and control.

Key Benefits
  • Complete ownership of your content and data
  • Automatic synchronisation with YouTube
  • Built-in analytics without third-party tracking
  • Fully customisable design and branding

Requirements

Before setting up TubeCMS, ensure your environment meets the following requirements:

Server Requirements

  • .NET 8 Runtime or later
  • 2GB RAM minimum (4GB recommended)
  • 1GB disk space for application
  • Additional space for media uploads

Supported Platforms

  • Linux (Ubuntu, Debian, CentOS, etc.)
  • Windows Server 2016 or later
  • Docker containers

Database Options

  • SQLite (default, no additional setup)
  • MySQL 8.0 or later

Initial Setup

After installation, TubeCMS will guide you through an interactive setup wizard.

Step 1: Access the Setup Wizard

Navigate to your site's URL. If this is a fresh installation, you'll be automatically redirected to the setup wizard at /Setup.

Step 2: Create Admin Account

Enter your email address and choose a secure password for the administrator account.

Step 3: Configure Database

Choose between SQLite (recommended for most users) or MySQL for larger installations.

Step 4: Connect YouTube

Enter your YouTube API key and channel ID to enable automatic video synchronisation.

Step 5: Activate License

Enter your license key to activate TubeCMS. Contact us if you need to obtain a license.

YouTube Integration

TubeCMS uses the YouTube Data API v3 to synchronize your channel's content.

Obtaining an API Key

  1. Go to the Google Cloud Console
  2. Create a new project or select an existing one
  3. Enable the YouTube Data API v3
  4. Create credentials (API Key)
  5. Copy the API key to your TubeCMS settings

Finding Your Channel ID

Your channel ID can be found in your YouTube channel's URL or in the YouTube Studio settings under "Channel" > "Advanced settings".

Sync Settings

Configure how often TubeCMS checks for new videos and updates view counts in the admin settings panel.

Customisation

TubeCMS offers extensive customisation options through the admin panel.

Theme Settings

  • Colours: Primary, secondary, accent, and background colours
  • Fonts: Choose from a selection of web fonts for headings and body text
  • Layout: Configure grid columns and video display options

Branding

  • Upload a custom favicon
  • Add banner images
  • Customize footer text
  • Add social media links

Database Options

SQLite

The default database option. Perfect for most installations with no additional configuration required.

SQLite stores all data in a single file, making backups simple and straightforward.

MySQL

Recommended for high-traffic sites or when you need advanced database features.

Configure the connection string in your environment variables or settings file.

Video Management

Manage your synced videos through the admin panel.

Video Annotations

Add custom titles, descriptions, or notes to any video without affecting the YouTube original.

Visibility Control

Hide specific videos from your site while keeping them on YouTube.

Featured Videos

Mark videos as featured to highlight them on your homepage.

Tagging

Organize videos with tags for better discoverability and filtering.

Newsletters

Create and publish blog posts alongside your video content.

Editor

Use the built-in WYSIWYG editor or write in Markdown for full control over formatting.

Scheduling

Schedule posts to publish at a future date and time.

Featured Images

Add featured images to make your posts visually appealing in listings.

Analytics

TubeCMS includes built-in analytics that respect user privacy.

Tracked Metrics

  • Page views
  • Video clicks
  • Referrer sources
  • Daily and monthly trends

Privacy

All analytics data is stored on your server. No third-party services are used, and no personal data is collected.

Export

Export your analytics data for use in external tools or reports.

Custom Pages

Create additional pages for your site using Markdown.

Creating Pages

Navigate to Admin > Pages > Add New to create a custom page.

Page Settings

  • Custom URL slug
  • SEO title and description
  • Visibility options

API Reference

TubeCMS provides internal APIs for various functionality. Contact support for API documentation specific to your installation.

Updates

TubeCMS includes a built-in update system.

Checking for Updates

Navigate to Admin > Updates to check for available updates.

Applying Updates

Updates can be applied with a single click. The system automatically backs up your database before applying changes.

Backup & Restore

Regular backups are essential for protecting your content.

Database Backup

For SQLite, simply copy the database file. For MySQL, use standard MySQL backup tools.

Media Files

Back up the wwwroot/uploads directory to preserve uploaded media.

Configuration

Back up your appsettings.json and any environment-specific configuration files.