Repository navigation
First Run
🏠 Home › First Run
From an empty config to a working install. A fresh install opens a setup wizard and keeps you there until the required steps are done. This page follows the wizard, then covers what comes after.
- The setup wizard
- 1. Create your admin account (or choose no login)
- 2. Connect Plex and your *arr instances
- 3. Add your TMDB API key
- 4. Poster sync (optional)
- 5. Notifications (optional)
- 6. Review & finish
- After the wizard
Open http://<your-host>:8000; a fresh install lands on /setup. Existing installs skip it.
| # | Step | Required? |
|---|---|---|
| 1 | Welcome | — |
| 2 | User account | Required (a login, or "No login") |
| 3 | Media Server (Plex) | At least one of Plex / *arr |
| 4 | *arr Instances (Radarr/Sonarr/Lidarr) | At least one of Plex / *arr |
| 5 | TMDB API key | Required |
| 6 | Poster Sync (Google Drive) | Optional |
| 7 | Notifications | Optional |
| 8 | Review → Finish | — |
To finish you need: a login choice, a TMDB key, and at least one Plex or *arr instance. The optional steps can be done later in Settings. To run the wizard again, use Settings → General → First-run setup.
Choose Require a login (recommended) or No login.
- Require a login: a username and password (8+ characters), stored locally and bcrypt-hashed. There's no email reset — if you lose it, see Troubleshooting → Reset the admin password.
- No login: anyone who can reach CHUB can change its settings, including your instance API keys. Only for a CHUB that isn't reachable from outside your network.
Change this later in Settings → General → Access.
Add each service CHUB should use. Each one is tested before it's saved.
For each Radarr / Sonarr / Lidarr:
| Field | Value |
|---|---|
| URL | An address CHUB can reach from inside its container: http://radarr:7878 on a shared Docker network, otherwise a LAN IP like http://192.168.1.10:7878. Not localhost — inside the container that's CHUB itself. |
| API key | The ARR's Settings → General → Security → API Key. |
For Plex:
| Field | Value |
|---|---|
| URL |
http://plex:32400 (or wherever Plex runs). |
| API key | Your X-Plex-Token. How to find it. |
Manage them later on Settings → Instances.
Plex libraries are opt-in. The first sync enables every library the server has. A library added to Plex later stays hidden until you tick it on the Plex card in Settings → Instances.
Paste a free TMDB v3 API key and save it. CHUB uses it to fill in missing TMDB ids, which improves poster matching and request links. Change it later under Settings → General → TMDB.
Connect Google Drive poster sources (sync_gdrive). Each drive is used for poster matching automatically.
Add Discord or Notifiarr destinations. Each picks its modules and whether it sends run summaries, errors, or both — see Configuration → notifications.
Click Finish. CHUB sets general.setup_completed: true and opens the dashboard.
On Settings → Modules, switch on the modules you want and click each to set it up (Modules explains them). Good first picks:
- poster_renamerr if you use Kometa — see Kometa Integration.
- upgradinatorr to trigger quality-upgrade searches on a schedule.
- labelarr to mirror ARR tags into Plex labels.
On Settings → Schedule, give each module an hourly, daily, weekly, monthly or cron schedule (formats). A module without one only runs by hand or by webhook.
| Module | Starting schedule |
|---|---|
poster_renamerr |
Every 4h — cron(0 */4 * * *)
|
jduparr |
Twice a day — daily(03:00|15:00)
|
upgradinatorr |
Daily — daily(03:15)
|
health_checkarr |
Every 6h — cron(0 */6 * * *)
|
Settings → Webhooks → Set up webhooks adds CHUB's poster webhook to each Radarr/Sonarr for you. URLs for doing it by hand (and for Tautulli) are there too. See Webhooks.
On a module's settings page, turn on Dry run and click Run now. If the log looks right, turn dry run off and let the schedule take over.
Next: Modules · Related: Configuration, Kometa Integration