Overview
Every configuration file of Identica, how they are written and reloaded, and how values are spelled.
This section describes every setting, file by file. Each page's place mirrors its file in the data directory, plugins/identica/ on Velocity and plugins/Identica/ on BungeeCord. To learn what to change for a task, start with the guides instead.
Files
| File | Page |
|---|---|
settings.yml | Settings |
engine.yml | Engine |
routing.yml | Routing |
commands.yml | Commands |
messages.yml | Messages |
persistence.yml | Persistence |
replication.yml | Replication |
providers/providers.yml | Providers |
identity/addresses.yml | Account addresses |
identity/username/ | Username |
features/recognition/ | Recognition |
features/restriction/ | Restriction |
features/restriction/join/ | Join restriction |
features/sentinel/ | Sentinel |
features/verification/ | Verification |
providers/Credential/ | Credential settings |
providers/Premium/ | Premium settings |
A provider or addon from elsewhere documents its own files.
YAML or JSON
The examples use YAML, Identica's default. An empty file in the data directory chooses the format: type=YAML or type=JSON. Identica creates type=YAML on its first start; rename it before you change any setting, because Identica does not convert files that already exist.
Setting flags
Some settings carry a flag:
- Advanced: the default suits almost every network. Change it only for a reason you can name.
- Warning: a change affects security or what players experience; read the setting's description first.
- Danger: a change can affect existing accounts and is hard to undo.
- Experimental: works, but may still change in a later release.
- Reserved: read, but without effect yet. Leave it as it is.
Unflagged settings are ordinary configuration.
What Identica writes back
On every start and reload, Identica completes each file with the settings it lacks and writes it back. Your values are kept; comments are not.
A list is taken as you wrote it, including an empty one: [] means "nothing", not "use the default". Remove the key to get the default list back.
settings.yml and the settings file of each feature start with _version, which Identica uses to upgrade them. Do not edit or remove it.
Reloading
/identica admin reload reads every file of the running proxy again: Identica's own, those of its features, and those of every loaded provider. Messages and settings that are read when they are used, such as the prompts players see or a provider's attempt limits, apply to the next players without a restart. The database connection is opened at startup, so a change to persistence.yml takes effect on the next start.
A file that cannot be read keeps the values it had, and the other files are still reloaded. The command then answers with commands.reload.error from messages.yml, whose {error} names each file that failed; it answers with commands.reload.success only when every file was reloaded. Identica does not rewrite a file it could not read, so you can fix it and reload again.
Value formats
- Durations:
"30s","10m","2h","1d12h", or ISO-8601 such as"PT10M". A bare number such as10means minutes. Quoted strings with a unit are the clearest. - Choices: upper case strings, such as
"RANDOM"or"REPLACE_EXISTING". - Switches:
trueorfalse. - Messages: MiniMessage text; see Messages.