Docs/ Custom Migrator

Settings reference ​

Migrator Settings can be changed by System Managers and Hydra Admins.

Target Configuration ​

FieldWhat it does
Target AppThe installed app the customizations are written into. Changing it refills Repository URL and clears Base Branch.
Repository URLThe app's GitHub repo, filled in from its Git remote. Any username or password in the URL is removed when you save.
Initialize Git RepositoryOnly shown when the app folder isn't a Git repo. See Set up.

GitHub Authentication ​

FieldWhat it does
GitHub PATYour GitHub token. Stored encrypted and never shown again. See Create a GitHub token.
Test ConnectionChecks the token can read the repo. Available after you save a token.
Base BranchThe branch pull requests target, and the branch new branches start from. Listed from GitHub after you save a token. If it's empty, develop is assumed.

DocType Configuration ​

The Migrator DocTypes table has one row per tracked type:

ColumnWhat it does
DocTypeThe record type. Each can appear only once.
EnabledUntick to stop showing it on the page.
Is DefaultSet by Custom Migrator for the eight built-in types. Read-only.
Filters (JSON)Optional filter object, tested when you save. See Choose what to track.
Label FieldOptional field to use as the label in the list.

Site Configuration ​

FieldWhat it does
Skip Fixtures on MigrateWhen on, bench migrate on this site applies only Custom Fields and Property Setters. Scripts, notifications and other fixtures from apps are skipped.

From the command line ​

bash
bench --site your-site configure-migrator --help
bench --site your-site get-migrator-site-config
Updated 5 Oct 2026