git.squeep.com Git - akkoma/blob - config/description.exs

   1 import Config
   2
   3 websocket_config = [
   4   path: "/websocket",
   5   serializer: [
   6     {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
   7     {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
   8   ],
   9   timeout: 60_000,
  10   transport_log: false,
  11   compress: false
  12 ]
  13
  14 installed_frontend_options = [
  15   %{
  16     key: "name",
  17     label: "Name",
  18     type: :string,
  19     description:
  20       "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
  21   },
  22   %{
  23     key: "ref",
  24     label: "Reference",
  25     type: :string,
  26     description:
  27       "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
  28   }
  29 ]
  30
  31 frontend_options = [
  32   %{
  33     key: "name",
  34     label: "Name",
  35     type: :string,
  36     description: "Name of the frontend."
  37   },
  38   %{
  39     key: "ref",
  40     label: "Reference",
  41     type: :string,
  42     description: "Reference of the frontend to be used."
  43   },
  44   %{
  45     key: "git",
  46     label: "Git Repository URL",
  47     type: :string,
  48     description: "URL of the git repository of the frontend"
  49   },
  50   %{
  51     key: "build_url",
  52     label: "Build URL",
  53     type: :string,
  54     description:
  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"
  57   },
  58   %{
  59     key: "build_dir",
  60     label: "Build directory",
  61     type: :string,
  62     description: "The directory inside the zip file "
  63   },
  64   %{
  65     key: "custom-http-headers",
  66     label: "Custom HTTP headers",
  67     type: {:list, :string},
  68     description: "The custom HTTP headers for the frontend"
  69   }
  70 ]
  71
  72 config :pleroma, :config_description, [
  73   %{
  74     group: :pleroma,
  75     key: Pleroma.Upload,
  76     type: :group,
  77     description: "Upload general settings",
  78     children: [
  79       %{
  80         key: :uploader,
  81         type: :module,
  82         description: "Module which will be used for uploads",
  83         suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
  84       },
  85       %{
  86         key: :filters,
  87         type: {:list, :module},
  88         description:
  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}
  91       },
  92       %{
  93         key: :link_name,
  94         type: :boolean,
  95         description:
  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`."
  97       },
  98       %{
  99         key: :base_url,
 100         label: "Base URL",
 101         type: :string,
 102         description:
 103           "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
 104         suggestions: [
 105           "https://cdn-host.com"
 106         ]
 107       },
 108       %{
 109         key: :proxy_remote,
 110         type: :boolean,
 111         description: """
 112         Proxy requests to the remote uploader.\n
 113         Useful if media upload endpoint is not internet accessible.
 114         """
 115       },
 116       %{
 117         key: :filename_display_max_length,
 118         type: :integer,
 119         description: "Set max length of a filename to display. 0 = no limit. Default: 30"
 120       }
 121     ]
 122   },
 123   %{
 124     group: :pleroma,
 125     key: Pleroma.Uploaders.Local,
 126     type: :group,
 127     description: "Local uploader-related settings",
 128     children: [
 129       %{
 130         key: :uploads,
 131         type: :string,
 132         description: "Path where user's uploads will be saved",
 133         suggestions: [
 134           "uploads"
 135         ]
 136       }
 137     ]
 138   },
 139   %{
 140     group: :pleroma,
 141     key: Pleroma.Uploaders.S3,
 142     type: :group,
 143     description: "S3 uploader-related settings",
 144     children: [
 145       %{
 146         key: :bucket,
 147         type: :string,
 148         description: "S3 bucket",
 149         suggestions: [
 150           "bucket"
 151         ]
 152       },
 153       %{
 154         key: :bucket_namespace,
 155         type: :string,
 156         description: "S3 bucket namespace",
 157         suggestions: ["pleroma"]
 158       },
 159       %{
 160         key: :truncated_namespace,
 161         type: :string,
 162         description:
 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."
 165       },
 166       %{
 167         key: :streaming_enabled,
 168         type: :boolean,
 169         description:
 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."
 171       }
 172     ]
 173   },
 174   %{
 175     group: :pleroma,
 176     key: Pleroma.Upload.Filter.Mogrify,
 177     type: :group,
 178     description: "Uploads mogrify filter settings",
 179     children: [
 180       %{
 181         key: :args,
 182         type: [:string, {:list, :string}, {:list, :tuple}],
 183         description:
 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.",
 186         suggestions: [
 187           "strip",
 188           "auto-orient",
 189           {"implode", "1"}
 190         ]
 191       }
 192     ]
 193   },
 194   %{
 195     group: :pleroma,
 196     key: Pleroma.Upload.Filter.AnonymizeFilename,
 197     type: :group,
 198     description: "Filter replaces the filename of the upload",
 199     children: [
 200       %{
 201         key: :text,
 202         type: :string,
 203         description:
 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}.",
 206         suggestions: [
 207           "custom-file-name.{extension}"
 208         ]
 209       }
 210     ]
 211   },
 212   %{
 213     group: :pleroma,
 214     key: Pleroma.Emails.Mailer,
 215     type: :group,
 216     description: "Mailer-related settings",
 217     children: [
 218       %{
 219         key: :enabled,
 220         label: "Mailer Enabled",
 221         type: :boolean
 222       },
 223       %{
 224         key: :adapter,
 225         type: :module,
 226         description:
 227           "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
 228         suggestions: [
 229           Swoosh.Adapters.AmazonSES,
 230           Swoosh.Adapters.Dyn,
 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
 241         ]
 242       },
 243       %{
 244         group: {:subgroup, Swoosh.Adapters.SMTP},
 245         key: :relay,
 246         type: :string,
 247         description: "Hostname or IP address",
 248         suggestions: ["smtp.example.com"]
 249       },
 250       %{
 251         group: {:subgroup, Swoosh.Adapters.SMTP},
 252         key: :port,
 253         type: :integer,
 254         description: "SMTP port",
 255         suggestions: ["1025"]
 256       },
 257       %{
 258         group: {:subgroup, Swoosh.Adapters.SMTP},
 259         key: :username,
 260         type: :string,
 261         description: "SMTP AUTH username",
 262         suggestions: ["user@example.com"]
 263       },
 264       %{
 265         group: {:subgroup, Swoosh.Adapters.SMTP},
 266         key: :password,
 267         type: :string,
 268         description: "SMTP AUTH password",
 269         suggestions: ["password"]
 270       },
 271       %{
 272         group: {:subgroup, Swoosh.Adapters.SMTP},
 273         key: :ssl,
 274         label: "Use SSL",
 275         type: :boolean,
 276         description: "Use Implicit SSL/TLS. e.g. port 465"
 277       },
 278       %{
 279         group: {:subgroup, Swoosh.Adapters.SMTP},
 280         key: :tls,
 281         label: "STARTTLS Mode",
 282         type: {:dropdown, :atom},
 283         description: "Explicit TLS (STARTTLS) enforcement mode",
 284         suggestions: [:if_available, :always, :never]
 285       },
 286       %{
 287         group: {:subgroup, Swoosh.Adapters.SMTP},
 288         key: :auth,
 289         label: "AUTH Mode",
 290         type: {:dropdown, :atom},
 291         description: "SMTP AUTH enforcement mode",
 292         suggestions: [:if_available, :always, :never]
 293       },
 294       %{
 295         group: {:subgroup, Swoosh.Adapters.SMTP},
 296         key: :retries,
 297         type: :integer,
 298         description: "SMTP temporary (4xx) error retries",
 299         suggestions: [1]
 300       },
 301       %{
 302         group: {:subgroup, Swoosh.Adapters.Sendgrid},
 303         key: :api_key,
 304         label: "SendGrid API Key",
 305         type: :string,
 306         suggestions: ["YOUR_API_KEY"]
 307       },
 308       %{
 309         group: {:subgroup, Swoosh.Adapters.Sendmail},
 310         key: :cmd_path,
 311         type: :string,
 312         suggestions: ["/usr/bin/sendmail"]
 313       },
 314       %{
 315         group: {:subgroup, Swoosh.Adapters.Sendmail},
 316         key: :cmd_args,
 317         type: :string,
 318         suggestions: ["-N delay,failure,success"]
 319       },
 320       %{
 321         group: {:subgroup, Swoosh.Adapters.Sendmail},
 322         key: :qmail,
 323         label: "Qmail compat mode",
 324         type: :boolean
 325       },
 326       %{
 327         group: {:subgroup, Swoosh.Adapters.Mandrill},
 328         key: :api_key,
 329         label: "Mandrill API Key",
 330         type: :string,
 331         suggestions: ["YOUR_API_KEY"]
 332       },
 333       %{
 334         group: {:subgroup, Swoosh.Adapters.Mailgun},
 335         key: :api_key,
 336         label: "Mailgun API Key",
 337         type: :string,
 338         suggestions: ["YOUR_API_KEY"]
 339       },
 340       %{
 341         group: {:subgroup, Swoosh.Adapters.Mailgun},
 342         key: :domain,
 343         type: :string,
 344         suggestions: ["YOUR_DOMAIN_NAME"]
 345       },
 346       %{
 347         group: {:subgroup, Swoosh.Adapters.Mailjet},
 348         key: :api_key,
 349         label: "MailJet Public API Key",
 350         type: :string,
 351         suggestions: ["MJ_APIKEY_PUBLIC"]
 352       },
 353       %{
 354         group: {:subgroup, Swoosh.Adapters.Mailjet},
 355         key: :secret,
 356         label: "MailJet Private API Key",
 357         type: :string,
 358         suggestions: ["MJ_APIKEY_PRIVATE"]
 359       },
 360       %{
 361         group: {:subgroup, Swoosh.Adapters.Postmark},
 362         key: :api_key,
 363         label: "Postmark API Key",
 364         type: :string,
 365         suggestions: ["X-Postmark-Server-Token"]
 366       },
 367       %{
 368         group: {:subgroup, Swoosh.Adapters.SparkPost},
 369         key: :api_key,
 370         label: "SparkPost API key",
 371         type: :string,
 372         suggestions: ["YOUR_API_KEY"]
 373       },
 374       %{
 375         group: {:subgroup, Swoosh.Adapters.SparkPost},
 376         key: :endpoint,
 377         type: :string,
 378         suggestions: ["https://api.sparkpost.com/api/v1"]
 379       },
 380       %{
 381         group: {:subgroup, Swoosh.Adapters.AmazonSES},
 382         key: :access_key,
 383         label: "AWS Access Key",
 384         type: :string,
 385         suggestions: ["AWS_ACCESS_KEY"]
 386       },
 387       %{
 388         group: {:subgroup, Swoosh.Adapters.AmazonSES},
 389         key: :secret,
 390         label: "AWS Secret Key",
 391         type: :string,
 392         suggestions: ["AWS_SECRET_KEY"]
 393       },
 394       %{
 395         group: {:subgroup, Swoosh.Adapters.AmazonSES},
 396         key: :region,
 397         label: "AWS Region",
 398         type: :string,
 399         suggestions: ["us-east-1", "us-east-2"]
 400       },
 401       %{
 402         group: {:subgroup, Swoosh.Adapters.Dyn},
 403         key: :api_key,
 404         label: "Dyn API Key",
 405         type: :string,
 406         suggestions: ["apikey"]
 407       },
 408       %{
 409         group: {:subgroup, Swoosh.Adapters.SocketLabs},
 410         key: :api_key,
 411         label: "SocketLabs API Key",
 412         type: :string,
 413         suggestions: ["INJECTION_API_KEY"]
 414       },
 415       %{
 416         group: {:subgroup, Swoosh.Adapters.SocketLabs},
 417         key: :server_id,
 418         label: "Server ID",
 419         type: :string,
 420         suggestions: ["SERVER_ID"]
 421       },
 422       %{
 423         group: {:subgroup, Swoosh.Adapters.Gmail},
 424         key: :access_token,
 425         label: "GMail API Access Token",
 426         type: :string,
 427         suggestions: ["GMAIL_API_ACCESS_TOKEN"]
 428       }
 429     ]
 430   },
 431   %{
 432     group: :pleroma,
 433     key: :uri_schemes,
 434     label: "URI Schemes",
 435     type: :group,
 436     description: "URI schemes related settings",
 437     children: [
 438       %{
 439         key: :valid_schemes,
 440         type: {:list, :string},
 441         description: "List of the scheme part that is considered valid to be an URL",
 442         suggestions: [
 443           "https",
 444           "http",
 445           "dat",
 446           "dweb",
 447           "gopher",
 448           "hyper",
 449           "ipfs",
 450           "ipns",
 451           "irc",
 452           "ircs",
 453           "magnet",
 454           "mailto",
 455           "mumble",
 456           "ssb",
 457           "xmpp"
 458         ]
 459       }
 460     ]
 461   },
 462   %{
 463     group: :pleroma,
 464     key: :features,
 465     type: :group,
 466     description: "Customizable features",
 467     children: [
 468       %{
 469         key: :improved_hashtag_timeline,
 470         type: {:dropdown, :atom},
 471         description:
 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]
 474       }
 475     ]
 476   },
 477   %{
 478     group: :pleroma,
 479     key: :populate_hashtags_table,
 480     type: :group,
 481     description: "`populate_hashtags_table` background migration settings",
 482     children: [
 483       %{
 484         key: :fault_rate_allowance,
 485         type: :float,
 486         description:
 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.",
 488         suggestions: [0.01]
 489       },
 490       %{
 491         key: :sleep_interval_ms,
 492         type: :integer,
 493         description:
 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)."
 495       }
 496     ]
 497   },
 498   %{
 499     group: :pleroma,
 500     key: :instance,
 501     type: :group,
 502     description: "Instance-related settings",
 503     children: [
 504       %{
 505         key: :name,
 506         type: :string,
 507         description: "Name of the instance",
 508         suggestions: [
 509           "Pleroma"
 510         ]
 511       },
 512       %{
 513         key: :email,
 514         label: "Admin Email Address",
 515         type: :string,
 516         description: "Email used to reach an Administrator/Moderator of the instance",
 517         suggestions: [
 518           "email@example.com"
 519         ]
 520       },
 521       %{
 522         key: :notify_email,
 523         label: "Sender Email Address",
 524         type: :string,
 525         description: "Envelope FROM address for mail sent via Pleroma",
 526         suggestions: [
 527           "notify@example.com"
 528         ]
 529       },
 530       %{
 531         key: :description,
 532         type: :string,
 533         description:
 534           "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
 535         suggestions: [
 536           "Very cool instance"
 537         ]
 538       },
 539       %{
 540         key: :limit,
 541         type: :integer,
 542         description: "Posts character limit (CW/Subject included in the counter)",
 543         suggestions: [
 544           5_000
 545         ]
 546       },
 547       %{
 548         key: :remote_limit,
 549         type: :integer,
 550         description: "Hard character limit beyond which remote posts will be dropped",
 551         suggestions: [
 552           100_000
 553         ]
 554       },
 555       %{
 556         key: :upload_limit,
 557         type: :integer,
 558         description: "File size limit of uploads (except for avatar, background, banner)",
 559         suggestions: [
 560           16_000_000
 561         ]
 562       },
 563       %{
 564         key: :avatar_upload_limit,
 565         type: :integer,
 566         description: "File size limit of user's profile avatars",
 567         suggestions: [
 568           2_000_000
 569         ]
 570       },
 571       %{
 572         key: :background_upload_limit,
 573         type: :integer,
 574         description: "File size limit of user's profile backgrounds",
 575         suggestions: [
 576           4_000_000
 577         ]
 578       },
 579       %{
 580         key: :banner_upload_limit,
 581         type: :integer,
 582         description: "File size limit of user's profile banners",
 583         suggestions: [
 584           4_000_000
 585         ]
 586       },
 587       %{
 588         key: :poll_limits,
 589         type: :map,
 590         description: "A map with poll limits for local polls",
 591         suggestions: [
 592           %{
 593             max_options: 20,
 594             max_option_chars: 200,
 595             min_expiration: 0,
 596             max_expiration: 31_536_000
 597           }
 598         ],
 599         children: [
 600           %{
 601             key: :max_options,
 602             type: :integer,
 603             description: "Maximum number of options",
 604             suggestions: [20]
 605           },
 606           %{
 607             key: :max_option_chars,
 608             type: :integer,
 609             description: "Maximum number of characters per option",
 610             suggestions: [200]
 611           },
 612           %{
 613             key: :min_expiration,
 614             type: :integer,
 615             description: "Minimum expiration time (in seconds)",
 616             suggestions: [0]
 617           },
 618           %{
 619             key: :max_expiration,
 620             type: :integer,
 621             description: "Maximum expiration time (in seconds)",
 622             suggestions: [3600]
 623           }
 624         ]
 625       },
 626       %{
 627         key: :registrations_open,
 628         type: :boolean,
 629         description:
 630           "Enable registrations for anyone. Invitations require this setting to be disabled."
 631       },
 632       %{
 633         key: :invites_enabled,
 634         type: :boolean,
 635         description:
 636           "Enable user invitations for admins (depends on `registrations_open` being disabled)"
 637       },
 638       %{
 639         key: :account_activation_required,
 640         type: :boolean,
 641         description: "Require users to confirm their emails before signing in"
 642       },
 643       %{
 644         key: :account_approval_required,
 645         type: :boolean,
 646         description: "Require users to be manually approved by an admin before signing in"
 647       },
 648       %{
 649         key: :federating,
 650         type: :boolean,
 651         description: "Enable federation with other instances"
 652       },
 653       %{
 654         key: :federation_incoming_replies_max_depth,
 655         label: "Fed. incoming replies max depth",
 656         type: :integer,
 657         description:
 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.",
 660         suggestions: [
 661           100
 662         ]
 663       },
 664       %{
 665         key: :federation_reachability_timeout_days,
 666         label: "Fed. reachability timeout days",
 667         type: :integer,
 668         description:
 669           "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
 670         suggestions: [
 671           7
 672         ]
 673       },
 674       %{
 675         key: :allow_relay,
 676         type: :boolean,
 677         description:
 678           "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
 679       },
 680       %{
 681         key: :public,
 682         type: :boolean,
 683         description:
 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."
 687       },
 688       %{
 689         key: :quarantined_instances,
 690         type: {:list, :tuple},
 691         key_placeholder: "instance",
 692         value_placeholder: "reason",
 693         description:
 694           "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
 695         suggestions: [
 696           {"quarantined.com", "Reason"},
 697           {"*.quarantined.com", "Reason"}
 698         ]
 699       },
 700       %{
 701         key: :static_dir,
 702         type: :string,
 703         description: "Instance static directory",
 704         suggestions: [
 705           "instance/static/"
 706         ]
 707       },
 708       %{
 709         key: :allowed_post_formats,
 710         type: {:list, :string},
 711         description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
 712         suggestions: [
 713           "text/plain",
 714           "text/html",
 715           "text/markdown",
 716           "text/bbcode"
 717         ]
 718       },
 719       %{
 720         key: :extended_nickname_format,
 721         type: :boolean,
 722         description:
 723           "Enable to use extended local nicknames format (allows underscores/dashes)." <>
 724             " This will break federation with older software for theses nicknames."
 725       },
 726       %{
 727         key: :cleanup_attachments,
 728         type: :boolean,
 729         description: """
 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.
 733         """
 734       },
 735       %{
 736         key: :max_pinned_statuses,
 737         type: :integer,
 738         description: "The maximum number of pinned statuses. 0 will disable the feature.",
 739         suggestions: [
 740           0,
 741           1,
 742           3
 743         ]
 744       },
 745       %{
 746         key: :autofollowed_nicknames,
 747         type: {:list, :string},
 748         description:
 749           "Set to nicknames of (local) users that every new user should automatically follow"
 750       },
 751       %{
 752         key: :autofollowing_nicknames,
 753         type: {:list, :string},
 754         description:
 755           "Set to nicknames of (local) users that automatically follows every newly registered user"
 756       },
 757       %{
 758         key: :attachment_links,
 759         type: :boolean,
 760         description: "Enable to automatically add attachment link text to statuses"
 761       },
 762       %{
 763         key: :max_report_comment_size,
 764         type: :integer,
 765         description: "The maximum size of the report comment. Default: 1000.",
 766         suggestions: [
 767           1_000
 768         ]
 769       },
 770       %{
 771         key: :safe_dm_mentions,
 772         label: "Safe DM mentions",
 773         type: :boolean,
 774         description:
 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\")." <>
 777             " Default: disabled"
 778       },
 779       %{
 780         key: :healthcheck,
 781         type: :boolean,
 782         description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
 783       },
 784       %{
 785         key: :remote_post_retention_days,
 786         type: :integer,
 787         description:
 788           "The default amount of days to retain remote posts when pruning the database",
 789         suggestions: [
 790           90
 791         ]
 792       },
 793       %{
 794         key: :user_bio_length,
 795         type: :integer,
 796         description: "A user bio maximum length. Default: 5000.",
 797         suggestions: [
 798           5_000
 799         ]
 800       },
 801       %{
 802         key: :user_name_length,
 803         type: :integer,
 804         description: "A user name maximum length. Default: 100.",
 805         suggestions: [
 806           100
 807         ]
 808       },
 809       %{
 810         key: :skip_thread_containment,
 811         type: :boolean,
 812         description: "Skip filtering out broken threads. Default: enabled."
 813       },
 814       %{
 815         key: :limit_to_local_content,
 816         type: {:dropdown, :atom},
 817         description:
 818           "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
 819         suggestions: [
 820           :unauthenticated,
 821           :all,
 822           false
 823         ]
 824       },
 825       %{
 826         key: :max_account_fields,
 827         type: :integer,
 828         description: "The maximum number of custom fields in the user profile. Default: 10.",
 829         suggestions: [
 830           10
 831         ]
 832       },
 833       %{
 834         key: :max_remote_account_fields,
 835         type: :integer,
 836         description:
 837           "The maximum number of custom fields in the remote user profile. Default: 20.",
 838         suggestions: [
 839           20
 840         ]
 841       },
 842       %{
 843         key: :account_field_name_length,
 844         type: :integer,
 845         description: "An account field name maximum length. Default: 512.",
 846         suggestions: [
 847           512
 848         ]
 849       },
 850       %{
 851         key: :account_field_value_length,
 852         type: :integer,
 853         description: "An account field value maximum length. Default: 2048.",
 854         suggestions: [
 855           2048
 856         ]
 857       },
 858       %{
 859         key: :registration_reason_length,
 860         type: :integer,
 861         description: "Maximum registration reason length. Default: 500.",
 862         suggestions: [
 863           500
 864         ]
 865       },
 866       %{
 867         key: :external_user_synchronization,
 868         type: :boolean,
 869         description: "Enabling following/followers counters synchronization for external users"
 870       },
 871       %{
 872         key: :multi_factor_authentication,
 873         type: :keyword,
 874         description: "Multi-factor authentication settings",
 875         suggestions: [
 876           [
 877             totp: [digits: 6, period: 30],
 878             backup_codes: [number: 5, length: 16]
 879           ]
 880         ],
 881         children: [
 882           %{
 883             key: :totp,
 884             label: "TOTP settings",
 885             type: :keyword,
 886             description: "TOTP settings",
 887             suggestions: [digits: 6, period: 30],
 888             children: [
 889               %{
 890                 key: :digits,
 891                 type: :integer,
 892                 suggestions: [6],
 893                 description:
 894                   "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
 895               },
 896               %{
 897                 key: :period,
 898                 type: :integer,
 899                 suggestions: [30],
 900                 description:
 901                   "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
 902               }
 903             ]
 904           },
 905           %{
 906             key: :backup_codes,
 907             type: :keyword,
 908             description: "MFA backup codes settings",
 909             suggestions: [number: 5, length: 16],
 910             children: [
 911               %{
 912                 key: :number,
 913                 type: :integer,
 914                 suggestions: [5],
 915                 description: "Number of backup codes to generate."
 916               },
 917               %{
 918                 key: :length,
 919                 type: :integer,
 920                 suggestions: [16],
 921                 description:
 922                   "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
 923               }
 924             ]
 925           }
 926         ]
 927       },
 928       %{
 929         key: :instance_thumbnail,
 930         type: {:string, :image},
 931         description:
 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"]
 934       },
 935       %{
 936         key: :show_reactions,
 937         type: :boolean,
 938         description: "Let favourites and emoji reactions be viewed through the API."
 939       }
 940     ]
 941   },
 942   %{
 943     group: :pleroma,
 944     key: :welcome,
 945     type: :group,
 946     description: "Welcome messages settings",
 947     children: [
 948       %{
 949         key: :direct_message,
 950         type: :keyword,
 951         descpiption: "Direct message settings",
 952         children: [
 953           %{
 954             key: :enabled,
 955             type: :boolean,
 956             description: "Enables sending a direct message to newly registered users"
 957           },
 958           %{
 959             key: :message,
 960             type: :string,
 961             description: "A message that will be sent to newly registered users",
 962             suggestions: [
 963               "Hi, @username! Welcome on board!"
 964             ]
 965           },
 966           %{
 967             key: :sender_nickname,
 968             type: :string,
 969             description: "The nickname of the local user that sends a welcome message",
 970             suggestions: [
 971               "lain"
 972             ]
 973           }
 974         ]
 975       },
 976       %{
 977         key: :chat_message,
 978         type: :keyword,
 979         descpiption: "Chat message settings",
 980         children: [
 981           %{
 982             key: :enabled,
 983             type: :boolean,
 984             description: "Enables sending a chat message to newly registered users"
 985           },
 986           %{
 987             key: :message,
 988             type: :string,
 989             description:
 990               "A message that will be sent to newly registered users as a chat message",
 991             suggestions: [
 992               "Hello, welcome on board!"
 993             ]
 994           },
 995           %{
 996             key: :sender_nickname,
 997             type: :string,
 998             description: "The nickname of the local user that sends a welcome chat message",
 999             suggestions: [
1000               "lain"
1001             ]
1002           }
1003         ]
1004       },
1005       %{
1006         key: :email,
1007         type: :keyword,
1008         descpiption: "Email message settings",
1009         children: [
1010           %{
1011             key: :enabled,
1012             type: :boolean,
1013             description: "Enables sending an email to newly registered users"
1014           },
1015           %{
1016             key: :sender,
1017             type: [:string, :tuple],
1018             description:
1019               "Email address and/or nickname that will be used to send the welcome email.",
1020             suggestions: [
1021               {"Pleroma App", "welcome@pleroma.app"}
1022             ]
1023           },
1024           %{
1025             key: :subject,
1026             type: :string,
1027             description:
1028               "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1029             suggestions: ["Welcome to <%= instance_name%>"]
1030           },
1031           %{
1032             key: :html,
1033             type: :string,
1034             description:
1035               "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1036             suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1037           },
1038           %{
1039             key: :text,
1040             type: :string,
1041             description:
1042               "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1043             suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1044           }
1045         ]
1046       }
1047     ]
1048   },
1049   %{
1050     group: :logger,
1051     type: :group,
1052     description: "Logger-related settings",
1053     children: [
1054       %{
1055         key: :backends,
1056         type: [:atom, :tuple, :module],
1057         description:
1058           "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1059         suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1060       }
1061     ]
1062   },
1063   %{
1064     group: :logger,
1065     type: :group,
1066     key: :ex_syslogger,
1067     label: "ExSyslogger",
1068     description: "ExSyslogger-related settings",
1069     children: [
1070       %{
1071         key: :level,
1072         type: {:dropdown, :atom},
1073         description: "Log level",
1074         suggestions: [:debug, :info, :warn, :error]
1075       },
1076       %{
1077         key: :ident,
1078         type: :string,
1079         description:
1080           "A string that's prepended to every message, and is typically set to the app name",
1081         suggestions: ["pleroma"]
1082       },
1083       %{
1084         key: :format,
1085         type: :string,
1086         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1087         suggestions: ["$metadata[$level] $message"]
1088       },
1089       %{
1090         key: :metadata,
1091         type: {:list, :atom},
1092         suggestions: [:request_id]
1093       }
1094     ]
1095   },
1096   %{
1097     group: :logger,
1098     type: :group,
1099     key: :console,
1100     label: "Console Logger",
1101     description: "Console logger settings",
1102     children: [
1103       %{
1104         key: :level,
1105         type: {:dropdown, :atom},
1106         description: "Log level",
1107         suggestions: [:debug, :info, :warn, :error]
1108       },
1109       %{
1110         key: :format,
1111         type: :string,
1112         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1113         suggestions: ["$metadata[$level] $message"]
1114       },
1115       %{
1116         key: :metadata,
1117         type: {:list, :atom},
1118         suggestions: [:request_id]
1119       }
1120     ]
1121   },
1122   %{
1123     group: :quack,
1124     type: :group,
1125     label: "Quack Logger",
1126     description: "Quack-related settings",
1127     children: [
1128       %{
1129         key: :level,
1130         type: {:dropdown, :atom},
1131         description: "Log level",
1132         suggestions: [:debug, :info, :warn, :error]
1133       },
1134       %{
1135         key: :meta,
1136         type: {:list, :atom},
1137         description: "Configure which metadata you want to report on",
1138         suggestions: [
1139           :application,
1140           :module,
1141           :file,
1142           :function,
1143           :line,
1144           :pid,
1145           :crash_reason,
1146           :initial_call,
1147           :registered_name,
1148           :all,
1149           :none
1150         ]
1151       },
1152       %{
1153         key: :webhook_url,
1154         label: "Webhook URL",
1155         type: :string,
1156         description: "Configure the Slack incoming webhook",
1157         suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1158       }
1159     ]
1160   },
1161   %{
1162     group: :pleroma,
1163     key: :frontend_configurations,
1164     type: :group,
1165     description:
1166       "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1167         "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1168         "add your own configuration your settings all fields must be complete.",
1169     children: [
1170       %{
1171         key: :pleroma_fe,
1172         label: "Pleroma FE",
1173         type: :map,
1174         description: "Settings for Pleroma FE",
1175         suggestions: [
1176           %{
1177             alwaysShowSubjectInput: true,
1178             background: "/static/aurora_borealis.jpg",
1179             collapseMessageWithSubject: false,
1180             greentext: false,
1181             hideFilteredStatuses: false,
1182             hideMutedPosts: false,
1183             hidePostStats: false,
1184             hideSitename: false,
1185             hideUserStats: false,
1186             loginMethod: "password",
1187             logo: "/static/logo.svg",
1188             logoMargin: ".1em",
1189             logoMask: true,
1190             minimalScopesMode: false,
1191             noAttachmentLinks: false,
1192             nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1193             postContentType: "text/plain",
1194             redirectRootLogin: "/main/friends",
1195             redirectRootNoLogin: "/main/all",
1196             scopeCopy: true,
1197             sidebarRight: false,
1198             showFeaturesPanel: true,
1199             showInstanceSpecificPanel: false,
1200             subjectLineBehavior: "email",
1201             theme: "pleroma-dark",
1202             webPushNotifications: false
1203           }
1204         ],
1205         children: [
1206           %{
1207             key: :alwaysShowSubjectInput,
1208             label: "Always show subject input",
1209             type: :boolean,
1210             description: "When disabled, auto-hide the subject field if it's empty"
1211           },
1212           %{
1213             key: :background,
1214             type: {:string, :image},
1215             description:
1216               "URL of the background, unless viewing a user profile with a background that is set",
1217             suggestions: ["/images/city.jpg"]
1218           },
1219           %{
1220             key: :collapseMessageWithSubject,
1221             label: "Collapse message with subject",
1222             type: :boolean,
1223             description:
1224               "When a message has a subject (aka Content Warning), collapse it by default"
1225           },
1226           %{
1227             key: :greentext,
1228             label: "Greentext",
1229             type: :boolean,
1230             description: "Enables green text on lines prefixed with the > character"
1231           },
1232           %{
1233             key: :hideFilteredStatuses,
1234             label: "Hide Filtered Statuses",
1235             type: :boolean,
1236             description: "Hides filtered statuses from timelines"
1237           },
1238           %{
1239             key: :hideMutedPosts,
1240             label: "Hide Muted Posts",
1241             type: :boolean,
1242             description: "Hides muted statuses from timelines"
1243           },
1244           %{
1245             key: :hidePostStats,
1246             label: "Hide post stats",
1247             type: :boolean,
1248             description: "Hide notices statistics (repeats, favorites, ...)"
1249           },
1250           %{
1251             key: :hideSitename,
1252             label: "Hide Sitename",
1253             type: :boolean,
1254             description: "Hides instance name from PleromaFE banner"
1255           },
1256           %{
1257             key: :hideUserStats,
1258             label: "Hide user stats",
1259             type: :boolean,
1260             description:
1261               "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1262           },
1263           %{
1264             key: :logo,
1265             type: {:string, :image},
1266             description: "URL of the logo, defaults to Pleroma's logo",
1267             suggestions: ["/static/logo.svg"]
1268           },
1269           %{
1270             key: :logoMargin,
1271             label: "Logo margin",
1272             type: :string,
1273             description:
1274               "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1275                 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1276             suggestions: [".1em"]
1277           },
1278           %{
1279             key: :logoMask,
1280             label: "Logo mask",
1281             type: :boolean,
1282             description:
1283               "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1284                 "If you want a colorful logo you must disable logoMask."
1285           },
1286           %{
1287             key: :minimalScopesMode,
1288             label: "Minimal scopes mode",
1289             type: :boolean,
1290             description:
1291               "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1292                 "Also prevents replying to a DM with a public post from PleromaFE."
1293           },
1294           %{
1295             key: :nsfwCensorImage,
1296             label: "NSFW Censor Image",
1297             type: {:string, :image},
1298             description:
1299               "URL of the image to use for hiding NSFW media attachments in the timeline",
1300             suggestions: ["/static/img/nsfw.74818f9.png"]
1301           },
1302           %{
1303             key: :postContentType,
1304             label: "Post Content Type",
1305             type: {:dropdown, :atom},
1306             description: "Default post formatting option",
1307             suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1308           },
1309           %{
1310             key: :redirectRootNoLogin,
1311             label: "Redirect root no login",
1312             type: :string,
1313             description:
1314               "Relative URL which indicates where to redirect when a user isn't logged in",
1315             suggestions: ["/main/all"]
1316           },
1317           %{
1318             key: :redirectRootLogin,
1319             label: "Redirect root login",
1320             type: :string,
1321             description:
1322               "Relative URL which indicates where to redirect when a user is logged in",
1323             suggestions: ["/main/friends"]
1324           },
1325           %{
1326             key: :scopeCopy,
1327             label: "Scope copy",
1328             type: :boolean,
1329             description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1330           },
1331           %{
1332             key: :sidebarRight,
1333             label: "Sidebar on Right",
1334             type: :boolean,
1335             description: "Change alignment of sidebar and panels to the right"
1336           },
1337           %{
1338             key: :showFeaturesPanel,
1339             label: "Show instance features panel",
1340             type: :boolean,
1341             description:
1342               "Enables panel displaying functionality of the instance on the About page"
1343           },
1344           %{
1345             key: :showInstanceSpecificPanel,
1346             label: "Show instance specific panel",
1347             type: :boolean,
1348             description: "Whether to show the instance's custom panel"
1349           },
1350           %{
1351             key: :subjectLineBehavior,
1352             label: "Subject line behavior",
1353             type: :string,
1354             description: "Allows changing the default behaviour of subject lines in replies.
1355           `email`: copy and preprend re:, as in email,
1356           `masto`: copy verbatim, as in Mastodon,
1357           `noop`: don't copy the subject.",
1358             suggestions: ["email", "masto", "noop"]
1359           },
1360           %{
1361             key: :theme,
1362             type: :string,
1363             description: "Which theme to use. Available themes are defined in styles.json",
1364             suggestions: ["pleroma-dark"]
1365           }
1366         ]
1367       }
1368     ]
1369   },
1370   %{
1371     group: :pleroma,
1372     key: :assets,
1373     type: :group,
1374     description:
1375       "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1376     children: [
1377       %{
1378         key: :mascots,
1379         type: {:keyword, :map},
1380         description:
1381           "Keyword of mascots, each element must contain both an URL and a mime_type key",
1382         suggestions: [
1383           pleroma_fox_tan: %{
1384             url: "/images/pleroma-fox-tan-smol.png",
1385             mime_type: "image/png"
1386           },
1387           pleroma_fox_tan_shy: %{
1388             url: "/images/pleroma-fox-tan-shy.png",
1389             mime_type: "image/png"
1390           }
1391         ]
1392       },
1393       %{
1394         key: :default_mascot,
1395         type: :atom,
1396         description:
1397           "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1398         suggestions: [
1399           :pleroma_fox_tan
1400         ]
1401       },
1402       %{
1403         key: :default_user_avatar,
1404         type: {:string, :image},
1405         description: "URL of the default user avatar",
1406         suggestions: ["/images/avi.png"]
1407       }
1408     ]
1409   },
1410   %{
1411     group: :pleroma,
1412     key: :manifest,
1413     type: :group,
1414     description:
1415       "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1416     children: [
1417       %{
1418         key: :icons,
1419         type: {:list, :map},
1420         description: "Describe the icons of the app",
1421         suggestion: [
1422           %{
1423             src: "/static/logo.png"
1424           },
1425           %{
1426             src: "/static/icon.png",
1427             type: "image/png"
1428           },
1429           %{
1430             src: "/static/icon.ico",
1431             sizes: "72x72 96x96 128x128 256x256"
1432           }
1433         ]
1434       },
1435       %{
1436         key: :theme_color,
1437         type: :string,
1438         description: "Describe the theme color of the app",
1439         suggestions: ["#282c37", "mediumpurple"]
1440       },
1441       %{
1442         key: :background_color,
1443         type: :string,
1444         description: "Describe the background color of the app",
1445         suggestions: ["#191b22", "aliceblue"]
1446       }
1447     ]
1448   },
1449   %{
1450     group: :pleroma,
1451     key: :media_proxy,
1452     type: :group,
1453     description: "Media proxy",
1454     children: [
1455       %{
1456         key: :enabled,
1457         type: :boolean,
1458         description: "Enables proxying of remote media via the instance's proxy"
1459       },
1460       %{
1461         key: :base_url,
1462         label: "Base URL",
1463         type: :string,
1464         description:
1465           "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1466         suggestions: ["https://example.com"]
1467       },
1468       %{
1469         key: :invalidation,
1470         type: :keyword,
1471         descpiption: "",
1472         suggestions: [
1473           enabled: true,
1474           provider: Pleroma.Web.MediaProxy.Invalidation.Script
1475         ],
1476         children: [
1477           %{
1478             key: :enabled,
1479             type: :boolean,
1480             description: "Enables media cache object invalidation."
1481           },
1482           %{
1483             key: :provider,
1484             type: :module,
1485             description: "Module which will be used to purge objects from the cache.",
1486             suggestions: [
1487               Pleroma.Web.MediaProxy.Invalidation.Script,
1488               Pleroma.Web.MediaProxy.Invalidation.Http
1489             ]
1490           }
1491         ]
1492       },
1493       %{
1494         key: :proxy_opts,
1495         label: "Advanced MediaProxy Options",
1496         type: :keyword,
1497         description: "Internal Pleroma.ReverseProxy settings",
1498         suggestions: [
1499           redirect_on_failure: false,
1500           max_body_length: 25 * 1_048_576,
1501           max_read_duration: 30_000
1502         ],
1503         children: [
1504           %{
1505             key: :redirect_on_failure,
1506             type: :boolean,
1507             description: """
1508             Redirects the client to the origin server upon encountering HTTP errors.\n
1509             Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1510             **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1511             IP addresses of your users to the other servers, bypassing the MediaProxy.
1512             """
1513           },
1514           %{
1515             key: :max_body_length,
1516             type: :integer,
1517             description:
1518               "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1519           },
1520           %{
1521             key: :max_read_duration,
1522             type: :integer,
1523             description: "Timeout (in milliseconds) of GET request to the remote URI."
1524           }
1525         ]
1526       },
1527       %{
1528         key: :whitelist,
1529         type: {:list, :string},
1530         description: "List of hosts with scheme to bypass the MediaProxy",
1531         suggestions: ["http://example.com"]
1532       }
1533     ]
1534   },
1535   %{
1536     group: :pleroma,
1537     key: :media_preview_proxy,
1538     type: :group,
1539     description: "Media preview proxy",
1540     children: [
1541       %{
1542         key: :enabled,
1543         type: :boolean,
1544         description:
1545           "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1546       },
1547       %{
1548         key: :thumbnail_max_width,
1549         type: :integer,
1550         description:
1551           "Max width of preview thumbnail for images (video preview always has original dimensions)."
1552       },
1553       %{
1554         key: :thumbnail_max_height,
1555         type: :integer,
1556         description:
1557           "Max height of preview thumbnail for images (video preview always has original dimensions)."
1558       },
1559       %{
1560         key: :image_quality,
1561         type: :integer,
1562         description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1563       },
1564       %{
1565         key: :min_content_length,
1566         type: :integer,
1567         description:
1568           "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1569       }
1570     ]
1571   },
1572   %{
1573     group: :pleroma,
1574     key: Pleroma.Web.MediaProxy.Invalidation.Http,
1575     type: :group,
1576     description: "HTTP invalidate settings",
1577     children: [
1578       %{
1579         key: :method,
1580         type: :atom,
1581         description: "HTTP method of request. Default: :purge"
1582       },
1583       %{
1584         key: :headers,
1585         type: {:keyword, :string},
1586         description: "HTTP headers of request",
1587         suggestions: [{"x-refresh", 1}]
1588       },
1589       %{
1590         key: :options,
1591         type: :keyword,
1592         description: "Request options",
1593         children: [
1594           %{
1595             key: :params,
1596             type: {:map, :string}
1597           }
1598         ]
1599       }
1600     ]
1601   },
1602   %{
1603     group: :pleroma,
1604     key: Pleroma.Web.MediaProxy.Invalidation.Script,
1605     type: :group,
1606     description: "Invalidation script settings",
1607     children: [
1608       %{
1609         key: :script_path,
1610         type: :string,
1611         description: "Path to executable script which will purge cached items.",
1612         suggestions: ["./installation/nginx-cache-purge.sh.example"]
1613       },
1614       %{
1615         key: :url_format,
1616         label: "URL Format",
1617         type: :string,
1618         description:
1619           "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1620         suggestions: [":htcacheclean"]
1621       }
1622     ]
1623   },
1624   %{
1625     group: :pleroma,
1626     key: :gopher,
1627     type: :group,
1628     description: "Gopher settings",
1629     children: [
1630       %{
1631         key: :enabled,
1632         type: :boolean,
1633         description: "Enables the gopher interface"
1634       },
1635       %{
1636         key: :ip,
1637         label: "IP",
1638         type: :tuple,
1639         description: "IP address to bind to",
1640         suggestions: [{0, 0, 0, 0}]
1641       },
1642       %{
1643         key: :port,
1644         type: :integer,
1645         description: "Port to bind to",
1646         suggestions: [9999]
1647       },
1648       %{
1649         key: :dstport,
1650         type: :integer,
1651         description: "Port advertised in URLs (optional, defaults to port)",
1652         suggestions: [9999]
1653       }
1654     ]
1655   },
1656   %{
1657     group: :pleroma,
1658     key: :activitypub,
1659     label: "ActivityPub",
1660     type: :group,
1661     description: "ActivityPub-related settings",
1662     children: [
1663       %{
1664         key: :unfollow_blocked,
1665         type: :boolean,
1666         description: "Whether blocks result in people getting unfollowed"
1667       },
1668       %{
1669         key: :outgoing_blocks,
1670         type: :boolean,
1671         description: "Whether to federate blocks to other instances"
1672       },
1673       %{
1674         key: :sign_object_fetches,
1675         type: :boolean,
1676         description: "Sign object fetches with HTTP signatures"
1677       },
1678       %{
1679         key: :note_replies_output_limit,
1680         type: :integer,
1681         description:
1682           "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1683       },
1684       %{
1685         key: :follow_handshake_timeout,
1686         type: :integer,
1687         description: "Following handshake timeout",
1688         suggestions: [500]
1689       }
1690     ]
1691   },
1692   %{
1693     group: :pleroma,
1694     key: :http_security,
1695     label: "HTTP security",
1696     type: :group,
1697     description: "HTTP security settings",
1698     children: [
1699       %{
1700         key: :enabled,
1701         type: :boolean,
1702         description: "Whether the managed content security policy is enabled"
1703       },
1704       %{
1705         key: :sts,
1706         label: "STS",
1707         type: :boolean,
1708         description: "Whether to additionally send a Strict-Transport-Security header"
1709       },
1710       %{
1711         key: :sts_max_age,
1712         label: "STS max age",
1713         type: :integer,
1714         description: "The maximum age for the Strict-Transport-Security header if sent",
1715         suggestions: [31_536_000]
1716       },
1717       %{
1718         key: :ct_max_age,
1719         label: "CT max age",
1720         type: :integer,
1721         description: "The maximum age for the Expect-CT header if sent",
1722         suggestions: [2_592_000]
1723       },
1724       %{
1725         key: :referrer_policy,
1726         type: :string,
1727         description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1728         suggestions: ["same-origin", "no-referrer"]
1729       },
1730       %{
1731         key: :report_uri,
1732         label: "Report URI",
1733         type: :string,
1734         description: "Adds the specified URL to report-uri and report-to group in CSP header",
1735         suggestions: ["https://example.com/report-uri"]
1736       }
1737     ]
1738   },
1739   %{
1740     group: :web_push_encryption,
1741     key: :vapid_details,
1742     label: "Vapid Details",
1743     type: :group,
1744     description:
1745       "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1746     children: [
1747       %{
1748         key: :subject,
1749         type: :string,
1750         description:
1751           "A mailto link for the administrative contact." <>
1752             " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1753         suggestions: ["mailto:moderators@pleroma.com"]
1754       },
1755       %{
1756         key: :public_key,
1757         type: :string,
1758         description: "VAPID public key",
1759         suggestions: ["Public key"]
1760       },
1761       %{
1762         key: :private_key,
1763         type: :string,
1764         description: "VAPID private key",
1765         suggestions: ["Private key"]
1766       }
1767     ]
1768   },
1769   %{
1770     group: :pleroma,
1771     key: Pleroma.Captcha,
1772     type: :group,
1773     description: "Captcha-related settings",
1774     children: [
1775       %{
1776         key: :enabled,
1777         type: :boolean,
1778         description: "Whether the captcha should be shown on registration"
1779       },
1780       %{
1781         key: :method,
1782         type: :module,
1783         description: "The method/service to use for captcha",
1784         suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1785       },
1786       %{
1787         key: :seconds_valid,
1788         type: :integer,
1789         description: "The time in seconds for which the captcha is valid",
1790         suggestions: [60]
1791       }
1792     ]
1793   },
1794   %{
1795     group: :pleroma,
1796     key: Pleroma.Captcha.Kocaptcha,
1797     type: :group,
1798     description:
1799       "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1800         " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1801     children: [
1802       %{
1803         key: :endpoint,
1804         type: :string,
1805         description: "The kocaptcha endpoint to use",
1806         suggestions: ["https://captcha.kotobank.ch"]
1807       }
1808     ]
1809   },
1810   %{
1811     group: :pleroma,
1812     label: "Pleroma Admin Token",
1813     type: :group,
1814     description:
1815       "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)",
1816     children: [
1817       %{
1818         key: :admin_token,
1819         type: :string,
1820         description: "Admin token",
1821         suggestions: [
1822           "Please use a high entropy string or UUID"
1823         ]
1824       }
1825     ]
1826   },
1827   %{
1828     group: :pleroma,
1829     key: Oban,
1830     type: :group,
1831     description:
1832       "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1833     children: [
1834       %{
1835         key: :log,
1836         type: {:dropdown, :atom},
1837         description: "Logs verbose mode",
1838         suggestions: [false, :error, :warn, :info, :debug]
1839       },
1840       %{
1841         key: :queues,
1842         type: {:keyword, :integer},
1843         description:
1844           "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1845         suggestions: [
1846           activity_expiration: 10,
1847           attachments_cleanup: 5,
1848           background: 5,
1849           federator_incoming: 50,
1850           federator_outgoing: 50,
1851           mailer: 10,
1852           scheduled_activities: 10,
1853           transmogrifier: 20,
1854           web_push: 50
1855         ],
1856         children: [
1857           %{
1858             key: :activity_expiration,
1859             type: :integer,
1860             description: "Activity expiration queue",
1861             suggestions: [10]
1862           },
1863           %{
1864             key: :backup,
1865             type: :integer,
1866             description: "Backup queue",
1867             suggestions: [1]
1868           },
1869           %{
1870             key: :attachments_cleanup,
1871             type: :integer,
1872             description: "Attachment deletion queue",
1873             suggestions: [5]
1874           },
1875           %{
1876             key: :background,
1877             type: :integer,
1878             description: "Background queue",
1879             suggestions: [5]
1880           },
1881           %{
1882             key: :federator_incoming,
1883             type: :integer,
1884             description: "Incoming federation queue",
1885             suggestions: [50]
1886           },
1887           %{
1888             key: :federator_outgoing,
1889             type: :integer,
1890             description: "Outgoing federation queue",
1891             suggestions: [50]
1892           },
1893           %{
1894             key: :mailer,
1895             type: :integer,
1896             description: "Email sender queue, see Pleroma.Emails.Mailer",
1897             suggestions: [10]
1898           },
1899           %{
1900             key: :scheduled_activities,
1901             type: :integer,
1902             description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1903             suggestions: [10]
1904           },
1905           %{
1906             key: :transmogrifier,
1907             type: :integer,
1908             description: "Transmogrifier queue",
1909             suggestions: [20]
1910           },
1911           %{
1912             key: :web_push,
1913             type: :integer,
1914             description: "Web push notifications queue",
1915             suggestions: [50]
1916           }
1917         ]
1918       },
1919       %{
1920         key: :crontab,
1921         type: {:list, :tuple},
1922         description: "Settings for cron background jobs",
1923         suggestions: [
1924           {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1925           {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1926         ]
1927       }
1928     ]
1929   },
1930   %{
1931     group: :pleroma,
1932     key: :workers,
1933     type: :group,
1934     description: "Includes custom worker options not interpretable directly by `Oban`",
1935     children: [
1936       %{
1937         key: :retries,
1938         type: {:keyword, :integer},
1939         description: "Max retry attempts for failed jobs, per `Oban` queue",
1940         suggestions: [
1941           federator_incoming: 5,
1942           federator_outgoing: 5
1943         ]
1944       }
1945     ]
1946   },
1947   %{
1948     group: :pleroma,
1949     key: Pleroma.Web.Metadata,
1950     type: :group,
1951     description: "Metadata-related settings",
1952     children: [
1953       %{
1954         key: :providers,
1955         type: {:list, :module},
1956         description: "List of metadata providers to enable",
1957         suggestions: [
1958           Pleroma.Web.Metadata.Providers.OpenGraph,
1959           Pleroma.Web.Metadata.Providers.TwitterCard,
1960           Pleroma.Web.Metadata.Providers.RelMe,
1961           Pleroma.Web.Metadata.Providers.Feed
1962         ]
1963       },
1964       %{
1965         key: :unfurl_nsfw,
1966         label: "Unfurl NSFW",
1967         type: :boolean,
1968         description: "When enabled NSFW attachments will be shown in previews"
1969       }
1970     ]
1971   },
1972   %{
1973     group: :pleroma,
1974     key: :rich_media,
1975     type: :group,
1976     description:
1977       "If enabled the instance will parse metadata from attached links to generate link previews",
1978     children: [
1979       %{
1980         key: :enabled,
1981         type: :boolean,
1982         description: "Enables RichMedia parsing of URLs"
1983       },
1984       %{
1985         key: :ignore_hosts,
1986         type: {:list, :string},
1987         description: "List of hosts which will be ignored by the metadata parser",
1988         suggestions: ["accounts.google.com", "xss.website"]
1989       },
1990       %{
1991         key: :ignore_tld,
1992         label: "Ignore TLD",
1993         type: {:list, :string},
1994         description: "List TLDs (top-level domains) which will ignore for parse metadata",
1995         suggestions: ["local", "localdomain", "lan"]
1996       },
1997       %{
1998         key: :parsers,
1999         type: {:list, :module},
2000         description:
2001           "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.",
2002         suggestions: [
2003           Pleroma.Web.RichMedia.Parsers.OEmbed,
2004           Pleroma.Web.RichMedia.Parsers.TwitterCard
2005         ]
2006       },
2007       %{
2008         key: :ttl_setters,
2009         label: "TTL setters",
2010         type: {:list, :module},
2011         description:
2012           "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.",
2013         suggestions: [
2014           Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2015         ]
2016       },
2017       %{
2018         key: :failure_backoff,
2019         type: :integer,
2020         description:
2021           "Amount of milliseconds after request failure, during which the request will not be retried.",
2022         suggestions: [60_000]
2023       }
2024     ]
2025   },
2026   %{
2027     group: :pleroma,
2028     key: Pleroma.Formatter,
2029     label: "Linkify",
2030     type: :group,
2031     description:
2032       "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2033     children: [
2034       %{
2035         key: :class,
2036         type: [:string, :boolean],
2037         description: "Specify the class to be added to the generated link. Disable to clear.",
2038         suggestions: ["auto-linker", false]
2039       },
2040       %{
2041         key: :rel,
2042         type: [:string, :boolean],
2043         description: "Override the rel attribute. Disable to clear.",
2044         suggestions: ["ugc", "noopener noreferrer", false]
2045       },
2046       %{
2047         key: :new_window,
2048         type: :boolean,
2049         description: "Link URLs will open in a new window/tab."
2050       },
2051       %{
2052         key: :truncate,
2053         type: [:integer, :boolean],
2054         description:
2055           "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2056         suggestions: [15, false]
2057       },
2058       %{
2059         key: :strip_prefix,
2060         type: :boolean,
2061         description: "Strip the scheme prefix."
2062       },
2063       %{
2064         key: :extra,
2065         type: :boolean,
2066         description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2067       },
2068       %{
2069         key: :validate_tld,
2070         type: [:atom, :boolean],
2071         description:
2072           "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)",
2073         suggestions: [:no_scheme, true]
2074       }
2075     ]
2076   },
2077   %{
2078     group: :pleroma,
2079     key: Pleroma.ScheduledActivity,
2080     type: :group,
2081     description: "Scheduled activities settings",
2082     children: [
2083       %{
2084         key: :daily_user_limit,
2085         type: :integer,
2086         description:
2087           "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2088         suggestions: [25]
2089       },
2090       %{
2091         key: :total_user_limit,
2092         type: :integer,
2093         description:
2094           "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2095         suggestions: [300]
2096       },
2097       %{
2098         key: :enabled,
2099         type: :boolean,
2100         description: "Whether scheduled activities are sent to the job queue to be executed"
2101       }
2102     ]
2103   },
2104   %{
2105     group: :pleroma,
2106     key: Pleroma.Workers.PurgeExpiredActivity,
2107     type: :group,
2108     description: "Expired activities settings",
2109     children: [
2110       %{
2111         key: :enabled,
2112         type: :boolean,
2113         description: "Enables expired activities addition & deletion"
2114       },
2115       %{
2116         key: :min_lifetime,
2117         type: :integer,
2118         description: "Minimum lifetime for ephemeral activity (in seconds)",
2119         suggestions: [600]
2120       }
2121     ]
2122   },
2123   %{
2124     group: :pleroma,
2125     label: "Pleroma Authenticator",
2126     type: :group,
2127     description: "Authenticator",
2128     children: [
2129       %{
2130         key: Pleroma.Web.Auth.Authenticator,
2131         type: :module,
2132         suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2133       }
2134     ]
2135   },
2136   %{
2137     group: :pleroma,
2138     key: :ldap,
2139     label: "LDAP",
2140     type: :group,
2141     description:
2142       "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2143         " will be verified by trying to authenticate (bind) to a LDAP server." <>
2144         " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2145         " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2146     children: [
2147       %{
2148         key: :enabled,
2149         type: :boolean,
2150         description: "Enables LDAP authentication"
2151       },
2152       %{
2153         key: :host,
2154         type: :string,
2155         description: "LDAP server hostname",
2156         suggestions: ["localhosts"]
2157       },
2158       %{
2159         key: :port,
2160         type: :integer,
2161         description: "LDAP port, e.g. 389 or 636",
2162         suggestions: [389, 636]
2163       },
2164       %{
2165         key: :ssl,
2166         label: "SSL",
2167         type: :boolean,
2168         description: "Enable to use SSL, usually implies the port 636"
2169       },
2170       %{
2171         key: :sslopts,
2172         label: "SSL options",
2173         type: :keyword,
2174         description: "Additional SSL options",
2175         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2176         children: [
2177           %{
2178             key: :cacertfile,
2179             type: :string,
2180             description: "Path to file with PEM encoded cacerts",
2181             suggestions: ["path/to/file/with/PEM/cacerts"]
2182           },
2183           %{
2184             key: :verify,
2185             type: :atom,
2186             description: "Type of cert verification",
2187             suggestions: [:verify_peer]
2188           }
2189         ]
2190       },
2191       %{
2192         key: :tls,
2193         label: "TLS",
2194         type: :boolean,
2195         description: "Enable to use STARTTLS, usually implies the port 389"
2196       },
2197       %{
2198         key: :tlsopts,
2199         label: "TLS options",
2200         type: :keyword,
2201         description: "Additional TLS options",
2202         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2203         children: [
2204           %{
2205             key: :cacertfile,
2206             type: :string,
2207             description: "Path to file with PEM encoded cacerts",
2208             suggestions: ["path/to/file/with/PEM/cacerts"]
2209           },
2210           %{
2211             key: :verify,
2212             type: :atom,
2213             description: "Type of cert verification",
2214             suggestions: [:verify_peer]
2215           }
2216         ]
2217       },
2218       %{
2219         key: :base,
2220         type: :string,
2221         description: "LDAP base, e.g. \"dc=example,dc=com\"",
2222         suggestions: ["dc=example,dc=com"]
2223       },
2224       %{
2225         key: :uid,
2226         label: "UID",
2227         type: :string,
2228         description:
2229           "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2230         suggestions: ["cn"]
2231       }
2232     ]
2233   },
2234   %{
2235     group: :pleroma,
2236     key: :auth,
2237     type: :group,
2238     description: "Authentication / authorization settings",
2239     children: [
2240       %{
2241         key: :enforce_oauth_admin_scope_usage,
2242         label: "Enforce OAuth admin scope usage",
2243         type: :boolean,
2244         description:
2245           "OAuth admin scope requirement toggle. " <>
2246             "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2247             "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2248             "`is_admin` user flag grants access to admin-specific actions."
2249       },
2250       %{
2251         key: :auth_template,
2252         type: :string,
2253         description:
2254           "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2255         suggestions: ["show.html"]
2256       },
2257       %{
2258         key: :oauth_consumer_template,
2259         label: "OAuth consumer template",
2260         type: :string,
2261         description:
2262           "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2263             " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2264         suggestions: ["consumer.html"]
2265       },
2266       %{
2267         key: :oauth_consumer_strategies,
2268         label: "OAuth consumer strategies",
2269         type: {:list, :string},
2270         description:
2271           "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2272             " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2273             " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2274         suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2275       }
2276     ]
2277   },
2278   %{
2279     group: :pleroma,
2280     key: :email_notifications,
2281     type: :group,
2282     description: "Email notifications settings",
2283     children: [
2284       %{
2285         key: :digest,
2286         type: :map,
2287         description:
2288           "emails of \"what you've missed\" for users who have been inactive for a while",
2289         suggestions: [
2290           %{
2291             active: false,
2292             schedule: "0 0 * * 0",
2293             interval: 7,
2294             inactivity_threshold: 7
2295           }
2296         ],
2297         children: [
2298           %{
2299             key: :active,
2300             label: "Enabled",
2301             type: :boolean,
2302             description: "Globally enable or disable digest emails"
2303           },
2304           %{
2305             key: :schedule,
2306             type: :string,
2307             description:
2308               "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2309             suggestions: ["0 0 * * 0"]
2310           },
2311           %{
2312             key: :interval,
2313             type: :integer,
2314             description: "Minimum interval between digest emails to one user",
2315             suggestions: [7]
2316           },
2317           %{
2318             key: :inactivity_threshold,
2319             type: :integer,
2320             description: "Minimum user inactivity threshold",
2321             suggestions: [7]
2322           }
2323         ]
2324       }
2325     ]
2326   },
2327   %{
2328     group: :pleroma,
2329     key: Pleroma.Emails.UserEmail,
2330     type: :group,
2331     description: "Email template settings",
2332     children: [
2333       %{
2334         key: :logo,
2335         type: {:string, :image},
2336         description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2337         suggestions: ["some/path/logo.png"]
2338       },
2339       %{
2340         key: :styling,
2341         type: :map,
2342         description: "A map with color settings for email templates.",
2343         suggestions: [
2344           %{
2345             link_color: "#d8a070",
2346             background_color: "#2C3645",
2347             content_background_color: "#1B2635",
2348             header_color: "#d8a070",
2349             text_color: "#b9b9ba",
2350             text_muted_color: "#b9b9ba"
2351           }
2352         ],
2353         children: [
2354           %{
2355             key: :link_color,
2356             type: :string,
2357             suggestions: ["#d8a070"]
2358           },
2359           %{
2360             key: :background_color,
2361             type: :string,
2362             suggestions: ["#2C3645"]
2363           },
2364           %{
2365             key: :content_background_color,
2366             type: :string,
2367             suggestions: ["#1B2635"]
2368           },
2369           %{
2370             key: :header_color,
2371             type: :string,
2372             suggestions: ["#d8a070"]
2373           },
2374           %{
2375             key: :text_color,
2376             type: :string,
2377             suggestions: ["#b9b9ba"]
2378           },
2379           %{
2380             key: :text_muted_color,
2381             type: :string,
2382             suggestions: ["#b9b9ba"]
2383           }
2384         ]
2385       }
2386     ]
2387   },
2388   %{
2389     group: :pleroma,
2390     key: Pleroma.Emails.NewUsersDigestEmail,
2391     type: :group,
2392     description: "New users admin email digest",
2393     children: [
2394       %{
2395         key: :enabled,
2396         type: :boolean,
2397         description: "Enables new users admin digest email when `true`"
2398       }
2399     ]
2400   },
2401   %{
2402     group: :pleroma,
2403     key: :oauth2,
2404     label: "OAuth2",
2405     type: :group,
2406     description: "Configure OAuth 2 provider capabilities",
2407     children: [
2408       %{
2409         key: :token_expires_in,
2410         type: :integer,
2411         description: "The lifetime in seconds of the access token",
2412         suggestions: [2_592_000]
2413       },
2414       %{
2415         key: :issue_new_refresh_token,
2416         type: :boolean,
2417         description:
2418           "Keeps old refresh token or generate new refresh token when to obtain an access token"
2419       },
2420       %{
2421         key: :clean_expired_tokens,
2422         type: :boolean,
2423         description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2424       }
2425     ]
2426   },
2427   %{
2428     group: :pleroma,
2429     key: :emoji,
2430     type: :group,
2431     children: [
2432       %{
2433         key: :shortcode_globs,
2434         type: {:list, :string},
2435         description: "Location of custom emoji files. * can be used as a wildcard.",
2436         suggestions: ["/emoji/custom/**/*.png"]
2437       },
2438       %{
2439         key: :pack_extensions,
2440         type: {:list, :string},
2441         description:
2442           "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2443         suggestions: [".png", ".gif"]
2444       },
2445       %{
2446         key: :groups,
2447         type: {:keyword, {:list, :string}},
2448         description:
2449           "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2450             " and the value is the location or array of locations. * can be used as a wildcard.",
2451         suggestions: [
2452           Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2453         ]
2454       },
2455       %{
2456         key: :default_manifest,
2457         type: :string,
2458         description:
2459           "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2460             " Currently only one manifest can be added (no arrays).",
2461         suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2462       },
2463       %{
2464         key: :shared_pack_cache_seconds_per_file,
2465         label: "Shared pack cache s/file",
2466         type: :integer,
2467         descpiption:
2468           "When an emoji pack is shared, the archive is created and cached in memory" <>
2469             " for this amount of seconds multiplied by the number of files.",
2470         suggestions: [60]
2471       }
2472     ]
2473   },
2474   %{
2475     group: :pleroma,
2476     key: :rate_limit,
2477     type: :group,
2478     description:
2479       "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2480     children: [
2481       %{
2482         key: :search,
2483         type: [:tuple, {:list, :tuple}],
2484         description: "For the search requests (account & status search etc.)",
2485         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2486       },
2487       %{
2488         key: :timeline,
2489         type: [:tuple, {:list, :tuple}],
2490         description: "For requests to timelines (each timeline has it's own limiter)",
2491         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2492       },
2493       %{
2494         key: :app_account_creation,
2495         type: [:tuple, {:list, :tuple}],
2496         description: "For registering user accounts from the same IP address",
2497         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2498       },
2499       %{
2500         key: :relations_actions,
2501         type: [:tuple, {:list, :tuple}],
2502         description: "For actions on relationships with all users (follow, unfollow)",
2503         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2504       },
2505       %{
2506         key: :relation_id_action,
2507         label: "Relation ID action",
2508         type: [:tuple, {:list, :tuple}],
2509         description: "For actions on relation with a specific user (follow, unfollow)",
2510         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2511       },
2512       %{
2513         key: :statuses_actions,
2514         type: [:tuple, {:list, :tuple}],
2515         description:
2516           "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2517         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2518       },
2519       %{
2520         key: :status_id_action,
2521         label: "Status ID action",
2522         type: [:tuple, {:list, :tuple}],
2523         description:
2524           "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2525         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2526       },
2527       %{
2528         key: :authentication,
2529         type: [:tuple, {:list, :tuple}],
2530         description: "For authentication create / password check / user existence check requests",
2531         suggestions: [{60_000, 15}]
2532       }
2533     ]
2534   },
2535   %{
2536     group: :esshd,
2537     label: "ESSHD",
2538     type: :group,
2539     description:
2540       "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2541         "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2542     children: [
2543       %{
2544         key: :enabled,
2545         type: :boolean,
2546         description: "Enables SSH"
2547       },
2548       %{
2549         key: :priv_dir,
2550         type: :string,
2551         description: "Dir with SSH keys",
2552         suggestions: ["/some/path/ssh_keys"]
2553       },
2554       %{
2555         key: :handler,
2556         type: :string,
2557         description: "Handler module",
2558         suggestions: ["Pleroma.BBS.Handler"]
2559       },
2560       %{
2561         key: :port,
2562         type: :integer,
2563         description: "Port to connect",
2564         suggestions: [10_022]
2565       },
2566       %{
2567         key: :password_authenticator,
2568         type: :string,
2569         description: "Authenticator module",
2570         suggestions: ["Pleroma.BBS.Authenticator"]
2571       }
2572     ]
2573   },
2574   %{
2575     group: :mime,
2576     label: "Mime Types",
2577     type: :group,
2578     description: "Mime Types settings",
2579     children: [
2580       %{
2581         key: :types,
2582         type: :map,
2583         suggestions: [
2584           %{
2585             "application/xml" => ["xml"],
2586             "application/xrd+xml" => ["xrd+xml"],
2587             "application/jrd+json" => ["jrd+json"],
2588             "application/activity+json" => ["activity+json"],
2589             "application/ld+json" => ["activity+json"]
2590           }
2591         ],
2592         children: [
2593           %{
2594             key: "application/xml",
2595             type: {:list, :string},
2596             suggestions: ["xml"]
2597           },
2598           %{
2599             key: "application/xrd+xml",
2600             type: {:list, :string},
2601             suggestions: ["xrd+xml"]
2602           },
2603           %{
2604             key: "application/jrd+json",
2605             type: {:list, :string},
2606             suggestions: ["jrd+json"]
2607           },
2608           %{
2609             key: "application/activity+json",
2610             type: {:list, :string},
2611             suggestions: ["activity+json"]
2612           },
2613           %{
2614             key: "application/ld+json",
2615             type: {:list, :string},
2616             suggestions: ["activity+json"]
2617           }
2618         ]
2619       }
2620     ]
2621   },
2622   %{
2623     group: :pleroma,
2624     key: :shout,
2625     type: :group,
2626     description: "Pleroma shout settings",
2627     children: [
2628       %{
2629         key: :enabled,
2630         type: :boolean,
2631         description: "Enables the backend Shoutbox chat feature."
2632       },
2633       %{
2634         key: :limit,
2635         type: :integer,
2636         description: "Shout message character limit.",
2637         suggestions: [
2638           5_000
2639         ]
2640       }
2641     ]
2642   },
2643   %{
2644     group: :pleroma,
2645     key: :http,
2646     label: "HTTP",
2647     type: :group,
2648     description: "HTTP settings",
2649     children: [
2650       %{
2651         key: :proxy_url,
2652         label: "Proxy URL",
2653         type: [:string, :tuple],
2654         description: "Proxy URL",
2655         suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2656       },
2657       %{
2658         key: :send_user_agent,
2659         type: :boolean
2660       },
2661       %{
2662         key: :user_agent,
2663         type: [:string, :atom],
2664         description:
2665           "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2666         suggestions: ["Pleroma", :default]
2667       },
2668       %{
2669         key: :adapter,
2670         type: :keyword,
2671         description: "Adapter specific options",
2672         suggestions: [],
2673         children: [
2674           %{
2675             key: :ssl_options,
2676             type: :keyword,
2677             label: "SSL Options",
2678             description: "SSL options for HTTP adapter",
2679             children: [
2680               %{
2681                 key: :versions,
2682                 type: {:list, :atom},
2683                 description: "List of TLS version to use",
2684                 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2685               }
2686             ]
2687           }
2688         ]
2689       }
2690     ]
2691   },
2692   %{
2693     group: :pleroma,
2694     key: :markup,
2695     label: "Markup Settings",
2696     type: :group,
2697     children: [
2698       %{
2699         key: :allow_inline_images,
2700         type: :boolean
2701       },
2702       %{
2703         key: :allow_headings,
2704         type: :boolean
2705       },
2706       %{
2707         key: :allow_tables,
2708         type: :boolean
2709       },
2710       %{
2711         key: :allow_fonts,
2712         type: :boolean
2713       },
2714       %{
2715         key: :scrub_policy,
2716         type: {:list, :module},
2717         description:
2718           "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2719         suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2720       }
2721     ]
2722   },
2723   %{
2724     group: :pleroma,
2725     key: :user,
2726     type: :group,
2727     children: [
2728       %{
2729         key: :deny_follow_blocked,
2730         type: :boolean
2731       }
2732     ]
2733   },
2734   %{
2735     group: :pleroma,
2736     key: Pleroma.User,
2737     type: :group,
2738     children: [
2739       %{
2740         key: :restricted_nicknames,
2741         type: {:list, :string},
2742         description: "List of nicknames users may not register with.",
2743         suggestions: [
2744           ".well-known",
2745           "~",
2746           "about",
2747           "activities",
2748           "api",
2749           "auth",
2750           "check_password",
2751           "dev",
2752           "friend-requests",
2753           "inbox",
2754           "internal",
2755           "main",
2756           "media",
2757           "nodeinfo",
2758           "notice",
2759           "oauth",
2760           "objects",
2761           "ostatus_subscribe",
2762           "pleroma",
2763           "proxy",
2764           "push",
2765           "registration",
2766           "relay",
2767           "settings",
2768           "status",
2769           "tag",
2770           "user-search",
2771           "user_exists",
2772           "users",
2773           "web"
2774         ]
2775       },
2776       %{
2777         key: :email_blacklist,
2778         type: {:list, :string},
2779         description: "List of email domains users may not register with.",
2780         suggestions: ["mailinator.com", "maildrop.cc"]
2781       }
2782     ]
2783   },
2784   %{
2785     group: :cors_plug,
2786     label: "CORS plug config",
2787     type: :group,
2788     children: [
2789       %{
2790         key: :max_age,
2791         type: :integer,
2792         suggestions: [86_400]
2793       },
2794       %{
2795         key: :methods,
2796         type: {:list, :string},
2797         suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2798       },
2799       %{
2800         key: :expose,
2801         type: {:list, :string},
2802         suggestions: [
2803           "Link",
2804           "X-RateLimit-Reset",
2805           "X-RateLimit-Limit",
2806           "X-RateLimit-Remaining",
2807           "X-Request-Id",
2808           "Idempotency-Key"
2809         ]
2810       },
2811       %{
2812         key: :credentials,
2813         type: :boolean
2814       },
2815       %{
2816         key: :headers,
2817         type: {:list, :string},
2818         suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2819       }
2820     ]
2821   },
2822   %{
2823     group: :pleroma,
2824     key: Pleroma.Web.Plugs.RemoteIp,
2825     type: :group,
2826     description: """
2827     `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2828     **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2829     """,
2830     children: [
2831       %{
2832         key: :enabled,
2833         type: :boolean,
2834         description: "Enable/disable the plug. Default: disabled."
2835       },
2836       %{
2837         key: :headers,
2838         type: {:list, :string},
2839         description: """
2840           A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2841         """
2842       },
2843       %{
2844         key: :proxies,
2845         type: {:list, :string},
2846         description:
2847           "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."
2848       },
2849       %{
2850         key: :reserved,
2851         type: {:list, :string},
2852         description: """
2853           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"]`
2854         """
2855       }
2856     ]
2857   },
2858   %{
2859     group: :pleroma,
2860     key: :web_cache_ttl,
2861     label: "Web cache TTL",
2862     type: :group,
2863     description:
2864       "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2865     children: [
2866       %{
2867         key: :activity_pub,
2868         type: :integer,
2869         description:
2870           "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2871         suggestions: [nil]
2872       },
2873       %{
2874         key: :activity_pub_question,
2875         type: :integer,
2876         description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2877         suggestions: [30_000]
2878       }
2879     ]
2880   },
2881   %{
2882     group: :pleroma,
2883     key: :static_fe,
2884     label: "Static FE",
2885     type: :group,
2886     description:
2887       "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2888     children: [
2889       %{
2890         key: :enabled,
2891         type: :boolean,
2892         description: "Enables the rendering of static HTML. Default: disabled."
2893       }
2894     ]
2895   },
2896   %{
2897     group: :pleroma,
2898     key: :feed,
2899     type: :group,
2900     description: "Configure feed rendering",
2901     children: [
2902       %{
2903         key: :post_title,
2904         type: :map,
2905         description: "Configure title rendering",
2906         children: [
2907           %{
2908             key: :max_length,
2909             type: :integer,
2910             description: "Maximum number of characters before truncating title",
2911             suggestions: [100]
2912           },
2913           %{
2914             key: :omission,
2915             type: :string,
2916             description: "Replacement which will be used after truncating string",
2917             suggestions: ["..."]
2918           }
2919         ]
2920       }
2921     ]
2922   },
2923   %{
2924     group: :pleroma,
2925     key: :mrf_follow_bot,
2926     tab: :mrf,
2927     related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2928     label: "MRF FollowBot Policy",
2929     type: :group,
2930     description: "Automatically follows newly discovered accounts.",
2931     children: [
2932       %{
2933         key: :follower_nickname,
2934         type: :string,
2935         description: "The name of the bot account to use for following newly discovered users.",
2936         suggestions: ["followbot"]
2937       }
2938     ]
2939   },
2940   %{
2941     group: :pleroma,
2942     key: :modules,
2943     type: :group,
2944     description: "Custom Runtime Modules",
2945     children: [
2946       %{
2947         key: :runtime_dir,
2948         type: :string,
2949         description: "A path to custom Elixir modules (such as MRF policies)."
2950       }
2951     ]
2952   },
2953   %{
2954     group: :pleroma,
2955     key: :streamer,
2956     type: :group,
2957     description: "Settings for notifications streamer",
2958     children: [
2959       %{
2960         key: :workers,
2961         type: :integer,
2962         description: "Number of workers to send notifications",
2963         suggestions: [3]
2964       },
2965       %{
2966         key: :overflow_workers,
2967         type: :integer,
2968         description: "Maximum number of workers created if pool is empty",
2969         suggestions: [2]
2970       }
2971     ]
2972   },
2973   %{
2974     group: :pleroma,
2975     key: :connections_pool,
2976     type: :group,
2977     description: "Advanced settings for `Gun` connections pool",
2978     children: [
2979       %{
2980         key: :connection_acquisition_wait,
2981         type: :integer,
2982         description:
2983           "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2984         suggestions: [250]
2985       },
2986       %{
2987         key: :connection_acquisition_retries,
2988         type: :integer,
2989         description:
2990           "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2991         suggestions: [5]
2992       },
2993       %{
2994         key: :max_connections,
2995         type: :integer,
2996         description: "Maximum number of connections in the pool. Default: 250 connections.",
2997         suggestions: [250]
2998       },
2999       %{
3000         key: :connect_timeout,
3001         type: :integer,
3002         description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3003         suggestions: [5000]
3004       },
3005       %{
3006         key: :reclaim_multiplier,
3007         type: :integer,
3008         description:
3009           "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3010         suggestions: [0.1]
3011       }
3012     ]
3013   },
3014   %{
3015     group: :pleroma,
3016     key: :pools,
3017     type: :group,
3018     description: "Advanced settings for `Gun` workers pools",
3019     children:
3020       Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3021         %{
3022           key: pool_name,
3023           type: :keyword,
3024           description: "Settings for #{pool_name} pool.",
3025           children: [
3026             %{
3027               key: :size,
3028               type: :integer,
3029               description: "Maximum number of concurrent requests in the pool.",
3030               suggestions: [50]
3031             },
3032             %{
3033               key: :max_waiting,
3034               type: :integer,
3035               description:
3036                 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3037               suggestions: [10]
3038             },
3039             %{
3040               key: :recv_timeout,
3041               type: :integer,
3042               description: "Timeout for the pool while gun will wait for response",
3043               suggestions: [10_000]
3044             }
3045           ]
3046         }
3047       end)
3048   },
3049   %{
3050     group: :pleroma,
3051     key: :hackney_pools,
3052     type: :group,
3053     description: "Advanced settings for `Hackney` connections pools",
3054     children: [
3055       %{
3056         key: :federation,
3057         type: :keyword,
3058         description: "Settings for federation pool.",
3059         children: [
3060           %{
3061             key: :max_connections,
3062             type: :integer,
3063             description: "Number workers in the pool.",
3064             suggestions: [50]
3065           },
3066           %{
3067             key: :timeout,
3068             type: :integer,
3069             description: "Timeout while `hackney` will wait for response.",
3070             suggestions: [150_000]
3071           }
3072         ]
3073       },
3074       %{
3075         key: :media,
3076         type: :keyword,
3077         description: "Settings for media pool.",
3078         children: [
3079           %{
3080             key: :max_connections,
3081             type: :integer,
3082             description: "Number workers in the pool.",
3083             suggestions: [50]
3084           },
3085           %{
3086             key: :timeout,
3087             type: :integer,
3088             description: "Timeout while `hackney` will wait for response.",
3089             suggestions: [150_000]
3090           }
3091         ]
3092       },
3093       %{
3094         key: :upload,
3095         type: :keyword,
3096         description: "Settings for upload pool.",
3097         children: [
3098           %{
3099             key: :max_connections,
3100             type: :integer,
3101             description: "Number workers in the pool.",
3102             suggestions: [25]
3103           },
3104           %{
3105             key: :timeout,
3106             type: :integer,
3107             description: "Timeout while `hackney` will wait for response.",
3108             suggestions: [300_000]
3109           }
3110         ]
3111       }
3112     ]
3113   },
3114   %{
3115     group: :pleroma,
3116     key: :restrict_unauthenticated,
3117     label: "Restrict Unauthenticated",
3118     type: :group,
3119     description:
3120       "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3121     children: [
3122       %{
3123         key: :timelines,
3124         type: :map,
3125         description: "Settings for public and federated timelines.",
3126         children: [
3127           %{
3128             key: :local,
3129             type: :boolean,
3130             description: "Disallow view public timeline."
3131           },
3132           %{
3133             key: :federated,
3134             type: :boolean,
3135             description: "Disallow view federated timeline."
3136           }
3137         ]
3138       },
3139       %{
3140         key: :profiles,
3141         type: :map,
3142         description: "Settings for user profiles.",
3143         children: [
3144           %{
3145             key: :local,
3146             type: :boolean,
3147             description: "Disallow view local user profiles."
3148           },
3149           %{
3150             key: :remote,
3151             type: :boolean,
3152             description: "Disallow view remote user profiles."
3153           }
3154         ]
3155       },
3156       %{
3157         key: :activities,
3158         type: :map,
3159         description: "Settings for statuses.",
3160         children: [
3161           %{
3162             key: :local,
3163             type: :boolean,
3164             description: "Disallow view local statuses."
3165           },
3166           %{
3167             key: :remote,
3168             type: :boolean,
3169             description: "Disallow view remote statuses."
3170           }
3171         ]
3172       }
3173     ]
3174   },
3175   %{
3176     group: :pleroma,
3177     key: Pleroma.Web.ApiSpec.CastAndValidate,
3178     type: :group,
3179     children: [
3180       %{
3181         key: :strict,
3182         type: :boolean,
3183         description:
3184           "Enables strict input validation (useful in development, not recommended in production)"
3185       }
3186     ]
3187   },
3188   %{
3189     group: :pleroma,
3190     key: :instances_favicons,
3191     type: :group,
3192     description: "Control favicons for instances",
3193     children: [
3194       %{
3195         key: :enabled,
3196         type: :boolean,
3197         description: "Allow/disallow displaying and getting instances favicons"
3198       }
3199     ]
3200   },
3201   %{
3202     group: :ex_aws,
3203     key: :s3,
3204     type: :group,
3205     descriptions: "S3 service related settings",
3206     children: [
3207       %{
3208         key: :access_key_id,
3209         type: :string,
3210         description: "S3 access key ID",
3211         suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3212       },
3213       %{
3214         key: :secret_access_key,
3215         type: :string,
3216         description: "Secret access key",
3217         suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3218       },
3219       %{
3220         key: :host,
3221         type: :string,
3222         description: "S3 host",
3223         suggestions: ["s3.eu-central-1.amazonaws.com"]
3224       },
3225       %{
3226         key: :region,
3227         type: :string,
3228         description: "S3 region (for AWS)",
3229         suggestions: ["us-east-1"]
3230       }
3231     ]
3232   },
3233   %{
3234     group: :pleroma,
3235     key: :frontends,
3236     type: :group,
3237     description: "Installed frontends management",
3238     children: [
3239       %{
3240         key: :primary,
3241         type: :map,
3242         description: "Primary frontend, the one that is served for all pages by default",
3243         children: installed_frontend_options
3244       },
3245       %{
3246         key: :admin,
3247         type: :map,
3248         description: "Admin frontend",
3249         children: installed_frontend_options
3250       },
3251       %{
3252         key: :available,
3253         type: :map,
3254         description:
3255           "A map containing available frontends and parameters for their installation.",
3256         children: frontend_options
3257       }
3258     ]
3259   },
3260   %{
3261     group: :pleroma,
3262     key: Pleroma.Web.Preload,
3263     type: :group,
3264     description: "Preload-related settings",
3265     children: [
3266       %{
3267         key: :providers,
3268         type: {:list, :module},
3269         description: "List of preload providers to enable",
3270         suggestions: [
3271           Pleroma.Web.Preload.Providers.Instance,
3272           Pleroma.Web.Preload.Providers.User,
3273           Pleroma.Web.Preload.Providers.Timelines,
3274           Pleroma.Web.Preload.Providers.StatusNet
3275         ]
3276       }
3277     ]
3278   },
3279   %{
3280     group: :pleroma,
3281     key: :majic_pool,
3282     type: :group,
3283     description: "Majic/libmagic configuration",
3284     children: [
3285       %{
3286         key: :size,
3287         type: :integer,
3288         description: "Number of majic workers to start.",
3289         suggestions: [2]
3290       }
3291     ]
3292   },
3293   %{
3294     group: :pleroma,
3295     key: Pleroma.User.Backup,
3296     type: :group,
3297     description: "Account Backup",
3298     children: [
3299       %{
3300         key: :purge_after_days,
3301         type: :integer,
3302         description: "Remove backup achives after N days",
3303         suggestions: [30]
3304       },
3305       %{
3306         key: :limit_days,
3307         type: :integer,
3308         description: "Limit user to export not more often than once per N days",
3309         suggestions: [7]
3310       }
3311     ]
3312   },
3313   %{
3314     group: :prometheus,
3315     key: Pleroma.Web.Endpoint.MetricsExporter,
3316     type: :group,
3317     description: "Prometheus app metrics endpoint configuration",
3318     children: [
3319       %{
3320         key: :enabled,
3321         type: :boolean,
3322         description: "[Pleroma extension] Enables app metrics endpoint."
3323       },
3324       %{
3325         key: :ip_whitelist,
3326         label: "IP Whitelist",
3327         type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3328         description: "Restrict access of app metrics endpoint to the specified IP addresses."
3329       },
3330       %{
3331         key: :auth,
3332         type: [:boolean, :tuple],
3333         description: "Enables HTTP Basic Auth for app metrics endpoint.",
3334         suggestion: [false, {:basic, "myusername", "mypassword"}]
3335       },
3336       %{
3337         key: :path,
3338         type: :string,
3339         description: "App metrics endpoint URI path.",
3340         suggestions: ["/api/pleroma/app_metrics"]
3341       },
3342       %{
3343         key: :format,
3344         type: :atom,
3345         description: "App metrics endpoint output format.",
3346         suggestions: [:text, :protobuf]
3347       }
3348     ]
3349   },
3350   %{
3351     group: :pleroma,
3352     key: ConcurrentLimiter,
3353     type: :group,
3354     description: "Limits configuration for background tasks.",
3355     children: [
3356       %{
3357         key: Pleroma.Web.RichMedia.Helpers,
3358         type: :keyword,
3359         description: "Concurrent limits configuration for getting RichMedia for activities.",
3360         suggestions: [max_running: 5, max_waiting: 5],
3361         children: [
3362           %{
3363             key: :max_running,
3364             type: :integer,
3365             description: "Max running concurrently jobs.",
3366             suggestion: [5]
3367           },
3368           %{
3369             key: :max_waiting,
3370             type: :integer,
3371             description: "Max waiting jobs.",
3372             suggestion: [5]
3373           }
3374         ]
3375       },
3376       %{
3377         key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3378         type: :keyword,
3379         description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3380         suggestions: [max_running: 5, max_waiting: 5],
3381         children: [
3382           %{
3383             key: :max_running,
3384             type: :integer,
3385             description: "Max running concurrently jobs.",
3386             suggestion: [5]
3387           },
3388           %{
3389             key: :max_waiting,
3390             type: :integer,
3391             description: "Max waiting jobs.",
3392             suggestion: [5]
3393           }
3394         ]
3395       }
3396     ]
3397   }
3398 ]