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

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