Skip to main content

Setup Wizard

When you start Yattee Server for the first time, the server automatically redirects all requests to the setup wizard at /setup. This wizard walks you through creating the initial admin account and optionally connecting an Invidious instance.

What the Wizard Configures

The setup wizard handles two things:

  1. Admin account creation -- The first user account with full administrative privileges.
  2. Invidious proxy configuration (optional) -- A connection to an Invidious instance for extended features.

Form Fields

FieldRequirementsDescription
Username3--50 charactersThe admin account username used to log in
PasswordMinimum 6 charactersThe admin account password
Confirm PasswordMust match passwordPassword confirmation to prevent typos
Invidious Proxy URLOptional, valid URLThe base URL of an Invidious instance (e.g., https://invidious.example.com)

Invidious Proxy

The Invidious Proxy URL field determines which features are available on the server:

With an Invidious instance configured:

  • Video search
  • Trending videos
  • Channel browsing
  • Captions and subtitles
  • Thumbnail proxying

Without an Invidious instance (yt-dlp only):

  • Direct video stream extraction via yt-dlp
  • Invidious-dependent features (search, trending, channels, captions, thumbnails) are disabled
info

You can always add or change the Invidious instance later from the admin panel. Leaving this field empty during setup does not permanently disable any features.

After Setup

Once you submit the form, the server:

  1. Creates the admin user account
  2. Configures the Invidious proxy (if a URL was provided)
  3. Redirects you to the watch page

From there, you can access the admin panel at /admin to configure sites, manage credentials, and adjust server settings.

note

Once setup is complete (i.e., at least one admin account exists), the setup wizard is no longer accessible. Navigating to /setup will redirect you to the main application.

Alternative: Auto-Provisioning

If you prefer to skip the interactive wizard -- for example, in automated deployments or CI/CD pipelines -- you can provision the admin account using environment variables:

environment:
- ADMIN_USERNAME=admin
- ADMIN_PASSWORD=your-secure-password
- INVIDIOUS_INSTANCE_URL=https://invidious.example.com

The INVIDIOUS_INSTANCE_URL variable is optional. When these variables are set and no admin account exists yet, the server creates the account automatically on startup without showing the setup wizard.

See the Docker Setup page for the full configuration example.

Next Steps

  • Docker Setup -- Full environment variable reference and volume configuration
  • Reverse Proxy -- Serve Yattee over HTTPS with a custom domain