2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 installed_frontend_options = [
21 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
28 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
37 description: "Name of the frontend."
43 description: "Reference of the frontend to be used."
47 label: "Git Repository URL",
49 description: "URL of the git repository of the frontend"
56 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
57 example: "https://some.url/builds/${ref}.zip"
61 label: "Build directory",
63 description: "The directory inside the zip file "
67 config :pleroma, :config_description, [
72 description: "Upload general settings",
77 description: "Module which will be used for uploads",
78 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
82 type: {:list, :module},
84 "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.",
85 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
91 "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`."
97 description: "Base URL for the uploads, needed if you use CDN",
99 "https://cdn-host.com"
106 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
110 label: "Proxy Options",
112 description: "Options for Pleroma.ReverseProxy",
114 redirect_on_failure: false,
115 max_body_length: 25 * 1_048_576,
117 follow_redirect: true,
123 key: :redirect_on_failure,
126 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
127 "Any error during body processing will not be redirected as the response is chunked."
130 key: :max_body_length,
133 "Limits the content length to be approximately the " <>
134 "specified length. It is validated with the `content-length` header and also verified when proxying."
140 description: "HTTP options",
145 description: "Adapter specific options",
150 label: "SSL Options",
151 description: "SSL options for HTTP adapter",
155 type: {:list, :atom},
156 description: "List of TLS versions to use",
157 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
166 type: [:string, :tuple],
167 description: "Proxy URL",
168 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
175 key: :filename_display_max_length,
177 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
183 key: Pleroma.Uploaders.Local,
185 description: "Local uploader-related settings",
190 description: "Path where user's uploads will be saved",
199 key: Pleroma.Uploaders.S3,
201 description: "S3 uploader-related settings",
206 description: "S3 bucket",
212 key: :bucket_namespace,
214 description: "S3 bucket namespace",
215 suggestions: ["pleroma"]
218 key: :public_endpoint,
220 description: "S3 endpoint",
221 suggestions: ["https://s3.amazonaws.com"]
224 key: :truncated_namespace,
227 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
228 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
231 key: :streaming_enabled,
234 "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."
240 key: Pleroma.Upload.Filter.Mogrify,
242 description: "Uploads mogrify filter settings",
246 type: [:string, {:list, :string}, {:list, :tuple}],
248 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
249 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
260 key: Pleroma.Upload.Filter.AnonymizeFilename,
262 description: "Filter replaces the filename of the upload",
268 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
269 " filename extension by using {extension}, for example custom-file-name.{extension}.",
271 "custom-file-name.{extension}"
278 key: Pleroma.Emails.Mailer,
280 description: "Mailer-related settings",
286 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
287 " or Swoosh.Adapters.Local for in-memory mailbox",
289 Swoosh.Adapters.SMTP,
290 Swoosh.Adapters.Sendgrid,
291 Swoosh.Adapters.Sendmail,
292 Swoosh.Adapters.Mandrill,
293 Swoosh.Adapters.Mailgun,
294 Swoosh.Adapters.Mailjet,
295 Swoosh.Adapters.Postmark,
296 Swoosh.Adapters.SparkPost,
297 Swoosh.Adapters.AmazonSES,
299 Swoosh.Adapters.SocketLabs,
300 Swoosh.Adapters.Gmail,
301 Swoosh.Adapters.Local
307 description: "Allow/disallow send emails"
310 group: {:subgroup, Swoosh.Adapters.SMTP},
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
314 suggestions: ["smtp.gmail.com"]
317 group: {:subgroup, Swoosh.Adapters.SMTP},
320 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
321 suggestions: ["pleroma"]
324 group: {:subgroup, Swoosh.Adapters.SMTP},
327 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
328 suggestions: ["password"]
331 group: {:subgroup, Swoosh.Adapters.SMTP},
335 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
338 group: {:subgroup, Swoosh.Adapters.SMTP},
342 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
343 suggestions: [:always, :never, :if_available]
346 group: {:subgroup, Swoosh.Adapters.SMTP},
349 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
350 suggestions: [:always, :never, :if_available]
353 group: {:subgroup, Swoosh.Adapters.SMTP},
356 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
360 group: {:subgroup, Swoosh.Adapters.SMTP},
363 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
367 group: {:subgroup, Swoosh.Adapters.SMTP},
369 label: "No MX lookups",
371 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
374 group: {:subgroup, Swoosh.Adapters.Sendgrid},
378 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
379 suggestions: ["my-api-key"]
382 group: {:subgroup, Swoosh.Adapters.Sendmail},
385 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
386 suggestions: ["/usr/bin/sendmail"]
389 group: {:subgroup, Swoosh.Adapters.Sendmail},
392 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
393 suggestions: ["-N delay,failure,success"]
396 group: {:subgroup, Swoosh.Adapters.Sendmail},
399 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
402 group: {:subgroup, Swoosh.Adapters.Mandrill},
406 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
407 suggestions: ["my-api-key"]
410 group: {:subgroup, Swoosh.Adapters.Mailgun},
414 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
415 suggestions: ["my-api-key"]
418 group: {:subgroup, Swoosh.Adapters.Mailgun},
421 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
422 suggestions: ["pleroma.com"]
425 group: {:subgroup, Swoosh.Adapters.Mailjet},
429 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
430 suggestions: ["my-api-key"]
433 group: {:subgroup, Swoosh.Adapters.Mailjet},
436 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
437 suggestions: ["my-secret-key"]
440 group: {:subgroup, Swoosh.Adapters.Postmark},
444 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
445 suggestions: ["my-api-key"]
448 group: {:subgroup, Swoosh.Adapters.SparkPost},
452 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
453 suggestions: ["my-api-key"]
456 group: {:subgroup, Swoosh.Adapters.SparkPost},
459 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
460 suggestions: ["https://api.sparkpost.com/api/v1"]
463 group: {:subgroup, Swoosh.Adapters.AmazonSES},
466 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
467 suggestions: ["us-east-1", "us-east-2"]
470 group: {:subgroup, Swoosh.Adapters.AmazonSES},
473 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
474 suggestions: ["aws-access-key"]
477 group: {:subgroup, Swoosh.Adapters.AmazonSES},
480 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
481 suggestions: ["aws-secret-key"]
484 group: {:subgroup, Swoosh.Adapters.Dyn},
488 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
489 suggestions: ["my-api-key"]
492 group: {:subgroup, Swoosh.Adapters.SocketLabs},
495 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
498 group: {:subgroup, Swoosh.Adapters.SocketLabs},
502 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
505 group: {:subgroup, Swoosh.Adapters.Gmail},
508 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
515 description: "`Swoosh.Adapters.Local` adapter specific settings",
518 group: {:subgroup, Swoosh.Adapters.Local},
521 description: "Run the preview server together as part of your app"
524 group: {:subgroup, Swoosh.Adapters.Local},
527 description: "The preview server port",
535 label: "URI Schemes",
537 description: "URI schemes related settings",
541 type: {:list, :string},
542 description: "List of the scheme part that is considered valid to be an URL",
567 description: "Instance-related settings",
572 description: "Name of the instance",
579 label: "Admin Email Address",
581 description: "Email used to reach an Administrator/Moderator of the instance",
588 label: "Sender Email Address",
590 description: "Envelope FROM address for mail sent via Pleroma",
599 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
607 description: "Posts character limit (CW/Subject included in the counter)",
615 description: "Character limit of the instance chat messages",
623 description: "Hard character limit beyond which remote posts will be dropped",
631 description: "File size limit of uploads (except for avatar, background, banner)",
637 key: :avatar_upload_limit,
639 description: "File size limit of user's profile avatars",
645 key: :background_upload_limit,
647 description: "File size limit of user's profile backgrounds",
653 key: :banner_upload_limit,
655 description: "File size limit of user's profile banners",
663 description: "A map with poll limits for local polls",
667 max_option_chars: 200,
669 max_expiration: 31_536_000
676 description: "Maximum number of options",
680 key: :max_option_chars,
682 description: "Maximum number of characters per option",
686 key: :min_expiration,
688 description: "Minimum expiration time (in seconds)",
692 key: :max_expiration,
694 description: "Maximum expiration time (in seconds)",
700 key: :registrations_open,
703 "Enable registrations for anyone. Invitations require this setting to be disabled."
706 key: :invites_enabled,
709 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
712 key: :account_activation_required,
714 description: "Require users to confirm their emails before signing in"
717 key: :account_approval_required,
719 description: "Require users to be manually approved by an admin before signing in"
724 description: "Enable federation with other instances"
727 key: :federation_incoming_replies_max_depth,
728 label: "Fed. incoming replies max depth",
731 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
732 " 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.",
738 key: :federation_reachability_timeout_days,
739 label: "Fed. reachability timeout days",
742 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
750 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
756 "Makes the client API in authenticated mode-only except for user-profiles." <>
757 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
758 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
761 key: :quarantined_instances,
762 type: {:list, :string},
764 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
773 description: "Instance static directory",
779 key: :allowed_post_formats,
780 type: {:list, :string},
781 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
790 key: :extended_nickname_format,
793 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
794 " This will break federation with older software for theses nicknames."
797 key: :cleanup_attachments,
800 Enable to remove associated attachments when status is removed.
801 This will not affect duplicates and attachments without status.
802 Enabling this will increase load to database when deleting statuses on larger instances.
806 key: :max_pinned_statuses,
808 description: "The maximum number of pinned statuses. 0 will disable the feature.",
816 key: :autofollowed_nicknames,
817 type: {:list, :string},
819 "Set to nicknames of (local) users that every new user should automatically follow",
828 key: :attachment_links,
830 description: "Enable to automatically add attachment link text to statuses"
833 key: :max_report_comment_size,
835 description: "The maximum size of the report comment. Default: 1000.",
841 key: :safe_dm_mentions,
842 label: "Safe DM mentions",
845 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
846 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
852 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
855 key: :remote_post_retention_days,
858 "The default amount of days to retain remote posts when pruning the database",
864 key: :user_bio_length,
866 description: "A user bio maximum length. Default: 5000.",
872 key: :user_name_length,
874 description: "A user name maximum length. Default: 100.",
880 key: :skip_thread_containment,
882 description: "Skip filtering out broken threads. Default: enabled."
885 key: :limit_to_local_content,
886 type: {:dropdown, :atom},
888 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
896 key: :max_account_fields,
898 description: "The maximum number of custom fields in the user profile. Default: 10.",
904 key: :max_remote_account_fields,
907 "The maximum number of custom fields in the remote user profile. Default: 20.",
913 key: :account_field_name_length,
915 description: "An account field name maximum length. Default: 512.",
921 key: :account_field_value_length,
923 description: "An account field value maximum length. Default: 2048.",
929 key: :registration_reason_length,
931 description: "Maximum registration reason length. Default: 500.",
937 key: :external_user_synchronization,
939 description: "Enabling following/followers counters synchronization for external users"
942 key: :multi_factor_authentication,
944 description: "Multi-factor authentication settings",
947 totp: [digits: 6, period: 30],
948 backup_codes: [number: 5, length: 16]
954 label: "TOTP settings",
956 description: "TOTP settings",
957 suggestions: [digits: 6, period: 30],
964 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
971 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
978 description: "MFA backup codes settings",
979 suggestions: [number: 5, length: 16],
985 description: "Number of backup codes to generate."
992 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
999 key: :instance_thumbnail,
1000 type: {:string, :image},
1002 "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.",
1003 suggestions: ["/instance/thumbnail.jpeg"]
1006 key: :show_reactions,
1008 description: "Let favourites and emoji reactions be viewed through the API."
1016 description: "Welcome messages settings",
1019 key: :direct_message,
1021 descpiption: "Direct message settings",
1026 description: "Enables sending a direct message to newly registered users"
1031 description: "A message that will be sent to newly registered users",
1033 "Hi, @username! Welcome on board!"
1037 key: :sender_nickname,
1039 description: "The nickname of the local user that sends a welcome message",
1049 descpiption: "Chat message settings",
1054 description: "Enables sending a chat message to newly registered users"
1060 "A message that will be sent to newly registered users as a chat message",
1062 "Hello, welcome on board!"
1066 key: :sender_nickname,
1068 description: "The nickname of the local user that sends a welcome chat message",
1078 descpiption: "Email message settings",
1083 description: "Enables sending an email to newly registered users"
1087 type: [:string, :tuple],
1089 "Email address and/or nickname that will be used to send the welcome email.",
1091 {"Pleroma App", "welcome@pleroma.app"}
1098 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1099 suggestions: ["Welcome to <%= instance_name%>"]
1105 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1106 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1112 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1113 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1122 description: "Logger-related settings",
1126 type: [:atom, :tuple, :module],
1128 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1129 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1137 label: "ExSyslogger",
1138 description: "ExSyslogger-related settings",
1142 type: {:dropdown, :atom},
1143 description: "Log level",
1144 suggestions: [:debug, :info, :warn, :error]
1150 "A string that's prepended to every message, and is typically set to the app name",
1151 suggestions: ["pleroma"]
1156 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1157 suggestions: ["$metadata[$level] $message"]
1161 type: {:list, :atom},
1162 suggestions: [:request_id]
1170 label: "Console Logger",
1171 description: "Console logger settings",
1175 type: {:dropdown, :atom},
1176 description: "Log level",
1177 suggestions: [:debug, :info, :warn, :error]
1182 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1183 suggestions: ["$metadata[$level] $message"]
1187 type: {:list, :atom},
1188 suggestions: [:request_id]
1195 label: "Quack Logger",
1196 description: "Quack-related settings",
1200 type: {:dropdown, :atom},
1201 description: "Log level",
1202 suggestions: [:debug, :info, :warn, :error]
1206 type: {:list, :atom},
1207 description: "Configure which metadata you want to report on",
1224 label: "Webhook URL",
1226 description: "Configure the Slack incoming webhook",
1227 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1233 key: :frontend_configurations,
1236 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1237 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1238 "add your own configuration your settings all fields must be complete.",
1242 label: "Pleroma FE",
1244 description: "Settings for Pleroma FE",
1247 alwaysShowSubjectInput: true,
1248 background: "/static/aurora_borealis.jpg",
1249 collapseMessageWithSubject: false,
1252 hideFilteredStatuses: false,
1253 hideMutedPosts: false,
1254 hidePostStats: false,
1255 hideSitename: false,
1256 hideUserStats: false,
1257 loginMethod: "password",
1258 logo: "/static/logo.png",
1261 minimalScopesMode: false,
1262 noAttachmentLinks: false,
1263 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1264 postContentType: "text/plain",
1265 redirectRootLogin: "/main/friends",
1266 redirectRootNoLogin: "/main/all",
1268 sidebarRight: false,
1269 showFeaturesPanel: true,
1270 showInstanceSpecificPanel: false,
1271 subjectLineBehavior: "email",
1272 theme: "pleroma-dark",
1273 webPushNotifications: false
1278 key: :alwaysShowSubjectInput,
1279 label: "Always show subject input",
1281 description: "When disabled, auto-hide the subject field if it's empty"
1285 type: {:string, :image},
1287 "URL of the background, unless viewing a user profile with a background that is set",
1288 suggestions: ["/images/city.jpg"]
1291 key: :collapseMessageWithSubject,
1292 label: "Collapse message with subject",
1295 "When a message has a subject (aka Content Warning), collapse it by default"
1299 label: "PleromaFE Chat",
1301 description: "Disables PleromaFE Chat component"
1307 description: "Enables green text on lines prefixed with the > character"
1310 key: :hideFilteredStatuses,
1311 label: "Hide Filtered Statuses",
1313 description: "Hides filtered statuses from timelines"
1316 key: :hideMutedPosts,
1317 label: "Hide Muted Posts",
1319 description: "Hides muted statuses from timelines"
1322 key: :hidePostStats,
1323 label: "Hide post stats",
1325 description: "Hide notices statistics (repeats, favorites, ...)"
1329 label: "Hide Sitename",
1331 description: "Hides instance name from PleromaFE banner"
1334 key: :hideUserStats,
1335 label: "Hide user stats",
1338 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1342 type: {:string, :image},
1343 description: "URL of the logo, defaults to Pleroma's logo",
1344 suggestions: ["/static/logo.png"]
1348 label: "Logo margin",
1351 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1352 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1353 suggestions: [".1em"]
1360 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1361 "If you want a colorful logo you must disable logoMask."
1364 key: :minimalScopesMode,
1365 label: "Minimal scopes mode",
1368 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1369 "Also prevents replying to a DM with a public post from PleromaFE."
1372 key: :nsfwCensorImage,
1373 label: "NSFW Censor Image",
1374 type: {:string, :image},
1376 "URL of the image to use for hiding NSFW media attachments in the timeline",
1377 suggestions: ["/static/img/nsfw.74818f9.png"]
1380 key: :postContentType,
1381 label: "Post Content Type",
1382 type: {:dropdown, :atom},
1383 description: "Default post formatting option",
1384 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1387 key: :redirectRootNoLogin,
1388 label: "Redirect root no login",
1391 "Relative URL which indicates where to redirect when a user isn't logged in",
1392 suggestions: ["/main/all"]
1395 key: :redirectRootLogin,
1396 label: "Redirect root login",
1399 "Relative URL which indicates where to redirect when a user is logged in",
1400 suggestions: ["/main/friends"]
1404 label: "Scope copy",
1406 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1410 label: "Sidebar on Right",
1412 description: "Change alignment of sidebar and panels to the right"
1415 key: :showFeaturesPanel,
1416 label: "Show instance features panel",
1419 "Enables panel displaying functionality of the instance on the About page"
1422 key: :showInstanceSpecificPanel,
1423 label: "Show instance specific panel",
1425 description: "Whether to show the instance's custom panel"
1428 key: :subjectLineBehavior,
1429 label: "Subject line behavior",
1431 description: "Allows changing the default behaviour of subject lines in replies.
1432 `email`: copy and preprend re:, as in email,
1433 `masto`: copy verbatim, as in Mastodon,
1434 `noop`: don't copy the subject.",
1435 suggestions: ["email", "masto", "noop"]
1440 description: "Which theme to use. Available themes are defined in styles.json",
1441 suggestions: ["pleroma-dark"]
1449 description: "Settings for Masto FE",
1452 showInstanceSpecificPanel: true
1457 key: :showInstanceSpecificPanel,
1458 label: "Show instance specific panel",
1460 description: "Whenether to show the instance's specific panel"
1471 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1475 type: {:keyword, :map},
1477 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1480 url: "/images/pleroma-fox-tan-smol.png",
1481 mime_type: "image/png"
1483 pleroma_fox_tan_shy: %{
1484 url: "/images/pleroma-fox-tan-shy.png",
1485 mime_type: "image/png"
1490 key: :default_mascot,
1493 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1499 key: :default_user_avatar,
1500 type: {:string, :image},
1501 description: "URL of the default user avatar",
1502 suggestions: ["/images/avi.png"]
1511 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1515 type: {:list, :map},
1516 description: "Describe the icons of the app",
1519 src: "/static/logo.png"
1522 src: "/static/icon.png",
1526 src: "/static/icon.ico",
1527 sizes: "72x72 96x96 128x128 256x256"
1534 description: "Describe the theme color of the app",
1535 suggestions: ["#282c37", "mediumpurple"]
1538 key: :background_color,
1540 description: "Describe the background color of the app",
1541 suggestions: ["#191b22", "aliceblue"]
1551 description: "General MRF settings",
1555 type: [:module, {:list, :module}],
1557 "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.",
1558 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1562 label: "MRF transparency",
1565 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1568 key: :transparency_exclusions,
1569 label: "MRF transparency exclusions",
1570 type: {:list, :string},
1572 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1583 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1584 label: "MRF Simple",
1586 description: "Simple ingress policies",
1589 key: :media_removal,
1590 type: {:list, :string},
1591 description: "List of instances to strip media attachments from",
1592 suggestions: ["example.com", "*.example.com"]
1596 label: "Media NSFW",
1597 type: {:list, :string},
1598 description: "List of instances to tag all media as NSFW (sensitive) from",
1599 suggestions: ["example.com", "*.example.com"]
1602 key: :federated_timeline_removal,
1603 type: {:list, :string},
1605 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1606 suggestions: ["example.com", "*.example.com"]
1610 type: {:list, :string},
1611 description: "List of instances to reject activities from (except deletes)",
1612 suggestions: ["example.com", "*.example.com"]
1616 type: {:list, :string},
1617 description: "List of instances to only accept activities from (except deletes)",
1618 suggestions: ["example.com", "*.example.com"]
1621 key: :followers_only,
1622 type: {:list, :string},
1623 description: "Force posts from the given instances to be visible by followers only",
1624 suggestions: ["example.com", "*.example.com"]
1627 key: :report_removal,
1628 type: {:list, :string},
1629 description: "List of instances to reject reports from",
1630 suggestions: ["example.com", "*.example.com"]
1633 key: :avatar_removal,
1634 type: {:list, :string},
1635 description: "List of instances to strip avatars from",
1636 suggestions: ["example.com", "*.example.com"]
1639 key: :banner_removal,
1640 type: {:list, :string},
1641 description: "List of instances to strip banners from",
1642 suggestions: ["example.com", "*.example.com"]
1645 key: :reject_deletes,
1646 type: {:list, :string},
1647 description: "List of instances to reject deletions from",
1648 suggestions: ["example.com", "*.example.com"]
1654 key: :mrf_activity_expiration,
1656 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1657 label: "MRF Activity Expiration Policy",
1659 description: "Adds automatic expiration to all local activities",
1664 description: "Default global expiration time for all local activities (in days)",
1665 suggestions: [90, 365]
1673 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1674 label: "MRF Subchain",
1677 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1678 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1682 type: {:map, {:list, :string}},
1683 description: "Matches a series of regular expressions against the actor field",
1686 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1694 key: :mrf_rejectnonpublic,
1696 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1697 description: "RejectNonPublic drops posts with non-public visibility settings.",
1698 label: "MRF Reject Non Public",
1702 key: :allow_followersonly,
1703 label: "Allow followers-only",
1705 description: "Whether to allow followers-only posts"
1710 description: "Whether to allow direct messages"
1716 key: :mrf_hellthread,
1718 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1719 label: "MRF Hellthread",
1721 description: "Block messages with excessive user mentions",
1724 key: :delist_threshold,
1727 "Number of mentioned users after which the message gets removed from timelines and" <>
1728 "disables notifications. Set to 0 to disable.",
1732 key: :reject_threshold,
1735 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1744 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1745 label: "MRF Keyword",
1747 description: "Reject or Word-Replace messages with a keyword or regex",
1751 type: {:list, :string},
1753 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1754 suggestions: ["foo", ~r/foo/iu]
1757 key: :federated_timeline_removal,
1758 type: {:list, :string},
1760 "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.",
1761 suggestions: ["foo", ~r/foo/iu]
1765 type: {:list, :tuple},
1767 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1768 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1776 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1777 label: "MRF Mention",
1779 description: "Block messages which mention a specific user",
1783 type: {:list, :string},
1784 description: "A list of actors for which any post mentioning them will be dropped",
1785 suggestions: ["actor1", "actor2"]
1791 key: :mrf_vocabulary,
1793 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1794 label: "MRF Vocabulary",
1796 description: "Filter messages which belong to certain activity vocabularies",
1800 type: {:list, :string},
1802 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1803 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1807 type: {:list, :string},
1809 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1810 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1816 # key: :mrf_user_allowlist,
1818 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1821 # "The keys in this section are the domain names that the policy should apply to." <>
1822 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1824 # %{"example.org" => ["https://example.org/users/admin"]}
1832 description: "Media proxy",
1837 description: "Enables proxying of remote media to the instance's proxy"
1844 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1845 suggestions: ["https://example.com"]
1853 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1859 description: "Enables media cache object invalidation."
1864 description: "Module which will be used to purge objects from the cache.",
1866 Pleroma.Web.MediaProxy.Invalidation.Script,
1867 Pleroma.Web.MediaProxy.Invalidation.Http
1874 label: "Proxy Options",
1876 description: "Options for Pleroma.ReverseProxy",
1878 redirect_on_failure: false,
1879 max_body_length: 25 * 1_048_576,
1880 max_read_duration: 30_000,
1882 follow_redirect: true,
1888 key: :redirect_on_failure,
1891 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1892 "Any error during body processing will not be redirected as the response is chunked."
1895 key: :max_body_length,
1898 "Limits the content length to be approximately the " <>
1899 "specified length. It is validated with the `content-length` header and also verified when proxying."
1902 key: :max_read_duration,
1904 description: "Timeout (in milliseconds) of GET request to remote URI."
1910 description: "HTTP options",
1915 description: "Adapter specific options",
1920 label: "SSL Options",
1921 description: "SSL options for HTTP adapter",
1925 type: {:list, :atom},
1926 description: "List of TLS version to use",
1927 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1936 type: [:string, :tuple],
1937 description: "Proxy URL",
1938 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1946 type: {:list, :string},
1947 description: "List of hosts with scheme to bypass the mediaproxy",
1948 suggestions: ["http://example.com"]
1954 key: :media_preview_proxy,
1956 description: "Media preview proxy",
1962 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1965 key: :thumbnail_max_width,
1968 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1971 key: :thumbnail_max_height,
1974 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1977 key: :image_quality,
1979 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1982 key: :min_content_length,
1985 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1991 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1993 description: "HTTP invalidate settings",
1998 description: "HTTP method of request. Default: :purge"
2002 type: {:keyword, :string},
2003 description: "HTTP headers of request",
2004 suggestions: [{"x-refresh", 1}]
2009 description: "Request options",
2013 type: {:map, :string}
2021 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2023 description: "Script invalidate settings",
2028 description: "Path to shell script. Which will run purge cache.",
2029 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2037 description: "Gopher settings",
2042 description: "Enables the gopher interface"
2048 description: "IP address to bind to",
2049 suggestions: [{0, 0, 0, 0}]
2054 description: "Port to bind to",
2060 description: "Port advertised in URLs (optional, defaults to port)",
2068 label: "ActivityPub",
2070 description: "ActivityPub-related settings",
2073 key: :unfollow_blocked,
2075 description: "Whether blocks result in people getting unfollowed"
2078 key: :outgoing_blocks,
2080 description: "Whether to federate blocks to other instances"
2083 key: :sign_object_fetches,
2085 description: "Sign object fetches with HTTP signatures"
2088 key: :note_replies_output_limit,
2091 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2094 key: :follow_handshake_timeout,
2096 description: "Following handshake timeout",
2103 key: :http_security,
2104 label: "HTTP security",
2106 description: "HTTP security settings",
2111 description: "Whether the managed content security policy is enabled"
2117 description: "Whether to additionally send a Strict-Transport-Security header"
2121 label: "STS max age",
2123 description: "The maximum age for the Strict-Transport-Security header if sent",
2124 suggestions: [31_536_000]
2128 label: "CT max age",
2130 description: "The maximum age for the Expect-CT header if sent",
2131 suggestions: [2_592_000]
2134 key: :referrer_policy,
2136 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2137 suggestions: ["same-origin", "no-referrer"]
2141 label: "Report URI",
2143 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2144 suggestions: ["https://example.com/report-uri"]
2149 group: :web_push_encryption,
2150 key: :vapid_details,
2151 label: "Vapid Details",
2154 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2160 "A mailto link for the administrative contact." <>
2161 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2162 suggestions: ["mailto:moderators@pleroma.com"]
2167 description: "VAPID public key",
2168 suggestions: ["Public key"]
2173 description: "VAPID private key",
2174 suggestions: ["Private key"]
2180 key: Pleroma.Captcha,
2182 description: "Captcha-related settings",
2187 description: "Whether the captcha should be shown on registration"
2192 description: "The method/service to use for captcha",
2193 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2196 key: :seconds_valid,
2198 description: "The time in seconds for which the captcha is valid",
2205 key: Pleroma.Captcha.Kocaptcha,
2208 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2209 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2214 description: "The kocaptcha endpoint to use",
2215 suggestions: ["https://captcha.kotobank.ch"]
2221 label: "Pleroma Admin Token",
2224 "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)",
2229 description: "Admin token",
2231 "Please use a high entropy string or UUID"
2241 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2243 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2244 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2245 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2246 (see https://github.com/sorentwo/oban/issues/52).
2251 type: {:dropdown, :atom},
2252 description: "Logs verbose mode",
2253 suggestions: [false, :error, :warn, :info, :debug]
2257 type: {:keyword, :integer},
2259 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2261 activity_expiration: 10,
2262 attachments_cleanup: 5,
2264 federator_incoming: 50,
2265 federator_outgoing: 50,
2267 scheduled_activities: 10,
2273 key: :activity_expiration,
2275 description: "Activity expiration queue",
2279 key: :attachments_cleanup,
2281 description: "Attachment deletion queue",
2287 description: "Background queue",
2291 key: :federator_incoming,
2293 description: "Incoming federation queue",
2297 key: :federator_outgoing,
2299 description: "Outgoing federation queue",
2305 description: "Email sender queue, see Pleroma.Emails.Mailer",
2309 key: :scheduled_activities,
2311 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2315 key: :transmogrifier,
2317 description: "Transmogrifier queue",
2323 description: "Web push notifications queue",
2330 type: {:list, :tuple},
2331 description: "Settings for cron background jobs",
2333 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2334 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2343 description: "Includes custom worker options not interpretable directly by `Oban`",
2347 type: {:keyword, :integer},
2348 description: "Max retry attempts for failed jobs, per `Oban` queue",
2350 federator_incoming: 5,
2351 federator_outgoing: 5
2358 key: Pleroma.Web.Metadata,
2360 description: "Metadata-related settings",
2364 type: {:list, :module},
2365 description: "List of metadata providers to enable",
2367 Pleroma.Web.Metadata.Providers.OpenGraph,
2368 Pleroma.Web.Metadata.Providers.TwitterCard,
2369 Pleroma.Web.Metadata.Providers.RelMe,
2370 Pleroma.Web.Metadata.Providers.Feed
2375 label: "Unfurl NSFW",
2377 description: "When enabled NSFW attachments will be shown in previews"
2386 "If enabled the instance will parse metadata from attached links to generate link previews",
2391 description: "Enables RichMedia parsing of URLs"
2395 type: {:list, :string},
2396 description: "List of hosts which will be ignored by the metadata parser",
2397 suggestions: ["accounts.google.com", "xss.website"]
2401 label: "Ignore TLD",
2402 type: {:list, :string},
2403 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2404 suggestions: ["local", "localdomain", "lan"]
2408 type: {:list, :module},
2410 "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.",
2412 Pleroma.Web.RichMedia.Parsers.OEmbed,
2413 Pleroma.Web.RichMedia.Parsers.TwitterCard
2418 label: "TTL setters",
2419 type: {:list, :module},
2421 "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.",
2423 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2427 key: :failure_backoff,
2430 "Amount of milliseconds after request failure, during which the request will not be retried.",
2431 suggestions: [60_000]
2437 key: Pleroma.Formatter,
2441 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2445 type: [:string, :boolean],
2446 description: "Specify the class to be added to the generated link. Disable to clear.",
2447 suggestions: ["auto-linker", false]
2451 type: [:string, :boolean],
2452 description: "Override the rel attribute. Disable to clear.",
2453 suggestions: ["ugc", "noopener noreferrer", false]
2458 description: "Link URLs will open in a new window/tab."
2462 type: [:integer, :boolean],
2464 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2465 suggestions: [15, false]
2470 description: "Strip the scheme prefix."
2475 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2479 type: [:atom, :boolean],
2481 "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)",
2482 suggestions: [:no_scheme, true]
2488 key: Pleroma.ScheduledActivity,
2490 description: "Scheduled activities settings",
2493 key: :daily_user_limit,
2496 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2500 key: :total_user_limit,
2503 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2509 description: "Whether scheduled activities are sent to the job queue to be executed"
2515 key: Pleroma.Workers.PurgeExpiredActivity,
2517 description: "Expired activities settings",
2522 description: "Enables expired activities addition & deletion"
2527 description: "Minimum lifetime for ephemeral activity (in seconds)",
2534 label: "Pleroma Authenticator",
2536 description: "Authenticator",
2539 key: Pleroma.Web.Auth.Authenticator,
2541 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2551 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2552 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2553 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2554 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2559 description: "Enables LDAP authentication"
2564 description: "LDAP server hostname",
2565 suggestions: ["localhosts"]
2570 description: "LDAP port, e.g. 389 or 636",
2571 suggestions: [389, 636]
2577 description: "Enable to use SSL, usually implies the port 636"
2581 label: "SSL options",
2583 description: "Additional SSL options",
2584 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2589 description: "Path to file with PEM encoded cacerts",
2590 suggestions: ["path/to/file/with/PEM/cacerts"]
2595 description: "Type of cert verification",
2596 suggestions: [:verify_peer]
2604 description: "Enable to use STARTTLS, usually implies the port 389"
2608 label: "TLS options",
2610 description: "Additional TLS options",
2611 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2616 description: "Path to file with PEM encoded cacerts",
2617 suggestions: ["path/to/file/with/PEM/cacerts"]
2622 description: "Type of cert verification",
2623 suggestions: [:verify_peer]
2630 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2631 suggestions: ["dc=example,dc=com"]
2638 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2647 description: "Authentication / authorization settings",
2650 key: :enforce_oauth_admin_scope_usage,
2651 label: "Enforce OAuth admin scope usage",
2654 "OAuth admin scope requirement toggle. " <>
2655 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2656 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2657 "`is_admin` user flag grants access to admin-specific actions."
2660 key: :auth_template,
2663 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2664 suggestions: ["show.html"]
2667 key: :oauth_consumer_template,
2668 label: "OAuth consumer template",
2671 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2672 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2673 suggestions: ["consumer.html"]
2676 key: :oauth_consumer_strategies,
2677 label: "OAuth consumer strategies",
2678 type: {:list, :string},
2680 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2681 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2682 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2683 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2689 key: :email_notifications,
2691 description: "Email notifications settings",
2697 "emails of \"what you've missed\" for users who have been inactive for a while",
2701 schedule: "0 0 * * 0",
2703 inactivity_threshold: 7
2711 description: "Globally enable or disable digest emails"
2717 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2718 suggestions: ["0 0 * * 0"]
2723 description: "Minimum interval between digest emails to one user",
2727 key: :inactivity_threshold,
2729 description: "Minimum user inactivity threshold",
2738 key: Pleroma.Emails.UserEmail,
2740 description: "Email template settings",
2744 type: {:string, :image},
2745 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2746 suggestions: ["some/path/logo.png"]
2751 description: "A map with color settings for email templates.",
2754 link_color: "#d8a070",
2755 background_color: "#2C3645",
2756 content_background_color: "#1B2635",
2757 header_color: "#d8a070",
2758 text_color: "#b9b9ba",
2759 text_muted_color: "#b9b9ba"
2766 suggestions: ["#d8a070"]
2769 key: :background_color,
2771 suggestions: ["#2C3645"]
2774 key: :content_background_color,
2776 suggestions: ["#1B2635"]
2781 suggestions: ["#d8a070"]
2786 suggestions: ["#b9b9ba"]
2789 key: :text_muted_color,
2791 suggestions: ["#b9b9ba"]
2799 key: Pleroma.Emails.NewUsersDigestEmail,
2801 description: "New users admin email digest",
2806 description: "Enables new users admin digest email when `true`"
2815 description: "Configure OAuth 2 provider capabilities",
2818 key: :token_expires_in,
2820 description: "The lifetime in seconds of the access token",
2824 key: :issue_new_refresh_token,
2827 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2830 key: :clean_expired_tokens,
2832 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2842 key: :shortcode_globs,
2843 type: {:list, :string},
2844 description: "Location of custom emoji files. * can be used as a wildcard.",
2845 suggestions: ["/emoji/custom/**/*.png"]
2848 key: :pack_extensions,
2849 type: {:list, :string},
2851 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2852 suggestions: [".png", ".gif"]
2856 type: {:keyword, {:list, :string}},
2858 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2859 " and the value is the location or array of locations. * can be used as a wildcard.",
2861 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2865 key: :default_manifest,
2868 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2869 " Currently only one manifest can be added (no arrays).",
2870 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2873 key: :shared_pack_cache_seconds_per_file,
2874 label: "Shared pack cache s/file",
2877 "When an emoji pack is shared, the archive is created and cached in memory" <>
2878 " for this amount of seconds multiplied by the number of files.",
2888 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2892 type: [:tuple, {:list, :tuple}],
2893 description: "For the search requests (account & status search etc.)",
2894 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2898 type: [:tuple, {:list, :tuple}],
2899 description: "For requests to timelines (each timeline has it's own limiter)",
2900 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2903 key: :app_account_creation,
2904 type: [:tuple, {:list, :tuple}],
2905 description: "For registering user accounts from the same IP address",
2906 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2909 key: :relations_actions,
2910 type: [:tuple, {:list, :tuple}],
2911 description: "For actions on relationships with all users (follow, unfollow)",
2912 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2915 key: :relation_id_action,
2916 label: "Relation ID action",
2917 type: [:tuple, {:list, :tuple}],
2918 description: "For actions on relation with a specific user (follow, unfollow)",
2919 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2922 key: :statuses_actions,
2923 type: [:tuple, {:list, :tuple}],
2925 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2926 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2929 key: :status_id_action,
2930 label: "Status ID action",
2931 type: [:tuple, {:list, :tuple}],
2933 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2934 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2937 key: :authentication,
2938 type: [:tuple, {:list, :tuple}],
2939 description: "For authentication create / password check / user existence check requests",
2940 suggestions: [{60_000, 15}]
2949 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2950 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2955 description: "Enables SSH"
2960 description: "Dir with SSH keys",
2961 suggestions: ["/some/path/ssh_keys"]
2966 description: "Handler module",
2967 suggestions: ["Pleroma.BBS.Handler"]
2972 description: "Port to connect",
2973 suggestions: [10_022]
2976 key: :password_authenticator,
2978 description: "Authenticator module",
2979 suggestions: ["Pleroma.BBS.Authenticator"]
2985 label: "Mime Types",
2987 description: "Mime Types settings",
2994 "application/xml" => ["xml"],
2995 "application/xrd+xml" => ["xrd+xml"],
2996 "application/jrd+json" => ["jrd+json"],
2997 "application/activity+json" => ["activity+json"],
2998 "application/ld+json" => ["activity+json"]
3003 key: "application/xml",
3004 type: {:list, :string},
3005 suggestions: ["xml"]
3008 key: "application/xrd+xml",
3009 type: {:list, :string},
3010 suggestions: ["xrd+xml"]
3013 key: "application/jrd+json",
3014 type: {:list, :string},
3015 suggestions: ["jrd+json"]
3018 key: "application/activity+json",
3019 type: {:list, :string},
3020 suggestions: ["activity+json"]
3023 key: "application/ld+json",
3024 type: {:list, :string},
3025 suggestions: ["activity+json"]
3035 description: "Pleroma chat settings",
3048 description: "HTTP settings",
3053 type: [:string, :tuple],
3054 description: "Proxy URL",
3055 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3058 key: :send_user_agent,
3063 type: [:string, :atom],
3065 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3066 suggestions: ["Pleroma", :default]
3071 description: "Adapter specific options",
3077 label: "SSL Options",
3078 description: "SSL options for HTTP adapter",
3082 type: {:list, :atom},
3083 description: "List of TLS version to use",
3084 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3095 label: "Markup Settings",
3099 key: :allow_inline_images,
3103 key: :allow_headings,
3116 type: {:list, :module},
3118 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3119 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3129 key: :deny_follow_blocked,
3136 key: :mrf_normalize_markup,
3138 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3139 label: "MRF Normalize Markup",
3140 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3146 suggestions: [Pleroma.HTML.Scrubber.Default]
3156 key: :restricted_nicknames,
3157 type: {:list, :string},
3158 description: "List of nicknames users may not register with.",
3177 "ostatus_subscribe",
3193 key: :email_blacklist,
3194 type: {:list, :string},
3195 description: "List of email domains users may not register with.",
3196 suggestions: ["mailinator.com", "maildrop.cc"]
3202 label: "CORS plug config",
3208 suggestions: [86_400]
3212 type: {:list, :string},
3213 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3217 type: {:list, :string},
3220 "X-RateLimit-Reset",
3221 "X-RateLimit-Limit",
3222 "X-RateLimit-Remaining",
3233 type: {:list, :string},
3234 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3240 key: Pleroma.Web.Plugs.RemoteIp,
3243 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3244 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3250 description: "Enable/disable the plug. Default: disabled."
3254 type: {:list, :string},
3256 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3261 type: {:list, :string},
3263 "A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128."
3267 type: {:list, :string},
3269 A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`
3276 key: :web_cache_ttl,
3277 label: "Web cache TTL",
3280 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3286 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3287 suggestions: [30_000, nil]
3290 key: :activity_pub_question,
3292 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3293 suggestions: [30_000]
3303 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3308 description: "Enables the rendering of static HTML. Default: disabled."
3316 description: "Configure feed rendering",
3321 description: "Configure title rendering",
3326 description: "Maximum number of characters before truncating title",
3332 description: "Replacement which will be used after truncating string",
3333 suggestions: ["..."]
3341 key: :mrf_object_age,
3343 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3344 label: "MRF Object Age",
3347 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3352 description: "Required age (in seconds) of a post before actions are taken.",
3353 suggestions: [172_800]
3357 type: {:list, :atom},
3359 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3360 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3361 "`:reject` rejects the message entirely",
3362 suggestions: [:delist, :strip_followers, :reject]
3370 description: "Custom Runtime Modules",
3375 description: "A path to custom Elixir modules (such as MRF policies)."
3383 description: "Settings for notifications streamer",
3388 description: "Number of workers to send notifications",
3392 key: :overflow_workers,
3394 description: "Maximum number of workers created if pool is empty",
3401 key: :connections_pool,
3403 description: "Advanced settings for `Gun` connections pool",
3406 key: :connection_acquisition_wait,
3409 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3413 key: :connection_acquisition_retries,
3416 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3420 key: :max_connections,
3422 description: "Maximum number of connections in the pool. Default: 250 connections.",
3426 key: :connect_timeout,
3428 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3432 key: :reclaim_multiplier,
3435 "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",
3444 description: "Advanced settings for `Gun` workers pools",
3446 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3450 description: "Settings for #{pool_name} pool.",
3455 description: "Maximum number of concurrent requests in the pool.",
3462 "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",
3468 description: "Timeout for the pool while gun will wait for response",
3469 suggestions: [10_000]
3477 key: :hackney_pools,
3479 description: "Advanced settings for `Hackney` connections pools",
3484 description: "Settings for federation pool.",
3487 key: :max_connections,
3489 description: "Number workers in the pool.",
3495 description: "Timeout while `hackney` will wait for response.",
3496 suggestions: [150_000]
3503 description: "Settings for media pool.",
3506 key: :max_connections,
3508 description: "Number workers in the pool.",
3514 description: "Timeout while `hackney` will wait for response.",
3515 suggestions: [150_000]
3522 description: "Settings for upload pool.",
3525 key: :max_connections,
3527 description: "Number workers in the pool.",
3533 description: "Timeout while `hackney` will wait for response.",
3534 suggestions: [300_000]
3542 key: :restrict_unauthenticated,
3543 label: "Restrict Unauthenticated",
3546 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3551 description: "Settings for public and federated timelines.",
3556 description: "Disallow view public timeline."
3561 description: "Disallow view federated timeline."
3568 description: "Settings for user profiles.",
3573 description: "Disallow view local user profiles."
3578 description: "Disallow view remote user profiles."
3585 description: "Settings for statuses.",
3590 description: "Disallow view local statuses."
3595 description: "Disallow view remote statuses."
3603 key: Pleroma.Web.ApiSpec.CastAndValidate,
3610 "Enables strict input validation (useful in development, not recommended in production)"
3616 key: :instances_favicons,
3618 description: "Control favicons for instances",
3623 description: "Allow/disallow displaying and getting instances favicons"
3631 descriptions: "S3 service related settings",
3634 key: :access_key_id,
3636 description: "S3 access key ID",
3637 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3640 key: :secret_access_key,
3642 description: "Secret access key",
3643 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3648 description: "S3 host",
3649 suggestions: ["s3.eu-central-1.amazonaws.com"]
3657 description: "Installed frontends management",
3662 description: "Primary frontend, the one that is served for all pages by default",
3663 children: installed_frontend_options
3668 description: "Admin frontend",
3669 children: installed_frontend_options
3675 "A map containing available frontends and parameters for their installation.",
3676 children: frontend_options
3682 key: Pleroma.Web.Preload,
3684 description: "Preload-related settings",
3688 type: {:list, :module},
3689 description: "List of preload providers to enable",
3691 Pleroma.Web.Preload.Providers.Instance,
3692 Pleroma.Web.Preload.Providers.User,
3693 Pleroma.Web.Preload.Providers.Timelines,
3694 Pleroma.Web.Preload.Providers.StatusNet
3703 description: "Majic/libmagic configuration",
3708 description: "Number of majic workers to start.",
3715 key: Pleroma.Web.Endpoint.MetricsExporter,
3717 description: "Prometheus app metrics endpoint configuration",
3722 description: "[Pleroma extension] Enables app metrics endpoint."
3726 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3728 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3732 type: [:boolean, :tuple],
3733 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3734 suggestion: [false, {:basic, "myusername", "mypassword"}]
3739 description: "App metrics endpoint URI path.",
3740 suggestions: ["/api/pleroma/app_metrics"]
3745 description: "App metrics endpoint output format.",
3746 suggestions: [:text, :protobuf]