Configuration Guide – WebUI Setup

Once Catalogerr is installed, most configuration can be completed through the WebUI.
For this guide, we’ll use the demo site as an example instance:

https://demo.patserver.com/

Visit https://demo.patserver.com/
Log in with the admin credentials created during installation (admin.py or installer script).

Navigate to Settings.
Here you can manage:

Archive Drives → set up mount points on the host system for your archive disks
Database Menu → manage what drives are registered in the Catalogerr database
API Key Management → create or remove API keys for external apps
Environment Variables (.env) → view & update your .env file directly in the UI
Backup & Restore → backup or restore your instance (includes config.yaml, connector.yaml, .env, .db, /static/posters/)

3️ Configure ARR & TMDB APIs

Before scanning your library, configure both:

Add Sonarr, Radarr, and TMDB API keys in the .env file
Also configure them again in the Connectors menu
(Connector API)

This step is intentionally redundant — it gives Catalogerr deeper integration with the ARR ecosystem.

4️ Run First Library Scan

Go to System and click:

** Scan Library**

Scanning logs currently appear only in the terminal (UI improvements planned).
The scan will index drives, media files, and enrich metadata.

5️ Run Background Tasks

After the scan completes, go to Tasks UI.

Run these tasks in order:

Connector Stats Collection (run_connector_stats)
Interval: 0:02:00
Press Run Now
Connector Media Sync
Poster Cache (All Media)
May show errors in the UI, but the task runs successfully in the background.

6️ Configuration Complete

You’ve now set up Catalogerr fully:

Drives & archives configured
ARR + TMDB integrations active
Connectors synced
Posters cached

From here, you can explore the Dashboard for stats and insights.

Next Steps

Explore collection health stats in the dashboard
Schedule automatic scans & sync tasks (planned feature)
Contribute feedback: Feedback Page