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