-
Notifications
You must be signed in to change notification settings - Fork 1
First Run
🏠 Home › First Run
The path from an empty config to a working install. CHUB walks you through this in a first-run wizard; the steps below match it.
- Create your admin user
- Connect your instances
- Global settings
- Enable modules
- Schedule
- Notifications
- Webhooks
- Smoke test
Open http://localhost:8000 (or http://<your-host>:8000). The first-run page asks for a username and password (minimum 8 characters).
Pick a strong password — there's no email-based reset. If you lose it, see Troubleshooting → Reset the admin password.
Go to Settings → Instances and add each service CHUB should talk to. This is the foundation — later steps assume your instances work.
For each Radarr / Sonarr / Lidarr:
| Field | Value |
|---|---|
| URL | An address CHUB can reach from inside its container — e.g. http://radarr:7878 if both share a Docker network, otherwise a host/LAN IP like http://192.168.1.10:7878. |
| 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. |
Click Test on every row and fix anything that fails before continuing.
Gotcha:
localhostinside the container is the container itself, not your host. Use a service name (shared Docker network) or a LAN IP for instance URLs.
Settings → General — set the theme, log level (info is fine), and — if webhooks will leave your LAN — a webhook_secret. Full reference: Configuration.
Settings → Modules has one page per module. Enable the ones you want and fill in their config. See Modules for what each does and its full schema. Common starting points:
- 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.
Unused modules just sit in the sidebar and do nothing.
Settings → Schedule — attach a cron or interval to each module you want to run automatically. Modules with no schedule are manual-only (run from the dashboard or via webhook).
| Module | Starting schedule |
|---|---|
poster_renamerr |
Every 4h |
jduparr |
Every 12h |
upgradinatorr |
Daily |
health_checkarr |
Every 6h |
Settings → Notifications — wire Discord or Notifiarr per module. Add a main entry to also catch unhandled errors. Per-service setup: Configuration → notifications.
Settings → Webhooks — generates ready-to-paste URLs for Sonarr / Radarr / Tautulli that include your webhook secret. Wiring details: Webhooks.
From the dashboard, click New run, pick a module with dry_run: true, and Run. Open the log — a clean run means you're ready to turn dry_run off and let the scheduler take over.
Next: Modules · Related: Configuration, Kometa Integration