6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "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`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "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.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "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`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "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."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Hard character limit beyond which remote posts will be dropped",
558 description: "File size limit of uploads (except for avatar, background, banner)",
564 key: :avatar_upload_limit,
566 description: "File size limit of user's profile avatars",
572 key: :background_upload_limit,
574 description: "File size limit of user's profile backgrounds",
580 key: :banner_upload_limit,
582 description: "File size limit of user's profile banners",
590 description: "A map with poll limits for local polls",
594 max_option_chars: 200,
596 max_expiration: 31_536_000
603 description: "Maximum number of options",
607 key: :max_option_chars,
609 description: "Maximum number of characters per option",
613 key: :min_expiration,
615 description: "Minimum expiration time (in seconds)",
619 key: :max_expiration,
621 description: "Maximum expiration time (in seconds)",
627 key: :registrations_open,
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
633 key: :invites_enabled,
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
639 key: :account_activation_required,
641 description: "Require users to confirm their emails before signing in"
644 key: :account_approval_required,
646 description: "Require users to be manually approved by an admin before signing in"
651 description: "Enable federation with other instances"
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " 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.",
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
689 key: :quarantined_instances,
690 type: {:list, :tuple},
691 key_placeholder: "instance",
692 value_placeholder: "reason",
694 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
696 {"quarantined.com", "Reason"},
697 {"*.quarantined.com", "Reason"}
703 description: "Instance static directory",
709 key: :allowed_post_formats,
710 type: {:list, :string},
711 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
720 key: :extended_nickname_format,
723 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
724 " This will break federation with older software for theses nicknames."
727 key: :cleanup_attachments,
730 Enable to remove associated attachments when status is removed.
731 This will not affect duplicates and attachments without status.
732 Enabling this will increase load to database when deleting statuses on larger instances.
736 key: :max_pinned_statuses,
738 description: "The maximum number of pinned statuses. 0 will disable the feature.",
746 key: :autofollowed_nicknames,
747 type: {:list, :string},
749 "Set to nicknames of (local) users that every new user should automatically follow"
752 key: :autofollowing_nicknames,
753 type: {:list, :string},
755 "Set to nicknames of (local) users that automatically follows every newly registered user"
758 key: :attachment_links,
760 description: "Enable to automatically add attachment link text to statuses"
763 key: :max_report_comment_size,
765 description: "The maximum size of the report comment. Default: 1000.",
771 key: :safe_dm_mentions,
772 label: "Safe DM mentions",
775 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
776 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
782 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
785 key: :remote_post_retention_days,
788 "The default amount of days to retain remote posts when pruning the database",
794 key: :user_bio_length,
796 description: "A user bio maximum length. Default: 5000.",
802 key: :user_name_length,
804 description: "A user name maximum length. Default: 100.",
810 key: :skip_thread_containment,
812 description: "Skip filtering out broken threads. Default: enabled."
815 key: :limit_to_local_content,
816 type: {:dropdown, :atom},
818 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
826 key: :max_account_fields,
828 description: "The maximum number of custom fields in the user profile. Default: 10.",
834 key: :max_remote_account_fields,
837 "The maximum number of custom fields in the remote user profile. Default: 20.",
843 key: :account_field_name_length,
845 description: "An account field name maximum length. Default: 512.",
851 key: :account_field_value_length,
853 description: "An account field value maximum length. Default: 2048.",
859 key: :registration_reason_length,
861 description: "Maximum registration reason length. Default: 500.",
867 key: :external_user_synchronization,
869 description: "Enabling following/followers counters synchronization for external users"
872 key: :multi_factor_authentication,
874 description: "Multi-factor authentication settings",
877 totp: [digits: 6, period: 30],
878 backup_codes: [number: 5, length: 16]
884 label: "TOTP settings",
886 description: "TOTP settings",
887 suggestions: [digits: 6, period: 30],
894 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
901 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
908 description: "MFA backup codes settings",
909 suggestions: [number: 5, length: 16],
915 description: "Number of backup codes to generate."
922 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
929 key: :instance_thumbnail,
930 type: {:string, :image},
932 "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.",
933 suggestions: ["/instance/thumbnail.jpeg"]
936 key: :show_reactions,
938 description: "Let favourites and emoji reactions be viewed through the API."
941 key: :profile_directory,
943 description: "Enable profile directory."
946 key: :privileged_staff,
949 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
957 description: "Welcome messages settings",
960 key: :direct_message,
962 descpiption: "Direct message settings",
967 description: "Enables sending a direct message to newly registered users"
972 description: "A message that will be sent to newly registered users",
974 "Hi, @username! Welcome on board!"
978 key: :sender_nickname,
980 description: "The nickname of the local user that sends a welcome message",
990 descpiption: "Email message settings",
995 description: "Enables sending an email to newly registered users"
999 type: [:string, :tuple],
1001 "Email address and/or nickname that will be used to send the welcome email.",
1003 {"Pleroma App", "welcome@pleroma.app"}
1010 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1011 suggestions: ["Welcome to <%= instance_name%>"]
1017 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1018 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1024 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1025 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1034 description: "Logger-related settings",
1038 type: [:atom, :tuple, :module],
1040 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1041 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1049 label: "ExSyslogger",
1050 description: "ExSyslogger-related settings",
1054 type: {:dropdown, :atom},
1055 description: "Log level",
1056 suggestions: [:debug, :info, :warn, :error]
1062 "A string that's prepended to every message, and is typically set to the app name",
1063 suggestions: ["pleroma"]
1068 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1069 suggestions: ["$metadata[$level] $message"]
1073 type: {:list, :atom},
1074 suggestions: [:request_id]
1082 label: "Console Logger",
1083 description: "Console logger settings",
1087 type: {:dropdown, :atom},
1088 description: "Log level",
1089 suggestions: [:debug, :info, :warn, :error]
1094 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1095 suggestions: ["$metadata[$level] $message"]
1099 type: {:list, :atom},
1100 suggestions: [:request_id]
1107 label: "Quack Logger",
1108 description: "Quack-related settings",
1112 type: {:dropdown, :atom},
1113 description: "Log level",
1114 suggestions: [:debug, :info, :warn, :error]
1118 type: {:list, :atom},
1119 description: "Configure which metadata you want to report on",
1136 label: "Webhook URL",
1138 description: "Configure the Slack incoming webhook",
1139 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1145 key: :frontend_configurations,
1148 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1149 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1150 "add your own configuration your settings all fields must be complete.",
1154 label: "Pleroma FE",
1156 description: "Settings for Pleroma FE",
1159 alwaysShowSubjectInput: true,
1160 background: "/static/aurora_borealis.jpg",
1161 collapseMessageWithSubject: false,
1163 hideFilteredStatuses: false,
1164 hideMutedPosts: false,
1165 hidePostStats: false,
1166 hideSitename: false,
1167 hideUserStats: false,
1168 loginMethod: "password",
1169 logo: "/static/logo.svg",
1172 minimalScopesMode: false,
1173 noAttachmentLinks: false,
1174 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1175 postContentType: "text/plain",
1176 redirectRootLogin: "/main/friends",
1177 redirectRootNoLogin: "/main/all",
1179 sidebarRight: false,
1180 showFeaturesPanel: true,
1181 showInstanceSpecificPanel: false,
1182 subjectLineBehavior: "email",
1183 theme: "pleroma-dark",
1184 webPushNotifications: false
1189 key: :alwaysShowSubjectInput,
1190 label: "Always show subject input",
1192 description: "When disabled, auto-hide the subject field if it's empty"
1196 type: {:string, :image},
1198 "URL of the background, unless viewing a user profile with a background that is set",
1199 suggestions: ["/images/city.jpg"]
1202 key: :collapseMessageWithSubject,
1203 label: "Collapse message with subject",
1206 "When a message has a subject (aka Content Warning), collapse it by default"
1212 description: "Enables green text on lines prefixed with the > character"
1215 key: :hideFilteredStatuses,
1216 label: "Hide Filtered Statuses",
1218 description: "Hides filtered statuses from timelines"
1221 key: :hideMutedPosts,
1222 label: "Hide Muted Posts",
1224 description: "Hides muted statuses from timelines"
1227 key: :hidePostStats,
1228 label: "Hide post stats",
1230 description: "Hide notices statistics (repeats, favorites, ...)"
1234 label: "Hide Sitename",
1236 description: "Hides instance name from PleromaFE banner"
1239 key: :hideUserStats,
1240 label: "Hide user stats",
1243 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1247 type: {:string, :image},
1248 description: "URL of the logo, defaults to Pleroma's logo",
1249 suggestions: ["/static/logo.svg"]
1253 label: "Logo margin",
1256 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1257 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1258 suggestions: [".1em"]
1265 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1266 "If you want a colorful logo you must disable logoMask."
1269 key: :minimalScopesMode,
1270 label: "Minimal scopes mode",
1273 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1274 "Also prevents replying to a DM with a public post from PleromaFE."
1277 key: :nsfwCensorImage,
1278 label: "NSFW Censor Image",
1279 type: {:string, :image},
1281 "URL of the image to use for hiding NSFW media attachments in the timeline",
1282 suggestions: ["/static/img/nsfw.74818f9.png"]
1285 key: :postContentType,
1286 label: "Post Content Type",
1287 type: {:dropdown, :atom},
1288 description: "Default post formatting option",
1289 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1292 key: :redirectRootNoLogin,
1293 label: "Redirect root no login",
1296 "Relative URL which indicates where to redirect when a user isn't logged in",
1297 suggestions: ["/main/all"]
1300 key: :redirectRootLogin,
1301 label: "Redirect root login",
1304 "Relative URL which indicates where to redirect when a user is logged in",
1305 suggestions: ["/main/friends"]
1309 label: "Scope copy",
1311 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1315 label: "Sidebar on Right",
1317 description: "Change alignment of sidebar and panels to the right"
1320 key: :showFeaturesPanel,
1321 label: "Show instance features panel",
1324 "Enables panel displaying functionality of the instance on the About page"
1327 key: :showInstanceSpecificPanel,
1328 label: "Show instance specific panel",
1330 description: "Whether to show the instance's custom panel"
1333 key: :subjectLineBehavior,
1334 label: "Subject line behavior",
1336 description: "Allows changing the default behaviour of subject lines in replies.
1337 `email`: copy and preprend re:, as in email,
1338 `masto`: copy verbatim, as in Mastodon,
1339 `noop`: don't copy the subject.",
1340 suggestions: ["email", "masto", "noop"]
1345 description: "Which theme to use. Available themes are defined in styles.json",
1346 suggestions: ["pleroma-dark"]
1354 description: "Settings for Masto FE",
1357 showInstanceSpecificPanel: true
1362 key: :showInstanceSpecificPanel,
1363 label: "Show instance specific panel",
1365 description: "Whenether to show the instance's specific panel"
1376 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1380 type: {:keyword, :map},
1382 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1385 url: "/images/pleroma-fox-tan-smol.png",
1386 mime_type: "image/png"
1388 pleroma_fox_tan_shy: %{
1389 url: "/images/pleroma-fox-tan-shy.png",
1390 mime_type: "image/png"
1395 key: :default_mascot,
1398 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1404 key: :default_user_avatar,
1405 type: {:string, :image},
1406 description: "URL of the default user avatar",
1407 suggestions: ["/images/avi.png"]
1416 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1420 type: {:list, :map},
1421 description: "Describe the icons of the app",
1424 src: "/static/logo.png"
1427 src: "/static/icon.png",
1431 src: "/static/icon.ico",
1432 sizes: "72x72 96x96 128x128 256x256"
1439 description: "Describe the theme color of the app",
1440 suggestions: ["#282c37", "mediumpurple"]
1443 key: :background_color,
1445 description: "Describe the background color of the app",
1446 suggestions: ["#191b22", "aliceblue"]
1454 description: "Media proxy",
1459 description: "Enables proxying of remote media via the instance's proxy"
1466 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1467 suggestions: ["https://example.com"]
1475 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1481 description: "Enables media cache object invalidation."
1486 description: "Module which will be used to purge objects from the cache.",
1488 Pleroma.Web.MediaProxy.Invalidation.Script,
1489 Pleroma.Web.MediaProxy.Invalidation.Http
1496 label: "Advanced MediaProxy Options",
1498 description: "Internal Pleroma.ReverseProxy settings",
1500 redirect_on_failure: false,
1501 max_body_length: 25 * 1_048_576,
1502 max_read_duration: 30_000
1506 key: :redirect_on_failure,
1509 Redirects the client to the origin server upon encountering HTTP errors.\n
1510 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1511 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1512 IP addresses of your users to the other servers, bypassing the MediaProxy.
1516 key: :max_body_length,
1519 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1522 key: :max_read_duration,
1524 description: "Timeout (in milliseconds) of GET request to the remote URI."
1530 type: {:list, :string},
1531 description: "List of hosts with scheme to bypass the MediaProxy",
1532 suggestions: ["http://example.com"]
1538 key: :media_preview_proxy,
1540 description: "Media preview proxy",
1546 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1549 key: :thumbnail_max_width,
1552 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1555 key: :thumbnail_max_height,
1558 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1561 key: :image_quality,
1563 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1566 key: :min_content_length,
1569 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1575 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1577 description: "HTTP invalidate settings",
1582 description: "HTTP method of request. Default: :purge"
1586 type: {:keyword, :string},
1587 description: "HTTP headers of request",
1588 suggestions: [{"x-refresh", 1}]
1593 description: "Request options",
1597 type: {:map, :string}
1605 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1607 description: "Invalidation script settings",
1612 description: "Path to executable script which will purge cached items.",
1613 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1617 label: "URL Format",
1620 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1621 suggestions: [":htcacheclean"]
1628 label: "ActivityPub",
1630 description: "ActivityPub-related settings",
1633 key: :unfollow_blocked,
1635 description: "Whether blocks result in people getting unfollowed"
1638 key: :outgoing_blocks,
1640 description: "Whether to federate blocks to other instances"
1643 key: :blockers_visible,
1645 description: "Whether a user can see someone who has blocked them"
1648 key: :sign_object_fetches,
1650 description: "Sign object fetches with HTTP signatures"
1653 key: :note_replies_output_limit,
1656 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1659 key: :follow_handshake_timeout,
1661 description: "Following handshake timeout",
1665 key: :max_collection_objects,
1668 "The maximum number of items to fetch from a remote collections. Setting this too low can lead to only getting partial collections, but too high and you can end up fetching far too many objects.",
1675 key: :http_security,
1676 label: "HTTP security",
1678 description: "HTTP security settings",
1683 description: "Whether the managed content security policy is enabled"
1689 description: "Whether to additionally send a Strict-Transport-Security header"
1693 label: "STS max age",
1695 description: "The maximum age for the Strict-Transport-Security header if sent",
1696 suggestions: [31_536_000]
1700 label: "CT max age",
1702 description: "The maximum age for the Expect-CT header if sent",
1703 suggestions: [2_592_000]
1706 key: :referrer_policy,
1708 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1709 suggestions: ["same-origin", "no-referrer"]
1713 label: "Report URI",
1715 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1716 suggestions: ["https://example.com/report-uri"]
1721 group: :web_push_encryption,
1722 key: :vapid_details,
1723 label: "Vapid Details",
1726 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1732 "A mailto link for the administrative contact." <>
1733 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1734 suggestions: ["mailto:moderators@pleroma.com"]
1739 description: "VAPID public key",
1740 suggestions: ["Public key"]
1745 description: "VAPID private key",
1746 suggestions: ["Private key"]
1752 key: Pleroma.Captcha,
1754 description: "Captcha-related settings",
1759 description: "Whether the captcha should be shown on registration"
1764 description: "The method/service to use for captcha",
1765 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1768 key: :seconds_valid,
1770 description: "The time in seconds for which the captcha is valid",
1777 key: Pleroma.Captcha.Kocaptcha,
1780 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1781 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1786 description: "The kocaptcha endpoint to use",
1787 suggestions: ["https://captcha.kotobank.ch"]
1793 label: "Pleroma Admin Token",
1796 "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)",
1801 description: "Admin token",
1803 "Please use a high entropy string or UUID"
1813 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1817 type: {:dropdown, :atom},
1818 description: "Logs verbose mode",
1819 suggestions: [false, :error, :warn, :info, :debug]
1823 type: {:keyword, :integer},
1825 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1827 activity_expiration: 10,
1828 attachments_cleanup: 5,
1830 federator_incoming: 50,
1831 federator_outgoing: 50,
1833 scheduled_activities: 10,
1839 key: :activity_expiration,
1841 description: "Activity expiration queue",
1847 description: "Backup queue",
1851 key: :attachments_cleanup,
1853 description: "Attachment deletion queue",
1859 description: "Background queue",
1863 key: :federator_incoming,
1865 description: "Incoming federation queue",
1869 key: :federator_outgoing,
1871 description: "Outgoing federation queue",
1877 description: "Email sender queue, see Pleroma.Emails.Mailer",
1881 key: :scheduled_activities,
1883 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1887 key: :transmogrifier,
1889 description: "Transmogrifier queue",
1895 description: "Web push notifications queue",
1902 type: {:list, :tuple},
1903 description: "Settings for cron background jobs",
1905 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1906 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1915 description: "Includes custom worker options not interpretable directly by `Oban`",
1919 type: {:keyword, :integer},
1920 description: "Max retry attempts for failed jobs, per `Oban` queue",
1922 federator_incoming: 5,
1923 federator_outgoing: 5
1930 key: Pleroma.Web.Metadata,
1932 description: "Metadata-related settings",
1936 type: {:list, :module},
1937 description: "List of metadata providers to enable",
1939 Pleroma.Web.Metadata.Providers.OpenGraph,
1940 Pleroma.Web.Metadata.Providers.TwitterCard,
1941 Pleroma.Web.Metadata.Providers.RelMe,
1942 Pleroma.Web.Metadata.Providers.Feed
1947 label: "Unfurl NSFW",
1949 description: "When enabled NSFW attachments will be shown in previews"
1955 key: Pleroma.Web.Metadata.Providers.Theme,
1957 description: "Specific provider to hand out themes to instances that scrape index.html",
1963 "The 'accent color' of the instance, used in places like misskey's instance ticker",
1964 suggestions: ["#593196"]
1973 "If enabled the instance will parse metadata from attached links to generate link previews",
1978 description: "Enables RichMedia parsing of URLs"
1982 type: {:list, :string},
1983 description: "List of hosts which will be ignored by the metadata parser",
1984 suggestions: ["accounts.google.com", "xss.website"]
1988 label: "Ignore TLD",
1989 type: {:list, :string},
1990 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1991 suggestions: ["local", "localdomain", "lan"]
1995 type: {:list, :module},
1997 "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.",
1999 Pleroma.Web.RichMedia.Parsers.OEmbed,
2000 Pleroma.Web.RichMedia.Parsers.TwitterCard
2005 label: "TTL setters",
2006 type: {:list, :module},
2008 "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.",
2010 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2014 key: :failure_backoff,
2017 "Amount of milliseconds after request failure, during which the request will not be retried.",
2018 suggestions: [60_000]
2024 key: Pleroma.Formatter,
2028 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2032 type: [:string, :boolean],
2033 description: "Specify the class to be added to the generated link. Disable to clear.",
2034 suggestions: ["auto-linker", false]
2038 type: [:string, :boolean],
2039 description: "Override the rel attribute. Disable to clear.",
2040 suggestions: ["ugc", "noopener noreferrer", false]
2045 description: "Link URLs will open in a new window/tab."
2049 type: [:integer, :boolean],
2051 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2052 suggestions: [15, false]
2057 description: "Strip the scheme prefix."
2062 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2066 type: [:atom, :boolean],
2068 "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)",
2069 suggestions: [:no_scheme, true]
2075 key: Pleroma.ScheduledActivity,
2077 description: "Scheduled activities settings",
2080 key: :daily_user_limit,
2083 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2087 key: :total_user_limit,
2090 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2096 description: "Whether scheduled activities are sent to the job queue to be executed"
2102 key: Pleroma.Workers.PurgeExpiredActivity,
2104 description: "Expired activities settings",
2109 description: "Enables expired activities addition & deletion"
2114 description: "Minimum lifetime for ephemeral activity (in seconds)",
2121 label: "Pleroma Authenticator",
2123 description: "Authenticator",
2126 key: Pleroma.Web.Auth.Authenticator,
2128 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2136 description: "Authentication / authorization settings",
2139 key: :enforce_oauth_admin_scope_usage,
2140 label: "Enforce OAuth admin scope usage",
2143 "OAuth admin scope requirement toggle. " <>
2144 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2145 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2146 "`is_admin` user flag grants access to admin-specific actions."
2149 key: :auth_template,
2152 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2153 suggestions: ["show.html"]
2156 key: :oauth_consumer_template,
2157 label: "OAuth consumer template",
2160 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2161 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2162 suggestions: ["consumer.html"]
2165 key: :oauth_consumer_strategies,
2166 label: "OAuth consumer strategies",
2167 type: {:list, :string},
2169 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2170 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2171 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2172 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2178 key: :email_notifications,
2180 description: "Email notifications settings",
2186 "emails of \"what you've missed\" for users who have been inactive for a while",
2190 schedule: "0 0 * * 0",
2192 inactivity_threshold: 7
2200 description: "Globally enable or disable digest emails"
2206 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2207 suggestions: ["0 0 * * 0"]
2212 description: "Minimum interval between digest emails to one user",
2216 key: :inactivity_threshold,
2218 description: "Minimum user inactivity threshold",
2227 key: Pleroma.Emails.UserEmail,
2229 description: "Email template settings",
2233 type: {:string, :image},
2234 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2235 suggestions: ["some/path/logo.png"]
2240 description: "A map with color settings for email templates.",
2243 link_color: "#d8a070",
2244 background_color: "#2C3645",
2245 content_background_color: "#1B2635",
2246 header_color: "#d8a070",
2247 text_color: "#b9b9ba",
2248 text_muted_color: "#b9b9ba"
2255 suggestions: ["#d8a070"]
2258 key: :background_color,
2260 suggestions: ["#2C3645"]
2263 key: :content_background_color,
2265 suggestions: ["#1B2635"]
2270 suggestions: ["#d8a070"]
2275 suggestions: ["#b9b9ba"]
2278 key: :text_muted_color,
2280 suggestions: ["#b9b9ba"]
2288 key: Pleroma.Emails.NewUsersDigestEmail,
2290 description: "New users admin email digest",
2295 description: "Enables new users admin digest email when `true`"
2304 description: "Configure OAuth 2 provider capabilities",
2307 key: :token_expires_in,
2309 description: "The lifetime in seconds of the access token",
2310 suggestions: [2_592_000]
2313 key: :issue_new_refresh_token,
2316 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2319 key: :clean_expired_tokens,
2321 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2331 key: :shortcode_globs,
2332 type: {:list, :string},
2333 description: "Location of custom emoji files. * can be used as a wildcard.",
2334 suggestions: ["/emoji/custom/**/*.png"]
2337 key: :pack_extensions,
2338 type: {:list, :string},
2340 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2341 suggestions: [".png", ".gif"]
2345 type: {:keyword, {:list, :string}},
2347 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2348 " and the value is the location or array of locations. * can be used as a wildcard.",
2350 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2354 key: :default_manifest,
2357 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2358 " Currently only one manifest can be added (no arrays).",
2359 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2362 key: :shared_pack_cache_seconds_per_file,
2363 label: "Shared pack cache s/file",
2366 "When an emoji pack is shared, the archive is created and cached in memory" <>
2367 " for this amount of seconds multiplied by the number of files.",
2377 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2381 type: [:tuple, {:list, :tuple}],
2382 description: "For the search requests (account & status search etc.)",
2383 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2387 type: [:tuple, {:list, :tuple}],
2388 description: "For requests to timelines (each timeline has it's own limiter)",
2389 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2392 key: :app_account_creation,
2393 type: [:tuple, {:list, :tuple}],
2394 description: "For registering user accounts from the same IP address",
2395 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2398 key: :relations_actions,
2399 type: [:tuple, {:list, :tuple}],
2400 description: "For actions on relationships with all users (follow, unfollow)",
2401 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2404 key: :relation_id_action,
2405 label: "Relation ID action",
2406 type: [:tuple, {:list, :tuple}],
2407 description: "For actions on relation with a specific user (follow, unfollow)",
2408 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2411 key: :statuses_actions,
2412 type: [:tuple, {:list, :tuple}],
2414 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2415 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2418 key: :status_id_action,
2419 label: "Status ID action",
2420 type: [:tuple, {:list, :tuple}],
2422 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2423 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2426 key: :authentication,
2427 type: [:tuple, {:list, :tuple}],
2428 description: "For authentication create / password check / user existence check requests",
2429 suggestions: [{60_000, 15}]
2435 label: "Mime Types",
2437 description: "Mime Types settings",
2444 "application/xml" => ["xml"],
2445 "application/xrd+xml" => ["xrd+xml"],
2446 "application/jrd+json" => ["jrd+json"],
2447 "application/activity+json" => ["activity+json"],
2448 "application/ld+json" => ["activity+json"]
2453 key: "application/xml",
2454 type: {:list, :string},
2455 suggestions: ["xml"]
2458 key: "application/xrd+xml",
2459 type: {:list, :string},
2460 suggestions: ["xrd+xml"]
2463 key: "application/jrd+json",
2464 type: {:list, :string},
2465 suggestions: ["jrd+json"]
2468 key: "application/activity+json",
2469 type: {:list, :string},
2470 suggestions: ["activity+json"]
2473 key: "application/ld+json",
2474 type: {:list, :string},
2475 suggestions: ["activity+json"]
2486 description: "HTTP settings",
2491 type: [:string, :tuple],
2492 description: "Proxy URL",
2493 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2497 type: [:string, :atom],
2499 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2500 suggestions: ["Pleroma", :default]
2505 description: "Adapter specific options",
2511 label: "SSL Options",
2512 description: "SSL options for HTTP adapter",
2516 type: {:list, :atom},
2517 description: "List of TLS version to use",
2518 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2529 label: "Markup Settings",
2533 key: :allow_inline_images,
2537 key: :allow_headings,
2550 type: {:list, :module},
2552 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2553 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2563 key: :deny_follow_blocked,
2574 key: :restricted_nicknames,
2575 type: {:list, :string},
2576 description: "List of nicknames users may not register with.",
2595 "ostatus_subscribe",
2611 key: :email_blacklist,
2612 type: {:list, :string},
2613 description: "List of email domains users may not register with.",
2614 suggestions: ["mailinator.com", "maildrop.cc"]
2620 label: "CORS plug config",
2626 suggestions: [86_400]
2630 type: {:list, :string},
2631 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2635 type: {:list, :string},
2638 "X-RateLimit-Reset",
2639 "X-RateLimit-Limit",
2640 "X-RateLimit-Remaining",
2651 type: {:list, :string},
2652 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2658 key: Pleroma.Web.Plugs.RemoteIp,
2661 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2662 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2668 description: "Enable/disable the plug. Default: disabled."
2672 type: {:list, :string},
2674 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2679 type: {:list, :string},
2681 "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."
2685 type: {:list, :string},
2687 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"]`
2694 key: :web_cache_ttl,
2695 label: "Web cache TTL",
2698 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2704 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2708 key: :activity_pub_question,
2710 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2711 suggestions: [30_000]
2721 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2726 description: "Enables the rendering of static HTML. Default: disabled."
2734 description: "Configure feed rendering",
2739 description: "Configure title rendering",
2744 description: "Maximum number of characters before truncating title",
2750 description: "Replacement which will be used after truncating string",
2751 suggestions: ["..."]
2759 key: :mrf_follow_bot,
2761 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2762 label: "MRF FollowBot Policy",
2764 description: "Automatically follows newly discovered accounts.",
2767 key: :follower_nickname,
2769 description: "The name of the bot account to use for following newly discovered users.",
2770 suggestions: ["followbot"]
2778 description: "Custom Runtime Modules",
2783 description: "A path to custom Elixir modules (such as MRF policies)."
2791 description: "Settings for notifications streamer",
2796 description: "Number of workers to send notifications",
2800 key: :overflow_workers,
2802 description: "Maximum number of workers created if pool is empty",
2809 key: :restrict_unauthenticated,
2810 label: "Restrict Unauthenticated",
2813 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2818 description: "Settings for public and federated timelines.",
2823 description: "Disallow view public timeline."
2828 description: "Disallow view federated timeline."
2835 description: "Settings for user profiles.",
2840 description: "Disallow view local user profiles."
2845 description: "Disallow view remote user profiles."
2852 description: "Settings for statuses.",
2857 description: "Disallow view local statuses."
2862 description: "Disallow view remote statuses."
2870 key: Pleroma.Web.ApiSpec.CastAndValidate,
2877 "Enables strict input validation (useful in development, not recommended in production)"
2883 key: :instances_favicons,
2885 description: "Control favicons for instances",
2890 description: "Allow/disallow displaying and getting instances favicons"
2898 descriptions: "S3 service related settings",
2901 key: :access_key_id,
2903 description: "S3 access key ID",
2904 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
2907 key: :secret_access_key,
2909 description: "Secret access key",
2910 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
2915 description: "S3 host",
2916 suggestions: ["s3.eu-central-1.amazonaws.com"]
2921 description: "S3 region (for AWS)",
2922 suggestions: ["us-east-1"]
2930 description: "Installed frontends management",
2935 description: "Primary frontend, the one that is served for all pages by default",
2936 children: installed_frontend_options
2941 description: "Admin frontend",
2942 children: installed_frontend_options
2947 description: "Mastodon frontend",
2948 children: installed_frontend_options
2953 description: "Swagger API reference frontend",
2955 installed_frontend_options ++
2961 description: "Whether to have this enabled at all"
2969 "A map containing available frontends and parameters for their installation.",
2970 children: frontend_options
2976 key: Pleroma.Web.Preload,
2978 description: "Preload-related settings",
2982 type: {:list, :module},
2983 description: "List of preload providers to enable",
2985 Pleroma.Web.Preload.Providers.Instance,
2986 Pleroma.Web.Preload.Providers.User,
2987 Pleroma.Web.Preload.Providers.Timelines,
2988 Pleroma.Web.Preload.Providers.StatusNet
2997 description: "Majic/libmagic configuration",
3002 description: "Number of majic workers to start.",
3009 key: Pleroma.User.Backup,
3011 description: "Account Backup",
3014 key: :purge_after_days,
3016 description: "Remove backup achives after N days",
3022 description: "Limit user to export not more often than once per N days",
3029 key: ConcurrentLimiter,
3031 description: "Limits configuration for background tasks.",
3034 key: Pleroma.Web.RichMedia.Helpers,
3036 description: "Concurrent limits configuration for getting RichMedia for activities.",
3037 suggestions: [max_running: 5, max_waiting: 5],
3042 description: "Max running concurrently jobs.",
3048 description: "Max waiting jobs.",
3054 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3056 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3057 suggestions: [max_running: 5, max_waiting: 5],
3062 description: "Max running concurrently jobs.",
3068 description: "Max waiting jobs.",
3077 key: Pleroma.Search,
3079 description: "General search settings.",
3084 description: "Selected search module.",
3085 suggestion: [Pleroma.Search.DatabaseSearch, Pleroma.Search.Meilisearch]
3091 key: Pleroma.Search.Meilisearch,
3093 description: "Meilisearch settings.",
3098 description: "Meilisearch URL.",
3099 suggestion: ["http://127.0.0.1:7700/"]
3105 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3109 key: :initial_indexing_chunk_size,
3112 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3113 " since there's a limit on maximum insert size",
3114 suggestion: [100_000]
3120 key: Pleroma.Search.Elasticsearch.Cluster,
3122 description: "Elasticsearch settings.",
3127 description: "Elasticsearch URL.",
3128 suggestion: ["http://127.0.0.1:9200/"]
3133 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3134 suggestion: ["elastic"]
3139 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3140 suggestion: ["changeme"]
3146 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3147 suggestion: [Elasticsearch.API.HTTP]
3153 "The JSON module used to encode/decode when communicating with Elasticsearch",
3159 description: "The indices to set up in Elasticsearch",
3164 description: "Config for the index to use for activities",
3170 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3171 suggestion: ["priv/es-mappings/activity.json"]
3176 description: "The internal store module",
3177 suggestion: [Pleroma.Search.Elasticsearch.Store]
3181 type: {:list, :module},
3182 description: "The internal types to use for this index",
3183 suggestion: [[Pleroma.Activity]]
3186 key: :bulk_page_size,
3188 description: "Size for bulk put requests, mostly used on building the index",
3192 key: :bulk_wait_interval,
3194 description: "Time to wait between bulk put requests (in ms)",
3195 suggestion: [15_000]