Skip to content

Commit 3584c39

Browse files
authored
Describe some admin-area config values (#1885)
1 parent 7ac8525 commit 3584c39

1 file changed

Lines changed: 21 additions & 12 deletions

File tree

content/en/admin/config.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,25 +1227,30 @@ If set to `true`, Mastodon will log some Sidekiq metrics into StatsD. Defaults t
12271227
12281228
#### `BUNDLE_GEMFILE`
12291229
1230+
Instructs bundler (ruby package manager) on how to build the application.
1231+
12301232
#### `DEEPL_API_KEY`
12311233
1232-
#### `DEEPL_PLAN`
1234+
When using DeepL, the API key used to access the translation service.
12331235
1234-
#### `ENABLE_SIDEKIQ_UNIQUE_JOBS_UI`
1236+
#### `DEEPL_PLAN`
12351237
1236-
Enable `sidekiq-unique-jobs`'s web interface. This can be used to review and clear the locks managed by this gem, but is rarely useful in practice and has had critical security vulnerabilities in the past.
1237-
If you only need to clear all locks, you can now use the newly-added `bundle exec rake sidekiq_unique_jobs:delete_all_locks`.
1238+
When using DeepL, the name of the configured plan.
12381239
12391240
**Version history:**\
12401241
4.2.6 - added
12411242
12421243
#### `LIBRE_TRANSLATE_ENDPOINT`
12431244
1245+
The endpoint (URL) with a running Libre Translate service.
1246+
12441247
#### `LIBRE_TRANSLATE_API_KEY`
12451248
1249+
When using Libre Translate, the API key used to access the translation service.
1250+
12461251
#### `GITHUB_REPOSITORY`
12471252
1248-
Defaults to `mastodon/mastodon`
1253+
The source repository containing the application code. Defaults to `mastodon/mastodon`
12491254
12501255
#### `SOURCE_BASE_URL`
12511256
@@ -1257,37 +1262,41 @@ Defaults to empty value (not enabled)
12571262
12581263
#### `LOCAL_HTTPS`
12591264
1265+
In production environments, HTTPS is always enabled. In other environments, this config value enables HTTPS when set to `true`.
1266+
12601267
#### `PATH`
12611268
12621269
#### `MAX_FOLLOWS_THRESHOLD`
12631270
1264-
Defaults to `7500`
1271+
Limit the number of (unauthorized) follows or follow requests of an account. Defaults to `7500`.
12651272
12661273
#### `MAX_FOLLOWS_RATIO`
12671274
1268-
Defaults to `1.1`
1275+
For accounts over the `MAX_FOLLOWS_THRESHOLD` limit of authorized follows, limits new unauthorized follows to follower count times this ratio. Defaults to `1.1`.
12691276
12701277
#### `IP_RETENTION_PERIOD`
12711278
1272-
Defaults to `31536000` (1 year)
1279+
Controls how long IP Address data connected to user records is preserved in the database. Defaults to `31536000` (1 year)
12731280
12741281
#### `SESSION_RETENTION_PERIOD`
12751282
1276-
Defaults to `31536000` (1 year)
1283+
Controls how long authentication sessions are kept valid without activity. Defaults to `31536000` (1 year)
12771284
12781285
#### `BACKTRACE`
12791286
12801287
Set to `1` to allow backtracing to Rails framework code.
12811288
1282-
#### `DISABLE_SIMPLECOV`
1283-
12841289
#### `EMAIL_DOMAIN_LISTS_APPLY_AFTER_CONFIRMATION`
12851290
1291+
When set to `true`, causes a check of user email address against the blocked list after confirmation (by default this only happens before confirmation).
1292+
12861293
#### `DISABLE_FOLLOWERS_SYNCHRONIZATION`
12871294
1295+
When set to `true`, disables the follower synchronization action which occurs after some events.
1296+
12881297
#### `MAX_REQUEST_POOL_SIZE`
12891298
1290-
Defaults to `512`.
1299+
Limits the maximum size of the HTTP request pool used to interact with other servers. Defaults to `512`.
12911300
12921301
#### `GITHUB_API_TOKEN`
12931302

0 commit comments

Comments
 (0)