Merge branch 'multiple-hackney-pools' into 'develop'

[akkoma] / docs / config.md

diff --git a/docs/config.md b/docs/config.md
index 5799f003e4f108d2cc1e9d7c9f970b358d3a924e..4f4a4378c1f0405f5c48b02100291d40e6678b25 100644 (file)
--- a/docs/config.md
+++ b/docs/config.md
@@ -110,7 +110,7 @@ Frontends can access these settings at `/api/pleroma/frontend_configurations`
 
 To add your own configuration for PleromaFE, use it like this:
 
-`config :pleroma, :frontend_configurations, :pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
+`config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
 
 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
 
@@ -234,3 +234,20 @@ curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerando
   * Pleroma.Web.Metadata.Providers.OpenGraph
   * Pleroma.Web.Metadata.Providers.TwitterCard
 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
+
+## :hackney_pools
+
+Advanced. Tweaks Hackney (http client) connections pools.
+
+There's three pools used:
+
+* `:federation` for the federation jobs.
+  You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
+* `:media` for rich media, media proxy
+* `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
+
+For each pool, the options are:
+
+* `max_connections` - how much connections a pool can hold
+* `timeout` - retention duration for connections
+