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

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