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: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
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.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "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`."
49 description: "Base URL for the uploads, needed if you use CDN",
51 "https://cdn-host.com"
58 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 label: "Proxy Options",
64 description: "Options for Pleroma.ReverseProxy",
66 redirect_on_failure: false,
67 max_body_length: 25 * 1_048_576,
69 follow_redirect: true,
75 key: :redirect_on_failure,
78 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
79 "Any error during body processing will not be redirected as the response is chunked."
82 key: :max_body_length,
85 "Limits the content length to be approximately the " <>
86 "specified length. It is validated with the `content-length` header and also verified when proxying."
92 description: "HTTP options",
97 description: "Adapter specific options",
102 label: "SSL Options",
103 description: "SSL options for HTTP adapter",
107 type: {:list, :atom},
108 description: "List of TLS versions to use",
109 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
118 type: [:string, :tuple],
119 description: "Proxy URL",
120 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: :filename_display_max_length,
129 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
135 key: Pleroma.Uploaders.Local,
137 description: "Local uploader-related settings",
142 description: "Path where user's uploads will be saved",
151 key: Pleroma.Uploaders.S3,
153 description: "S3 uploader-related settings",
158 description: "S3 bucket",
164 key: :bucket_namespace,
166 description: "S3 bucket namespace",
167 suggestions: ["pleroma"]
170 key: :public_endpoint,
172 description: "S3 endpoint",
173 suggestions: ["https://s3.amazonaws.com"]
176 key: :truncated_namespace,
179 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
180 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
183 key: :streaming_enabled,
186 "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."
192 key: Pleroma.Upload.Filter.Mogrify,
194 description: "Uploads mogrify filter settings",
198 type: [:string, {:list, :string}, {:list, :tuple}],
200 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
201 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
212 key: Pleroma.Upload.Filter.AnonymizeFilename,
214 description: "Filter replaces the filename of the upload",
220 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
221 " filename extension by using {extension}, for example custom-file-name.{extension}.",
223 "custom-file-name.{extension}"
230 key: Pleroma.Emails.Mailer,
232 description: "Mailer-related settings",
238 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
239 " or Swoosh.Adapters.Local for in-memory mailbox",
241 Swoosh.Adapters.SMTP,
242 Swoosh.Adapters.Sendgrid,
243 Swoosh.Adapters.Sendmail,
244 Swoosh.Adapters.Mandrill,
245 Swoosh.Adapters.Mailgun,
246 Swoosh.Adapters.Mailjet,
247 Swoosh.Adapters.Postmark,
248 Swoosh.Adapters.SparkPost,
249 Swoosh.Adapters.AmazonSES,
251 Swoosh.Adapters.SocketLabs,
252 Swoosh.Adapters.Gmail,
253 Swoosh.Adapters.Local
259 description: "Allow/disallow send emails"
262 group: {:subgroup, Swoosh.Adapters.SMTP},
265 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
266 suggestions: ["smtp.gmail.com"]
269 group: {:subgroup, Swoosh.Adapters.SMTP},
272 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
273 suggestions: ["pleroma"]
276 group: {:subgroup, Swoosh.Adapters.SMTP},
279 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
280 suggestions: ["password"]
283 group: {:subgroup, Swoosh.Adapters.SMTP},
287 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
290 group: {:subgroup, Swoosh.Adapters.SMTP},
294 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
295 suggestions: [:always, :never, :if_available]
298 group: {:subgroup, Swoosh.Adapters.SMTP},
301 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 suggestions: [:always, :never, :if_available]
305 group: {:subgroup, Swoosh.Adapters.SMTP},
308 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
312 group: {:subgroup, Swoosh.Adapters.SMTP},
315 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
319 group: {:subgroup, Swoosh.Adapters.SMTP},
321 label: "No MX lookups",
323 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
326 group: {:subgroup, Swoosh.Adapters.Sendgrid},
330 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
331 suggestions: ["my-api-key"]
334 group: {:subgroup, Swoosh.Adapters.Sendmail},
337 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
338 suggestions: ["/usr/bin/sendmail"]
341 group: {:subgroup, Swoosh.Adapters.Sendmail},
344 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
345 suggestions: ["-N delay,failure,success"]
348 group: {:subgroup, Swoosh.Adapters.Sendmail},
351 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
354 group: {:subgroup, Swoosh.Adapters.Mandrill},
358 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
359 suggestions: ["my-api-key"]
362 group: {:subgroup, Swoosh.Adapters.Mailgun},
366 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
367 suggestions: ["my-api-key"]
370 group: {:subgroup, Swoosh.Adapters.Mailgun},
373 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
374 suggestions: ["pleroma.com"]
377 group: {:subgroup, Swoosh.Adapters.Mailjet},
381 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
382 suggestions: ["my-api-key"]
385 group: {:subgroup, Swoosh.Adapters.Mailjet},
388 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
389 suggestions: ["my-secret-key"]
392 group: {:subgroup, Swoosh.Adapters.Postmark},
396 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
397 suggestions: ["my-api-key"]
400 group: {:subgroup, Swoosh.Adapters.SparkPost},
404 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
405 suggestions: ["my-api-key"]
408 group: {:subgroup, Swoosh.Adapters.SparkPost},
411 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
412 suggestions: ["https://api.sparkpost.com/api/v1"]
415 group: {:subgroup, Swoosh.Adapters.AmazonSES},
418 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
419 suggestions: ["us-east-1", "us-east-2"]
422 group: {:subgroup, Swoosh.Adapters.AmazonSES},
425 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
426 suggestions: ["aws-access-key"]
429 group: {:subgroup, Swoosh.Adapters.AmazonSES},
432 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
433 suggestions: ["aws-secret-key"]
436 group: {:subgroup, Swoosh.Adapters.Dyn},
440 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
441 suggestions: ["my-api-key"]
444 group: {:subgroup, Swoosh.Adapters.SocketLabs},
447 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
450 group: {:subgroup, Swoosh.Adapters.SocketLabs},
454 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
457 group: {:subgroup, Swoosh.Adapters.Gmail},
460 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
467 description: "`Swoosh.Adapters.Local` adapter specific settings",
470 group: {:subgroup, Swoosh.Adapters.Local},
473 description: "Run the preview server together as part of your app"
476 group: {:subgroup, Swoosh.Adapters.Local},
479 description: "The preview server port",
487 label: "URI Schemes",
489 description: "URI schemes related settings",
493 type: {:list, :string},
494 description: "List of the scheme part that is considered valid to be an URL",
518 description: "Instance-related settings",
523 description: "Name of the instance",
530 label: "Admin Email Address",
532 description: "Email used to reach an Administrator/Moderator of the instance",
539 label: "Sender Email Address",
541 description: "Envelope FROM address for mail sent via Pleroma",
550 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
558 description: "Posts character limit (CW/Subject included in the counter)",
566 description: "Character limit of the instance chat messages",
574 description: "Hard character limit beyond which remote posts will be dropped",
582 description: "File size limit of uploads (except for avatar, background, banner)",
588 key: :avatar_upload_limit,
590 description: "File size limit of user's profile avatars",
596 key: :background_upload_limit,
598 description: "File size limit of user's profile backgrounds",
604 key: :banner_upload_limit,
606 description: "File size limit of user's profile banners",
614 description: "A map with poll limits for local polls",
618 max_option_chars: 200,
620 max_expiration: 31_536_000
627 description: "Maximum number of options",
631 key: :max_option_chars,
633 description: "Maximum number of characters per option",
637 key: :min_expiration,
639 description: "Minimum expiration time (in seconds)",
643 key: :max_expiration,
645 description: "Maximum expiration time (in seconds)",
651 key: :registrations_open,
654 "Enable registrations for anyone. Invitations require this setting to be disabled."
657 key: :invites_enabled,
660 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
663 key: :account_activation_required,
665 description: "Require users to confirm their emails before signing in"
670 description: "Enable federation with other instances"
673 key: :federation_incoming_replies_max_depth,
674 label: "Fed. incoming replies max depth",
677 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
678 " 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.",
684 key: :federation_reachability_timeout_days,
685 label: "Fed. reachability timeout days",
688 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
696 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
702 "Makes the client API in authentificated mode-only except for user-profiles." <>
703 " Useful for disabling the Local Timeline and The Whole Known Network."
706 key: :quarantined_instances,
707 type: {:list, :string},
709 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
716 key: :managed_config,
719 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
724 description: "Instance static directory",
730 key: :allowed_post_formats,
731 type: {:list, :string},
732 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
741 key: :extended_nickname_format,
744 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
745 " This will break federation with older software for theses nicknames."
748 key: :cleanup_attachments,
751 Enable to remove associated attachments when status is removed.
752 This will not affect duplicates and attachments without status.
753 Enabling this will increase load to database when deleting statuses on larger instances.
757 key: :max_pinned_statuses,
759 description: "The maximum number of pinned statuses. 0 will disable the feature.",
767 key: :autofollowed_nicknames,
768 type: {:list, :string},
770 "Set to nicknames of (local) users that every new user should automatically follow",
779 key: :attachment_links,
781 description: "Enable to automatically add attachment link text to statuses"
784 key: :welcome_message,
787 "A message that will be sent to a newly registered users as a direct message",
789 "Hi, @username! Welcome on board!"
793 key: :welcome_user_nickname,
795 description: "The nickname of the local user that sends the welcome message",
801 key: :max_report_comment_size,
803 description: "The maximum size of the report comment. Default: 1000.",
809 key: :safe_dm_mentions,
810 label: "Safe DM mentions",
813 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
814 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
820 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
823 key: :remote_post_retention_days,
826 "The default amount of days to retain remote posts when pruning the database",
832 key: :user_bio_length,
834 description: "A user bio maximum length. Default: 5000.",
840 key: :user_name_length,
842 description: "A user name maximum length. Default: 100.",
848 key: :skip_thread_containment,
850 description: "Skip filtering out broken threads. Default: enabled."
853 key: :limit_to_local_content,
854 type: {:dropdown, :atom},
856 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
864 key: :max_account_fields,
866 description: "The maximum number of custom fields in the user profile. Default: 10.",
872 key: :max_remote_account_fields,
875 "The maximum number of custom fields in the remote user profile. Default: 20.",
881 key: :account_field_name_length,
883 description: "An account field name maximum length. Default: 512.",
889 key: :account_field_value_length,
891 description: "An account field value maximum length. Default: 2048.",
897 key: :external_user_synchronization,
899 description: "Enabling following/followers counters synchronization for external users"
902 key: :multi_factor_authentication,
904 description: "Multi-factor authentication settings",
907 totp: [digits: 6, period: 30],
908 backup_codes: [number: 5, length: 16]
914 label: "TOTP settings",
916 description: "TOTP settings",
917 suggestions: [digits: 6, period: 30],
924 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
931 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
938 description: "MFA backup codes settings",
939 suggestions: [number: 5, length: 16],
945 description: "Number of backup codes to generate."
952 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
959 key: :instance_thumbnail,
962 "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.",
963 suggestions: ["/instance/thumbnail.jpeg"]
970 description: "Logger-related settings",
974 type: [:atom, :tuple, :module],
976 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
977 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
985 label: "ExSyslogger",
986 description: "ExSyslogger-related settings",
990 type: {:dropdown, :atom},
991 description: "Log level",
992 suggestions: [:debug, :info, :warn, :error]
998 "A string that's prepended to every message, and is typically set to the app name",
999 suggestions: ["pleroma"]
1004 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1005 suggestions: ["$metadata[$level] $message"]
1009 type: {:list, :atom},
1010 suggestions: [:request_id]
1018 label: "Console Logger",
1019 description: "Console logger settings",
1023 type: {:dropdown, :atom},
1024 description: "Log level",
1025 suggestions: [:debug, :info, :warn, :error]
1030 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1031 suggestions: ["$metadata[$level] $message"]
1035 type: {:list, :atom},
1036 suggestions: [:request_id]
1043 label: "Quack Logger",
1044 description: "Quack-related settings",
1048 type: {:dropdown, :atom},
1049 description: "Log level",
1050 suggestions: [:debug, :info, :warn, :error]
1054 type: {:list, :atom},
1055 description: "Configure which metadata you want to report on",
1073 description: "Configure the Slack incoming webhook",
1074 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1080 key: :frontend_configurations,
1083 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1084 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1085 "add your own configuration your settings all fields must be complete.",
1089 label: "Pleroma FE",
1091 description: "Settings for Pleroma FE",
1094 alwaysShowSubjectInput: true,
1095 background: "/static/aurora_borealis.jpg",
1096 collapseMessageWithSubject: false,
1099 hideFilteredStatuses: false,
1100 hideMutedPosts: false,
1101 hidePostStats: false,
1102 hideSitename: false,
1103 hideUserStats: false,
1104 loginMethod: "password",
1105 logo: "/static/logo.png",
1108 minimalScopesMode: false,
1109 noAttachmentLinks: false,
1110 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1111 postContentType: "text/plain",
1112 redirectRootLogin: "/main/friends",
1113 redirectRootNoLogin: "/main/all",
1115 sidebarRight: false,
1116 showFeaturesPanel: true,
1117 showInstanceSpecificPanel: false,
1118 subjectLineBehavior: "email",
1119 theme: "pleroma-dark",
1120 webPushNotifications: false
1125 key: :alwaysShowSubjectInput,
1126 label: "Always show subject input",
1128 description: "When disabled, auto-hide the subject field if it's empty"
1134 "URL of the background, unless viewing a user profile with a background that is set",
1135 suggestions: ["/images/city.jpg"]
1138 key: :collapseMessageWithSubject,
1139 label: "Collapse message with subject",
1142 "When a message has a subject (aka Content Warning), collapse it by default"
1146 label: "PleromaFE Chat",
1148 description: "Disables PleromaFE Chat component"
1154 description: "Enables green text on lines prefixed with the > character"
1157 key: :hideFilteredStatuses,
1158 label: "Hide Filtered Statuses",
1160 description: "Hides filtered statuses from timelines"
1163 key: :hideMutedPosts,
1164 label: "Hide Muted Posts",
1166 description: "Hides muted statuses from timelines"
1169 key: :hidePostStats,
1170 label: "Hide post stats",
1172 description: "Hide notices statistics (repeats, favorites, ...)"
1176 label: "Hide Sitename",
1178 description: "Hides instance name from PleromaFE banner"
1181 key: :hideUserStats,
1182 label: "Hide user stats",
1185 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1190 description: "URL of the logo, defaults to Pleroma's logo",
1191 suggestions: ["/static/logo.png"]
1195 label: "Logo margin",
1198 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1199 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1200 suggestions: [".1em"]
1207 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1208 "If you want a colorful logo you must disable logoMask."
1211 key: :minimalScopesMode,
1212 label: "Minimal scopes mode",
1215 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1216 "Also prevents replying to a DM with a public post from PleromaFE."
1219 key: :nsfwCensorImage,
1220 label: "NSFW Censor Image",
1223 "URL of the image to use for hiding NSFW media attachments in the timeline",
1224 suggestions: ["/static/img/nsfw.74818f9.png"]
1227 key: :postContentType,
1228 label: "Post Content Type",
1229 type: {:dropdown, :atom},
1230 description: "Default post formatting option",
1231 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1234 key: :redirectRootNoLogin,
1235 label: "Redirect root no login",
1238 "Relative URL which indicates where to redirect when a user isn't logged in",
1239 suggestions: ["/main/all"]
1242 key: :redirectRootLogin,
1243 label: "Redirect root login",
1246 "Relative URL which indicates where to redirect when a user is logged in",
1247 suggestions: ["/main/friends"]
1251 label: "Scope copy",
1253 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1257 label: "Sidebar on Right",
1259 description: "Change alignment of sidebar and panels to the right"
1262 key: :showFeaturesPanel,
1263 label: "Show instance features panel",
1266 "Enables panel displaying functionality of the instance on the About page"
1269 key: :showInstanceSpecificPanel,
1270 label: "Show instance specific panel",
1272 description: "Whether to show the instance's custom panel"
1275 key: :subjectLineBehavior,
1276 label: "Subject line behavior",
1278 description: "Allows changing the default behaviour of subject lines in replies.
1279 `email`: copy and preprend re:, as in email,
1280 `masto`: copy verbatim, as in Mastodon,
1281 `noop`: don't copy the subject.",
1282 suggestions: ["email", "masto", "noop"]
1287 description: "Which theme to use. Available themes are defined in styles.json",
1288 suggestions: ["pleroma-dark"]
1296 description: "Settings for Masto FE",
1299 showInstanceSpecificPanel: true
1304 key: :showInstanceSpecificPanel,
1305 label: "Show instance specific panel",
1307 description: "Whenether to show the instance's specific panel"
1318 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1322 type: {:keyword, :map},
1324 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1327 url: "/images/pleroma-fox-tan-smol.png",
1328 mime_type: "image/png"
1330 pleroma_fox_tan_shy: %{
1331 url: "/images/pleroma-fox-tan-shy.png",
1332 mime_type: "image/png"
1337 key: :default_mascot,
1340 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1346 key: :default_user_avatar,
1348 description: "URL of the default user avatar",
1349 suggestions: ["/images/avi.png"]
1358 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1362 type: {:list, :map},
1363 description: "Describe the icons of the app",
1366 src: "/static/logo.png"
1369 src: "/static/icon.png",
1373 src: "/static/icon.ico",
1374 sizes: "72x72 96x96 128x128 256x256"
1381 description: "Describe the theme color of the app",
1382 suggestions: ["#282c37", "mediumpurple"]
1385 key: :background_color,
1387 description: "Describe the background color of the app",
1388 suggestions: ["#191b22", "aliceblue"]
1396 label: "MRF Simple",
1398 description: "Message Rewrite Facility",
1401 key: :media_removal,
1402 type: {:list, :string},
1403 description: "List of instances to strip media attachments from",
1404 suggestions: ["example.com", "*.example.com"]
1408 label: "Media NSFW",
1409 type: {:list, :string},
1410 description: "List of instances to tag all media as NSFW (sensitive) from",
1411 suggestions: ["example.com", "*.example.com"]
1414 key: :federated_timeline_removal,
1415 type: {:list, :string},
1417 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1418 suggestions: ["example.com", "*.example.com"]
1422 type: {:list, :string},
1423 description: "List of instances to reject activities from (except deletes)",
1424 suggestions: ["example.com", "*.example.com"]
1428 type: {:list, :string},
1429 description: "List of instances to only accept activities from (except deletes)",
1430 suggestions: ["example.com", "*.example.com"]
1433 key: :report_removal,
1434 type: {:list, :string},
1435 description: "List of instances to reject reports from",
1436 suggestions: ["example.com", "*.example.com"]
1439 key: :avatar_removal,
1440 type: {:list, :string},
1441 description: "List of instances to strip avatars from",
1442 suggestions: ["example.com", "*.example.com"]
1445 key: :banner_removal,
1446 type: {:list, :string},
1447 description: "List of instances to strip banners from",
1448 suggestions: ["example.com", "*.example.com"]
1451 key: :reject_deletes,
1452 type: {:list, :string},
1453 description: "List of instances to reject deletions from",
1454 suggestions: ["example.com", "*.example.com"]
1460 key: :mrf_activity_expiration,
1462 label: "MRF Activity Expiration Policy",
1464 description: "Adds expiration to all local Create Note activities",
1469 description: "Default global expiration time for all local Create activities (in days)",
1470 suggestions: [90, 365]
1478 label: "MRF Subchain",
1481 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1482 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1487 description: "Matches a series of regular expressions against the actor field",
1490 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1498 key: :mrf_rejectnonpublic,
1501 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1502 label: "MRF Reject Non Public",
1506 key: :allow_followersonly,
1507 label: "Allow followers-only",
1509 description: "Whether to allow followers-only posts"
1514 description: "Whether to allow direct messages"
1520 key: :mrf_hellthread,
1522 label: "MRF Hellthread",
1524 description: "Block messages with too much mentions",
1527 key: :delist_threshold,
1530 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1531 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1535 key: :reject_threshold,
1538 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1547 label: "MRF Keyword",
1549 description: "Reject or Word-Replace messages with a keyword or regex",
1553 type: [:string, :regex],
1555 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1556 suggestions: ["foo", ~r/foo/iu]
1559 key: :federated_timeline_removal,
1560 type: [:string, :regex],
1562 "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.",
1563 suggestions: ["foo", ~r/foo/iu]
1567 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1569 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1570 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1578 label: "MRF Mention",
1580 description: "Block messages which mention a user",
1584 type: {:list, :string},
1585 description: "A list of actors for which any post mentioning them will be dropped",
1586 suggestions: ["actor1", "actor2"]
1592 key: :mrf_vocabulary,
1594 label: "MRF Vocabulary",
1596 description: "Filter messages which belong to certain activity vocabularies",
1600 type: {:list, :string},
1602 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1603 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1607 type: {:list, :string},
1609 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1610 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1616 # key: :mrf_user_allowlist,
1619 # "The keys in this section are the domain names that the policy should apply to." <>
1620 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1622 # %{"example.org" => ["https://example.org/users/admin"]}
1630 description: "Media proxy",
1635 description: "Enables proxying of remote media to the instance's proxy"
1642 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1643 suggestions: ["https://example.com"]
1651 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1657 description: "Enables invalidate media cache"
1662 description: "Module which will be used to cache purge.",
1664 Pleroma.Web.MediaProxy.Invalidation.Script,
1665 Pleroma.Web.MediaProxy.Invalidation.Http
1672 label: "Proxy Options",
1674 description: "Options for Pleroma.ReverseProxy",
1676 redirect_on_failure: false,
1677 max_body_length: 25 * 1_048_576,
1679 follow_redirect: true,
1685 key: :redirect_on_failure,
1688 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1689 "Any error during body processing will not be redirected as the response is chunked."
1692 key: :max_body_length,
1695 "Limits the content length to be approximately the " <>
1696 "specified length. It is validated with the `content-length` header and also verified when proxying."
1702 description: "HTTP options",
1707 description: "Adapter specific options",
1712 label: "SSL Options",
1713 description: "SSL options for HTTP adapter",
1717 type: {:list, :atom},
1718 description: "List of TLS version to use",
1719 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1728 type: [:string, :tuple],
1729 description: "Proxy URL",
1730 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1738 type: {:list, :string},
1739 description: "List of domains to bypass the mediaproxy",
1740 suggestions: ["example.com"]
1746 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1748 description: "HTTP invalidate settings",
1753 description: "HTTP method of request. Default: :purge"
1757 type: {:list, :tuple},
1758 description: "HTTP headers of request.",
1759 suggestions: [{"x-refresh", 1}]
1764 description: "Request options.",
1765 suggestions: [params: %{ts: "xxx"}]
1771 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1773 description: "Script invalidate settings",
1778 description: "Path to shell script. Which will run purge cache.",
1779 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1787 description: "Gopher settings",
1792 description: "Enables the gopher interface"
1798 description: "IP address to bind to",
1799 suggestions: [{0, 0, 0, 0}]
1804 description: "Port to bind to",
1810 description: "Port advertised in URLs (optional, defaults to port)",
1818 label: "ActivityPub",
1820 description: "ActivityPub-related settings",
1823 key: :unfollow_blocked,
1825 description: "Whether blocks result in people getting unfollowed"
1828 key: :outgoing_blocks,
1830 description: "Whether to federate blocks to other instances"
1833 key: :sign_object_fetches,
1835 description: "Sign object fetches with HTTP signatures"
1838 key: :note_replies_output_limit,
1841 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1844 key: :follow_handshake_timeout,
1846 description: "Following handshake timeout",
1853 key: :http_security,
1854 label: "HTTP security",
1856 description: "HTTP security settings",
1861 description: "Whether the managed content security policy is enabled"
1867 description: "Whether to additionally send a Strict-Transport-Security header"
1871 label: "STS max age",
1873 description: "The maximum age for the Strict-Transport-Security header if sent",
1874 suggestions: [31_536_000]
1878 label: "CT max age",
1880 description: "The maximum age for the Expect-CT header if sent",
1881 suggestions: [2_592_000]
1884 key: :referrer_policy,
1886 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1887 suggestions: ["same-origin", "no-referrer"]
1891 label: "Report URI",
1893 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1894 suggestions: ["https://example.com/report-uri"]
1899 group: :web_push_encryption,
1900 key: :vapid_details,
1901 label: "Vapid Details",
1904 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1910 "A mailto link for the administrative contact." <>
1911 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1912 suggestions: ["mailto:moderators@pleroma.com"]
1917 description: "VAPID public key",
1918 suggestions: ["Public key"]
1923 description: "VAPID private key",
1924 suggestions: ["Private key"]
1930 key: Pleroma.Captcha,
1932 description: "Captcha-related settings",
1937 description: "Whether the captcha should be shown on registration"
1942 description: "The method/service to use for captcha",
1943 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1946 key: :seconds_valid,
1948 description: "The time in seconds for which the captcha is valid",
1955 key: Pleroma.Captcha.Kocaptcha,
1958 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1959 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1964 description: "The kocaptcha endpoint to use",
1965 suggestions: ["https://captcha.kotobank.ch"]
1971 label: "Pleroma Admin Token",
1974 "Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the `admin_token` parameter",
1979 description: "Admin token",
1980 suggestions: ["We recommend a secure random string or UUID"]
1989 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1991 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1992 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1993 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1994 (see https://github.com/sorentwo/oban/issues/52).
1999 type: {:dropdown, :atom},
2000 description: "Logs verbose mode",
2001 suggestions: [false, :error, :warn, :info, :debug]
2005 type: [:atom, :tuple],
2007 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
2008 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
2012 type: {:keyword, :integer},
2014 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2016 activity_expiration: 10,
2017 attachments_cleanup: 5,
2019 federator_incoming: 50,
2020 federator_outgoing: 50,
2022 scheduled_activities: 10,
2028 key: :activity_expiration,
2030 description: "Activity expiration queue",
2034 key: :attachments_cleanup,
2036 description: "Attachment deletion queue",
2042 description: "Background queue",
2046 key: :federator_incoming,
2048 description: "Incoming federation queue",
2052 key: :federator_outgoing,
2054 description: "Outgoing federation queue",
2060 description: "Email sender queue, see Pleroma.Emails.Mailer",
2064 key: :scheduled_activities,
2066 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2070 key: :transmogrifier,
2072 description: "Transmogrifier queue",
2078 description: "Web push notifications queue",
2085 type: {:list, :tuple},
2086 description: "Settings for cron background jobs",
2088 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2089 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2090 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2091 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2092 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2101 description: "Includes custom worker options not interpretable directly by `Oban`",
2105 type: {:keyword, :integer},
2106 description: "Max retry attempts for failed jobs, per `Oban` queue",
2108 federator_incoming: 5,
2109 federator_outgoing: 5
2116 key: Pleroma.Web.Metadata,
2118 description: "Metadata-related settings",
2122 type: {:list, :module},
2123 description: "List of metadata providers to enable",
2125 Pleroma.Web.Metadata.Providers.OpenGraph,
2126 Pleroma.Web.Metadata.Providers.TwitterCard,
2127 Pleroma.Web.Metadata.Providers.RelMe,
2128 Pleroma.Web.Metadata.Providers.Feed
2133 label: "Unfurl NSFW",
2135 description: "When enabled NSFW attachments will be shown in previews"
2144 "If enabled the instance will parse metadata from attached links to generate link previews",
2149 description: "Enables RichMedia parsing of URLs"
2153 type: {:list, :string},
2154 description: "List of hosts which will be ignored by the metadata parser",
2155 suggestions: ["accounts.google.com", "xss.website"]
2159 label: "Ignore TLD",
2160 type: {:list, :string},
2161 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2162 suggestions: ["local", "localdomain", "lan"]
2166 type: {:list, :module},
2168 "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.",
2170 Pleroma.Web.RichMedia.Parsers.OEmbed,
2171 Pleroma.Web.RichMedia.Parsers.TwitterCard
2176 label: "TTL setters",
2177 type: {:list, :module},
2179 "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.",
2181 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2187 group: :auto_linker,
2189 label: "Auto Linker",
2191 description: "Configuration for the auto_linker library",
2195 type: [:string, false],
2196 description: "Specify the class to be added to the generated link. Disable to clear.",
2197 suggestions: ["auto-linker", false]
2201 type: [:string, false],
2202 description: "Override the rel attribute. Disable to clear.",
2203 suggestions: ["ugc", "noopener noreferrer", false]
2208 description: "Link URLs will open in new window/tab"
2212 type: [:integer, false],
2214 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2215 suggestions: [15, false]
2220 description: "Strip the scheme prefix"
2225 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2231 key: Pleroma.ScheduledActivity,
2233 description: "Scheduled activities settings",
2236 key: :daily_user_limit,
2239 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2243 key: :total_user_limit,
2246 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2252 description: "Whether scheduled activities are sent to the job queue to be executed"
2258 key: Pleroma.ActivityExpiration,
2260 description: "Expired activity settings",
2265 description: "Whether expired activities will be sent to the job queue to be deleted"
2271 label: "Pleroma Authenticator",
2273 description: "Authenticator",
2276 key: Pleroma.Web.Auth.Authenticator,
2278 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2288 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2289 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2290 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2291 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2296 description: "Enables LDAP authentication"
2301 description: "LDAP server hostname",
2302 suggestions: ["localhosts"]
2307 description: "LDAP port, e.g. 389 or 636",
2308 suggestions: [389, 636]
2314 description: "Enable to use SSL, usually implies the port 636"
2318 label: "SSL options",
2320 description: "Additional SSL options",
2321 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2326 description: "Path to file with PEM encoded cacerts",
2327 suggestions: ["path/to/file/with/PEM/cacerts"]
2332 description: "Type of cert verification",
2333 suggestions: [:verify_peer]
2341 description: "Enable to use STARTTLS, usually implies the port 389"
2345 label: "TLS options",
2347 description: "Additional TLS options",
2348 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2353 description: "Path to file with PEM encoded cacerts",
2354 suggestions: ["path/to/file/with/PEM/cacerts"]
2359 description: "Type of cert verification",
2360 suggestions: [:verify_peer]
2367 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2368 suggestions: ["dc=example,dc=com"]
2375 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2384 description: "Authentication / authorization settings",
2387 key: :enforce_oauth_admin_scope_usage,
2388 label: "Enforce OAuth admin scope usage",
2391 "OAuth admin scope requirement toggle. " <>
2392 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2393 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2394 "`is_admin` user flag grants access to admin-specific actions."
2397 key: :auth_template,
2400 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2401 suggestions: ["show.html"]
2404 key: :oauth_consumer_template,
2405 label: "OAuth consumer template",
2408 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2409 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2410 suggestions: ["consumer.html"]
2413 key: :oauth_consumer_strategies,
2414 label: "OAuth consumer strategies",
2415 type: {:list, :string},
2417 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2418 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2419 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2420 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2426 key: :email_notifications,
2428 description: "Email notifications settings",
2434 "emails of \"what you've missed\" for users who have been inactive for a while",
2438 schedule: "0 0 * * 0",
2440 inactivity_threshold: 7
2448 description: "Globally enable or disable digest emails"
2454 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2455 suggestions: ["0 0 * * 0"]
2460 description: "Minimum interval between digest emails to one user",
2464 key: :inactivity_threshold,
2466 description: "Minimum user inactivity threshold",
2475 key: Pleroma.Emails.UserEmail,
2477 description: "Email template settings",
2482 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2483 suggestions: ["some/path/logo.png"]
2488 description: "a map with color settings for email templates.",
2491 link_color: "#d8a070",
2492 background_color: "#2C3645",
2493 content_background_color: "#1B2635",
2494 header_color: "#d8a070",
2495 text_color: "#b9b9ba",
2496 text_muted_color: "#b9b9ba"
2503 suggestions: ["#d8a070"]
2506 key: :background_color,
2508 suggestions: ["#2C3645"]
2511 key: :content_background_color,
2513 suggestions: ["#1B2635"]
2518 suggestions: ["#d8a070"]
2523 suggestions: ["#b9b9ba"]
2526 key: :text_muted_color,
2528 suggestions: ["#b9b9ba"]
2536 key: Pleroma.Emails.NewUsersDigestEmail,
2538 description: "New users admin email digest",
2543 description: "Enables new users admin digest email when `true`",
2544 suggestions: [false]
2553 description: "Configure OAuth 2 provider capabilities",
2556 key: :token_expires_in,
2558 description: "The lifetime in seconds of the access token",
2562 key: :issue_new_refresh_token,
2565 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2568 key: :clean_expired_tokens,
2570 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2580 key: :shortcode_globs,
2581 type: {:list, :string},
2582 description: "Location of custom emoji files. * can be used as a wildcard.",
2583 suggestions: ["/emoji/custom/**/*.png"]
2586 key: :pack_extensions,
2587 type: {:list, :string},
2589 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2590 suggestions: [".png", ".gif"]
2594 type: {:keyword, :string, {:list, :string}},
2596 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2597 " and the value is the location or array of locations. * can be used as a wildcard.",
2599 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2603 key: :default_manifest,
2606 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2607 " Currently only one manifest can be added (no arrays).",
2608 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2611 key: :shared_pack_cache_seconds_per_file,
2612 label: "Shared pack cache s/file",
2615 "When an emoji pack is shared, the archive is created and cached in memory" <>
2616 " for this amount of seconds multiplied by the number of files.",
2626 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2630 type: [:tuple, {:list, :tuple}],
2631 description: "For the search requests (account & status search etc.)",
2632 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2636 type: [:tuple, {:list, :tuple}],
2637 description: "For requests to timelines (each timeline has it's own limiter)",
2638 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2641 key: :app_account_creation,
2642 type: [:tuple, {:list, :tuple}],
2643 description: "For registering user accounts from the same IP address",
2644 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2647 key: :relations_actions,
2648 type: [:tuple, {:list, :tuple}],
2649 description: "For actions on relationships with all users (follow, unfollow)",
2650 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2653 key: :relation_id_action,
2654 label: "Relation ID action",
2655 type: [:tuple, {:list, :tuple}],
2656 description: "For actions on relation with a specific user (follow, unfollow)",
2657 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2660 key: :statuses_actions,
2661 type: [:tuple, {:list, :tuple}],
2663 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2664 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2667 key: :status_id_action,
2668 label: "Status ID action",
2669 type: [:tuple, {:list, :tuple}],
2671 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2672 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2675 key: :authentication,
2676 type: [:tuple, {:list, :tuple}],
2677 description: "For authentication create / password check / user existence check requests",
2678 suggestions: [{60_000, 15}]
2687 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2688 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2693 description: "Enables SSH"
2698 description: "Dir with SSH keys",
2699 suggestions: ["/some/path/ssh_keys"]
2704 description: "Handler module",
2705 suggestions: ["Pleroma.BBS.Handler"]
2710 description: "Port to connect",
2711 suggestions: [10_022]
2714 key: :password_authenticator,
2716 description: "Authenticator module",
2717 suggestions: ["Pleroma.BBS.Authenticator"]
2723 label: "Mime Types",
2725 description: "Mime Types settings",
2732 "application/xml" => ["xml"],
2733 "application/xrd+xml" => ["xrd+xml"],
2734 "application/jrd+json" => ["jrd+json"],
2735 "application/activity+json" => ["activity+json"],
2736 "application/ld+json" => ["activity+json"]
2741 key: "application/xml",
2742 type: {:list, :string},
2743 suggestions: ["xml"]
2746 key: "application/xrd+xml",
2747 type: {:list, :string},
2748 suggestions: ["xrd+xml"]
2751 key: "application/jrd+json",
2752 type: {:list, :string},
2753 suggestions: ["jrd+json"]
2756 key: "application/activity+json",
2757 type: {:list, :string},
2758 suggestions: ["activity+json"]
2761 key: "application/ld+json",
2762 type: {:list, :string},
2763 suggestions: ["activity+json"]
2773 description: "Pleroma chat settings",
2786 description: "HTTP settings",
2791 type: [:string, :tuple],
2792 description: "Proxy URL",
2793 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2796 key: :send_user_agent,
2801 type: [:string, :atom],
2803 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2804 suggestions: ["Pleroma", :default]
2809 description: "Adapter specific options",
2815 label: "SSL Options",
2816 description: "SSL options for HTTP adapter",
2820 type: {:list, :atom},
2821 description: "List of TLS version to use",
2822 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2833 label: "Markup Settings",
2837 key: :allow_inline_images,
2841 key: :allow_headings,
2854 type: {:list, :module},
2856 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2857 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2867 key: :deny_follow_blocked,
2875 key: :mrf_normalize_markup,
2876 label: "MRF Normalize Markup",
2877 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2883 suggestions: [Pleroma.HTML.Scrubber.Default]
2893 key: :restricted_nicknames,
2894 type: {:list, :string},
2913 "ostatus_subscribe",
2932 label: "CORS plug config",
2938 suggestions: [86_400]
2942 type: {:list, :string},
2943 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2947 type: {:list, :string},
2950 "X-RateLimit-Reset",
2951 "X-RateLimit-Limit",
2952 "X-RateLimit-Remaining",
2963 type: {:list, :string},
2964 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2970 key: Pleroma.Plugs.RemoteIp,
2973 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2974 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2980 description: "Enable/disable the plug. Default: disabled."
2984 type: {:list, :string},
2986 "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]`."
2990 type: {:list, :string},
2992 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2996 type: {:list, :string},
2998 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3004 key: :web_cache_ttl,
3005 label: "Web cache TTL",
3008 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3014 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3015 suggestions: [30_000, nil]
3018 key: :activity_pub_question,
3020 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3021 suggestions: [30_000]
3031 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3036 description: "Enables the rendering of static HTML. Default: disabled."
3044 description: "Configure feed rendering",
3049 description: "Configure title rendering",
3054 description: "Maximum number of characters before truncating title",
3060 description: "Replacement which will be used after truncating string",
3061 suggestions: ["..."]
3069 key: :mrf_object_age,
3070 label: "MRF Object Age",
3073 description: "Rejects or delists posts based on their age when received.",
3078 description: "Required age (in seconds) of a post before actions are taken.",
3079 suggestions: [172_800]
3083 type: {:list, :atom},
3085 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3086 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3087 "`:reject` rejects the message entirely",
3088 suggestions: [:delist, :strip_followers, :reject]
3096 description: "Custom Runtime Modules",
3101 description: "A path to custom Elixir modules (such as MRF policies)."
3109 description: "Settings for notifications streamer",
3114 description: "Number of workers to send notifications",
3118 key: :overflow_workers,
3120 description: "Maximum number of workers created if pool is empty",
3127 key: :connections_pool,
3129 description: "Advanced settings for `gun` connections pool",
3132 key: :checkin_timeout,
3134 description: "Timeout to checkin connection from pool. Default: 250ms.",
3138 key: :max_connections,
3140 description: "Maximum number of connections in the pool. Default: 250 connections.",
3147 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3151 key: :retry_timeout,
3154 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3158 key: :await_up_timeout,
3160 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3169 description: "Advanced settings for `gun` workers pools",
3174 description: "Settings for federation pool.",
3179 description: "Number workers in the pool.",
3185 description: "Number of additional workers if pool is under load.",
3191 description: "Timeout while `gun` will wait for response.",
3192 suggestions: [150_000]
3199 description: "Settings for media pool.",
3204 description: "Number workers in the pool.",
3210 description: "Number of additional workers if pool is under load.",
3216 description: "Timeout while `gun` will wait for response.",
3217 suggestions: [150_000]
3224 description: "Settings for upload pool.",
3229 description: "Number workers in the pool.",
3235 description: "Number of additional workers if pool is under load.",
3241 description: "Timeout while `gun` will wait for response.",
3242 suggestions: [300_000]
3249 description: "Settings for default pool.",
3254 description: "Number workers in the pool.",
3260 description: "Number of additional workers if pool is under load.",
3266 description: "Timeout while `gun` will wait for response.",
3267 suggestions: [10_000]
3275 key: :hackney_pools,
3277 description: "Advanced settings for `hackney` connections pools",
3282 description: "Settings for federation pool.",
3285 key: :max_connections,
3287 description: "Number workers in the pool.",
3293 description: "Timeout while `hackney` will wait for response.",
3294 suggestions: [150_000]
3301 description: "Settings for media pool.",
3304 key: :max_connections,
3306 description: "Number workers in the pool.",
3312 description: "Timeout while `hackney` will wait for response.",
3313 suggestions: [150_000]
3320 description: "Settings for upload pool.",
3323 key: :max_connections,
3325 description: "Number workers in the pool.",
3331 description: "Timeout while `hackney` will wait for response.",
3332 suggestions: [300_000]
3340 key: :restrict_unauthenticated,
3343 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3348 description: "Settings for public and federated timelines.",
3353 description: "Disallow view public timeline."
3358 description: "Disallow view federated timeline."
3365 description: "Settings for user profiles.",
3370 description: "Disallow view local user profiles."
3375 description: "Disallow view remote user profiles."
3382 description: "Settings for statuses.",
3387 description: "Disallow view local statuses."
3392 description: "Disallow view remote statuses."
3400 key: Pleroma.Web.ApiSpec.CastAndValidate,
3407 "Enables strict input validation (useful in development, not recommended in production)",
3408 suggestions: [false]
3418 description: "General MRF settings",
3422 type: [:module, {:list, :module}],
3424 "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.",
3426 Generator.list_modules_in_dir(
3427 "lib/pleroma/web/activity_pub/mrf",
3428 "Elixir.Pleroma.Web.ActivityPub.MRF."
3433 label: "MRF transparency",
3436 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
3439 key: :transparency_exclusions,
3440 label: "MRF transparency exclusions",
3441 type: {:list, :string},
3443 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",