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         key: :profile_directory,
 942         type: :boolean,
 943         description: "Enable profile directory."
 944       }
 945     ]
 946   },
 947   %{
 948     group: :pleroma,
 949     key: :welcome,
 950     type: :group,
 951     description: "Welcome messages settings",
 952     children: [
 953       %{
 954         key: :direct_message,
 955         type: :keyword,
 956         descpiption: "Direct message settings",
 957         children: [
 958           %{
 959             key: :enabled,
 960             type: :boolean,
 961             description: "Enables sending a direct message to newly registered users"
 962           },
 963           %{
 964             key: :message,
 965             type: :string,
 966             description: "A message that will be sent to newly registered users",
 967             suggestions: [
 968               "Hi, @username! Welcome on board!"
 969             ]
 970           },
 971           %{
 972             key: :sender_nickname,
 973             type: :string,
 974             description: "The nickname of the local user that sends a welcome message",
 975             suggestions: [
 976               "lain"
 977             ]
 978           }
 979         ]
 980       },
 981       %{
 982         key: :chat_message,
 983         type: :keyword,
 984         descpiption: "Chat message settings",
 985         children: [
 986           %{
 987             key: :enabled,
 988             type: :boolean,
 989             description: "Enables sending a chat message to newly registered users"
 990           },
 991           %{
 992             key: :message,
 993             type: :string,
 994             description:
 995               "A message that will be sent to newly registered users as a chat message",
 996             suggestions: [
 997               "Hello, welcome on board!"
 998             ]
 999           },
1000           %{
1001             key: :sender_nickname,
1002             type: :string,
1003             description: "The nickname of the local user that sends a welcome chat message",
1004             suggestions: [
1005               "lain"
1006             ]
1007           }
1008         ]
1009       },
1010       %{
1011         key: :email,
1012         type: :keyword,
1013         descpiption: "Email message settings",
1014         children: [
1015           %{
1016             key: :enabled,
1017             type: :boolean,
1018             description: "Enables sending an email to newly registered users"
1019           },
1020           %{
1021             key: :sender,
1022             type: [:string, :tuple],
1023             description:
1024               "Email address and/or nickname that will be used to send the welcome email.",
1025             suggestions: [
1026               {"Pleroma App", "welcome@pleroma.app"}
1027             ]
1028           },
1029           %{
1030             key: :subject,
1031             type: :string,
1032             description:
1033               "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1034             suggestions: ["Welcome to <%= instance_name%>"]
1035           },
1036           %{
1037             key: :html,
1038             type: :string,
1039             description:
1040               "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1041             suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1042           },
1043           %{
1044             key: :text,
1045             type: :string,
1046             description:
1047               "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1048             suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1049           }
1050         ]
1051       }
1052     ]
1053   },
1054   %{
1055     group: :logger,
1056     type: :group,
1057     description: "Logger-related settings",
1058     children: [
1059       %{
1060         key: :backends,
1061         type: [:atom, :tuple, :module],
1062         description:
1063           "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1064         suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1065       }
1066     ]
1067   },
1068   %{
1069     group: :logger,
1070     type: :group,
1071     key: :ex_syslogger,
1072     label: "ExSyslogger",
1073     description: "ExSyslogger-related settings",
1074     children: [
1075       %{
1076         key: :level,
1077         type: {:dropdown, :atom},
1078         description: "Log level",
1079         suggestions: [:debug, :info, :warn, :error]
1080       },
1081       %{
1082         key: :ident,
1083         type: :string,
1084         description:
1085           "A string that's prepended to every message, and is typically set to the app name",
1086         suggestions: ["pleroma"]
1087       },
1088       %{
1089         key: :format,
1090         type: :string,
1091         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1092         suggestions: ["$metadata[$level] $message"]
1093       },
1094       %{
1095         key: :metadata,
1096         type: {:list, :atom},
1097         suggestions: [:request_id]
1098       }
1099     ]
1100   },
1101   %{
1102     group: :logger,
1103     type: :group,
1104     key: :console,
1105     label: "Console Logger",
1106     description: "Console logger settings",
1107     children: [
1108       %{
1109         key: :level,
1110         type: {:dropdown, :atom},
1111         description: "Log level",
1112         suggestions: [:debug, :info, :warn, :error]
1113       },
1114       %{
1115         key: :format,
1116         type: :string,
1117         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1118         suggestions: ["$metadata[$level] $message"]
1119       },
1120       %{
1121         key: :metadata,
1122         type: {:list, :atom},
1123         suggestions: [:request_id]
1124       }
1125     ]
1126   },
1127   %{
1128     group: :quack,
1129     type: :group,
1130     label: "Quack Logger",
1131     description: "Quack-related settings",
1132     children: [
1133       %{
1134         key: :level,
1135         type: {:dropdown, :atom},
1136         description: "Log level",
1137         suggestions: [:debug, :info, :warn, :error]
1138       },
1139       %{
1140         key: :meta,
1141         type: {:list, :atom},
1142         description: "Configure which metadata you want to report on",
1143         suggestions: [
1144           :application,
1145           :module,
1146           :file,
1147           :function,
1148           :line,
1149           :pid,
1150           :crash_reason,
1151           :initial_call,
1152           :registered_name,
1153           :all,
1154           :none
1155         ]
1156       },
1157       %{
1158         key: :webhook_url,
1159         label: "Webhook URL",
1160         type: :string,
1161         description: "Configure the Slack incoming webhook",
1162         suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1163       }
1164     ]
1165   },
1166   %{
1167     group: :pleroma,
1168     key: :frontend_configurations,
1169     type: :group,
1170     description:
1171       "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1172         "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1173         "add your own configuration your settings all fields must be complete.",
1174     children: [
1175       %{
1176         key: :pleroma_fe,
1177         label: "Pleroma FE",
1178         type: :map,
1179         description: "Settings for Pleroma FE",
1180         suggestions: [
1181           %{
1182             alwaysShowSubjectInput: true,
1183             background: "/static/aurora_borealis.jpg",
1184             collapseMessageWithSubject: false,
1185             greentext: false,
1186             hideFilteredStatuses: false,
1187             hideMutedPosts: false,
1188             hidePostStats: false,
1189             hideSitename: false,
1190             hideUserStats: false,
1191             loginMethod: "password",
1192             logo: "/static/logo.svg",
1193             logoMargin: ".1em",
1194             logoMask: true,
1195             minimalScopesMode: false,
1196             noAttachmentLinks: false,
1197             nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1198             postContentType: "text/plain",
1199             redirectRootLogin: "/main/friends",
1200             redirectRootNoLogin: "/main/all",
1201             scopeCopy: true,
1202             sidebarRight: false,
1203             showFeaturesPanel: true,
1204             showInstanceSpecificPanel: false,
1205             subjectLineBehavior: "email",
1206             theme: "pleroma-dark",
1207             webPushNotifications: false
1208           }
1209         ],
1210         children: [
1211           %{
1212             key: :alwaysShowSubjectInput,
1213             label: "Always show subject input",
1214             type: :boolean,
1215             description: "When disabled, auto-hide the subject field if it's empty"
1216           },
1217           %{
1218             key: :background,
1219             type: {:string, :image},
1220             description:
1221               "URL of the background, unless viewing a user profile with a background that is set",
1222             suggestions: ["/images/city.jpg"]
1223           },
1224           %{
1225             key: :collapseMessageWithSubject,
1226             label: "Collapse message with subject",
1227             type: :boolean,
1228             description:
1229               "When a message has a subject (aka Content Warning), collapse it by default"
1230           },
1231           %{
1232             key: :greentext,
1233             label: "Greentext",
1234             type: :boolean,
1235             description: "Enables green text on lines prefixed with the > character"
1236           },
1237           %{
1238             key: :hideFilteredStatuses,
1239             label: "Hide Filtered Statuses",
1240             type: :boolean,
1241             description: "Hides filtered statuses from timelines"
1242           },
1243           %{
1244             key: :hideMutedPosts,
1245             label: "Hide Muted Posts",
1246             type: :boolean,
1247             description: "Hides muted statuses from timelines"
1248           },
1249           %{
1250             key: :hidePostStats,
1251             label: "Hide post stats",
1252             type: :boolean,
1253             description: "Hide notices statistics (repeats, favorites, ...)"
1254           },
1255           %{
1256             key: :hideSitename,
1257             label: "Hide Sitename",
1258             type: :boolean,
1259             description: "Hides instance name from PleromaFE banner"
1260           },
1261           %{
1262             key: :hideUserStats,
1263             label: "Hide user stats",
1264             type: :boolean,
1265             description:
1266               "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1267           },
1268           %{
1269             key: :logo,
1270             type: {:string, :image},
1271             description: "URL of the logo, defaults to Pleroma's logo",
1272             suggestions: ["/static/logo.svg"]
1273           },
1274           %{
1275             key: :logoMargin,
1276             label: "Logo margin",
1277             type: :string,
1278             description:
1279               "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1280                 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1281             suggestions: [".1em"]
1282           },
1283           %{
1284             key: :logoMask,
1285             label: "Logo mask",
1286             type: :boolean,
1287             description:
1288               "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1289                 "If you want a colorful logo you must disable logoMask."
1290           },
1291           %{
1292             key: :minimalScopesMode,
1293             label: "Minimal scopes mode",
1294             type: :boolean,
1295             description:
1296               "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1297                 "Also prevents replying to a DM with a public post from PleromaFE."
1298           },
1299           %{
1300             key: :nsfwCensorImage,
1301             label: "NSFW Censor Image",
1302             type: {:string, :image},
1303             description:
1304               "URL of the image to use for hiding NSFW media attachments in the timeline",
1305             suggestions: ["/static/img/nsfw.74818f9.png"]
1306           },
1307           %{
1308             key: :postContentType,
1309             label: "Post Content Type",
1310             type: {:dropdown, :atom},
1311             description: "Default post formatting option",
1312             suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1313           },
1314           %{
1315             key: :redirectRootNoLogin,
1316             label: "Redirect root no login",
1317             type: :string,
1318             description:
1319               "Relative URL which indicates where to redirect when a user isn't logged in",
1320             suggestions: ["/main/all"]
1321           },
1322           %{
1323             key: :redirectRootLogin,
1324             label: "Redirect root login",
1325             type: :string,
1326             description:
1327               "Relative URL which indicates where to redirect when a user is logged in",
1328             suggestions: ["/main/friends"]
1329           },
1330           %{
1331             key: :scopeCopy,
1332             label: "Scope copy",
1333             type: :boolean,
1334             description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1335           },
1336           %{
1337             key: :sidebarRight,
1338             label: "Sidebar on Right",
1339             type: :boolean,
1340             description: "Change alignment of sidebar and panels to the right"
1341           },
1342           %{
1343             key: :showFeaturesPanel,
1344             label: "Show instance features panel",
1345             type: :boolean,
1346             description:
1347               "Enables panel displaying functionality of the instance on the About page"
1348           },
1349           %{
1350             key: :showInstanceSpecificPanel,
1351             label: "Show instance specific panel",
1352             type: :boolean,
1353             description: "Whether to show the instance's custom panel"
1354           },
1355           %{
1356             key: :subjectLineBehavior,
1357             label: "Subject line behavior",
1358             type: :string,
1359             description: "Allows changing the default behaviour of subject lines in replies.
1360           `email`: copy and preprend re:, as in email,
1361           `masto`: copy verbatim, as in Mastodon,
1362           `noop`: don't copy the subject.",
1363             suggestions: ["email", "masto", "noop"]
1364           },
1365           %{
1366             key: :theme,
1367             type: :string,
1368             description: "Which theme to use. Available themes are defined in styles.json",
1369             suggestions: ["pleroma-dark"]
1370           }
1371         ]
1372       }
1373     ]
1374   },
1375   %{
1376     group: :pleroma,
1377     key: :assets,
1378     type: :group,
1379     description:
1380       "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1381     children: [
1382       %{
1383         key: :mascots,
1384         type: {:keyword, :map},
1385         description:
1386           "Keyword of mascots, each element must contain both an URL and a mime_type key",
1387         suggestions: [
1388           pleroma_fox_tan: %{
1389             url: "/images/pleroma-fox-tan-smol.png",
1390             mime_type: "image/png"
1391           },
1392           pleroma_fox_tan_shy: %{
1393             url: "/images/pleroma-fox-tan-shy.png",
1394             mime_type: "image/png"
1395           }
1396         ]
1397       },
1398       %{
1399         key: :default_mascot,
1400         type: :atom,
1401         description:
1402           "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1403         suggestions: [
1404           :pleroma_fox_tan
1405         ]
1406       },
1407       %{
1408         key: :default_user_avatar,
1409         type: {:string, :image},
1410         description: "URL of the default user avatar",
1411         suggestions: ["/images/avi.png"]
1412       }
1413     ]
1414   },
1415   %{
1416     group: :pleroma,
1417     key: :manifest,
1418     type: :group,
1419     description:
1420       "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1421     children: [
1422       %{
1423         key: :icons,
1424         type: {:list, :map},
1425         description: "Describe the icons of the app",
1426         suggestion: [
1427           %{
1428             src: "/static/logo.png"
1429           },
1430           %{
1431             src: "/static/icon.png",
1432             type: "image/png"
1433           },
1434           %{
1435             src: "/static/icon.ico",
1436             sizes: "72x72 96x96 128x128 256x256"
1437           }
1438         ]
1439       },
1440       %{
1441         key: :theme_color,
1442         type: :string,
1443         description: "Describe the theme color of the app",
1444         suggestions: ["#282c37", "mediumpurple"]
1445       },
1446       %{
1447         key: :background_color,
1448         type: :string,
1449         description: "Describe the background color of the app",
1450         suggestions: ["#191b22", "aliceblue"]
1451       }
1452     ]
1453   },
1454   %{
1455     group: :pleroma,
1456     key: :media_proxy,
1457     type: :group,
1458     description: "Media proxy",
1459     children: [
1460       %{
1461         key: :enabled,
1462         type: :boolean,
1463         description: "Enables proxying of remote media via the instance's proxy"
1464       },
1465       %{
1466         key: :base_url,
1467         label: "Base URL",
1468         type: :string,
1469         description:
1470           "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1471         suggestions: ["https://example.com"]
1472       },
1473       %{
1474         key: :invalidation,
1475         type: :keyword,
1476         descpiption: "",
1477         suggestions: [
1478           enabled: true,
1479           provider: Pleroma.Web.MediaProxy.Invalidation.Script
1480         ],
1481         children: [
1482           %{
1483             key: :enabled,
1484             type: :boolean,
1485             description: "Enables media cache object invalidation."
1486           },
1487           %{
1488             key: :provider,
1489             type: :module,
1490             description: "Module which will be used to purge objects from the cache.",
1491             suggestions: [
1492               Pleroma.Web.MediaProxy.Invalidation.Script,
1493               Pleroma.Web.MediaProxy.Invalidation.Http
1494             ]
1495           }
1496         ]
1497       },
1498       %{
1499         key: :proxy_opts,
1500         label: "Advanced MediaProxy Options",
1501         type: :keyword,
1502         description: "Internal Pleroma.ReverseProxy settings",
1503         suggestions: [
1504           redirect_on_failure: false,
1505           max_body_length: 25 * 1_048_576,
1506           max_read_duration: 30_000
1507         ],
1508         children: [
1509           %{
1510             key: :redirect_on_failure,
1511             type: :boolean,
1512             description: """
1513             Redirects the client to the origin server upon encountering HTTP errors.\n
1514             Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1515             **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1516             IP addresses of your users to the other servers, bypassing the MediaProxy.
1517             """
1518           },
1519           %{
1520             key: :max_body_length,
1521             type: :integer,
1522             description:
1523               "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1524           },
1525           %{
1526             key: :max_read_duration,
1527             type: :integer,
1528             description: "Timeout (in milliseconds) of GET request to the remote URI."
1529           }
1530         ]
1531       },
1532       %{
1533         key: :whitelist,
1534         type: {:list, :string},
1535         description: "List of hosts with scheme to bypass the MediaProxy",
1536         suggestions: ["http://example.com"]
1537       }
1538     ]
1539   },
1540   %{
1541     group: :pleroma,
1542     key: :media_preview_proxy,
1543     type: :group,
1544     description: "Media preview proxy",
1545     children: [
1546       %{
1547         key: :enabled,
1548         type: :boolean,
1549         description:
1550           "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1551       },
1552       %{
1553         key: :thumbnail_max_width,
1554         type: :integer,
1555         description:
1556           "Max width of preview thumbnail for images (video preview always has original dimensions)."
1557       },
1558       %{
1559         key: :thumbnail_max_height,
1560         type: :integer,
1561         description:
1562           "Max height of preview thumbnail for images (video preview always has original dimensions)."
1563       },
1564       %{
1565         key: :image_quality,
1566         type: :integer,
1567         description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1568       },
1569       %{
1570         key: :min_content_length,
1571         type: :integer,
1572         description:
1573           "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1574       }
1575     ]
1576   },
1577   %{
1578     group: :pleroma,
1579     key: Pleroma.Web.MediaProxy.Invalidation.Http,
1580     type: :group,
1581     description: "HTTP invalidate settings",
1582     children: [
1583       %{
1584         key: :method,
1585         type: :atom,
1586         description: "HTTP method of request. Default: :purge"
1587       },
1588       %{
1589         key: :headers,
1590         type: {:keyword, :string},
1591         description: "HTTP headers of request",
1592         suggestions: [{"x-refresh", 1}]
1593       },
1594       %{
1595         key: :options,
1596         type: :keyword,
1597         description: "Request options",
1598         children: [
1599           %{
1600             key: :params,
1601             type: {:map, :string}
1602           }
1603         ]
1604       }
1605     ]
1606   },
1607   %{
1608     group: :pleroma,
1609     key: Pleroma.Web.MediaProxy.Invalidation.Script,
1610     type: :group,
1611     description: "Invalidation script settings",
1612     children: [
1613       %{
1614         key: :script_path,
1615         type: :string,
1616         description: "Path to executable script which will purge cached items.",
1617         suggestions: ["./installation/nginx-cache-purge.sh.example"]
1618       },
1619       %{
1620         key: :url_format,
1621         label: "URL Format",
1622         type: :string,
1623         description:
1624           "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1625         suggestions: [":htcacheclean"]
1626       }
1627     ]
1628   },
1629   %{
1630     group: :pleroma,
1631     key: :gopher,
1632     type: :group,
1633     description: "Gopher settings",
1634     children: [
1635       %{
1636         key: :enabled,
1637         type: :boolean,
1638         description: "Enables the gopher interface"
1639       },
1640       %{
1641         key: :ip,
1642         label: "IP",
1643         type: :tuple,
1644         description: "IP address to bind to",
1645         suggestions: [{0, 0, 0, 0}]
1646       },
1647       %{
1648         key: :port,
1649         type: :integer,
1650         description: "Port to bind to",
1651         suggestions: [9999]
1652       },
1653       %{
1654         key: :dstport,
1655         type: :integer,
1656         description: "Port advertised in URLs (optional, defaults to port)",
1657         suggestions: [9999]
1658       }
1659     ]
1660   },
1661   %{
1662     group: :pleroma,
1663     key: :activitypub,
1664     label: "ActivityPub",
1665     type: :group,
1666     description: "ActivityPub-related settings",
1667     children: [
1668       %{
1669         key: :unfollow_blocked,
1670         type: :boolean,
1671         description: "Whether blocks result in people getting unfollowed"
1672       },
1673       %{
1674         key: :outgoing_blocks,
1675         type: :boolean,
1676         description: "Whether to federate blocks to other instances"
1677       },
1678       %{
1679         key: :blockers_visible,
1680         type: :boolean,
1681         description: "Whether a user can see someone who has blocked them"
1682       },
1683       %{
1684         key: :sign_object_fetches,
1685         type: :boolean,
1686         description: "Sign object fetches with HTTP signatures"
1687       },
1688       %{
1689         key: :note_replies_output_limit,
1690         type: :integer,
1691         description:
1692           "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1693       },
1694       %{
1695         key: :follow_handshake_timeout,
1696         type: :integer,
1697         description: "Following handshake timeout",
1698         suggestions: [500]
1699       }
1700     ]
1701   },
1702   %{
1703     group: :pleroma,
1704     key: :http_security,
1705     label: "HTTP security",
1706     type: :group,
1707     description: "HTTP security settings",
1708     children: [
1709       %{
1710         key: :enabled,
1711         type: :boolean,
1712         description: "Whether the managed content security policy is enabled"
1713       },
1714       %{
1715         key: :sts,
1716         label: "STS",
1717         type: :boolean,
1718         description: "Whether to additionally send a Strict-Transport-Security header"
1719       },
1720       %{
1721         key: :sts_max_age,
1722         label: "STS max age",
1723         type: :integer,
1724         description: "The maximum age for the Strict-Transport-Security header if sent",
1725         suggestions: [31_536_000]
1726       },
1727       %{
1728         key: :ct_max_age,
1729         label: "CT max age",
1730         type: :integer,
1731         description: "The maximum age for the Expect-CT header if sent",
1732         suggestions: [2_592_000]
1733       },
1734       %{
1735         key: :referrer_policy,
1736         type: :string,
1737         description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1738         suggestions: ["same-origin", "no-referrer"]
1739       },
1740       %{
1741         key: :report_uri,
1742         label: "Report URI",
1743         type: :string,
1744         description: "Adds the specified URL to report-uri and report-to group in CSP header",
1745         suggestions: ["https://example.com/report-uri"]
1746       }
1747     ]
1748   },
1749   %{
1750     group: :web_push_encryption,
1751     key: :vapid_details,
1752     label: "Vapid Details",
1753     type: :group,
1754     description:
1755       "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1756     children: [
1757       %{
1758         key: :subject,
1759         type: :string,
1760         description:
1761           "A mailto link for the administrative contact." <>
1762             " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1763         suggestions: ["mailto:moderators@pleroma.com"]
1764       },
1765       %{
1766         key: :public_key,
1767         type: :string,
1768         description: "VAPID public key",
1769         suggestions: ["Public key"]
1770       },
1771       %{
1772         key: :private_key,
1773         type: :string,
1774         description: "VAPID private key",
1775         suggestions: ["Private key"]
1776       }
1777     ]
1778   },
1779   %{
1780     group: :pleroma,
1781     key: Pleroma.Captcha,
1782     type: :group,
1783     description: "Captcha-related settings",
1784     children: [
1785       %{
1786         key: :enabled,
1787         type: :boolean,
1788         description: "Whether the captcha should be shown on registration"
1789       },
1790       %{
1791         key: :method,
1792         type: :module,
1793         description: "The method/service to use for captcha",
1794         suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1795       },
1796       %{
1797         key: :seconds_valid,
1798         type: :integer,
1799         description: "The time in seconds for which the captcha is valid",
1800         suggestions: [60]
1801       }
1802     ]
1803   },
1804   %{
1805     group: :pleroma,
1806     key: Pleroma.Captcha.Kocaptcha,
1807     type: :group,
1808     description:
1809       "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1810         " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1811     children: [
1812       %{
1813         key: :endpoint,
1814         type: :string,
1815         description: "The kocaptcha endpoint to use",
1816         suggestions: ["https://captcha.kotobank.ch"]
1817       }
1818     ]
1819   },
1820   %{
1821     group: :pleroma,
1822     label: "Pleroma Admin Token",
1823     type: :group,
1824     description:
1825       "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)",
1826     children: [
1827       %{
1828         key: :admin_token,
1829         type: :string,
1830         description: "Admin token",
1831         suggestions: [
1832           "Please use a high entropy string or UUID"
1833         ]
1834       }
1835     ]
1836   },
1837   %{
1838     group: :pleroma,
1839     key: Oban,
1840     type: :group,
1841     description:
1842       "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1843     children: [
1844       %{
1845         key: :log,
1846         type: {:dropdown, :atom},
1847         description: "Logs verbose mode",
1848         suggestions: [false, :error, :warn, :info, :debug]
1849       },
1850       %{
1851         key: :queues,
1852         type: {:keyword, :integer},
1853         description:
1854           "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1855         suggestions: [
1856           activity_expiration: 10,
1857           attachments_cleanup: 5,
1858           background: 5,
1859           federator_incoming: 50,
1860           federator_outgoing: 50,
1861           mailer: 10,
1862           scheduled_activities: 10,
1863           transmogrifier: 20,
1864           web_push: 50
1865         ],
1866         children: [
1867           %{
1868             key: :activity_expiration,
1869             type: :integer,
1870             description: "Activity expiration queue",
1871             suggestions: [10]
1872           },
1873           %{
1874             key: :backup,
1875             type: :integer,
1876             description: "Backup queue",
1877             suggestions: [1]
1878           },
1879           %{
1880             key: :attachments_cleanup,
1881             type: :integer,
1882             description: "Attachment deletion queue",
1883             suggestions: [5]
1884           },
1885           %{
1886             key: :background,
1887             type: :integer,
1888             description: "Background queue",
1889             suggestions: [5]
1890           },
1891           %{
1892             key: :federator_incoming,
1893             type: :integer,
1894             description: "Incoming federation queue",
1895             suggestions: [50]
1896           },
1897           %{
1898             key: :federator_outgoing,
1899             type: :integer,
1900             description: "Outgoing federation queue",
1901             suggestions: [50]
1902           },
1903           %{
1904             key: :mailer,
1905             type: :integer,
1906             description: "Email sender queue, see Pleroma.Emails.Mailer",
1907             suggestions: [10]
1908           },
1909           %{
1910             key: :scheduled_activities,
1911             type: :integer,
1912             description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1913             suggestions: [10]
1914           },
1915           %{
1916             key: :transmogrifier,
1917             type: :integer,
1918             description: "Transmogrifier queue",
1919             suggestions: [20]
1920           },
1921           %{
1922             key: :web_push,
1923             type: :integer,
1924             description: "Web push notifications queue",
1925             suggestions: [50]
1926           }
1927         ]
1928       },
1929       %{
1930         key: :crontab,
1931         type: {:list, :tuple},
1932         description: "Settings for cron background jobs",
1933         suggestions: [
1934           {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1935           {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1936         ]
1937       }
1938     ]
1939   },
1940   %{
1941     group: :pleroma,
1942     key: :workers,
1943     type: :group,
1944     description: "Includes custom worker options not interpretable directly by `Oban`",
1945     children: [
1946       %{
1947         key: :retries,
1948         type: {:keyword, :integer},
1949         description: "Max retry attempts for failed jobs, per `Oban` queue",
1950         suggestions: [
1951           federator_incoming: 5,
1952           federator_outgoing: 5
1953         ]
1954       }
1955     ]
1956   },
1957   %{
1958     group: :pleroma,
1959     key: Pleroma.Web.Metadata,
1960     type: :group,
1961     description: "Metadata-related settings",
1962     children: [
1963       %{
1964         key: :providers,
1965         type: {:list, :module},
1966         description: "List of metadata providers to enable",
1967         suggestions: [
1968           Pleroma.Web.Metadata.Providers.OpenGraph,
1969           Pleroma.Web.Metadata.Providers.TwitterCard,
1970           Pleroma.Web.Metadata.Providers.RelMe,
1971           Pleroma.Web.Metadata.Providers.Feed
1972         ]
1973       },
1974       %{
1975         key: :unfurl_nsfw,
1976         label: "Unfurl NSFW",
1977         type: :boolean,
1978         description: "When enabled NSFW attachments will be shown in previews"
1979       }
1980     ]
1981   },
1982   %{
1983     group: :pleroma,
1984     key: :rich_media,
1985     type: :group,
1986     description:
1987       "If enabled the instance will parse metadata from attached links to generate link previews",
1988     children: [
1989       %{
1990         key: :enabled,
1991         type: :boolean,
1992         description: "Enables RichMedia parsing of URLs"
1993       },
1994       %{
1995         key: :ignore_hosts,
1996         type: {:list, :string},
1997         description: "List of hosts which will be ignored by the metadata parser",
1998         suggestions: ["accounts.google.com", "xss.website"]
1999       },
2000       %{
2001         key: :ignore_tld,
2002         label: "Ignore TLD",
2003         type: {:list, :string},
2004         description: "List TLDs (top-level domains) which will ignore for parse metadata",
2005         suggestions: ["local", "localdomain", "lan"]
2006       },
2007       %{
2008         key: :parsers,
2009         type: {:list, :module},
2010         description:
2011           "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.",
2012         suggestions: [
2013           Pleroma.Web.RichMedia.Parsers.OEmbed,
2014           Pleroma.Web.RichMedia.Parsers.TwitterCard
2015         ]
2016       },
2017       %{
2018         key: :ttl_setters,
2019         label: "TTL setters",
2020         type: {:list, :module},
2021         description:
2022           "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.",
2023         suggestions: [
2024           Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2025         ]
2026       },
2027       %{
2028         key: :failure_backoff,
2029         type: :integer,
2030         description:
2031           "Amount of milliseconds after request failure, during which the request will not be retried.",
2032         suggestions: [60_000]
2033       }
2034     ]
2035   },
2036   %{
2037     group: :pleroma,
2038     key: Pleroma.Formatter,
2039     label: "Linkify",
2040     type: :group,
2041     description:
2042       "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2043     children: [
2044       %{
2045         key: :class,
2046         type: [:string, :boolean],
2047         description: "Specify the class to be added to the generated link. Disable to clear.",
2048         suggestions: ["auto-linker", false]
2049       },
2050       %{
2051         key: :rel,
2052         type: [:string, :boolean],
2053         description: "Override the rel attribute. Disable to clear.",
2054         suggestions: ["ugc", "noopener noreferrer", false]
2055       },
2056       %{
2057         key: :new_window,
2058         type: :boolean,
2059         description: "Link URLs will open in a new window/tab."
2060       },
2061       %{
2062         key: :truncate,
2063         type: [:integer, :boolean],
2064         description:
2065           "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2066         suggestions: [15, false]
2067       },
2068       %{
2069         key: :strip_prefix,
2070         type: :boolean,
2071         description: "Strip the scheme prefix."
2072       },
2073       %{
2074         key: :extra,
2075         type: :boolean,
2076         description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2077       },
2078       %{
2079         key: :validate_tld,
2080         type: [:atom, :boolean],
2081         description:
2082           "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)",
2083         suggestions: [:no_scheme, true]
2084       }
2085     ]
2086   },
2087   %{
2088     group: :pleroma,
2089     key: Pleroma.ScheduledActivity,
2090     type: :group,
2091     description: "Scheduled activities settings",
2092     children: [
2093       %{
2094         key: :daily_user_limit,
2095         type: :integer,
2096         description:
2097           "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2098         suggestions: [25]
2099       },
2100       %{
2101         key: :total_user_limit,
2102         type: :integer,
2103         description:
2104           "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2105         suggestions: [300]
2106       },
2107       %{
2108         key: :enabled,
2109         type: :boolean,
2110         description: "Whether scheduled activities are sent to the job queue to be executed"
2111       }
2112     ]
2113   },
2114   %{
2115     group: :pleroma,
2116     key: Pleroma.Workers.PurgeExpiredActivity,
2117     type: :group,
2118     description: "Expired activities settings",
2119     children: [
2120       %{
2121         key: :enabled,
2122         type: :boolean,
2123         description: "Enables expired activities addition & deletion"
2124       },
2125       %{
2126         key: :min_lifetime,
2127         type: :integer,
2128         description: "Minimum lifetime for ephemeral activity (in seconds)",
2129         suggestions: [600]
2130       }
2131     ]
2132   },
2133   %{
2134     group: :pleroma,
2135     label: "Pleroma Authenticator",
2136     type: :group,
2137     description: "Authenticator",
2138     children: [
2139       %{
2140         key: Pleroma.Web.Auth.Authenticator,
2141         type: :module,
2142         suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2143       }
2144     ]
2145   },
2146   %{
2147     group: :pleroma,
2148     key: :ldap,
2149     label: "LDAP",
2150     type: :group,
2151     description:
2152       "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2153         " will be verified by trying to authenticate (bind) to a LDAP server." <>
2154         " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2155         " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2156     children: [
2157       %{
2158         key: :enabled,
2159         type: :boolean,
2160         description: "Enables LDAP authentication"
2161       },
2162       %{
2163         key: :host,
2164         type: :string,
2165         description: "LDAP server hostname",
2166         suggestions: ["localhosts"]
2167       },
2168       %{
2169         key: :port,
2170         type: :integer,
2171         description: "LDAP port, e.g. 389 or 636",
2172         suggestions: [389, 636]
2173       },
2174       %{
2175         key: :ssl,
2176         label: "SSL",
2177         type: :boolean,
2178         description: "Enable to use SSL, usually implies the port 636"
2179       },
2180       %{
2181         key: :sslopts,
2182         label: "SSL options",
2183         type: :keyword,
2184         description: "Additional SSL options",
2185         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2186         children: [
2187           %{
2188             key: :cacertfile,
2189             type: :string,
2190             description: "Path to file with PEM encoded cacerts",
2191             suggestions: ["path/to/file/with/PEM/cacerts"]
2192           },
2193           %{
2194             key: :verify,
2195             type: :atom,
2196             description: "Type of cert verification",
2197             suggestions: [:verify_peer]
2198           }
2199         ]
2200       },
2201       %{
2202         key: :tls,
2203         label: "TLS",
2204         type: :boolean,
2205         description: "Enable to use STARTTLS, usually implies the port 389"
2206       },
2207       %{
2208         key: :tlsopts,
2209         label: "TLS options",
2210         type: :keyword,
2211         description: "Additional TLS options",
2212         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2213         children: [
2214           %{
2215             key: :cacertfile,
2216             type: :string,
2217             description: "Path to file with PEM encoded cacerts",
2218             suggestions: ["path/to/file/with/PEM/cacerts"]
2219           },
2220           %{
2221             key: :verify,
2222             type: :atom,
2223             description: "Type of cert verification",
2224             suggestions: [:verify_peer]
2225           }
2226         ]
2227       },
2228       %{
2229         key: :base,
2230         type: :string,
2231         description: "LDAP base, e.g. \"dc=example,dc=com\"",
2232         suggestions: ["dc=example,dc=com"]
2233       },
2234       %{
2235         key: :uid,
2236         label: "UID",
2237         type: :string,
2238         description:
2239           "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2240         suggestions: ["cn"]
2241       }
2242     ]
2243   },
2244   %{
2245     group: :pleroma,
2246     key: :auth,
2247     type: :group,
2248     description: "Authentication / authorization settings",
2249     children: [
2250       %{
2251         key: :enforce_oauth_admin_scope_usage,
2252         label: "Enforce OAuth admin scope usage",
2253         type: :boolean,
2254         description:
2255           "OAuth admin scope requirement toggle. " <>
2256             "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2257             "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2258             "`is_admin` user flag grants access to admin-specific actions."
2259       },
2260       %{
2261         key: :auth_template,
2262         type: :string,
2263         description:
2264           "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2265         suggestions: ["show.html"]
2266       },
2267       %{
2268         key: :oauth_consumer_template,
2269         label: "OAuth consumer template",
2270         type: :string,
2271         description:
2272           "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2273             " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2274         suggestions: ["consumer.html"]
2275       },
2276       %{
2277         key: :oauth_consumer_strategies,
2278         label: "OAuth consumer strategies",
2279         type: {:list, :string},
2280         description:
2281           "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2282             " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2283             " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2284         suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2285       }
2286     ]
2287   },
2288   %{
2289     group: :pleroma,
2290     key: :email_notifications,
2291     type: :group,
2292     description: "Email notifications settings",
2293     children: [
2294       %{
2295         key: :digest,
2296         type: :map,
2297         description:
2298           "emails of \"what you've missed\" for users who have been inactive for a while",
2299         suggestions: [
2300           %{
2301             active: false,
2302             schedule: "0 0 * * 0",
2303             interval: 7,
2304             inactivity_threshold: 7
2305           }
2306         ],
2307         children: [
2308           %{
2309             key: :active,
2310             label: "Enabled",
2311             type: :boolean,
2312             description: "Globally enable or disable digest emails"
2313           },
2314           %{
2315             key: :schedule,
2316             type: :string,
2317             description:
2318               "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2319             suggestions: ["0 0 * * 0"]
2320           },
2321           %{
2322             key: :interval,
2323             type: :integer,
2324             description: "Minimum interval between digest emails to one user",
2325             suggestions: [7]
2326           },
2327           %{
2328             key: :inactivity_threshold,
2329             type: :integer,
2330             description: "Minimum user inactivity threshold",
2331             suggestions: [7]
2332           }
2333         ]
2334       }
2335     ]
2336   },
2337   %{
2338     group: :pleroma,
2339     key: Pleroma.Emails.UserEmail,
2340     type: :group,
2341     description: "Email template settings",
2342     children: [
2343       %{
2344         key: :logo,
2345         type: {:string, :image},
2346         description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2347         suggestions: ["some/path/logo.png"]
2348       },
2349       %{
2350         key: :styling,
2351         type: :map,
2352         description: "A map with color settings for email templates.",
2353         suggestions: [
2354           %{
2355             link_color: "#d8a070",
2356             background_color: "#2C3645",
2357             content_background_color: "#1B2635",
2358             header_color: "#d8a070",
2359             text_color: "#b9b9ba",
2360             text_muted_color: "#b9b9ba"
2361           }
2362         ],
2363         children: [
2364           %{
2365             key: :link_color,
2366             type: :string,
2367             suggestions: ["#d8a070"]
2368           },
2369           %{
2370             key: :background_color,
2371             type: :string,
2372             suggestions: ["#2C3645"]
2373           },
2374           %{
2375             key: :content_background_color,
2376             type: :string,
2377             suggestions: ["#1B2635"]
2378           },
2379           %{
2380             key: :header_color,
2381             type: :string,
2382             suggestions: ["#d8a070"]
2383           },
2384           %{
2385             key: :text_color,
2386             type: :string,
2387             suggestions: ["#b9b9ba"]
2388           },
2389           %{
2390             key: :text_muted_color,
2391             type: :string,
2392             suggestions: ["#b9b9ba"]
2393           }
2394         ]
2395       }
2396     ]
2397   },
2398   %{
2399     group: :pleroma,
2400     key: Pleroma.Emails.NewUsersDigestEmail,
2401     type: :group,
2402     description: "New users admin email digest",
2403     children: [
2404       %{
2405         key: :enabled,
2406         type: :boolean,
2407         description: "Enables new users admin digest email when `true`"
2408       }
2409     ]
2410   },
2411   %{
2412     group: :pleroma,
2413     key: :oauth2,
2414     label: "OAuth2",
2415     type: :group,
2416     description: "Configure OAuth 2 provider capabilities",
2417     children: [
2418       %{
2419         key: :token_expires_in,
2420         type: :integer,
2421         description: "The lifetime in seconds of the access token",
2422         suggestions: [2_592_000]
2423       },
2424       %{
2425         key: :issue_new_refresh_token,
2426         type: :boolean,
2427         description:
2428           "Keeps old refresh token or generate new refresh token when to obtain an access token"
2429       },
2430       %{
2431         key: :clean_expired_tokens,
2432         type: :boolean,
2433         description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2434       }
2435     ]
2436   },
2437   %{
2438     group: :pleroma,
2439     key: :emoji,
2440     type: :group,
2441     children: [
2442       %{
2443         key: :shortcode_globs,
2444         type: {:list, :string},
2445         description: "Location of custom emoji files. * can be used as a wildcard.",
2446         suggestions: ["/emoji/custom/**/*.png"]
2447       },
2448       %{
2449         key: :pack_extensions,
2450         type: {:list, :string},
2451         description:
2452           "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2453         suggestions: [".png", ".gif"]
2454       },
2455       %{
2456         key: :groups,
2457         type: {:keyword, {:list, :string}},
2458         description:
2459           "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2460             " and the value is the location or array of locations. * can be used as a wildcard.",
2461         suggestions: [
2462           Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2463         ]
2464       },
2465       %{
2466         key: :default_manifest,
2467         type: :string,
2468         description:
2469           "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2470             " Currently only one manifest can be added (no arrays).",
2471         suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2472       },
2473       %{
2474         key: :shared_pack_cache_seconds_per_file,
2475         label: "Shared pack cache s/file",
2476         type: :integer,
2477         descpiption:
2478           "When an emoji pack is shared, the archive is created and cached in memory" <>
2479             " for this amount of seconds multiplied by the number of files.",
2480         suggestions: [60]
2481       }
2482     ]
2483   },
2484   %{
2485     group: :pleroma,
2486     key: :rate_limit,
2487     type: :group,
2488     description:
2489       "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2490     children: [
2491       %{
2492         key: :search,
2493         type: [:tuple, {:list, :tuple}],
2494         description: "For the search requests (account & status search etc.)",
2495         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2496       },
2497       %{
2498         key: :timeline,
2499         type: [:tuple, {:list, :tuple}],
2500         description: "For requests to timelines (each timeline has it's own limiter)",
2501         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2502       },
2503       %{
2504         key: :app_account_creation,
2505         type: [:tuple, {:list, :tuple}],
2506         description: "For registering user accounts from the same IP address",
2507         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2508       },
2509       %{
2510         key: :relations_actions,
2511         type: [:tuple, {:list, :tuple}],
2512         description: "For actions on relationships with all users (follow, unfollow)",
2513         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2514       },
2515       %{
2516         key: :relation_id_action,
2517         label: "Relation ID action",
2518         type: [:tuple, {:list, :tuple}],
2519         description: "For actions on relation with a specific user (follow, unfollow)",
2520         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2521       },
2522       %{
2523         key: :statuses_actions,
2524         type: [:tuple, {:list, :tuple}],
2525         description:
2526           "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2527         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2528       },
2529       %{
2530         key: :status_id_action,
2531         label: "Status ID action",
2532         type: [:tuple, {:list, :tuple}],
2533         description:
2534           "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2535         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536       },
2537       %{
2538         key: :authentication,
2539         type: [:tuple, {:list, :tuple}],
2540         description: "For authentication create / password check / user existence check requests",
2541         suggestions: [{60_000, 15}]
2542       }
2543     ]
2544   },
2545   %{
2546     group: :esshd,
2547     label: "ESSHD",
2548     type: :group,
2549     description:
2550       "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2551         "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2552     children: [
2553       %{
2554         key: :enabled,
2555         type: :boolean,
2556         description: "Enables SSH"
2557       },
2558       %{
2559         key: :priv_dir,
2560         type: :string,
2561         description: "Dir with SSH keys",
2562         suggestions: ["/some/path/ssh_keys"]
2563       },
2564       %{
2565         key: :handler,
2566         type: :string,
2567         description: "Handler module",
2568         suggestions: ["Pleroma.BBS.Handler"]
2569       },
2570       %{
2571         key: :port,
2572         type: :integer,
2573         description: "Port to connect",
2574         suggestions: [10_022]
2575       },
2576       %{
2577         key: :password_authenticator,
2578         type: :string,
2579         description: "Authenticator module",
2580         suggestions: ["Pleroma.BBS.Authenticator"]
2581       }
2582     ]
2583   },
2584   %{
2585     group: :mime,
2586     label: "Mime Types",
2587     type: :group,
2588     description: "Mime Types settings",
2589     children: [
2590       %{
2591         key: :types,
2592         type: :map,
2593         suggestions: [
2594           %{
2595             "application/xml" => ["xml"],
2596             "application/xrd+xml" => ["xrd+xml"],
2597             "application/jrd+json" => ["jrd+json"],
2598             "application/activity+json" => ["activity+json"],
2599             "application/ld+json" => ["activity+json"]
2600           }
2601         ],
2602         children: [
2603           %{
2604             key: "application/xml",
2605             type: {:list, :string},
2606             suggestions: ["xml"]
2607           },
2608           %{
2609             key: "application/xrd+xml",
2610             type: {:list, :string},
2611             suggestions: ["xrd+xml"]
2612           },
2613           %{
2614             key: "application/jrd+json",
2615             type: {:list, :string},
2616             suggestions: ["jrd+json"]
2617           },
2618           %{
2619             key: "application/activity+json",
2620             type: {:list, :string},
2621             suggestions: ["activity+json"]
2622           },
2623           %{
2624             key: "application/ld+json",
2625             type: {:list, :string},
2626             suggestions: ["activity+json"]
2627           }
2628         ]
2629       }
2630     ]
2631   },
2632   %{
2633     group: :pleroma,
2634     key: :shout,
2635     type: :group,
2636     description: "Pleroma shout settings",
2637     children: [
2638       %{
2639         key: :enabled,
2640         type: :boolean,
2641         description: "Enables the backend Shoutbox chat feature."
2642       },
2643       %{
2644         key: :limit,
2645         type: :integer,
2646         description: "Shout message character limit.",
2647         suggestions: [
2648           5_000
2649         ]
2650       }
2651     ]
2652   },
2653   %{
2654     group: :pleroma,
2655     key: :http,
2656     label: "HTTP",
2657     type: :group,
2658     description: "HTTP settings",
2659     children: [
2660       %{
2661         key: :proxy_url,
2662         label: "Proxy URL",
2663         type: [:string, :tuple],
2664         description: "Proxy URL",
2665         suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2666       },
2667       %{
2668         key: :send_user_agent,
2669         type: :boolean
2670       },
2671       %{
2672         key: :user_agent,
2673         type: [:string, :atom],
2674         description:
2675           "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2676         suggestions: ["Pleroma", :default]
2677       },
2678       %{
2679         key: :adapter,
2680         type: :keyword,
2681         description: "Adapter specific options",
2682         suggestions: [],
2683         children: [
2684           %{
2685             key: :ssl_options,
2686             type: :keyword,
2687             label: "SSL Options",
2688             description: "SSL options for HTTP adapter",
2689             children: [
2690               %{
2691                 key: :versions,
2692                 type: {:list, :atom},
2693                 description: "List of TLS version to use",
2694                 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2695               }
2696             ]
2697           }
2698         ]
2699       }
2700     ]
2701   },
2702   %{
2703     group: :pleroma,
2704     key: :markup,
2705     label: "Markup Settings",
2706     type: :group,
2707     children: [
2708       %{
2709         key: :allow_inline_images,
2710         type: :boolean
2711       },
2712       %{
2713         key: :allow_headings,
2714         type: :boolean
2715       },
2716       %{
2717         key: :allow_tables,
2718         type: :boolean
2719       },
2720       %{
2721         key: :allow_fonts,
2722         type: :boolean
2723       },
2724       %{
2725         key: :scrub_policy,
2726         type: {:list, :module},
2727         description:
2728           "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2729         suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2730       }
2731     ]
2732   },
2733   %{
2734     group: :pleroma,
2735     key: :user,
2736     type: :group,
2737     children: [
2738       %{
2739         key: :deny_follow_blocked,
2740         type: :boolean
2741       }
2742     ]
2743   },
2744   %{
2745     group: :pleroma,
2746     key: Pleroma.User,
2747     type: :group,
2748     children: [
2749       %{
2750         key: :restricted_nicknames,
2751         type: {:list, :string},
2752         description: "List of nicknames users may not register with.",
2753         suggestions: [
2754           ".well-known",
2755           "~",
2756           "about",
2757           "activities",
2758           "api",
2759           "auth",
2760           "check_password",
2761           "dev",
2762           "friend-requests",
2763           "inbox",
2764           "internal",
2765           "main",
2766           "media",
2767           "nodeinfo",
2768           "notice",
2769           "oauth",
2770           "objects",
2771           "ostatus_subscribe",
2772           "pleroma",
2773           "proxy",
2774           "push",
2775           "registration",
2776           "relay",
2777           "settings",
2778           "status",
2779           "tag",
2780           "user-search",
2781           "user_exists",
2782           "users",
2783           "web"
2784         ]
2785       },
2786       %{
2787         key: :email_blacklist,
2788         type: {:list, :string},
2789         description: "List of email domains users may not register with.",
2790         suggestions: ["mailinator.com", "maildrop.cc"]
2791       }
2792     ]
2793   },
2794   %{
2795     group: :cors_plug,
2796     label: "CORS plug config",
2797     type: :group,
2798     children: [
2799       %{
2800         key: :max_age,
2801         type: :integer,
2802         suggestions: [86_400]
2803       },
2804       %{
2805         key: :methods,
2806         type: {:list, :string},
2807         suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2808       },
2809       %{
2810         key: :expose,
2811         type: {:list, :string},
2812         suggestions: [
2813           "Link",
2814           "X-RateLimit-Reset",
2815           "X-RateLimit-Limit",
2816           "X-RateLimit-Remaining",
2817           "X-Request-Id",
2818           "Idempotency-Key"
2819         ]
2820       },
2821       %{
2822         key: :credentials,
2823         type: :boolean
2824       },
2825       %{
2826         key: :headers,
2827         type: {:list, :string},
2828         suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2829       }
2830     ]
2831   },
2832   %{
2833     group: :pleroma,
2834     key: Pleroma.Web.Plugs.RemoteIp,
2835     type: :group,
2836     description: """
2837     `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2838     **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2839     """,
2840     children: [
2841       %{
2842         key: :enabled,
2843         type: :boolean,
2844         description: "Enable/disable the plug. Default: disabled."
2845       },
2846       %{
2847         key: :headers,
2848         type: {:list, :string},
2849         description: """
2850           A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2851         """
2852       },
2853       %{
2854         key: :proxies,
2855         type: {:list, :string},
2856         description:
2857           "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."
2858       },
2859       %{
2860         key: :reserved,
2861         type: {:list, :string},
2862         description: """
2863           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"]`
2864         """
2865       }
2866     ]
2867   },
2868   %{
2869     group: :pleroma,
2870     key: :web_cache_ttl,
2871     label: "Web cache TTL",
2872     type: :group,
2873     description:
2874       "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2875     children: [
2876       %{
2877         key: :activity_pub,
2878         type: :integer,
2879         description:
2880           "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2881         suggestions: [nil]
2882       },
2883       %{
2884         key: :activity_pub_question,
2885         type: :integer,
2886         description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2887         suggestions: [30_000]
2888       }
2889     ]
2890   },
2891   %{
2892     group: :pleroma,
2893     key: :static_fe,
2894     label: "Static FE",
2895     type: :group,
2896     description:
2897       "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2898     children: [
2899       %{
2900         key: :enabled,
2901         type: :boolean,
2902         description: "Enables the rendering of static HTML. Default: disabled."
2903       }
2904     ]
2905   },
2906   %{
2907     group: :pleroma,
2908     key: :feed,
2909     type: :group,
2910     description: "Configure feed rendering",
2911     children: [
2912       %{
2913         key: :post_title,
2914         type: :map,
2915         description: "Configure title rendering",
2916         children: [
2917           %{
2918             key: :max_length,
2919             type: :integer,
2920             description: "Maximum number of characters before truncating title",
2921             suggestions: [100]
2922           },
2923           %{
2924             key: :omission,
2925             type: :string,
2926             description: "Replacement which will be used after truncating string",
2927             suggestions: ["..."]
2928           }
2929         ]
2930       }
2931     ]
2932   },
2933   %{
2934     group: :pleroma,
2935     key: :mrf_follow_bot,
2936     tab: :mrf,
2937     related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2938     label: "MRF FollowBot Policy",
2939     type: :group,
2940     description: "Automatically follows newly discovered accounts.",
2941     children: [
2942       %{
2943         key: :follower_nickname,
2944         type: :string,
2945         description: "The name of the bot account to use for following newly discovered users.",
2946         suggestions: ["followbot"]
2947       }
2948     ]
2949   },
2950   %{
2951     group: :pleroma,
2952     key: :modules,
2953     type: :group,
2954     description: "Custom Runtime Modules",
2955     children: [
2956       %{
2957         key: :runtime_dir,
2958         type: :string,
2959         description: "A path to custom Elixir modules (such as MRF policies)."
2960       }
2961     ]
2962   },
2963   %{
2964     group: :pleroma,
2965     key: :streamer,
2966     type: :group,
2967     description: "Settings for notifications streamer",
2968     children: [
2969       %{
2970         key: :workers,
2971         type: :integer,
2972         description: "Number of workers to send notifications",
2973         suggestions: [3]
2974       },
2975       %{
2976         key: :overflow_workers,
2977         type: :integer,
2978         description: "Maximum number of workers created if pool is empty",
2979         suggestions: [2]
2980       }
2981     ]
2982   },
2983   %{
2984     group: :pleroma,
2985     key: :connections_pool,
2986     type: :group,
2987     description: "Advanced settings for `Gun` connections pool",
2988     children: [
2989       %{
2990         key: :connection_acquisition_wait,
2991         type: :integer,
2992         description:
2993           "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2994         suggestions: [250]
2995       },
2996       %{
2997         key: :connection_acquisition_retries,
2998         type: :integer,
2999         description:
3000           "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3001         suggestions: [5]
3002       },
3003       %{
3004         key: :max_connections,
3005         type: :integer,
3006         description: "Maximum number of connections in the pool. Default: 250 connections.",
3007         suggestions: [250]
3008       },
3009       %{
3010         key: :connect_timeout,
3011         type: :integer,
3012         description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3013         suggestions: [5000]
3014       },
3015       %{
3016         key: :reclaim_multiplier,
3017         type: :integer,
3018         description:
3019           "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",
3020         suggestions: [0.1]
3021       }
3022     ]
3023   },
3024   %{
3025     group: :pleroma,
3026     key: :pools,
3027     type: :group,
3028     description: "Advanced settings for `Gun` workers pools",
3029     children:
3030       Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3031         %{
3032           key: pool_name,
3033           type: :keyword,
3034           description: "Settings for #{pool_name} pool.",
3035           children: [
3036             %{
3037               key: :size,
3038               type: :integer,
3039               description: "Maximum number of concurrent requests in the pool.",
3040               suggestions: [50]
3041             },
3042             %{
3043               key: :max_waiting,
3044               type: :integer,
3045               description:
3046                 "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",
3047               suggestions: [10]
3048             },
3049             %{
3050               key: :recv_timeout,
3051               type: :integer,
3052               description: "Timeout for the pool while gun will wait for response",
3053               suggestions: [10_000]
3054             }
3055           ]
3056         }
3057       end)
3058   },
3059   %{
3060     group: :pleroma,
3061     key: :hackney_pools,
3062     type: :group,
3063     description: "Advanced settings for `Hackney` connections pools",
3064     children: [
3065       %{
3066         key: :federation,
3067         type: :keyword,
3068         description: "Settings for federation pool.",
3069         children: [
3070           %{
3071             key: :max_connections,
3072             type: :integer,
3073             description: "Number workers in the pool.",
3074             suggestions: [50]
3075           },
3076           %{
3077             key: :timeout,
3078             type: :integer,
3079             description: "Timeout while `hackney` will wait for response.",
3080             suggestions: [150_000]
3081           }
3082         ]
3083       },
3084       %{
3085         key: :media,
3086         type: :keyword,
3087         description: "Settings for media pool.",
3088         children: [
3089           %{
3090             key: :max_connections,
3091             type: :integer,
3092             description: "Number workers in the pool.",
3093             suggestions: [50]
3094           },
3095           %{
3096             key: :timeout,
3097             type: :integer,
3098             description: "Timeout while `hackney` will wait for response.",
3099             suggestions: [150_000]
3100           }
3101         ]
3102       },
3103       %{
3104         key: :upload,
3105         type: :keyword,
3106         description: "Settings for upload pool.",
3107         children: [
3108           %{
3109             key: :max_connections,
3110             type: :integer,
3111             description: "Number workers in the pool.",
3112             suggestions: [25]
3113           },
3114           %{
3115             key: :timeout,
3116             type: :integer,
3117             description: "Timeout while `hackney` will wait for response.",
3118             suggestions: [300_000]
3119           }
3120         ]
3121       }
3122     ]
3123   },
3124   %{
3125     group: :pleroma,
3126     key: :restrict_unauthenticated,
3127     label: "Restrict Unauthenticated",
3128     type: :group,
3129     description:
3130       "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3131     children: [
3132       %{
3133         key: :timelines,
3134         type: :map,
3135         description: "Settings for public and federated timelines.",
3136         children: [
3137           %{
3138             key: :local,
3139             type: :boolean,
3140             description: "Disallow view public timeline."
3141           },
3142           %{
3143             key: :federated,
3144             type: :boolean,
3145             description: "Disallow view federated timeline."
3146           }
3147         ]
3148       },
3149       %{
3150         key: :profiles,
3151         type: :map,
3152         description: "Settings for user profiles.",
3153         children: [
3154           %{
3155             key: :local,
3156             type: :boolean,
3157             description: "Disallow view local user profiles."
3158           },
3159           %{
3160             key: :remote,
3161             type: :boolean,
3162             description: "Disallow view remote user profiles."
3163           }
3164         ]
3165       },
3166       %{
3167         key: :activities,
3168         type: :map,
3169         description: "Settings for statuses.",
3170         children: [
3171           %{
3172             key: :local,
3173             type: :boolean,
3174             description: "Disallow view local statuses."
3175           },
3176           %{
3177             key: :remote,
3178             type: :boolean,
3179             description: "Disallow view remote statuses."
3180           }
3181         ]
3182       }
3183     ]
3184   },
3185   %{
3186     group: :pleroma,
3187     key: Pleroma.Web.ApiSpec.CastAndValidate,
3188     type: :group,
3189     children: [
3190       %{
3191         key: :strict,
3192         type: :boolean,
3193         description:
3194           "Enables strict input validation (useful in development, not recommended in production)"
3195       }
3196     ]
3197   },
3198   %{
3199     group: :pleroma,
3200     key: :instances_favicons,
3201     type: :group,
3202     description: "Control favicons for instances",
3203     children: [
3204       %{
3205         key: :enabled,
3206         type: :boolean,
3207         description: "Allow/disallow displaying and getting instances favicons"
3208       }
3209     ]
3210   },
3211   %{
3212     group: :ex_aws,
3213     key: :s3,
3214     type: :group,
3215     descriptions: "S3 service related settings",
3216     children: [
3217       %{
3218         key: :access_key_id,
3219         type: :string,
3220         description: "S3 access key ID",
3221         suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3222       },
3223       %{
3224         key: :secret_access_key,
3225         type: :string,
3226         description: "Secret access key",
3227         suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3228       },
3229       %{
3230         key: :host,
3231         type: :string,
3232         description: "S3 host",
3233         suggestions: ["s3.eu-central-1.amazonaws.com"]
3234       },
3235       %{
3236         key: :region,
3237         type: :string,
3238         description: "S3 region (for AWS)",
3239         suggestions: ["us-east-1"]
3240       }
3241     ]
3242   },
3243   %{
3244     group: :pleroma,
3245     key: :frontends,
3246     type: :group,
3247     description: "Installed frontends management",
3248     children: [
3249       %{
3250         key: :primary,
3251         type: :map,
3252         description: "Primary frontend, the one that is served for all pages by default",
3253         children: installed_frontend_options
3254       },
3255       %{
3256         key: :admin,
3257         type: :map,
3258         description: "Admin frontend",
3259         children: installed_frontend_options
3260       },
3261       %{
3262         key: :available,
3263         type: :map,
3264         description:
3265           "A map containing available frontends and parameters for their installation.",
3266         children: frontend_options
3267       }
3268     ]
3269   },
3270   %{
3271     group: :pleroma,
3272     key: Pleroma.Web.Preload,
3273     type: :group,
3274     description: "Preload-related settings",
3275     children: [
3276       %{
3277         key: :providers,
3278         type: {:list, :module},
3279         description: "List of preload providers to enable",
3280         suggestions: [
3281           Pleroma.Web.Preload.Providers.Instance,
3282           Pleroma.Web.Preload.Providers.User,
3283           Pleroma.Web.Preload.Providers.Timelines,
3284           Pleroma.Web.Preload.Providers.StatusNet
3285         ]
3286       }
3287     ]
3288   },
3289   %{
3290     group: :pleroma,
3291     key: :majic_pool,
3292     type: :group,
3293     description: "Majic/libmagic configuration",
3294     children: [
3295       %{
3296         key: :size,
3297         type: :integer,
3298         description: "Number of majic workers to start.",
3299         suggestions: [2]
3300       }
3301     ]
3302   },
3303   %{
3304     group: :pleroma,
3305     key: Pleroma.User.Backup,
3306     type: :group,
3307     description: "Account Backup",
3308     children: [
3309       %{
3310         key: :purge_after_days,
3311         type: :integer,
3312         description: "Remove backup achives after N days",
3313         suggestions: [30]
3314       },
3315       %{
3316         key: :limit_days,
3317         type: :integer,
3318         description: "Limit user to export not more often than once per N days",
3319         suggestions: [7]
3320       }
3321     ]
3322   },
3323   %{
3324     group: :prometheus,
3325     key: Pleroma.Web.Endpoint.MetricsExporter,
3326     type: :group,
3327     description: "Prometheus app metrics endpoint configuration",
3328     children: [
3329       %{
3330         key: :enabled,
3331         type: :boolean,
3332         description: "[Pleroma extension] Enables app metrics endpoint."
3333       },
3334       %{
3335         key: :ip_whitelist,
3336         label: "IP Whitelist",
3337         type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3338         description: "Restrict access of app metrics endpoint to the specified IP addresses."
3339       },
3340       %{
3341         key: :auth,
3342         type: [:boolean, :tuple],
3343         description: "Enables HTTP Basic Auth for app metrics endpoint.",
3344         suggestion: [false, {:basic, "myusername", "mypassword"}]
3345       },
3346       %{
3347         key: :path,
3348         type: :string,
3349         description: "App metrics endpoint URI path.",
3350         suggestions: ["/api/pleroma/app_metrics"]
3351       },
3352       %{
3353         key: :format,
3354         type: :atom,
3355         description: "App metrics endpoint output format.",
3356         suggestions: [:text, :protobuf]
3357       }
3358     ]
3359   },
3360   %{
3361     group: :pleroma,
3362     key: ConcurrentLimiter,
3363     type: :group,
3364     description: "Limits configuration for background tasks.",
3365     children: [
3366       %{
3367         key: Pleroma.Web.RichMedia.Helpers,
3368         type: :keyword,
3369         description: "Concurrent limits configuration for getting RichMedia for activities.",
3370         suggestions: [max_running: 5, max_waiting: 5],
3371         children: [
3372           %{
3373             key: :max_running,
3374             type: :integer,
3375             description: "Max running concurrently jobs.",
3376             suggestion: [5]
3377           },
3378           %{
3379             key: :max_waiting,
3380             type: :integer,
3381             description: "Max waiting jobs.",
3382             suggestion: [5]
3383           }
3384         ]
3385       },
3386       %{
3387         key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3388         type: :keyword,
3389         description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3390         suggestions: [max_running: 5, max_waiting: 5],
3391         children: [
3392           %{
3393             key: :max_running,
3394             type: :integer,
3395             description: "Max running concurrently jobs.",
3396             suggestion: [5]
3397           },
3398           %{
3399             key: :max_waiting,
3400             type: :integer,
3401             description: "Max waiting jobs.",
3402             suggestion: [5]
3403           }
3404         ]
3405       }
3406     ]
3407   }
3408 ]