Plugin Configuration
Plugin configuration options
Main Options
| Option | Type | Default | Description |
|---|---|---|---|
siteName | string | - | Site name |
domain | string | - | Domain |
login | LoginConfig | - | Login page text, see below |
disabled | boolean | false | Disable plugin |
redirects | RedirectsConfig | false | {} | Redirects config or false to disable |
revalidation | RevalidationConfig | - | Cache revalidation config |
lexicalReferences | LexicalReferencesConfig | Enabled | Lexical reference tracking for block relationships |
externalRelationshipSources | ExternalRelationshipSourceConfig[] | - | Sources that power externalRelationshipField |
Login Options
| Option | Type | Default | Description |
|---|---|---|---|
description | Record<string, string> | string | Names domain | The sentence under the welcome title. A string, or one per admin language. For a CMS that manages several websites. |
adsignPlugin({
siteName: 'Ditec',
domain: 'ditec.no',
login: {
description: {
en: 'This is the login page to manage content on the Ditec dealer websites.',
nb: 'Dette er innloggingssiden for å administrere innholdet på Ditec-forhandlernes nettsider.',
},
},
});Redirects Options
| Option | Type | Default | Description |
|---|---|---|---|
redirectEnabledCollections | string[] | Auto-detected | Collections that support redirects |
fields | function | - | Add/modify redirect collection fields |
redirectsOverrides | Partial<CollectionConfig> | {} | Override redirect collection config |
redeploy | RedeployConfig | - | Auto-deploy config |
Redeploy Options
| Option | Type | Default | Description |
|---|---|---|---|
url | string | - | Deploy hook URL |
delayMinutes | number | 10 | Delay before triggering |
Revalidation Options
| Option | Type | Description |
|---|---|---|
url | string | string[] | Revalidation endpoint(s) |
secret | string | Secret token |
batch | boolean | Required, no default. true sends one POST per URL as { secret, tags }; false sends one POST per tag as { secret, tag } and is deprecated. See Revalidation. |
mode | 'autoMode' | 'legacyMode' | Defaults to 'autoMode'. In 'autoMode', the plugin walks config.collections / config.globals for entries whose custom.revalidate is set and attaches hooks. In 'legacyMode', source is forbidden and manual revalidateHook calls are required. Revalidation POSTs use { secret, tag } when batch: false and { secret, tags } when batch: true, in either mode. |
source | string | Optional publisher identifier. When set, every emitted tag is prefixed with ${source}_. Forbidden in legacyMode. See Revalidation. |
Lexical References Options
| Option | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Enable lexical references tracking |
fieldName | string | lexicalReferences | Field name that stores reference tags |
collections | Record<string, boolean> | {} | Per-collection overrides (set to false to disable) |