Quick start

This path uses the supported Docker Compose local build. It does not require a published Brokerr image.

1. Prepare the checkout

git clone https://gitlab.com/dom53-docker-server/brokerr.git
cd brokerr
cp data/config.yml.example data/config.yml
python -c "import base64,secrets; print(base64.urlsafe_b64encode(secrets.token_bytes(32)).decode().rstrip('='))" > data/master_key

Keep data/master_key private and preserve it separately from the database.

2. Start Brokerr

docker compose up --build -d
docker compose logs -f brokerr

Open http://localhost:8080. Sign in with admin / admin, then create the permanent administrator when prompted. The bootstrap credentials stop working after setup.

3. Add Plex

Open Settings > Sources > Plex and choose Sign in with Plex. Select a server, import it, load its libraries, enable the libraries you want to expose to profiles, and save Settings.

4. Add a target

Open Settings > Targets, choose a provider, and add a target. Keep Hosted Brokerr gateway unless you maintain your own provider application. Save the target, select Connect, complete provider authorization, and run Test connection.

5. Create the profile

Open Settings > Profiles. Select the Plex source, target, and source libraries. Leave Dry-run enabled and scheduled incremental/full sync paused. Save the profile.

6. Review the first run

Open the profile and run a Full sync. In Runs, review unmatched entries, mapping reasons, target-before state, and planned changes. Correct mappings or ignore items that should never sync. Only use Apply after the diff is safe.