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