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

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