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