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

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