2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
27 Generator.uploaders_list()
32 type: {:list, :module},
33 description: "List of filter modules for uploads",
35 Generator.filters_list()
42 "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`"
47 description: "Base url for the uploads, needed if you use CDN",
49 "https://cdn-host.com"
56 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected."
61 description: "Proxy options, see `Pleroma.ReverseProxy` documentation"
67 key: Pleroma.Uploaders.Local,
69 description: "Local uploader-related settings",
74 description: "Path where user uploads will be saved",
83 key: Pleroma.Uploaders.S3,
85 description: "S3 uploader-related settings",
90 description: "S3 bucket",
96 key: :bucket_namespace,
98 description: "S3 bucket namespace",
99 suggestions: ["pleroma"]
102 key: :public_endpoint,
104 description: "S3 endpoint",
105 suggestions: ["https://s3.amazonaws.com"]
108 key: :truncated_namespace,
111 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
112 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
115 key: :streaming_enabled,
118 "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."
124 key: Pleroma.Upload.Filter.Mogrify,
126 description: "Uploads mogrify filter settings",
130 type: [:string, {:list, :string}, {:list, :tuple}],
131 description: "List of actions for the mogrify command",
134 ["strip", "auto-orient"],
136 ["strip", "auto-orient", {"implode", "1"}]
143 key: Pleroma.Upload.Filter.AnonymizeFilename,
145 description: "Filter replaces the filename of the upload",
151 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
152 " filename extension by using {extension}, for example custom-file-name.{extension}",
154 "custom-file-name.{extension}",
162 key: Pleroma.Emails.Mailer,
164 description: "Mailer-related settings",
170 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
171 " or Swoosh.Adapters.Local for in-memory mailbox",
173 Swoosh.Adapters.SMTP,
174 Swoosh.Adapters.Sendgrid,
175 Swoosh.Adapters.Sendmail,
176 Swoosh.Adapters.Mandrill,
177 Swoosh.Adapters.Mailgun,
178 Swoosh.Adapters.Mailjet,
179 Swoosh.Adapters.Postmark,
180 Swoosh.Adapters.SparkPost,
181 Swoosh.Adapters.AmazonSES,
183 Swoosh.Adapters.SocketLabs,
184 Swoosh.Adapters.Gmail
190 description: "Allow/disallow send emails"
193 group: {:subgroup, Swoosh.Adapters.SMTP},
196 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
197 suggestions: ["smtp.gmail.com"]
200 group: {:subgroup, Swoosh.Adapters.SMTP},
203 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
204 suggestions: ["pleroma"]
207 group: {:subgroup, Swoosh.Adapters.SMTP},
210 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
211 suggestions: ["password"]
214 group: {:subgroup, Swoosh.Adapters.SMTP},
217 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
220 group: {:subgroup, Swoosh.Adapters.SMTP},
223 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
224 suggestions: [:always, :never, :if_available]
227 group: {:subgroup, Swoosh.Adapters.SMTP},
230 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
231 suggestions: [:always, :never, :if_available]
234 group: {:subgroup, Swoosh.Adapters.SMTP},
237 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
241 group: {:subgroup, Swoosh.Adapters.SMTP},
244 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
248 group: {:subgroup, Swoosh.Adapters.SMTP},
251 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
254 group: {:subgroup, Swoosh.Adapters.Sendgrid},
257 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
258 suggestions: ["my-api-key"]
261 group: {:subgroup, Swoosh.Adapters.Sendmail},
264 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
265 suggestions: ["/usr/bin/sendmail"]
268 group: {:subgroup, Swoosh.Adapters.Sendmail},
271 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
272 suggestions: ["-N delay,failure,success"]
275 group: {:subgroup, Swoosh.Adapters.Sendmail},
278 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
281 group: {:subgroup, Swoosh.Adapters.Mandrill},
284 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
285 suggestions: ["my-api-key"]
288 group: {:subgroup, Swoosh.Adapters.Mailgun},
291 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
292 suggestions: ["my-api-key"]
295 group: {:subgroup, Swoosh.Adapters.Mailgun},
298 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
299 suggestions: ["pleroma.com"]
302 group: {:subgroup, Swoosh.Adapters.Mailjet},
305 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
306 suggestions: ["my-api-key"]
309 group: {:subgroup, Swoosh.Adapters.Mailjet},
312 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
313 suggestions: ["my-secret-key"]
316 group: {:subgroup, Swoosh.Adapters.Postmark},
319 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
320 suggestions: ["my-api-key"]
323 group: {:subgroup, Swoosh.Adapters.SparkPost},
326 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
327 suggestions: ["my-api-key"]
330 group: {:subgroup, Swoosh.Adapters.SparkPost},
333 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
334 suggestions: ["https://api.sparkpost.com/api/v1"]
337 group: {:subgroup, Swoosh.Adapters.AmazonSES},
340 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
341 suggestions: ["us-east-1", "us-east-2"]
344 group: {:subgroup, Swoosh.Adapters.AmazonSES},
347 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
348 suggestions: ["aws-access-key"]
351 group: {:subgroup, Swoosh.Adapters.AmazonSES},
354 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
355 suggestions: ["aws-secret-key"]
358 group: {:subgroup, Swoosh.Adapters.Dyn},
361 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
362 suggestions: ["my-api-key"]
365 group: {:subgroup, Swoosh.Adapters.SocketLabs},
368 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
371 group: {:subgroup, Swoosh.Adapters.SocketLabs},
374 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
377 group: {:subgroup, Swoosh.Adapters.Gmail},
380 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
388 description: "URI schemes related settings",
392 type: {:list, :string},
393 description: "List of the scheme part that is considered valid to be an URL",
419 description: "Instance-related settings",
424 description: "Name of the instance",
432 description: "Email used to reach an Administrator/Moderator of the instance",
440 description: "Email used for notifications",
448 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
456 description: "Posts character limit (CW/Subject included in the counter)",
464 description: "Hard character limit beyond which remote posts will be dropped",
472 description: "File size limit of uploads (except for avatar, background, banner)",
478 key: :avatar_upload_limit,
480 description: "File size limit of user's profile avatars",
486 key: :background_upload_limit,
488 description: "File size limit of user's profile backgrounds",
494 key: :banner_upload_limit,
496 description: "File size limit of user's profile banners",
504 description: "A map with poll limits for local polls",
508 max_option_chars: 200,
510 max_expiration: 31_536_000
517 description: "Maximum number of options",
521 key: :max_option_chars,
523 description: "Maximum number of characters per option",
527 key: :min_expiration,
529 description: "Minimum expiration time (in seconds)",
533 key: :max_expiration,
535 description: "Maximum expiration time (in seconds)",
541 key: :registrations_open,
543 description: "Enable registrations for anyone, invitations can be enabled when false"
546 key: :invites_enabled,
548 description: "Enable user invitations for admins (depends on registrations_open: false)"
551 key: :account_activation_required,
553 description: "Require users to confirm their emails before signing in"
558 description: "Enable federation with other instances"
561 key: :federation_incoming_replies_max_depth,
564 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
565 " 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",
571 key: :federation_reachability_timeout_days,
574 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
580 key: :federation_publisher_modules,
581 type: [:list, :module],
582 description: "List of modules for federation publishing",
584 Pleroma.Web.ActivityPub.Publisher,
592 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
595 key: :rewrite_policy,
596 type: {:list, :module},
597 description: "A list of MRF policies enabled",
599 Pleroma.Web.ActivityPub.MRF.NoOpPolicy,
607 "Makes the client API in authentificated mode-only except for user-profiles." <>
608 " Useful for disabling the Local Timeline and The Whole Known Network"
611 key: :quarantined_instances,
612 type: {:list, :string},
614 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
621 key: :managed_config,
624 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
629 description: "Instance static directory",
635 key: :allowed_post_formats,
636 type: {:list, :string},
637 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
648 key: :mrf_transparency,
651 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
654 key: :mrf_transparency_exclusions,
655 type: {:list, :string},
657 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
663 key: :extended_nickname_format,
666 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
667 " This will break federation with older software for theses nicknames"
670 key: :max_pinned_statuses,
672 description: "The maximum number of pinned statuses. 0 will disable the feature",
680 key: :autofollowed_nicknames,
681 type: {:list, :string},
683 "Set to nicknames of (local) users that every new user should automatically follow",
692 key: :no_attachment_links,
695 "Set to true to disable automatically adding attachment link text to statuses"
698 key: :welcome_message,
701 "A message that will be send to a newly registered users as a direct message",
703 "Hi, @username! Welcome to the board!",
708 key: :welcome_user_nickname,
710 description: "The nickname of the local user that sends the welcome message",
717 key: :max_report_comment_size,
719 description: "The maximum size of the report comment (Default: 1000)",
725 key: :safe_dm_mentions,
728 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
729 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
735 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
738 key: :remote_post_retention_days,
741 "The default amount of days to retain remote posts when pruning the database",
747 key: :user_bio_length,
749 description: "A user bio maximum length (default: 5000)",
755 key: :user_name_length,
757 description: "A user name maximum length (default: 100)",
763 key: :skip_thread_containment,
765 description: "Skip filter out broken threads. The default is true"
768 key: :limit_to_local_content,
769 type: [:atom, false],
771 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
779 key: :dynamic_configuration,
782 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"
785 key: :max_account_fields,
787 description: "The maximum number of custom fields in the user profile (default: 10)",
793 key: :max_remote_account_fields,
796 "The maximum number of custom fields in the remote user profile (default: 20)",
802 key: :account_field_name_length,
804 description: "An account field name maximum length (default: 512)",
810 key: :account_field_value_length,
812 description: "An account field value maximum length (default: 2048)",
818 key: :external_user_synchronization,
820 description: "Enabling following/followers counters synchronization for external users"
827 description: "Logger-related settings",
831 type: [:atom, :tuple, :module],
833 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
834 suggestions: [[:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]]
842 description: "ExSyslogger-related settings",
847 description: "Log level",
848 suggestions: [:debug, :info, :warn, :error]
854 "A string that's prepended to every message, and is typically set to the app name",
855 suggestions: ["pleroma"]
860 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
861 suggestions: ["$metadata[$level] $message"]
865 type: {:list, :atom},
866 suggestions: [[:request_id]]
874 description: "Console logger settings",
879 description: "Log level",
880 suggestions: [:debug, :info, :warn, :error]
885 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
886 suggestions: ["$metadata[$level] $message"]
890 type: {:list, :atom},
891 suggestions: [[:request_id]]
898 description: "Quack-related settings",
903 description: "Log level",
904 suggestions: [:debug, :info, :warn, :error]
908 type: {:list, :atom},
909 description: "Configure which metadata you want to report on",
927 description: "Configure the Slack incoming webhook",
928 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
934 key: :frontend_configurations,
936 description: "A keyword list that keeps the configuration data for any kind of frontend",
941 description: "Settings for Pleroma FE",
944 theme: "pleroma-dark",
945 logo: "/static/logo.png",
946 background: "/images/city.jpg",
947 redirectRootNoLogin: "/main/all",
948 redirectRootLogin: "/main/friends",
949 showInstanceSpecificPanel: true,
950 scopeOptionsEnabled: false,
951 formattingOptionsEnabled: false,
952 collapseMessageWithSubject: false,
953 hidePostStats: false,
954 hideUserStats: false,
956 subjectLineBehavior: "email",
957 alwaysShowSubjectInput: true
964 description: "Which theme to use, they are defined in styles.json",
965 suggestions: ["pleroma-dark"]
970 description: "URL of the logo, defaults to Pleroma's logo",
971 suggestions: ["/static/logo.png"]
977 "URL of the background, unless viewing a user profile with a background that is set",
978 suggestions: ["/images/city.jpg"]
981 key: :redirectRootNoLogin,
984 "relative URL which indicates where to redirect when a user isn't logged in",
985 suggestions: ["/main/all"]
988 key: :redirectRootLogin,
991 "relative URL which indicates where to redirect when a user is logged in",
992 suggestions: ["/main/friends"]
995 key: :showInstanceSpecificPanel,
997 description: "Whenether to show the instance's specific panel"
1000 key: :scopeOptionsEnabled,
1002 description: "Enable setting an notice visibility and subject/CW when posting"
1005 key: :formattingOptionsEnabled,
1008 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1011 key: :collapseMessageWithSubject,
1014 "When a message has a subject(aka Content Warning), collapse it by default"
1017 key: :hidePostStats,
1019 description: "Hide notices statistics(repeats, favorites, ...)"
1022 key: :hideUserStats,
1025 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1030 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1033 key: :subjectLineBehavior,
1035 description: "Allows changing the default behaviour of subject lines in replies.
1036 `email`: Copy and preprend re:, as in email,
1037 `masto`: Copy verbatim, as in Mastodon,
1038 `noop`: Don't copy the subjec",
1039 suggestions: ["email", "masto", "noop"]
1042 key: :alwaysShowSubjectInput,
1044 description: "When set to false, auto-hide the subject field when it's empty"
1051 description: "Settings for Masto FE",
1054 showInstanceSpecificPanel: true
1059 key: :showInstanceSpecificPanel,
1061 description: "Whenether to show the instance's specific panel"
1072 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1078 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1082 url: "/images/pleroma-fox-tan-smol.png",
1083 mime_type: "image/png"
1085 pleroma_fox_tan_shy: %{
1086 url: "/images/pleroma-fox-tan-shy.png",
1087 mime_type: "image/png"
1093 key: :default_mascot,
1096 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1107 description: "Message Rewrite Facility",
1110 key: :media_removal,
1111 type: {:list, :string},
1112 description: "List of instances to remove medias from",
1113 suggestions: ["example.com", "*.example.com"]
1117 type: {:list, :string},
1118 description: "List of instances to put medias as NSFW(sensitive) from",
1119 suggestions: ["example.com", "*.example.com"]
1122 key: :federated_timeline_removal,
1123 type: {:list, :string},
1125 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1126 suggestions: ["example.com", "*.example.com"]
1130 type: {:list, :string},
1131 description: "List of instances to reject any activities from",
1132 suggestions: ["example.com", "*.example.com"]
1136 type: {:list, :string},
1137 description: "List of instances to accept any activities from",
1138 suggestions: ["example.com", "*.example.com"]
1141 key: :report_removal,
1142 type: {:list, :string},
1143 description: "List of instances to reject reports from",
1144 suggestions: ["example.com", "*.example.com"]
1147 key: :avatar_removal,
1148 type: {:list, :string},
1149 description: "List of instances to strip avatars from",
1150 suggestions: ["example.com", "*.example.com"]
1153 key: :banner_removal,
1154 type: {:list, :string},
1155 description: "List of instances to strip banners from",
1156 suggestions: ["example.com", "*.example.com"]
1165 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1166 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1171 description: "Matches a series of regular expressions against the actor field",
1174 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1182 key: :mrf_rejectnonpublic,
1186 key: :allow_followersonly,
1188 description: "whether to allow followers-only posts"
1193 description: "whether to allow direct messages"
1199 key: :mrf_hellthread,
1201 description: "Block messages with too much mentions",
1204 key: :delist_threshold,
1207 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1208 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1212 key: :reject_threshold,
1215 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1224 description: "Reject or Word-Replace messages with a keyword or regex",
1228 type: [:string, :regex],
1230 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1231 suggestions: ["foo", ~r/foo/iu]
1234 key: :federated_timeline_removal,
1235 type: [:string, :regex],
1237 "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",
1238 suggestions: ["foo", ~r/foo/iu]
1242 type: [{:string, :string}, {:regex, :string}],
1244 "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",
1245 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1253 description: "Block messages which mention a user",
1257 type: {:list, :string},
1258 description: "A list of actors, for which to drop any posts mentioning",
1259 suggestions: [["actor1", "actor2"]]
1265 key: :mrf_vocabulary,
1267 description: "Filter messages which belong to certain activity vocabularies",
1271 type: {:list, :string},
1273 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1274 suggestions: [["Create", "Follow", "Mention", "Announce", "Like"]]
1278 type: {:list, :string},
1280 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1281 suggestions: [["Create", "Follow", "Mention", "Announce", "Like"]]
1287 # key: :mrf_user_allowlist,
1290 # "The keys in this section are the domain names that the policy should apply to." <>
1291 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1293 # ["example.org": ["https://example.org/users/admin"]],
1295 # ["example.org": ["https://example.org/users/admin"]]
1303 description: "Media proxy",
1308 description: "Enables proxying of remote media to the instance's proxy"
1314 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1315 suggestions: ["https://example.com"]
1320 description: "Options for Pleroma.ReverseProxy",
1321 suggestions: [[max_body_length: 25 * 1_048_576, redirect_on_failure: false]]
1325 type: {:list, :string},
1326 description: "List of domains to bypass the mediaproxy",
1327 suggestions: ["example.com"]
1335 description: "Gopher settings",
1340 description: "Enables the gopher interface"
1345 description: "IP address to bind to",
1346 suggestions: [{0, 0, 0, 0}]
1351 description: "Port to bind to",
1357 description: "Port advertised in urls (optional, defaults to port)",
1364 key: Pleroma.Web.Endpoint,
1366 description: "Phoenix endpoint configuration",
1371 description: "http protocol configuration",
1373 [port: 8080, ip: {127, 0, 0, 1}]
1378 type: {:list, :tuple},
1379 description: "dispatch settings",
1384 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1385 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1386 {Phoenix.Transports.WebSocket,
1387 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1388 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1390 # end copied from config.exs
1405 description: "port",
1415 description: "configuration for generating urls",
1417 [host: "example.com", port: 2020, scheme: "https"]
1423 description: "Host",
1431 description: "port",
1439 description: "Scheme",
1448 key: :instrumenters,
1449 type: {:list, :module},
1450 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1455 suggestions: ["https"]
1458 key: :secret_key_base,
1460 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1465 suggestions: ["CqaoopA2"]
1468 key: :render_errors,
1470 suggestions: [[view: Pleroma.Web.ErrorView, accepts: ~w(json)]],
1475 suggestions: [Pleroma.Web.ErrorView]
1479 type: {:list, :string},
1480 suggestions: ["json"]
1487 suggestions: [[name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2]],
1492 suggestions: [Pleroma.PubSub]
1497 suggestions: [Phoenix.PubSub.PG2]
1502 key: :secure_cookie_flag,
1506 key: :extra_cookie_attrs,
1507 type: {:list, :string},
1508 suggestions: ["SameSite=Lax"]
1516 description: "ActivityPub-related settings",
1519 key: :unfollow_blocked,
1521 description: "Whether blocks result in people getting unfollowed"
1524 key: :outgoing_blocks,
1526 description: "Whether to federate blocks to other instances"
1529 key: :sign_object_fetches,
1531 description: "Sign object fetches with HTTP signatures"
1534 key: :follow_handshake_timeout,
1536 description: "Following handshake timeout",
1543 key: :http_security,
1545 description: "HTTP security settings",
1550 description: "Whether the managed content security policy is enabled"
1555 description: "Whether to additionally send a Strict-Transport-Security header"
1560 description: "The maximum age for the Strict-Transport-Security header if sent",
1561 suggestions: [31_536_000]
1566 description: "The maximum age for the Expect-CT header if sent",
1567 suggestions: [2_592_000]
1570 key: :referrer_policy,
1572 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1573 suggestions: ["same-origin", "no-referrer"]
1578 description: "Adds the specified url to report-uri and report-to group in CSP header",
1579 suggestions: ["https://example.com/report-uri"]
1584 group: :web_push_encryption,
1585 key: :vapid_details,
1588 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1594 "a mailto link for the administrative contact." <>
1595 " It's best if this email is not a personal email address, but rather a group email so that if a person leaves an organization," <>
1596 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1597 suggestions: ["Subject"]
1602 description: "VAPID public key",
1603 suggestions: ["Public key"]
1608 description: "VAPID private keyn",
1609 suggestions: ["Private key"]
1615 key: Pleroma.Captcha,
1617 description: "Captcha-related settings",
1622 description: "Whether the captcha should be shown on registration"
1627 description: "The method/service to use for captcha",
1628 suggestions: [Pleroma.Captcha.Kocaptcha]
1631 key: :seconds_valid,
1633 description: "The time in seconds for which the captcha is valid",
1640 key: Pleroma.Captcha.Kocaptcha,
1643 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1644 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1649 description: "the kocaptcha endpoint to use",
1650 suggestions: ["https://captcha.kotobank.ch"]
1658 "Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the 'admin_token' parameter",
1663 description: "Token",
1664 suggestions: ["some_random_token"]
1669 group: :pleroma_job_queue,
1672 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1676 key: Pleroma.Web.Federator.RetryQueue,
1678 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1683 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1692 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1694 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1695 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1696 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1697 (see https://github.com/sorentwo/oban/issues/52).
1703 description: "Application's Ecto repo",
1704 suggestions: [Pleroma.Repo]
1709 description: "Logs verbose mode"
1713 type: [:atom, :tuple],
1715 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1716 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1722 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1725 activity_expiration: 10,
1727 federator_incoming: 50,
1728 federator_outgoing: 50,
1730 scheduled_activities: 10,
1737 key: :activity_expiration,
1739 description: "Activity expiration queue",
1745 description: "Background queue",
1749 key: :federator_incoming,
1751 description: "Incoming federation queue",
1755 key: :federator_outgoing,
1757 description: "Outgoing federation queue",
1763 description: "Email sender queue, see Pleroma.Emails.Mailer",
1767 key: :scheduled_activities,
1769 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1773 key: :transmogrifier,
1775 description: "Transmogrifier queue",
1781 description: "Web push notifications queue",
1792 description: "Includes custom worker options not interpretable directly by `Oban`",
1797 description: "Max retry attempts for failed jobs, per `Oban` queue",
1800 federator_incoming: 5,
1801 federator_outgoing: 5
1809 key: Pleroma.Web.Metadata,
1811 decsription: "Metadata-related settings",
1815 type: {:list, :module},
1816 description: "List of metadata providers to enable",
1819 Pleroma.Web.Metadata.Providers.OpenGraph,
1820 Pleroma.Web.Metadata.Providers.TwitterCard,
1821 Pleroma.Web.Metadata.Providers.RelMe
1828 description: "If set to true nsfw attachments will be shown in previews"
1841 "if enabled the instance will parse metadata from attached links to generate link previews"
1845 type: {:list, :string},
1846 description: "list of hosts which will be ignored by the metadata parser",
1847 suggestions: [["accounts.google.com", "xss.website"]]
1851 type: {:list, :string},
1852 description: "list TLDs (top-level domains) which will ignore for parse metadata",
1853 suggestions: [["local", "localdomain", "lan"]]
1857 type: {:list, :module},
1858 description: "list of Rich Media parsers",
1860 Generator.richmedia_parsers()
1865 type: {:list, :module},
1866 description: "list of rich media ttl setters",
1868 [Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl]
1875 key: :fetch_initial_posts,
1877 description: "Fetching initial posts settings",
1883 "if enabled, when a new user is federated with, fetch some of their latest posts"
1888 description: "the amount of pages to fetch",
1894 group: :auto_linker,
1897 description: "Configuration for the auto_linker library",
1901 type: [:string, false],
1902 description: "specify the class to be added to the generated link. false to clear",
1903 suggestions: ["auto-linker", false]
1907 type: [:string, false],
1908 description: "override the rel attribute. false to clear",
1909 suggestions: ["ugc", "noopener noreferrer", false]
1914 description: "set to false to remove target='_blank' attribute"
1919 description: "Set to true to link urls with schema http://google.com"
1923 type: [:integer, false],
1925 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
1926 suggestions: [15, false]
1931 description: "Strip the scheme prefix"
1936 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
1942 key: Pleroma.ScheduledActivity,
1944 description: "Scheduled activities settings",
1947 key: :daily_user_limit,
1950 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
1954 key: :total_user_limit,
1957 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
1963 description: "whether scheduled activities are sent to the job queue to be executed"
1969 key: Pleroma.ActivityExpiration,
1971 description: "Expired activity settings",
1976 description: "whether expired activities will be sent to the job queue to be deleted"
1983 description: "Authenticator",
1986 key: Pleroma.Web.Auth.Authenticator,
1988 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
1997 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
1998 " will be verified by trying to authenticate (bind) to an LDAP server." <>
1999 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2000 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2005 description: "enables LDAP authentication"
2010 description: "LDAP server hostname",
2011 suggestions: ["localhosts"]
2016 description: "LDAP port, e.g. 389 or 636",
2017 suggestions: [389, 636]
2022 description: "true to use SSL, usually implies the port 636"
2027 description: "additional SSL options"
2032 description: "true to start TLS, usually implies the port 389"
2037 description: "additional TLS options"
2042 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2043 suggestions: ["dc=example,dc=com"]
2049 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2058 description: "Authentication / authorization settings",
2061 key: :auth_template,
2064 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2065 suggestions: ["show.html"]
2068 key: :oauth_consumer_template,
2071 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2072 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2073 suggestions: ["consumer.html"]
2076 key: :oauth_consumer_strategies,
2079 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2080 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2081 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2082 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2088 key: :email_notifications,
2090 description: "Email notifications settings",
2096 "emails of \"what you've missed\" for users who have been inactive for a while",
2100 schedule: "0 0 * * 0",
2102 inactivity_threshold: 7
2109 description: "globally enable or disable digest emails"
2115 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2116 suggestions: ["0 0 * * 0"]
2121 description: "Minimum interval between digest emails to one user",
2125 key: :inactivity_threshold,
2127 description: "Minimum user inactivity threshold",
2136 key: Pleroma.Emails.UserEmail,
2138 description: "Email template settings",
2142 type: [:string, nil],
2143 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2144 suggestions: ["some/path/logo.png", nil]
2149 description: "a map with color settings for email templates.",
2152 link_color: "#d8a070",
2153 background_color: "#2C3645",
2154 content_background_color: "#1B2635",
2155 header_color: "#d8a070",
2156 text_color: "#b9b9ba",
2157 text_muted_color: "#b9b9ba"
2164 suggestions: ["#d8a070"]
2167 key: :background_color,
2169 suggestions: ["#2C3645"]
2172 key: :content_background_color,
2174 suggestions: ["#1B2635"]
2179 suggestions: ["#d8a070"]
2184 suggestions: ["#b9b9ba"]
2187 key: :text_muted_color,
2189 suggestions: ["#b9b9ba"]
2199 description: "Configure OAuth 2 provider capabilities",
2202 key: :token_expires_in,
2204 description: "The lifetime in seconds of the access token",
2208 key: :issue_new_refresh_token,
2211 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2214 key: :clean_expired_tokens,
2216 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2219 key: :clean_expired_tokens_interval,
2222 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2223 suggestions: [86_400_000]
2233 key: :shortcode_globs,
2234 type: {:list, :string},
2235 description: "Location of custom emoji files. * can be used as a wildcard",
2236 suggestions: [["/emoji/custom/**/*.png"]]
2239 key: :pack_extensions,
2240 type: {:list, :string},
2242 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2243 suggestions: [[".png", ".gif"]]
2249 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2250 " and the value the location or array of locations. * can be used as a wildcard",
2253 # Put groups that have higher priority than defaults here. Example in `docs/config/custom_emoji.md`
2254 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2259 key: :default_manifest,
2262 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2263 " Currently only one manifest can be added (no arrays)",
2264 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2267 key: :shared_pack_cache_seconds_per_file,
2270 "When an emoji pack is shared, the archive is created and cached in memory" <>
2271 " for this amount of seconds multiplied by the number of files.",
2280 description: "Database related settings",
2285 description: "If RUM indexes should be used. Defaults to false"
2294 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2298 type: [:tuple, {:list, :tuple}],
2299 description: "for the search requests (account & status search etc.)",
2300 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2303 key: :app_account_creation,
2304 type: [:tuple, {:list, :tuple}],
2305 description: "for registering user accounts from the same IP address",
2306 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2309 key: :relations_actions,
2310 type: [:tuple, {:list, :tuple}],
2311 description: "for actions on relations with all users (follow, unfollow)",
2312 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2315 key: :relation_id_action,
2316 type: [:tuple, {:list, :tuple}],
2317 description: "for actions on relation with a specific user (follow, unfollow)",
2318 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2321 key: :statuses_actions,
2322 type: [:tuple, {:list, :tuple}],
2324 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2325 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2328 key: :status_id_action,
2329 type: [:tuple, {:list, :tuple}],
2331 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2332 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2335 key: :authentication,
2336 type: [:tuple, {:list, :tuple}],
2337 description: "for authentication create / password check / user existence check requests",
2338 suggestions: [{60_000, 15}]
2346 "To enable simple command line interface accessible over ssh, add a setting like this to your configuration file",
2351 description: "Enables ssh"
2356 description: "Dir with ssh keys",
2357 suggestions: ["/some/path/ssh_keys"]
2362 description: "Handler module",
2363 suggestions: ["Pleroma.BBS.Handler"]
2368 description: "Port to connect",
2369 suggestions: [10_022]
2372 key: :password_authenticator,
2374 description: "Authenticator module",
2375 suggestions: ["Pleroma.BBS.Authenticator"]
2382 description: "Mime types",
2389 "application/xml" => ["xml"],
2390 "application/xrd+xml" => ["xrd+xml"],
2391 "application/jrd+json" => ["jrd+json"],
2392 "application/activity+json" => ["activity+json"],
2393 "application/ld+json" => ["activity+json"]
2398 key: "application/xml",
2399 type: {:list, :string},
2400 suggestions: [["xml"]]
2403 key: "application/xrd+xml",
2404 type: {:list, :string},
2405 suggestions: [["xrd+xml"]]
2408 key: "application/jrd+json",
2409 type: {:list, :string},
2410 suggestions: [["jrd+json"]]
2413 key: "application/activity+json",
2414 type: {:list, :string},
2415 suggestions: [["activity+json"]]
2418 key: "application/ld+json",
2419 type: {:list, :string},
2420 suggestions: [["activity+json"]]
2429 description: "Tesla settings",
2434 description: "Tesla adapter",
2435 suggestions: [Tesla.Adapter.Hackney]
2443 description: "Pleroma chat settings",
2459 description: "Enables suggestions"
2462 key: :third_party_engine,
2464 description: "URL for third party engine",
2466 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2472 description: "Request timeout to third party engine",
2473 suggestions: [300_000]
2478 description: "Limit for suggestions",
2484 suggestions: ["https://vinayaka.distsn.org"]
2490 key: Pleroma.Web.Endpoint.MetricsExporter,
2492 description: "Prometheus settings",
2497 description: "API endpoint with metrics",
2498 suggestions: ["/api/pleroma/app_metrics"]
2503 group: :http_signatures,
2505 description: "HTTP Signatures settings",
2510 suggestions: [Pleroma.Signature]
2516 key: Pleroma.Uploaders.MDII,
2522 suggestions: ["https://mdii.sakura.ne.jp/mdii-post.cgi"]
2527 suggestions: ["https://mdii.sakura.ne.jp"]
2535 description: "HTTP settings",
2539 type: [:string, :atom, nil],
2540 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}, nil]
2543 key: :send_user_agent,
2552 # Workaround for remote server certificate chain issues
2553 partial_chain: &:hackney_connect.partial_chain/1,
2554 # We don't support TLS v1.3 yet
2555 versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
2568 key: :allow_inline_images,
2572 key: :allow_headings,
2585 type: {:list, :module},
2586 suggestions: [[Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]]
2596 key: :deny_follow_blocked,
2603 key: :mrf_normalize_markup,
2609 suggestions: [Pleroma.HTML.Scrubber.Default]
2619 key: :restricted_nicknames,
2620 type: {:list, :string},
2640 "ostatus_subscribe",
2665 suggestions: [86_400]
2669 type: {:list, :string},
2670 suggestions: [["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]]
2678 "X-RateLimit-Reset",
2679 "X-RateLimit-Limit",
2680 "X-RateLimit-Remaining",
2692 type: {:list, :string},
2693 suggestions: [["Authorization", "Content-Type", "Idempotency-Key"]]
2699 key: Pleroma.Plugs.RemoteIp,
2702 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2704 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2710 description: "Enable/disable the plug. Defaults to `false`.",
2711 suggestions: [true, false]
2715 type: {:list, :string},
2717 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
2721 type: {:list, :string},
2723 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2727 type: {:list, :string},
2729 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2735 key: :web_cache_ttl,
2738 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2744 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
2745 suggestions: [30_000, nil]
2748 key: :activity_pub_question,
2751 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
2752 suggestions: [30_000]