providers/providers.yml
Every setting of providers/providers.yml.
providers/providers.yml enables providers and sets their order, their hostnames, and their own session and feature settings. Each provider's own settings are in its folder next to this file. How a provider is picked explains how the order and the hostnames are used.
behavior
Advanced
Takesa positive duration
Default"10m"
Affectshow long Identica remembers that a provider was already tried for a username and address
A player whose premium login failed, for example an offline client with a premium username, continues with the next provider when they join again from the same address within this time. Longer values keep that choice longer; shorter ones let the provider be tried again sooner.
Takesa list of provider entries
Affectswhich providers are loaded, and how each one takes part
Identica loads a provider only when it has an entry here with enabled: true.
behavior:
attemptTtl: "10m"
providers:
- id: "premium"
displayName: "Premium"
enabled: true
priority: 100
entrypoints:
- "premium.example.com"
session:
concurrencyPolicy: "REJECT_NEW"
- id: "credential"
displayName: "Credential"
enabled: true
priority: 50
entrypoints:
- "credential.example.com"Takesa provider id, such as premium or credential, in any case
Affectswhich installed provider the entry configures
Takesa string
Default""
Affectsthe provider's name in messages to players, such as the provider choice
A blank name uses the provider's own name.
Takesan integer
Affectswhich provider wins when several have an equally strong reason to handle a player
Higher values win.
Takesa list of hostnames, as host or host:port
Affectswhich hostnames pick this provider for a joining player
A host entry matches the hostname on any port; host:port only on that port. When several providers list a hostname, the one with the higher priority takes it. Leave the list empty when your players all join through one address. See Hostnames.
Advanced
Takesan object with an authentication, registration or migration list of method names
Defaultabsent
Affectswhich of the provider's methods each scenario offers, and in which order
Only for a provider that offers several ways to get a scenario done, such as a quick check and a guided setup; its own documentation names them. A scenario left out offers all of them in the provider's order. A listed scenario offers only the methods it names, in that order:
methods:
migration: ["guided", "quick"]With choice: "AUTOMATIC" the first method that can finish the login is used; with "PROMPTED" the player sees each listed method as an option. See Provider choice.
Advanced
Takes"REPLACE_EXISTING" or "REJECT_NEW"
Defaultabsent
Affectswhat happens when an account of this provider logs in from a second connection
When absent, the provider follows sessions.concurrencyPolicy of settings.yml.
Takesan object with one entry per feature
Defaultabsent
Affectsthis provider's own settings for a feature
Whatever an entry leaves out comes from the feature's shared settings. The provider must support the feature; turning on a feature the provider does not support stops the provider from loading.
| Key | Page |
|---|---|
features.recognition | Recognition |
features.restriction.enabled | Restriction |
features.restriction.join | Join restriction |
features.sentinel.enabled | Sentinel |
features.verification | Verification |
See Features.