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
590 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
593 key: :rewrite_policy,
594 type: {:list, :module},
595 description: "A list of MRF policies enabled",
597 Pleroma.Web.ActivityPub.MRF.NoOpPolicy,
605 "Makes the client API in authentificated mode-only except for user-profiles." <>
606 " Useful for disabling the Local Timeline and The Whole Known Network"
609 key: :quarantined_instances,
610 type: {:list, :string},
612 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
619 key: :managed_config,
622 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
627 description: "Instance static directory",
633 key: :allowed_post_formats,
634 type: {:list, :string},
635 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
646 key: :mrf_transparency,
649 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
652 key: :mrf_transparency_exclusions,
653 type: {:list, :string},
655 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
661 key: :extended_nickname_format,
664 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
665 " This will break federation with older software for theses nicknames"
668 key: :max_pinned_statuses,
670 description: "The maximum number of pinned statuses. 0 will disable the feature",
678 key: :autofollowed_nicknames,
679 type: {:list, :string},
681 "Set to nicknames of (local) users that every new user should automatically follow",
690 key: :no_attachment_links,
693 "Set to true to disable automatically adding attachment link text to statuses"
696 key: :welcome_message,
699 "A message that will be send to a newly registered users as a direct message",
701 "Hi, @username! Welcome to the board!",
706 key: :welcome_user_nickname,
708 description: "The nickname of the local user that sends the welcome message",
715 key: :max_report_comment_size,
717 description: "The maximum size of the report comment (Default: 1000)",
723 key: :safe_dm_mentions,
726 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
727 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
733 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
736 key: :remote_post_retention_days,
739 "The default amount of days to retain remote posts when pruning the database",
745 key: :user_bio_length,
747 description: "A user bio maximum length (default: 5000)",
753 key: :user_name_length,
755 description: "A user name maximum length (default: 100)",
761 key: :skip_thread_containment,
763 description: "Skip filter out broken threads. The default is true"
766 key: :limit_to_local_content,
767 type: [:atom, false],
769 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
777 key: :dynamic_configuration,
780 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"
783 key: :max_account_fields,
785 description: "The maximum number of custom fields in the user profile (default: 10)",
791 key: :max_remote_account_fields,
794 "The maximum number of custom fields in the remote user profile (default: 20)",
800 key: :account_field_name_length,
802 description: "An account field name maximum length (default: 512)",
808 key: :account_field_value_length,
810 description: "An account field value maximum length (default: 2048)",
816 key: :external_user_synchronization,
818 description: "Enabling following/followers counters synchronization for external users"
825 description: "Logger-related settings",
829 type: [:atom, :tuple, :module],
831 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
832 suggestions: [[:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]]
840 description: "ExSyslogger-related settings",
845 description: "Log level",
846 suggestions: [:debug, :info, :warn, :error]
852 "A string that's prepended to every message, and is typically set to the app name",
853 suggestions: ["pleroma"]
858 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
859 suggestions: ["$metadata[$level] $message"]
863 type: {:list, :atom},
864 suggestions: [[:request_id]]
872 description: "Console logger settings",
877 description: "Log level",
878 suggestions: [:debug, :info, :warn, :error]
883 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
884 suggestions: ["$metadata[$level] $message"]
888 type: {:list, :atom},
889 suggestions: [[:request_id]]
896 description: "Quack-related settings",
901 description: "Log level",
902 suggestions: [:debug, :info, :warn, :error]
906 type: {:list, :atom},
907 description: "Configure which metadata you want to report on",
925 description: "Configure the Slack incoming webhook",
926 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
932 key: :frontend_configurations,
934 description: "A keyword list that keeps the configuration data for any kind of frontend",
939 description: "Settings for Pleroma FE",
942 theme: "pleroma-dark",
943 logo: "/static/logo.png",
944 background: "/images/city.jpg",
945 redirectRootNoLogin: "/main/all",
946 redirectRootLogin: "/main/friends",
947 showInstanceSpecificPanel: true,
948 scopeOptionsEnabled: false,
949 formattingOptionsEnabled: false,
950 collapseMessageWithSubject: false,
951 hidePostStats: false,
952 hideUserStats: false,
954 subjectLineBehavior: "email",
955 alwaysShowSubjectInput: true
962 description: "Which theme to use, they are defined in styles.json",
963 suggestions: ["pleroma-dark"]
968 description: "URL of the logo, defaults to Pleroma's logo",
969 suggestions: ["/static/logo.png"]
975 "URL of the background, unless viewing a user profile with a background that is set",
976 suggestions: ["/images/city.jpg"]
979 key: :redirectRootNoLogin,
982 "relative URL which indicates where to redirect when a user isn't logged in",
983 suggestions: ["/main/all"]
986 key: :redirectRootLogin,
989 "relative URL which indicates where to redirect when a user is logged in",
990 suggestions: ["/main/friends"]
993 key: :showInstanceSpecificPanel,
995 description: "Whenether to show the instance's specific panel"
998 key: :scopeOptionsEnabled,
1000 description: "Enable setting an notice visibility and subject/CW when posting"
1003 key: :formattingOptionsEnabled,
1006 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1009 key: :collapseMessageWithSubject,
1012 "When a message has a subject(aka Content Warning), collapse it by default"
1015 key: :hidePostStats,
1017 description: "Hide notices statistics(repeats, favorites, ...)"
1020 key: :hideUserStats,
1023 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1028 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1031 key: :subjectLineBehavior,
1033 description: "Allows changing the default behaviour of subject lines in replies.
1034 `email`: Copy and preprend re:, as in email,
1035 `masto`: Copy verbatim, as in Mastodon,
1036 `noop`: Don't copy the subjec",
1037 suggestions: ["email", "masto", "noop"]
1040 key: :alwaysShowSubjectInput,
1042 description: "When set to false, auto-hide the subject field when it's empty"
1049 description: "Settings for Masto FE",
1052 showInstanceSpecificPanel: true
1057 key: :showInstanceSpecificPanel,
1059 description: "Whenether to show the instance's specific panel"
1070 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1076 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1080 url: "/images/pleroma-fox-tan-smol.png",
1081 mime_type: "image/png"
1083 pleroma_fox_tan_shy: %{
1084 url: "/images/pleroma-fox-tan-shy.png",
1085 mime_type: "image/png"
1091 key: :default_mascot,
1094 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1105 description: "Message Rewrite Facility",
1108 key: :media_removal,
1109 type: {:list, :string},
1110 description: "List of instances to remove medias from",
1111 suggestions: ["example.com", "*.example.com"]
1115 type: {:list, :string},
1116 description: "List of instances to put medias as NSFW(sensitive) from",
1117 suggestions: ["example.com", "*.example.com"]
1120 key: :federated_timeline_removal,
1121 type: {:list, :string},
1123 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1124 suggestions: ["example.com", "*.example.com"]
1128 type: {:list, :string},
1129 description: "List of instances to reject any activities from",
1130 suggestions: ["example.com", "*.example.com"]
1134 type: {:list, :string},
1135 description: "List of instances to accept any activities from",
1136 suggestions: ["example.com", "*.example.com"]
1139 key: :report_removal,
1140 type: {:list, :string},
1141 description: "List of instances to reject reports from",
1142 suggestions: ["example.com", "*.example.com"]
1145 key: :avatar_removal,
1146 type: {:list, :string},
1147 description: "List of instances to strip avatars from",
1148 suggestions: ["example.com", "*.example.com"]
1151 key: :banner_removal,
1152 type: {:list, :string},
1153 description: "List of instances to strip banners from",
1154 suggestions: ["example.com", "*.example.com"]
1163 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1164 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1169 description: "Matches a series of regular expressions against the actor field",
1172 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1180 key: :mrf_rejectnonpublic,
1184 key: :allow_followersonly,
1186 description: "whether to allow followers-only posts"
1191 description: "whether to allow direct messages"
1197 key: :mrf_hellthread,
1199 description: "Block messages with too much mentions",
1202 key: :delist_threshold,
1205 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1206 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1210 key: :reject_threshold,
1213 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1222 description: "Reject or Word-Replace messages with a keyword or regex",
1226 type: [:string, :regex],
1228 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1229 suggestions: ["foo", ~r/foo/iu]
1232 key: :federated_timeline_removal,
1233 type: [:string, :regex],
1235 "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",
1236 suggestions: ["foo", ~r/foo/iu]
1240 type: [{:string, :string}, {:regex, :string}],
1242 "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",
1243 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1251 description: "Block messages which mention a user",
1255 type: {:list, :string},
1256 description: "A list of actors, for which to drop any posts mentioning",
1257 suggestions: [["actor1", "actor2"]]
1263 key: :mrf_vocabulary,
1265 description: "Filter messages which belong to certain activity vocabularies",
1269 type: {:list, :string},
1271 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1272 suggestions: [["Create", "Follow", "Mention", "Announce", "Like"]]
1276 type: {:list, :string},
1278 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1279 suggestions: [["Create", "Follow", "Mention", "Announce", "Like"]]
1285 # key: :mrf_user_allowlist,
1288 # "The keys in this section are the domain names that the policy should apply to." <>
1289 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1291 # ["example.org": ["https://example.org/users/admin"]],
1293 # ["example.org": ["https://example.org/users/admin"]]
1301 description: "Media proxy",
1306 description: "Enables proxying of remote media to the instance's proxy"
1312 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1313 suggestions: ["https://example.com"]
1318 description: "Options for Pleroma.ReverseProxy",
1319 suggestions: [[max_body_length: 25 * 1_048_576, redirect_on_failure: false]]
1323 type: {:list, :string},
1324 description: "List of domains to bypass the mediaproxy",
1325 suggestions: ["example.com"]
1333 description: "Gopher settings",
1338 description: "Enables the gopher interface"
1343 description: "IP address to bind to",
1344 suggestions: [{0, 0, 0, 0}]
1349 description: "Port to bind to",
1355 description: "Port advertised in urls (optional, defaults to port)",
1362 key: Pleroma.Web.Endpoint,
1364 description: "Phoenix endpoint configuration",
1369 description: "http protocol configuration",
1371 [port: 8080, ip: {127, 0, 0, 1}]
1376 type: {:list, :tuple},
1377 description: "dispatch settings",
1382 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1383 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1384 {Phoenix.Transports.WebSocket,
1385 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1386 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1388 # end copied from config.exs
1403 description: "port",
1413 description: "configuration for generating urls",
1415 [host: "example.com", port: 2020, scheme: "https"]
1421 description: "Host",
1429 description: "port",
1437 description: "Scheme",
1446 key: :instrumenters,
1447 type: {:list, :module},
1448 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1453 suggestions: ["https"]
1456 key: :secret_key_base,
1458 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1463 suggestions: ["CqaoopA2"]
1466 key: :render_errors,
1468 suggestions: [[view: Pleroma.Web.ErrorView, accepts: ~w(json)]],
1473 suggestions: [Pleroma.Web.ErrorView]
1477 type: {:list, :string},
1478 suggestions: ["json"]
1485 suggestions: [[name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2]],
1490 suggestions: [Pleroma.PubSub]
1495 suggestions: [Phoenix.PubSub.PG2]
1500 key: :secure_cookie_flag,
1504 key: :extra_cookie_attrs,
1505 type: {:list, :string},
1506 suggestions: ["SameSite=Lax"]
1514 description: "ActivityPub-related settings",
1517 key: :unfollow_blocked,
1519 description: "Whether blocks result in people getting unfollowed"
1522 key: :outgoing_blocks,
1524 description: "Whether to federate blocks to other instances"
1527 key: :sign_object_fetches,
1529 description: "Sign object fetches with HTTP signatures"
1532 key: :follow_handshake_timeout,
1534 description: "Following handshake timeout",
1541 key: :http_security,
1543 description: "HTTP security settings",
1548 description: "Whether the managed content security policy is enabled"
1553 description: "Whether to additionally send a Strict-Transport-Security header"
1558 description: "The maximum age for the Strict-Transport-Security header if sent",
1559 suggestions: [31_536_000]
1564 description: "The maximum age for the Expect-CT header if sent",
1565 suggestions: [2_592_000]
1568 key: :referrer_policy,
1570 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1571 suggestions: ["same-origin", "no-referrer"]
1576 description: "Adds the specified url to report-uri and report-to group in CSP header",
1577 suggestions: ["https://example.com/report-uri"]
1582 group: :web_push_encryption,
1583 key: :vapid_details,
1586 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1592 "a mailto link for the administrative contact." <>
1593 " 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," <>
1594 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1595 suggestions: ["Subject"]
1600 description: "VAPID public key",
1601 suggestions: ["Public key"]
1606 description: "VAPID private keyn",
1607 suggestions: ["Private key"]
1613 key: Pleroma.Captcha,
1615 description: "Captcha-related settings",
1620 description: "Whether the captcha should be shown on registration"
1625 description: "The method/service to use for captcha",
1626 suggestions: [Pleroma.Captcha.Kocaptcha]
1629 key: :seconds_valid,
1631 description: "The time in seconds for which the captcha is valid",
1638 key: Pleroma.Captcha.Kocaptcha,
1641 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1642 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1647 description: "the kocaptcha endpoint to use",
1648 suggestions: ["https://captcha.kotobank.ch"]
1656 "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",
1661 description: "Token",
1662 suggestions: ["some_random_token"]
1667 group: :pleroma_job_queue,
1670 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1674 key: Pleroma.Web.Federator.RetryQueue,
1676 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1681 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1690 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1692 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1693 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1694 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1695 (see https://github.com/sorentwo/oban/issues/52).
1701 description: "Application's Ecto repo",
1702 suggestions: [Pleroma.Repo]
1707 description: "Logs verbose mode"
1711 type: [:atom, :tuple],
1713 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1714 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1720 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1723 activity_expiration: 10,
1725 federator_incoming: 50,
1726 federator_outgoing: 50,
1728 scheduled_activities: 10,
1735 key: :activity_expiration,
1737 description: "Activity expiration queue",
1743 description: "Background queue",
1747 key: :federator_incoming,
1749 description: "Incoming federation queue",
1753 key: :federator_outgoing,
1755 description: "Outgoing federation queue",
1761 description: "Email sender queue, see Pleroma.Emails.Mailer",
1765 key: :scheduled_activities,
1767 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1771 key: :transmogrifier,
1773 description: "Transmogrifier queue",
1779 description: "Web push notifications queue",
1790 description: "Includes custom worker options not interpretable directly by `Oban`",
1795 description: "Max retry attempts for failed jobs, per `Oban` queue",
1798 federator_incoming: 5,
1799 federator_outgoing: 5
1807 key: Pleroma.Web.Metadata,
1809 decsription: "Metadata-related settings",
1813 type: {:list, :module},
1814 description: "List of metadata providers to enable",
1817 Pleroma.Web.Metadata.Providers.OpenGraph,
1818 Pleroma.Web.Metadata.Providers.TwitterCard,
1819 Pleroma.Web.Metadata.Providers.RelMe
1826 description: "If set to true nsfw attachments will be shown in previews"
1839 "if enabled the instance will parse metadata from attached links to generate link previews"
1843 type: {:list, :string},
1844 description: "list of hosts which will be ignored by the metadata parser",
1845 suggestions: [["accounts.google.com", "xss.website"]]
1849 type: {:list, :string},
1850 description: "list TLDs (top-level domains) which will ignore for parse metadata",
1851 suggestions: [["local", "localdomain", "lan"]]
1855 type: {:list, :module},
1856 description: "list of Rich Media parsers",
1858 Generator.richmedia_parsers()
1863 type: {:list, :module},
1864 description: "list of rich media ttl setters",
1866 [Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl]
1873 key: :fetch_initial_posts,
1875 description: "Fetching initial posts settings",
1881 "if enabled, when a new user is federated with, fetch some of their latest posts"
1886 description: "the amount of pages to fetch",
1892 group: :auto_linker,
1895 description: "Configuration for the auto_linker library",
1899 type: [:string, false],
1900 description: "specify the class to be added to the generated link. false to clear",
1901 suggestions: ["auto-linker", false]
1905 type: [:string, false],
1906 description: "override the rel attribute. false to clear",
1907 suggestions: ["ugc", "noopener noreferrer", false]
1912 description: "set to false to remove target='_blank' attribute"
1917 description: "Set to true to link urls with schema http://google.com"
1921 type: [:integer, false],
1923 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
1924 suggestions: [15, false]
1929 description: "Strip the scheme prefix"
1934 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
1940 key: Pleroma.ScheduledActivity,
1942 description: "Scheduled activities settings",
1945 key: :daily_user_limit,
1948 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
1952 key: :total_user_limit,
1955 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
1961 description: "whether scheduled activities are sent to the job queue to be executed"
1967 key: Pleroma.ActivityExpiration,
1969 description: "Expired activity settings",
1974 description: "whether expired activities will be sent to the job queue to be deleted"
1981 description: "Authenticator",
1984 key: Pleroma.Web.Auth.Authenticator,
1986 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
1995 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
1996 " will be verified by trying to authenticate (bind) to an LDAP server." <>
1997 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
1998 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2003 description: "enables LDAP authentication"
2008 description: "LDAP server hostname",
2009 suggestions: ["localhosts"]
2014 description: "LDAP port, e.g. 389 or 636",
2015 suggestions: [389, 636]
2020 description: "true to use SSL, usually implies the port 636"
2025 description: "additional SSL options"
2030 description: "true to start TLS, usually implies the port 389"
2035 description: "additional TLS options"
2040 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2041 suggestions: ["dc=example,dc=com"]
2047 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2056 description: "Authentication / authorization settings",
2059 key: :auth_template,
2062 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2063 suggestions: ["show.html"]
2066 key: :oauth_consumer_template,
2069 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2070 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2071 suggestions: ["consumer.html"]
2074 key: :oauth_consumer_strategies,
2077 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2078 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2079 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2080 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2086 key: :email_notifications,
2088 description: "Email notifications settings",
2094 "emails of \"what you've missed\" for users who have been inactive for a while",
2098 schedule: "0 0 * * 0",
2100 inactivity_threshold: 7
2107 description: "globally enable or disable digest emails"
2113 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2114 suggestions: ["0 0 * * 0"]
2119 description: "Minimum interval between digest emails to one user",
2123 key: :inactivity_threshold,
2125 description: "Minimum user inactivity threshold",
2134 key: Pleroma.Emails.UserEmail,
2136 description: "Email template settings",
2140 type: [:string, nil],
2141 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2142 suggestions: ["some/path/logo.png", nil]
2147 description: "a map with color settings for email templates.",
2150 link_color: "#d8a070",
2151 background_color: "#2C3645",
2152 content_background_color: "#1B2635",
2153 header_color: "#d8a070",
2154 text_color: "#b9b9ba",
2155 text_muted_color: "#b9b9ba"
2162 suggestions: ["#d8a070"]
2165 key: :background_color,
2167 suggestions: ["#2C3645"]
2170 key: :content_background_color,
2172 suggestions: ["#1B2635"]
2177 suggestions: ["#d8a070"]
2182 suggestions: ["#b9b9ba"]
2185 key: :text_muted_color,
2187 suggestions: ["#b9b9ba"]
2197 description: "Configure OAuth 2 provider capabilities",
2200 key: :token_expires_in,
2202 description: "The lifetime in seconds of the access token",
2206 key: :issue_new_refresh_token,
2209 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2212 key: :clean_expired_tokens,
2214 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2217 key: :clean_expired_tokens_interval,
2220 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2221 suggestions: [86_400_000]
2231 key: :shortcode_globs,
2232 type: {:list, :string},
2233 description: "Location of custom emoji files. * can be used as a wildcard",
2234 suggestions: [["/emoji/custom/**/*.png"]]
2237 key: :pack_extensions,
2238 type: {:list, :string},
2240 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2241 suggestions: [[".png", ".gif"]]
2247 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2248 " and the value the location or array of locations. * can be used as a wildcard",
2251 # Put groups that have higher priority than defaults here. Example in `docs/config/custom_emoji.md`
2252 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2257 key: :default_manifest,
2260 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2261 " Currently only one manifest can be added (no arrays)",
2262 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2265 key: :shared_pack_cache_seconds_per_file,
2268 "When an emoji pack is shared, the archive is created and cached in memory" <>
2269 " for this amount of seconds multiplied by the number of files.",
2278 description: "Database related settings",
2283 description: "If RUM indexes should be used. Defaults to false"
2292 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2296 type: [:tuple, {:list, :tuple}],
2297 description: "for the search requests (account & status search etc.)",
2298 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2301 key: :app_account_creation,
2302 type: [:tuple, {:list, :tuple}],
2303 description: "for registering user accounts from the same IP address",
2304 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2307 key: :relations_actions,
2308 type: [:tuple, {:list, :tuple}],
2309 description: "for actions on relations with all users (follow, unfollow)",
2310 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2313 key: :relation_id_action,
2314 type: [:tuple, {:list, :tuple}],
2315 description: "for actions on relation with a specific user (follow, unfollow)",
2316 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2319 key: :statuses_actions,
2320 type: [:tuple, {:list, :tuple}],
2322 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2323 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2326 key: :status_id_action,
2327 type: [:tuple, {:list, :tuple}],
2329 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2330 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2333 key: :authentication,
2334 type: [:tuple, {:list, :tuple}],
2335 description: "for authentication create / password check / user existence check requests",
2336 suggestions: [{60_000, 15}]
2344 "To enable simple command line interface accessible over ssh, add a setting like this to your configuration file",
2349 description: "Enables ssh"
2354 description: "Dir with ssh keys",
2355 suggestions: ["/some/path/ssh_keys"]
2360 description: "Handler module",
2361 suggestions: ["Pleroma.BBS.Handler"]
2366 description: "Port to connect",
2367 suggestions: [10_022]
2370 key: :password_authenticator,
2372 description: "Authenticator module",
2373 suggestions: ["Pleroma.BBS.Authenticator"]
2380 description: "Mime types",
2387 "application/xml" => ["xml"],
2388 "application/xrd+xml" => ["xrd+xml"],
2389 "application/jrd+json" => ["jrd+json"],
2390 "application/activity+json" => ["activity+json"],
2391 "application/ld+json" => ["activity+json"]
2396 key: "application/xml",
2397 type: {:list, :string},
2398 suggestions: [["xml"]]
2401 key: "application/xrd+xml",
2402 type: {:list, :string},
2403 suggestions: [["xrd+xml"]]
2406 key: "application/jrd+json",
2407 type: {:list, :string},
2408 suggestions: [["jrd+json"]]
2411 key: "application/activity+json",
2412 type: {:list, :string},
2413 suggestions: [["activity+json"]]
2416 key: "application/ld+json",
2417 type: {:list, :string},
2418 suggestions: [["activity+json"]]
2427 description: "Tesla settings",
2432 description: "Tesla adapter",
2433 suggestions: [Tesla.Adapter.Hackney]
2441 description: "Pleroma chat settings",
2457 description: "Enables suggestions"
2460 key: :third_party_engine,
2462 description: "URL for third party engine",
2464 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2470 description: "Request timeout to third party engine",
2471 suggestions: [300_000]
2476 description: "Limit for suggestions",
2482 suggestions: ["https://vinayaka.distsn.org"]
2488 key: Pleroma.Web.Endpoint.MetricsExporter,
2490 description: "Prometheus settings",
2495 description: "API endpoint with metrics",
2496 suggestions: ["/api/pleroma/app_metrics"]
2501 group: :http_signatures,
2503 description: "HTTP Signatures settings",
2508 suggestions: [Pleroma.Signature]
2514 key: Pleroma.Uploaders.MDII,
2520 suggestions: ["https://mdii.sakura.ne.jp/mdii-post.cgi"]
2525 suggestions: ["https://mdii.sakura.ne.jp"]
2533 description: "HTTP settings",
2537 type: [:string, :atom, nil],
2538 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}, nil]
2541 key: :send_user_agent,
2550 # Workaround for remote server certificate chain issues
2551 partial_chain: &:hackney_connect.partial_chain/1,
2552 # We don't support TLS v1.3 yet
2553 versions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
2566 key: :allow_inline_images,
2570 key: :allow_headings,
2583 type: {:list, :module},
2584 suggestions: [[Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]]
2594 key: :deny_follow_blocked,
2601 key: :mrf_normalize_markup,
2607 suggestions: [Pleroma.HTML.Scrubber.Default]
2617 key: :restricted_nicknames,
2618 type: {:list, :string},
2638 "ostatus_subscribe",
2663 suggestions: [86_400]
2667 type: {:list, :string},
2668 suggestions: [["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]]
2676 "X-RateLimit-Reset",
2677 "X-RateLimit-Limit",
2678 "X-RateLimit-Remaining",
2690 type: {:list, :string},
2691 suggestions: [["Authorization", "Content-Type", "Idempotency-Key"]]
2697 key: Pleroma.Plugs.RemoteIp,
2700 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2702 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2708 description: "Enable/disable the plug. Defaults to `false`.",
2709 suggestions: [true, false]
2713 type: {:list, :string},
2715 "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]`."
2719 type: {:list, :string},
2721 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2725 type: {:list, :string},
2727 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2733 key: :web_cache_ttl,
2736 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2742 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
2743 suggestions: [30_000, nil]
2746 key: :activity_pub_question,
2749 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
2750 suggestions: [30_000]