2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
30 type: {:list, :module},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
33 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
39 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
45 description: "Base URL for the uploads, needed if you use CDN",
47 "https://cdn-host.com"
54 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
58 label: "Proxy Options",
60 description: "Options for Pleroma.ReverseProxy",
62 redirect_on_failure: false,
63 max_body_length: 25 * 1_048_576,
65 follow_redirect: true,
71 key: :redirect_on_failure,
74 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
75 "Any error during body processing will not be redirected as the response is chunked."
78 key: :max_body_length,
81 "Limits the content length to be approximately the " <>
82 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS versions to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
123 key: :filename_display_max_length,
125 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
131 key: Pleroma.Uploaders.Local,
133 description: "Local uploader-related settings",
138 description: "Path where user's uploads will be saved",
147 key: Pleroma.Uploaders.S3,
149 description: "S3 uploader-related settings",
154 description: "S3 bucket",
160 key: :bucket_namespace,
162 description: "S3 bucket namespace",
163 suggestions: ["pleroma"]
166 key: :public_endpoint,
168 description: "S3 endpoint",
169 suggestions: ["https://s3.amazonaws.com"]
172 key: :truncated_namespace,
175 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
176 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
179 key: :streaming_enabled,
182 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
188 key: Pleroma.Upload.Filter.Mogrify,
190 description: "Uploads mogrify filter settings",
194 type: [:string, {:list, :string}, {:list, :tuple}],
196 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
197 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
208 key: Pleroma.Upload.Filter.AnonymizeFilename,
210 description: "Filter replaces the filename of the upload",
216 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
217 " filename extension by using {extension}, for example custom-file-name.{extension}.",
219 "custom-file-name.{extension}"
226 key: Pleroma.Emails.Mailer,
228 description: "Mailer-related settings",
234 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
235 " or Swoosh.Adapters.Local for in-memory mailbox",
237 Swoosh.Adapters.SMTP,
238 Swoosh.Adapters.Sendgrid,
239 Swoosh.Adapters.Sendmail,
240 Swoosh.Adapters.Mandrill,
241 Swoosh.Adapters.Mailgun,
242 Swoosh.Adapters.Mailjet,
243 Swoosh.Adapters.Postmark,
244 Swoosh.Adapters.SparkPost,
245 Swoosh.Adapters.AmazonSES,
247 Swoosh.Adapters.SocketLabs,
248 Swoosh.Adapters.Gmail,
249 Swoosh.Adapters.Local
255 description: "Allow/disallow send emails"
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["smtp.gmail.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["pleroma"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
275 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
276 suggestions: ["password"]
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
286 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
298 suggestions: [:always, :never, :if_available]
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
311 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
315 group: {:subgroup, Swoosh.Adapters.SMTP},
317 label: "No MX lookups",
319 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
322 group: {:subgroup, Swoosh.Adapters.Sendgrid},
326 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
327 suggestions: ["my-api-key"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["/usr/bin/sendmail"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
341 suggestions: ["-N delay,failure,success"]
344 group: {:subgroup, Swoosh.Adapters.Sendmail},
347 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
350 group: {:subgroup, Swoosh.Adapters.Mandrill},
354 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["my-api-key"]
366 group: {:subgroup, Swoosh.Adapters.Mailgun},
369 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
370 suggestions: ["pleroma.com"]
373 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-api-key"]
381 group: {:subgroup, Swoosh.Adapters.Mailjet},
384 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
385 suggestions: ["my-secret-key"]
388 group: {:subgroup, Swoosh.Adapters.Postmark},
392 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["my-api-key"]
404 group: {:subgroup, Swoosh.Adapters.SparkPost},
407 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
408 suggestions: ["https://api.sparkpost.com/api/v1"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["us-east-1", "us-east-2"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-access-key"]
425 group: {:subgroup, Swoosh.Adapters.AmazonSES},
428 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
429 suggestions: ["aws-secret-key"]
432 group: {:subgroup, Swoosh.Adapters.Dyn},
436 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
437 suggestions: ["my-api-key"]
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.SocketLabs},
450 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
453 group: {:subgroup, Swoosh.Adapters.Gmail},
456 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
463 description: "`Swoosh.Adapters.Local` adapter specific settings",
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "Run the preview server together as part of your app"
472 group: {:subgroup, Swoosh.Adapters.Local},
475 description: "The preview server port",
483 label: "URI Schemes",
485 description: "URI schemes related settings",
489 type: {:list, :string},
490 description: "List of the scheme part that is considered valid to be an URL",
515 description: "Instance-related settings",
520 description: "Name of the instance",
527 label: "Admin Email Address",
529 description: "Email used to reach an Administrator/Moderator of the instance",
536 label: "Sender Email Address",
538 description: "Envelope FROM address for mail sent via Pleroma",
547 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
555 description: "Posts character limit (CW/Subject included in the counter)",
563 description: "Character limit of the instance chat messages",
571 description: "Hard character limit beyond which remote posts will be dropped",
579 description: "File size limit of uploads (except for avatar, background, banner)",
585 key: :avatar_upload_limit,
587 description: "File size limit of user's profile avatars",
593 key: :background_upload_limit,
595 description: "File size limit of user's profile backgrounds",
601 key: :banner_upload_limit,
603 description: "File size limit of user's profile banners",
611 description: "A map with poll limits for local polls",
615 max_option_chars: 200,
617 max_expiration: 31_536_000
624 description: "Maximum number of options",
628 key: :max_option_chars,
630 description: "Maximum number of characters per option",
634 key: :min_expiration,
636 description: "Minimum expiration time (in seconds)",
640 key: :max_expiration,
642 description: "Maximum expiration time (in seconds)",
648 key: :registrations_open,
651 "Enable registrations for anyone. Invitations require this setting to be disabled."
654 key: :invites_enabled,
657 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
660 key: :account_activation_required,
662 description: "Require users to confirm their emails before signing in"
667 description: "Enable federation with other instances"
670 key: :federation_incoming_replies_max_depth,
671 label: "Fed. incoming replies max depth",
674 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
675 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
681 key: :federation_reachability_timeout_days,
682 label: "Fed. reachability timeout days",
685 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
693 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
699 "Makes the client API in authenticated mode-only except for user-profiles." <>
700 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
701 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
704 key: :quarantined_instances,
705 type: {:list, :string},
707 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
714 key: :managed_config,
717 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
722 description: "Instance static directory",
728 key: :allowed_post_formats,
729 type: {:list, :string},
730 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
739 key: :extended_nickname_format,
742 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
743 " This will break federation with older software for theses nicknames."
746 key: :cleanup_attachments,
749 Enable to remove associated attachments when status is removed.
750 This will not affect duplicates and attachments without status.
751 Enabling this will increase load to database when deleting statuses on larger instances.
755 key: :max_pinned_statuses,
757 description: "The maximum number of pinned statuses. 0 will disable the feature.",
765 key: :autofollowed_nicknames,
766 type: {:list, :string},
768 "Set to nicknames of (local) users that every new user should automatically follow",
777 key: :attachment_links,
779 description: "Enable to automatically add attachment link text to statuses"
782 key: :max_report_comment_size,
784 description: "The maximum size of the report comment. Default: 1000.",
790 key: :safe_dm_mentions,
791 label: "Safe DM mentions",
794 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
795 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
801 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
804 key: :remote_post_retention_days,
807 "The default amount of days to retain remote posts when pruning the database",
813 key: :user_bio_length,
815 description: "A user bio maximum length. Default: 5000.",
821 key: :user_name_length,
823 description: "A user name maximum length. Default: 100.",
829 key: :skip_thread_containment,
831 description: "Skip filtering out broken threads. Default: enabled."
834 key: :limit_to_local_content,
835 type: {:dropdown, :atom},
837 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
845 key: :max_account_fields,
847 description: "The maximum number of custom fields in the user profile. Default: 10.",
853 key: :max_remote_account_fields,
856 "The maximum number of custom fields in the remote user profile. Default: 20.",
862 key: :account_field_name_length,
864 description: "An account field name maximum length. Default: 512.",
870 key: :account_field_value_length,
872 description: "An account field value maximum length. Default: 2048.",
878 key: :external_user_synchronization,
880 description: "Enabling following/followers counters synchronization for external users"
883 key: :multi_factor_authentication,
885 description: "Multi-factor authentication settings",
888 totp: [digits: 6, period: 30],
889 backup_codes: [number: 5, length: 16]
895 label: "TOTP settings",
897 description: "TOTP settings",
898 suggestions: [digits: 6, period: 30],
905 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
912 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
919 description: "MFA backup codes settings",
920 suggestions: [number: 5, length: 16],
926 description: "Number of backup codes to generate."
933 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
940 key: :instance_thumbnail,
943 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
944 suggestions: ["/instance/thumbnail.jpeg"]
951 description: "Welcome messages settings",
954 group: :direct_message,
956 descpiption: "Direct message settings",
961 description: "Enables sends direct message for new user after registration"
967 "A message that will be sent to a newly registered users as a direct message",
969 "Hi, @username! Welcome on board!"
973 key: :sender_nickname,
975 description: "The nickname of the local user that sends the welcome message",
985 descpiption: "Email message settings",
990 description: "Enables sends direct message for new user after registration"
994 type: [:string, :tuple],
996 "The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.",
998 {"Pleroma App", "welcome@pleroma.app"}
1005 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1006 suggestions: ["Welcome to <%= instance_name%>"]
1012 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1013 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1019 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1020 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1029 description: "Logger-related settings",
1033 type: [:atom, :tuple, :module],
1035 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1036 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1044 label: "ExSyslogger",
1045 description: "ExSyslogger-related settings",
1049 type: {:dropdown, :atom},
1050 description: "Log level",
1051 suggestions: [:debug, :info, :warn, :error]
1057 "A string that's prepended to every message, and is typically set to the app name",
1058 suggestions: ["pleroma"]
1063 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1064 suggestions: ["$metadata[$level] $message"]
1068 type: {:list, :atom},
1069 suggestions: [:request_id]
1077 label: "Console Logger",
1078 description: "Console logger settings",
1082 type: {:dropdown, :atom},
1083 description: "Log level",
1084 suggestions: [:debug, :info, :warn, :error]
1089 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1090 suggestions: ["$metadata[$level] $message"]
1094 type: {:list, :atom},
1095 suggestions: [:request_id]
1102 label: "Quack Logger",
1103 description: "Quack-related settings",
1107 type: {:dropdown, :atom},
1108 description: "Log level",
1109 suggestions: [:debug, :info, :warn, :error]
1113 type: {:list, :atom},
1114 description: "Configure which metadata you want to report on",
1131 label: "Webhook URL",
1133 description: "Configure the Slack incoming webhook",
1134 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1140 key: :frontend_configurations,
1143 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1144 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1145 "add your own configuration your settings all fields must be complete.",
1149 label: "Pleroma FE",
1151 description: "Settings for Pleroma FE",
1154 alwaysShowSubjectInput: true,
1155 background: "/static/aurora_borealis.jpg",
1156 collapseMessageWithSubject: false,
1159 hideFilteredStatuses: false,
1160 hideMutedPosts: false,
1161 hidePostStats: false,
1162 hideSitename: false,
1163 hideUserStats: false,
1164 loginMethod: "password",
1165 logo: "/static/logo.png",
1168 minimalScopesMode: false,
1169 noAttachmentLinks: false,
1170 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1171 postContentType: "text/plain",
1172 redirectRootLogin: "/main/friends",
1173 redirectRootNoLogin: "/main/all",
1175 sidebarRight: false,
1176 showFeaturesPanel: true,
1177 showInstanceSpecificPanel: false,
1178 subjectLineBehavior: "email",
1179 theme: "pleroma-dark",
1180 webPushNotifications: false
1185 key: :alwaysShowSubjectInput,
1186 label: "Always show subject input",
1188 description: "When disabled, auto-hide the subject field if it's empty"
1194 "URL of the background, unless viewing a user profile with a background that is set",
1195 suggestions: ["/images/city.jpg"]
1198 key: :collapseMessageWithSubject,
1199 label: "Collapse message with subject",
1202 "When a message has a subject (aka Content Warning), collapse it by default"
1206 label: "PleromaFE Chat",
1208 description: "Disables PleromaFE Chat component"
1214 description: "Enables green text on lines prefixed with the > character"
1217 key: :hideFilteredStatuses,
1218 label: "Hide Filtered Statuses",
1220 description: "Hides filtered statuses from timelines"
1223 key: :hideMutedPosts,
1224 label: "Hide Muted Posts",
1226 description: "Hides muted statuses from timelines"
1229 key: :hidePostStats,
1230 label: "Hide post stats",
1232 description: "Hide notices statistics (repeats, favorites, ...)"
1236 label: "Hide Sitename",
1238 description: "Hides instance name from PleromaFE banner"
1241 key: :hideUserStats,
1242 label: "Hide user stats",
1245 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1250 description: "URL of the logo, defaults to Pleroma's logo",
1251 suggestions: ["/static/logo.png"]
1255 label: "Logo margin",
1258 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1259 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1260 suggestions: [".1em"]
1267 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1268 "If you want a colorful logo you must disable logoMask."
1271 key: :minimalScopesMode,
1272 label: "Minimal scopes mode",
1275 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1276 "Also prevents replying to a DM with a public post from PleromaFE."
1279 key: :nsfwCensorImage,
1280 label: "NSFW Censor Image",
1283 "URL of the image to use for hiding NSFW media attachments in the timeline",
1284 suggestions: ["/static/img/nsfw.74818f9.png"]
1287 key: :postContentType,
1288 label: "Post Content Type",
1289 type: {:dropdown, :atom},
1290 description: "Default post formatting option",
1291 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1294 key: :redirectRootNoLogin,
1295 label: "Redirect root no login",
1298 "Relative URL which indicates where to redirect when a user isn't logged in",
1299 suggestions: ["/main/all"]
1302 key: :redirectRootLogin,
1303 label: "Redirect root login",
1306 "Relative URL which indicates where to redirect when a user is logged in",
1307 suggestions: ["/main/friends"]
1311 label: "Scope copy",
1313 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1317 label: "Sidebar on Right",
1319 description: "Change alignment of sidebar and panels to the right"
1322 key: :showFeaturesPanel,
1323 label: "Show instance features panel",
1326 "Enables panel displaying functionality of the instance on the About page"
1329 key: :showInstanceSpecificPanel,
1330 label: "Show instance specific panel",
1332 description: "Whether to show the instance's custom panel"
1335 key: :subjectLineBehavior,
1336 label: "Subject line behavior",
1338 description: "Allows changing the default behaviour of subject lines in replies.
1339 `email`: copy and preprend re:, as in email,
1340 `masto`: copy verbatim, as in Mastodon,
1341 `noop`: don't copy the subject.",
1342 suggestions: ["email", "masto", "noop"]
1347 description: "Which theme to use. Available themes are defined in styles.json",
1348 suggestions: ["pleroma-dark"]
1356 description: "Settings for Masto FE",
1359 showInstanceSpecificPanel: true
1364 key: :showInstanceSpecificPanel,
1365 label: "Show instance specific panel",
1367 description: "Whenether to show the instance's specific panel"
1378 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1382 type: {:keyword, :map},
1384 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1387 url: "/images/pleroma-fox-tan-smol.png",
1388 mime_type: "image/png"
1390 pleroma_fox_tan_shy: %{
1391 url: "/images/pleroma-fox-tan-shy.png",
1392 mime_type: "image/png"
1397 key: :default_mascot,
1400 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1406 key: :default_user_avatar,
1408 description: "URL of the default user avatar",
1409 suggestions: ["/images/avi.png"]
1418 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1422 type: {:list, :map},
1423 description: "Describe the icons of the app",
1426 src: "/static/logo.png"
1429 src: "/static/icon.png",
1433 src: "/static/icon.ico",
1434 sizes: "72x72 96x96 128x128 256x256"
1441 description: "Describe the theme color of the app",
1442 suggestions: ["#282c37", "mediumpurple"]
1445 key: :background_color,
1447 description: "Describe the background color of the app",
1448 suggestions: ["#191b22", "aliceblue"]
1458 description: "General MRF settings",
1462 type: [:module, {:list, :module}],
1464 "A list of MRF policies enabled. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
1465 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1469 label: "MRF transparency",
1472 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1475 key: :transparency_exclusions,
1476 label: "MRF transparency exclusions",
1477 type: {:list, :string},
1479 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1490 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1491 label: "MRF Simple",
1493 description: "Simple ingress policies",
1496 key: :media_removal,
1497 type: {:list, :string},
1498 description: "List of instances to strip media attachments from",
1499 suggestions: ["example.com", "*.example.com"]
1503 label: "Media NSFW",
1504 type: {:list, :string},
1505 description: "List of instances to tag all media as NSFW (sensitive) from",
1506 suggestions: ["example.com", "*.example.com"]
1509 key: :federated_timeline_removal,
1510 type: {:list, :string},
1512 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1513 suggestions: ["example.com", "*.example.com"]
1517 type: {:list, :string},
1518 description: "List of instances to reject activities from (except deletes)",
1519 suggestions: ["example.com", "*.example.com"]
1523 type: {:list, :string},
1524 description: "List of instances to only accept activities from (except deletes)",
1525 suggestions: ["example.com", "*.example.com"]
1529 type: {:list, :string},
1530 description: "Force posts from the given instances to be visible by followers only",
1531 suggestions: ["example.com", "*.example.com"]
1534 key: :report_removal,
1535 type: {:list, :string},
1536 description: "List of instances to reject reports from",
1537 suggestions: ["example.com", "*.example.com"]
1540 key: :avatar_removal,
1541 type: {:list, :string},
1542 description: "List of instances to strip avatars from",
1543 suggestions: ["example.com", "*.example.com"]
1546 key: :banner_removal,
1547 type: {:list, :string},
1548 description: "List of instances to strip banners from",
1549 suggestions: ["example.com", "*.example.com"]
1552 key: :reject_deletes,
1553 type: {:list, :string},
1554 description: "List of instances to reject deletions from",
1555 suggestions: ["example.com", "*.example.com"]
1561 key: :mrf_activity_expiration,
1563 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1564 label: "MRF Activity Expiration Policy",
1566 description: "Adds automatic expiration to all local activities",
1571 description: "Default global expiration time for all local activities (in days)",
1572 suggestions: [90, 365]
1580 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1581 label: "MRF Subchain",
1584 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1585 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1589 type: {:map, {:list, :string}},
1590 description: "Matches a series of regular expressions against the actor field",
1593 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1601 key: :mrf_rejectnonpublic,
1603 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1604 description: "RejectNonPublic drops posts with non-public visibility settings.",
1605 label: "MRF Reject Non Public",
1609 key: :allow_followersonly,
1610 label: "Allow followers-only",
1612 description: "Whether to allow followers-only posts"
1617 description: "Whether to allow direct messages"
1623 key: :mrf_hellthread,
1625 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1626 label: "MRF Hellthread",
1628 description: "Block messages with excessive user mentions",
1631 key: :delist_threshold,
1634 "Number of mentioned users after which the message gets removed from timelines and" <>
1635 "disables notifications. Set to 0 to disable.",
1639 key: :reject_threshold,
1642 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1651 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1652 label: "MRF Keyword",
1654 description: "Reject or Word-Replace messages with a keyword or regex",
1658 type: {:list, :string},
1660 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1661 suggestions: ["foo", ~r/foo/iu]
1664 key: :federated_timeline_removal,
1665 type: {:list, :string},
1667 "A list of patterns which result in message being removed from federated timelines (a.k.a unlisted). Each pattern can be a string or a regular expression.",
1668 suggestions: ["foo", ~r/foo/iu]
1672 type: {:list, :tuple},
1674 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1675 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1683 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1684 label: "MRF Mention",
1686 description: "Block messages which mention a specific user",
1690 type: {:list, :string},
1691 description: "A list of actors for which any post mentioning them will be dropped",
1692 suggestions: ["actor1", "actor2"]
1698 key: :mrf_vocabulary,
1700 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1701 label: "MRF Vocabulary",
1703 description: "Filter messages which belong to certain activity vocabularies",
1707 type: {:list, :string},
1709 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1710 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1714 type: {:list, :string},
1716 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1717 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1723 # key: :mrf_user_allowlist,
1725 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1728 # "The keys in this section are the domain names that the policy should apply to." <>
1729 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1731 # %{"example.org" => ["https://example.org/users/admin"]}
1739 description: "Media proxy",
1744 description: "Enables proxying of remote media to the instance's proxy"
1751 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1752 suggestions: ["https://example.com"]
1760 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1766 description: "Enables invalidate media cache"
1771 description: "Module which will be used to cache purge.",
1773 Pleroma.Web.MediaProxy.Invalidation.Script,
1774 Pleroma.Web.MediaProxy.Invalidation.Http
1781 label: "Proxy Options",
1783 description: "Options for Pleroma.ReverseProxy",
1785 redirect_on_failure: false,
1786 max_body_length: 25 * 1_048_576,
1788 follow_redirect: true,
1794 key: :redirect_on_failure,
1797 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1798 "Any error during body processing will not be redirected as the response is chunked."
1801 key: :max_body_length,
1804 "Limits the content length to be approximately the " <>
1805 "specified length. It is validated with the `content-length` header and also verified when proxying."
1811 description: "HTTP options",
1816 description: "Adapter specific options",
1821 label: "SSL Options",
1822 description: "SSL options for HTTP adapter",
1826 type: {:list, :atom},
1827 description: "List of TLS version to use",
1828 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1837 type: [:string, :tuple],
1838 description: "Proxy URL",
1839 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1847 type: {:list, :string},
1848 description: "List of hosts with scheme to bypass the mediaproxy",
1849 suggestions: ["http://example.com"]
1855 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1857 description: "HTTP invalidate settings",
1862 description: "HTTP method of request. Default: :purge"
1866 type: {:keyword, :string},
1867 description: "HTTP headers of request",
1868 suggestions: [{"x-refresh", 1}]
1873 description: "Request options",
1877 type: {:map, :string}
1885 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1887 description: "Script invalidate settings",
1892 description: "Path to shell script. Which will run purge cache.",
1893 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1901 description: "Gopher settings",
1906 description: "Enables the gopher interface"
1912 description: "IP address to bind to",
1913 suggestions: [{0, 0, 0, 0}]
1918 description: "Port to bind to",
1924 description: "Port advertised in URLs (optional, defaults to port)",
1932 label: "ActivityPub",
1934 description: "ActivityPub-related settings",
1937 key: :unfollow_blocked,
1939 description: "Whether blocks result in people getting unfollowed"
1942 key: :outgoing_blocks,
1944 description: "Whether to federate blocks to other instances"
1947 key: :sign_object_fetches,
1949 description: "Sign object fetches with HTTP signatures"
1952 key: :note_replies_output_limit,
1955 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1958 key: :follow_handshake_timeout,
1960 description: "Following handshake timeout",
1967 key: :http_security,
1968 label: "HTTP security",
1970 description: "HTTP security settings",
1975 description: "Whether the managed content security policy is enabled"
1981 description: "Whether to additionally send a Strict-Transport-Security header"
1985 label: "STS max age",
1987 description: "The maximum age for the Strict-Transport-Security header if sent",
1988 suggestions: [31_536_000]
1992 label: "CT max age",
1994 description: "The maximum age for the Expect-CT header if sent",
1995 suggestions: [2_592_000]
1998 key: :referrer_policy,
2000 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2001 suggestions: ["same-origin", "no-referrer"]
2005 label: "Report URI",
2007 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2008 suggestions: ["https://example.com/report-uri"]
2013 group: :web_push_encryption,
2014 key: :vapid_details,
2015 label: "Vapid Details",
2018 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2024 "A mailto link for the administrative contact." <>
2025 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2026 suggestions: ["mailto:moderators@pleroma.com"]
2031 description: "VAPID public key",
2032 suggestions: ["Public key"]
2037 description: "VAPID private key",
2038 suggestions: ["Private key"]
2044 key: Pleroma.Captcha,
2046 description: "Captcha-related settings",
2051 description: "Whether the captcha should be shown on registration"
2056 description: "The method/service to use for captcha",
2057 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2060 key: :seconds_valid,
2062 description: "The time in seconds for which the captcha is valid",
2069 key: Pleroma.Captcha.Kocaptcha,
2072 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2073 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2078 description: "The kocaptcha endpoint to use",
2079 suggestions: ["https://captcha.kotobank.ch"]
2085 label: "Pleroma Admin Token",
2088 "Allows setting a token that can be used to authenticate requests with admin privileges without a normal user account token. Append the `admin_token` parameter to requests to utilize it. (Please reconsider using HTTP Basic Auth or OAuth-based authentication if possible)",
2093 description: "Admin token",
2095 "Please use a high entropy string or UUID"
2105 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2107 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2108 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2109 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2110 (see https://github.com/sorentwo/oban/issues/52).
2115 type: {:dropdown, :atom},
2116 description: "Logs verbose mode",
2117 suggestions: [false, :error, :warn, :info, :debug]
2121 type: {:keyword, :integer},
2123 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2125 activity_expiration: 10,
2126 attachments_cleanup: 5,
2128 federator_incoming: 50,
2129 federator_outgoing: 50,
2131 scheduled_activities: 10,
2137 key: :activity_expiration,
2139 description: "Activity expiration queue",
2143 key: :attachments_cleanup,
2145 description: "Attachment deletion queue",
2151 description: "Background queue",
2155 key: :federator_incoming,
2157 description: "Incoming federation queue",
2161 key: :federator_outgoing,
2163 description: "Outgoing federation queue",
2169 description: "Email sender queue, see Pleroma.Emails.Mailer",
2173 key: :scheduled_activities,
2175 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2179 key: :transmogrifier,
2181 description: "Transmogrifier queue",
2187 description: "Web push notifications queue",
2194 type: {:list, :tuple},
2195 description: "Settings for cron background jobs",
2197 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2198 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2199 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2200 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2201 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2210 description: "Includes custom worker options not interpretable directly by `Oban`",
2214 type: {:keyword, :integer},
2215 description: "Max retry attempts for failed jobs, per `Oban` queue",
2217 federator_incoming: 5,
2218 federator_outgoing: 5
2225 key: Pleroma.Web.Metadata,
2227 description: "Metadata-related settings",
2231 type: {:list, :module},
2232 description: "List of metadata providers to enable",
2234 Pleroma.Web.Metadata.Providers.OpenGraph,
2235 Pleroma.Web.Metadata.Providers.TwitterCard,
2236 Pleroma.Web.Metadata.Providers.RelMe,
2237 Pleroma.Web.Metadata.Providers.Feed
2242 label: "Unfurl NSFW",
2244 description: "When enabled NSFW attachments will be shown in previews"
2253 "If enabled the instance will parse metadata from attached links to generate link previews",
2258 description: "Enables RichMedia parsing of URLs"
2262 type: {:list, :string},
2263 description: "List of hosts which will be ignored by the metadata parser",
2264 suggestions: ["accounts.google.com", "xss.website"]
2268 label: "Ignore TLD",
2269 type: {:list, :string},
2270 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2271 suggestions: ["local", "localdomain", "lan"]
2275 type: {:list, :module},
2277 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom module you need to use full name.",
2279 Pleroma.Web.RichMedia.Parsers.OEmbed,
2280 Pleroma.Web.RichMedia.Parsers.TwitterCard
2285 label: "TTL setters",
2286 type: {:list, :module},
2288 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom module you need to use full name.",
2290 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2297 key: Pleroma.Formatter,
2298 label: "Auto Linker",
2301 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2305 type: [:string, :boolean],
2306 description: "Specify the class to be added to the generated link. Disable to clear.",
2307 suggestions: ["auto-linker", false]
2311 type: [:string, :boolean],
2312 description: "Override the rel attribute. Disable to clear.",
2313 suggestions: ["ugc", "noopener noreferrer", false]
2318 description: "Link URLs will open in a new window/tab."
2322 type: [:integer, :boolean],
2324 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2325 suggestions: [15, false]
2330 description: "Strip the scheme prefix."
2335 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2339 type: [:atom, :boolean],
2341 "Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for URLs without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't)",
2342 suggestions: [:no_scheme, true]
2348 key: Pleroma.ScheduledActivity,
2350 description: "Scheduled activities settings",
2353 key: :daily_user_limit,
2356 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2360 key: :total_user_limit,
2363 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2369 description: "Whether scheduled activities are sent to the job queue to be executed"
2375 key: Pleroma.ActivityExpiration,
2377 description: "Expired activity settings",
2382 description: "Whether expired activities will be sent to the job queue to be deleted"
2388 label: "Pleroma Authenticator",
2390 description: "Authenticator",
2393 key: Pleroma.Web.Auth.Authenticator,
2395 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2405 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2406 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2407 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2408 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2413 description: "Enables LDAP authentication"
2418 description: "LDAP server hostname",
2419 suggestions: ["localhosts"]
2424 description: "LDAP port, e.g. 389 or 636",
2425 suggestions: [389, 636]
2431 description: "Enable to use SSL, usually implies the port 636"
2435 label: "SSL options",
2437 description: "Additional SSL options",
2438 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2443 description: "Path to file with PEM encoded cacerts",
2444 suggestions: ["path/to/file/with/PEM/cacerts"]
2449 description: "Type of cert verification",
2450 suggestions: [:verify_peer]
2458 description: "Enable to use STARTTLS, usually implies the port 389"
2462 label: "TLS options",
2464 description: "Additional TLS options",
2465 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2470 description: "Path to file with PEM encoded cacerts",
2471 suggestions: ["path/to/file/with/PEM/cacerts"]
2476 description: "Type of cert verification",
2477 suggestions: [:verify_peer]
2484 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2485 suggestions: ["dc=example,dc=com"]
2492 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2501 description: "Authentication / authorization settings",
2504 key: :enforce_oauth_admin_scope_usage,
2505 label: "Enforce OAuth admin scope usage",
2508 "OAuth admin scope requirement toggle. " <>
2509 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2510 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2511 "`is_admin` user flag grants access to admin-specific actions."
2514 key: :auth_template,
2517 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2518 suggestions: ["show.html"]
2521 key: :oauth_consumer_template,
2522 label: "OAuth consumer template",
2525 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2526 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2527 suggestions: ["consumer.html"]
2530 key: :oauth_consumer_strategies,
2531 label: "OAuth consumer strategies",
2532 type: {:list, :string},
2534 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2535 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2536 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2537 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2543 key: :email_notifications,
2545 description: "Email notifications settings",
2551 "emails of \"what you've missed\" for users who have been inactive for a while",
2555 schedule: "0 0 * * 0",
2557 inactivity_threshold: 7
2565 description: "Globally enable or disable digest emails"
2571 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2572 suggestions: ["0 0 * * 0"]
2577 description: "Minimum interval between digest emails to one user",
2581 key: :inactivity_threshold,
2583 description: "Minimum user inactivity threshold",
2592 key: Pleroma.Emails.UserEmail,
2594 description: "Email template settings",
2599 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2600 suggestions: ["some/path/logo.png"]
2605 description: "A map with color settings for email templates.",
2608 link_color: "#d8a070",
2609 background_color: "#2C3645",
2610 content_background_color: "#1B2635",
2611 header_color: "#d8a070",
2612 text_color: "#b9b9ba",
2613 text_muted_color: "#b9b9ba"
2620 suggestions: ["#d8a070"]
2623 key: :background_color,
2625 suggestions: ["#2C3645"]
2628 key: :content_background_color,
2630 suggestions: ["#1B2635"]
2635 suggestions: ["#d8a070"]
2640 suggestions: ["#b9b9ba"]
2643 key: :text_muted_color,
2645 suggestions: ["#b9b9ba"]
2653 key: Pleroma.Emails.NewUsersDigestEmail,
2655 description: "New users admin email digest",
2660 description: "Enables new users admin digest email when `true`"
2669 description: "Configure OAuth 2 provider capabilities",
2672 key: :token_expires_in,
2674 description: "The lifetime in seconds of the access token",
2678 key: :issue_new_refresh_token,
2681 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2684 key: :clean_expired_tokens,
2686 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2696 key: :shortcode_globs,
2697 type: {:list, :string},
2698 description: "Location of custom emoji files. * can be used as a wildcard.",
2699 suggestions: ["/emoji/custom/**/*.png"]
2702 key: :pack_extensions,
2703 type: {:list, :string},
2705 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2706 suggestions: [".png", ".gif"]
2710 type: {:keyword, {:list, :string}},
2712 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2713 " and the value is the location or array of locations. * can be used as a wildcard.",
2715 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2719 key: :default_manifest,
2722 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2723 " Currently only one manifest can be added (no arrays).",
2724 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2727 key: :shared_pack_cache_seconds_per_file,
2728 label: "Shared pack cache s/file",
2731 "When an emoji pack is shared, the archive is created and cached in memory" <>
2732 " for this amount of seconds multiplied by the number of files.",
2742 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2746 type: [:tuple, {:list, :tuple}],
2747 description: "For the search requests (account & status search etc.)",
2748 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2752 type: [:tuple, {:list, :tuple}],
2753 description: "For requests to timelines (each timeline has it's own limiter)",
2754 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2757 key: :app_account_creation,
2758 type: [:tuple, {:list, :tuple}],
2759 description: "For registering user accounts from the same IP address",
2760 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2763 key: :relations_actions,
2764 type: [:tuple, {:list, :tuple}],
2765 description: "For actions on relationships with all users (follow, unfollow)",
2766 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2769 key: :relation_id_action,
2770 label: "Relation ID action",
2771 type: [:tuple, {:list, :tuple}],
2772 description: "For actions on relation with a specific user (follow, unfollow)",
2773 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2776 key: :statuses_actions,
2777 type: [:tuple, {:list, :tuple}],
2779 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2780 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2783 key: :status_id_action,
2784 label: "Status ID action",
2785 type: [:tuple, {:list, :tuple}],
2787 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2788 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2791 key: :authentication,
2792 type: [:tuple, {:list, :tuple}],
2793 description: "For authentication create / password check / user existence check requests",
2794 suggestions: [{60_000, 15}]
2803 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2804 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2809 description: "Enables SSH"
2814 description: "Dir with SSH keys",
2815 suggestions: ["/some/path/ssh_keys"]
2820 description: "Handler module",
2821 suggestions: ["Pleroma.BBS.Handler"]
2826 description: "Port to connect",
2827 suggestions: [10_022]
2830 key: :password_authenticator,
2832 description: "Authenticator module",
2833 suggestions: ["Pleroma.BBS.Authenticator"]
2839 label: "Mime Types",
2841 description: "Mime Types settings",
2848 "application/xml" => ["xml"],
2849 "application/xrd+xml" => ["xrd+xml"],
2850 "application/jrd+json" => ["jrd+json"],
2851 "application/activity+json" => ["activity+json"],
2852 "application/ld+json" => ["activity+json"]
2857 key: "application/xml",
2858 type: {:list, :string},
2859 suggestions: ["xml"]
2862 key: "application/xrd+xml",
2863 type: {:list, :string},
2864 suggestions: ["xrd+xml"]
2867 key: "application/jrd+json",
2868 type: {:list, :string},
2869 suggestions: ["jrd+json"]
2872 key: "application/activity+json",
2873 type: {:list, :string},
2874 suggestions: ["activity+json"]
2877 key: "application/ld+json",
2878 type: {:list, :string},
2879 suggestions: ["activity+json"]
2889 description: "Pleroma chat settings",
2902 description: "HTTP settings",
2907 type: [:string, :tuple],
2908 description: "Proxy URL",
2909 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2912 key: :send_user_agent,
2917 type: [:string, :atom],
2919 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2920 suggestions: ["Pleroma", :default]
2925 description: "Adapter specific options",
2931 label: "SSL Options",
2932 description: "SSL options for HTTP adapter",
2936 type: {:list, :atom},
2937 description: "List of TLS version to use",
2938 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2949 label: "Markup Settings",
2953 key: :allow_inline_images,
2957 key: :allow_headings,
2970 type: {:list, :module},
2972 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2973 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2983 key: :deny_follow_blocked,
2990 key: :mrf_normalize_markup,
2992 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
2993 label: "MRF Normalize Markup",
2994 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3000 suggestions: [Pleroma.HTML.Scrubber.Default]
3010 key: :restricted_nicknames,
3011 type: {:list, :string},
3030 "ostatus_subscribe",
3049 label: "CORS plug config",
3055 suggestions: [86_400]
3059 type: {:list, :string},
3060 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3064 type: {:list, :string},
3067 "X-RateLimit-Reset",
3068 "X-RateLimit-Limit",
3069 "X-RateLimit-Remaining",
3080 type: {:list, :string},
3081 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3087 key: Pleroma.Plugs.RemoteIp,
3090 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3091 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3097 description: "Enable/disable the plug. Default: disabled."
3101 type: {:list, :string},
3103 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Default: `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
3107 type: {:list, :string},
3109 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3113 type: {:list, :string},
3115 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3121 key: :web_cache_ttl,
3122 label: "Web cache TTL",
3125 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3131 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3132 suggestions: [30_000, nil]
3135 key: :activity_pub_question,
3137 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3138 suggestions: [30_000]
3148 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3153 description: "Enables the rendering of static HTML. Default: disabled."
3161 description: "Configure feed rendering",
3166 description: "Configure title rendering",
3171 description: "Maximum number of characters before truncating title",
3177 description: "Replacement which will be used after truncating string",
3178 suggestions: ["..."]
3186 key: :mrf_object_age,
3188 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3189 label: "MRF Object Age",
3192 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3197 description: "Required age (in seconds) of a post before actions are taken.",
3198 suggestions: [172_800]
3202 type: {:list, :atom},
3204 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3205 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3206 "`:reject` rejects the message entirely",
3207 suggestions: [:delist, :strip_followers, :reject]
3215 description: "Custom Runtime Modules",
3220 description: "A path to custom Elixir modules (such as MRF policies)."
3228 description: "Settings for notifications streamer",
3233 description: "Number of workers to send notifications",
3237 key: :overflow_workers,
3239 description: "Maximum number of workers created if pool is empty",
3246 key: :connections_pool,
3248 description: "Advanced settings for `gun` connections pool",
3251 key: :connection_acquisition_wait,
3254 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3258 key: :connection_acquisition_retries,
3261 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3265 key: :max_connections,
3267 description: "Maximum number of connections in the pool. Default: 250 connections.",
3271 key: :await_up_timeout,
3273 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3277 key: :reclaim_multiplier,
3280 "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3289 description: "Advanced settings for `gun` workers pools",
3291 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3295 description: "Settings for #{pool_name} pool.",
3300 description: "Maximum number of concurrent requests in the pool.",
3307 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3316 key: :hackney_pools,
3318 description: "Advanced settings for `hackney` connections pools",
3323 description: "Settings for federation pool.",
3326 key: :max_connections,
3328 description: "Number workers in the pool.",
3334 description: "Timeout while `hackney` will wait for response.",
3335 suggestions: [150_000]
3342 description: "Settings for media pool.",
3345 key: :max_connections,
3347 description: "Number workers in the pool.",
3353 description: "Timeout while `hackney` will wait for response.",
3354 suggestions: [150_000]
3361 description: "Settings for upload pool.",
3364 key: :max_connections,
3366 description: "Number workers in the pool.",
3372 description: "Timeout while `hackney` will wait for response.",
3373 suggestions: [300_000]
3381 key: :restrict_unauthenticated,
3384 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3389 description: "Settings for public and federated timelines.",
3394 description: "Disallow view public timeline."
3399 description: "Disallow view federated timeline."
3406 description: "Settings for user profiles.",
3411 description: "Disallow view local user profiles."
3416 description: "Disallow view remote user profiles."
3423 description: "Settings for statuses.",
3428 description: "Disallow view local statuses."
3433 description: "Disallow view remote statuses."
3441 key: Pleroma.Web.ApiSpec.CastAndValidate,
3448 "Enables strict input validation (useful in development, not recommended in production)"
3454 key: :instances_favicons,
3456 description: "Control favicons for instances",
3461 description: "Allow/disallow displaying and getting instances favicons"
3469 descriptions: "S3 service related settings",
3472 key: :access_key_id,
3474 description: "S3 access key ID",
3475 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3478 key: :secret_access_key,
3480 description: "Secret access key",
3481 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3486 description: "S3 host",
3487 suggestions: ["s3.eu-central-1.amazonaws.com"]
3495 description: "Installed frontends management",
3500 description: "Primary frontend, the one that is served for all pages by default",
3505 description: "Name of the installed primary frontend"
3510 description: "reference of the installed primary frontend to be used"