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