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

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