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_activity_expiration,
1477     label: "MRF Activity Expiration Policy",
1478     type: :group,
1479     description: "Adds expiration to all local Create Note activities",
1480     children: [
1481       %{
1482         key: :days,
1483         type: :integer,
1484         description: "Default global expiration time for all local Create activities (in days)",
1485         suggestions: [90, 365]
1486       }
1487     ]
1488   },
1489   %{
1490     group: :pleroma,
1491     key: :mrf_subchain,
1492     label: "MRF subchain",
1493     type: :group,
1494     description:
1495       "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1496         " All criteria are configured as a map of regular expressions to lists of policy modules.",
1497     children: [
1498       %{
1499         key: :match_actor,
1500         type: :map,
1501         description: "Matches a series of regular expressions against the actor field",
1502         suggestions: [
1503           %{
1504             ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1505           }
1506         ]
1507       }
1508     ]
1509   },
1510   %{
1511     group: :pleroma,
1512     key: :mrf_rejectnonpublic,
1513     description:
1514       "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1515     label: "MRF reject non public",
1516     type: :group,
1517     children: [
1518       %{
1519         key: :allow_followersonly,
1520         label: "Allow followers-only",
1521         type: :boolean,
1522         description: "Whether to allow followers-only posts"
1523       },
1524       %{
1525         key: :allow_direct,
1526         type: :boolean,
1527         description: "Whether to allow direct messages"
1528       }
1529     ]
1530   },
1531   %{
1532     group: :pleroma,
1533     key: :mrf_hellthread,
1534     label: "MRF hellthread",
1535     type: :group,
1536     description: "Block messages with too much mentions",
1537     children: [
1538       %{
1539         key: :delist_threshold,
1540         type: :integer,
1541         description:
1542           "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1543             " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1544         suggestions: [10]
1545       },
1546       %{
1547         key: :reject_threshold,
1548         type: :integer,
1549         description:
1550           "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1551         suggestions: [20]
1552       }
1553     ]
1554   },
1555   %{
1556     group: :pleroma,
1557     key: :mrf_keyword,
1558     label: "MRF keyword",
1559     type: :group,
1560     description: "Reject or Word-Replace messages with a keyword or regex",
1561     children: [
1562       %{
1563         key: :reject,
1564         type: [:string, :regex],
1565         description:
1566           "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1567         suggestions: ["foo", ~r/foo/iu]
1568       },
1569       %{
1570         key: :federated_timeline_removal,
1571         type: [:string, :regex],
1572         description:
1573           "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.",
1574         suggestions: ["foo", ~r/foo/iu]
1575       },
1576       %{
1577         key: :replace,
1578         type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1579         description:
1580           "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1581         suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1582       }
1583     ]
1584   },
1585   %{
1586     group: :pleroma,
1587     key: :mrf_mention,
1588     label: "MRF mention",
1589     type: :group,
1590     description: "Block messages which mention a user",
1591     children: [
1592       %{
1593         key: :actors,
1594         type: {:list, :string},
1595         description: "A list of actors for which any post mentioning them will be dropped.",
1596         suggestions: ["actor1", "actor2"]
1597       }
1598     ]
1599   },
1600   %{
1601     group: :pleroma,
1602     key: :mrf_vocabulary,
1603     label: "MRF vocabulary",
1604     type: :group,
1605     description: "Filter messages which belong to certain activity vocabularies",
1606     children: [
1607       %{
1608         key: :accept,
1609         type: {:list, :string},
1610         description:
1611           "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1612         suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1613       },
1614       %{
1615         key: :reject,
1616         type: {:list, :string},
1617         description:
1618           "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1619         suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1620       }
1621     ]
1622   },
1623   # %{
1624   #   group: :pleroma,
1625   #   key: :mrf_user_allowlist,
1626   #   type: :group,
1627   #   description:
1628   #     "The keys in this section are the domain names that the policy should apply to." <>
1629   #       " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1630   #   children: [
1631   #     ["example.org": ["https://example.org/users/admin"]],
1632   #     suggestions: [
1633   #       ["example.org": ["https://example.org/users/admin"]]
1634   #     ]
1635   #   ]
1636   # },
1637   %{
1638     group: :pleroma,
1639     key: :media_proxy,
1640     type: :group,
1641     description: "Media proxy",
1642     children: [
1643       %{
1644         key: :enabled,
1645         type: :boolean,
1646         description: "Enables proxying of remote media to the instance's proxy"
1647       },
1648       %{
1649         key: :base_url,
1650         type: :string,
1651         description:
1652           "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1653         suggestions: ["https://example.com"]
1654       },
1655       %{
1656         key: :proxy_opts,
1657         type: :keyword,
1658         description: "Options for Pleroma.ReverseProxy",
1659         suggestions: [
1660           redirect_on_failure: false,
1661           max_body_length: 25 * 1_048_576,
1662           http: [
1663             follow_redirect: true,
1664             pool: :media
1665           ]
1666         ],
1667         children: [
1668           %{
1669             key: :redirect_on_failure,
1670             type: :boolean,
1671             description:
1672               "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1673                 "Any error during body processing will not be redirected as the response is chunked."
1674           },
1675           %{
1676             key: :max_body_length,
1677             type: :integer,
1678             description:
1679               "Limits the content length to be approximately the " <>
1680                 "specified length. It is validated with the `content-length` header and also verified when proxying."
1681           },
1682           %{
1683             key: :http,
1684             type: :keyword,
1685             description: "HTTP options",
1686             children: [
1687               %{
1688                 key: :adapter,
1689                 type: :keyword,
1690                 description: "Adapter specific options",
1691                 children: [
1692                   %{
1693                     key: :ssl_options,
1694                     type: :keyword,
1695                     label: "SSL Options",
1696                     description: "SSL options for HTTP adapter",
1697                     children: [
1698                       %{
1699                         key: :versions,
1700                         type: {:list, :atom},
1701                         description: "List of TLS version to use",
1702                         suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1703                       }
1704                     ]
1705                   }
1706                 ]
1707               },
1708               %{
1709                 key: :proxy_url,
1710                 label: "Proxy URL",
1711                 type: [:string, :tuple],
1712                 description: "Proxy URL",
1713                 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1714               }
1715             ]
1716           }
1717         ]
1718       },
1719       %{
1720         key: :whitelist,
1721         type: {:list, :string},
1722         description: "List of domains to bypass the mediaproxy",
1723         suggestions: ["example.com"]
1724       }
1725     ]
1726   },
1727   %{
1728     group: :pleroma,
1729     key: :gopher,
1730     type: :group,
1731     description: "Gopher settings",
1732     children: [
1733       %{
1734         key: :enabled,
1735         type: :boolean,
1736         description: "Enables the gopher interface"
1737       },
1738       %{
1739         key: :ip,
1740         type: :tuple,
1741         description: "IP address to bind to",
1742         suggestions: [{0, 0, 0, 0}]
1743       },
1744       %{
1745         key: :port,
1746         type: :integer,
1747         description: "Port to bind to",
1748         suggestions: [9999]
1749       },
1750       %{
1751         key: :dstport,
1752         type: :integer,
1753         description: "Port advertised in urls (optional, defaults to port)",
1754         suggestions: [9999]
1755       }
1756     ]
1757   },
1758   %{
1759     group: :pleroma,
1760     key: :activitypub,
1761     type: :group,
1762     description: "ActivityPub-related settings",
1763     children: [
1764       %{
1765         key: :unfollow_blocked,
1766         type: :boolean,
1767         description: "Whether blocks result in people getting unfollowed"
1768       },
1769       %{
1770         key: :outgoing_blocks,
1771         type: :boolean,
1772         description: "Whether to federate blocks to other instances"
1773       },
1774       %{
1775         key: :sign_object_fetches,
1776         type: :boolean,
1777         description: "Sign object fetches with HTTP signatures"
1778       },
1779       %{
1780         key: :note_replies_output_limit,
1781         type: :integer,
1782         description:
1783           "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1784       },
1785       %{
1786         key: :follow_handshake_timeout,
1787         type: :integer,
1788         description: "Following handshake timeout",
1789         suggestions: [500]
1790       }
1791     ]
1792   },
1793   %{
1794     group: :pleroma,
1795     key: :http_security,
1796     type: :group,
1797     description: "HTTP security settings",
1798     children: [
1799       %{
1800         key: :enabled,
1801         type: :boolean,
1802         description: "Whether the managed content security policy is enabled"
1803       },
1804       %{
1805         key: :sts,
1806         label: "STS",
1807         type: :boolean,
1808         description: "Whether to additionally send a Strict-Transport-Security header"
1809       },
1810       %{
1811         key: :sts_max_age,
1812         label: "STS max age",
1813         type: :integer,
1814         description: "The maximum age for the Strict-Transport-Security header if sent",
1815         suggestions: [31_536_000]
1816       },
1817       %{
1818         key: :ct_max_age,
1819         label: "CT max age",
1820         type: :integer,
1821         description: "The maximum age for the Expect-CT header if sent",
1822         suggestions: [2_592_000]
1823       },
1824       %{
1825         key: :referrer_policy,
1826         type: :string,
1827         description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1828         suggestions: ["same-origin", "no-referrer"]
1829       },
1830       %{
1831         key: :report_uri,
1832         label: "Report URI",
1833         type: :string,
1834         description: "Adds the specified url to report-uri and report-to group in CSP header",
1835         suggestions: ["https://example.com/report-uri"]
1836       }
1837     ]
1838   },
1839   %{
1840     group: :web_push_encryption,
1841     key: :vapid_details,
1842     type: :group,
1843     description:
1844       "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1845     children: [
1846       %{
1847         key: :subject,
1848         type: :string,
1849         description:
1850           "A mailto link for the administrative contact." <>
1851             " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1852         suggestions: ["mailto:moderators@pleroma.com"]
1853       },
1854       %{
1855         key: :public_key,
1856         type: :string,
1857         description: "VAPID public key",
1858         suggestions: ["Public key"]
1859       },
1860       %{
1861         key: :private_key,
1862         type: :string,
1863         description: "VAPID private key",
1864         suggestions: ["Private key"]
1865       }
1866     ]
1867   },
1868   %{
1869     group: :pleroma,
1870     key: Pleroma.Captcha,
1871     type: :group,
1872     description: "Captcha-related settings",
1873     children: [
1874       %{
1875         key: :enabled,
1876         type: :boolean,
1877         description: "Whether the captcha should be shown on registration"
1878       },
1879       %{
1880         key: :method,
1881         type: :module,
1882         description: "The method/service to use for captcha",
1883         suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1884       },
1885       %{
1886         key: :seconds_valid,
1887         type: :integer,
1888         description: "The time in seconds for which the captcha is valid",
1889         suggestions: [60]
1890       }
1891     ]
1892   },
1893   %{
1894     group: :pleroma,
1895     key: Pleroma.Captcha.Kocaptcha,
1896     type: :group,
1897     description:
1898       "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1899         " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1900     children: [
1901       %{
1902         key: :endpoint,
1903         type: :string,
1904         description: "The kocaptcha endpoint to use",
1905         suggestions: ["https://captcha.kotobank.ch"]
1906       }
1907     ]
1908   },
1909   %{
1910     group: :pleroma,
1911     type: :group,
1912     description:
1913       "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",
1914     children: [
1915       %{
1916         key: :admin_token,
1917         type: :string,
1918         description: "Token",
1919         suggestions: ["We recommend a secure random string or UUID"]
1920       }
1921     ]
1922   },
1923   %{
1924     group: :pleroma,
1925     key: Oban,
1926     type: :group,
1927     description: """
1928     [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1929
1930     Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1931       it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1932       otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1933       (see https://github.com/sorentwo/oban/issues/52).
1934     """,
1935     children: [
1936       %{
1937         key: :verbose,
1938         type: {:dropdown, :atom},
1939         description: "Logs verbose mode",
1940         suggestions: [false, :error, :warn, :info, :debug]
1941       },
1942       %{
1943         key: :prune,
1944         type: [:atom, :tuple],
1945         description:
1946           "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1947         suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1948       },
1949       %{
1950         key: :queues,
1951         type: {:keyword, :integer},
1952         description:
1953           "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1954         suggestions: [
1955           activity_expiration: 10,
1956           attachments_cleanup: 5,
1957           background: 5,
1958           federator_incoming: 50,
1959           federator_outgoing: 50,
1960           mailer: 10,
1961           scheduled_activities: 10,
1962           transmogrifier: 20,
1963           web_push: 50
1964         ],
1965         children: [
1966           %{
1967             key: :activity_expiration,
1968             type: :integer,
1969             description: "Activity expiration queue",
1970             suggestions: [10]
1971           },
1972           %{
1973             key: :attachments_cleanup,
1974             type: :integer,
1975             description: "Attachment deletion queue",
1976             suggestions: [5]
1977           },
1978           %{
1979             key: :background,
1980             type: :integer,
1981             description: "Background queue",
1982             suggestions: [5]
1983           },
1984           %{
1985             key: :federator_incoming,
1986             type: :integer,
1987             description: "Incoming federation queue",
1988             suggestions: [50]
1989           },
1990           %{
1991             key: :federator_outgoing,
1992             type: :integer,
1993             description: "Outgoing federation queue",
1994             suggestions: [50]
1995           },
1996           %{
1997             key: :mailer,
1998             type: :integer,
1999             description: "Email sender queue, see Pleroma.Emails.Mailer",
2000             suggestions: [10]
2001           },
2002           %{
2003             key: :scheduled_activities,
2004             type: :integer,
2005             description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2006             suggestions: [10]
2007           },
2008           %{
2009             key: :transmogrifier,
2010             type: :integer,
2011             description: "Transmogrifier queue",
2012             suggestions: [20]
2013           },
2014           %{
2015             key: :web_push,
2016             type: :integer,
2017             description: "Web push notifications queue",
2018             suggestions: [50]
2019           }
2020         ]
2021       },
2022       %{
2023         key: :crontab,
2024         type: {:list, :tuple},
2025         description: "Settings for cron background jobs",
2026         suggestions: [
2027           {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2028           {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2029           {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2030           {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2031           {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2032         ]
2033       }
2034     ]
2035   },
2036   %{
2037     group: :pleroma,
2038     key: :workers,
2039     type: :group,
2040     description: "Includes custom worker options not interpretable directly by `Oban`",
2041     children: [
2042       %{
2043         key: :retries,
2044         type: {:keyword, :integer},
2045         description: "Max retry attempts for failed jobs, per `Oban` queue",
2046         suggestions: [
2047           federator_incoming: 5,
2048           federator_outgoing: 5
2049         ]
2050       }
2051     ]
2052   },
2053   %{
2054     group: :pleroma,
2055     key: Pleroma.Web.Metadata,
2056     type: :group,
2057     description: "Metadata-related settings",
2058     children: [
2059       %{
2060         key: :providers,
2061         type: {:list, :module},
2062         description: "List of metadata providers to enable",
2063         suggestions: [
2064           Pleroma.Web.Metadata.Providers.OpenGraph,
2065           Pleroma.Web.Metadata.Providers.TwitterCard,
2066           Pleroma.Web.Metadata.Providers.RelMe,
2067           Pleroma.Web.Metadata.Providers.Feed
2068         ]
2069       },
2070       %{
2071         key: :unfurl_nsfw,
2072         label: "Unfurl NSFW",
2073         type: :boolean,
2074         description: "When enabled NSFW attachments will be shown in previews"
2075       }
2076     ]
2077   },
2078   %{
2079     group: :pleroma,
2080     key: :rich_media,
2081     type: :group,
2082     description:
2083       "If enabled the instance will parse metadata from attached links to generate link previews.",
2084     children: [
2085       %{
2086         key: :enabled,
2087         type: :boolean,
2088         description: "Enables RichMedia parsing of URLs."
2089       },
2090       %{
2091         key: :ignore_hosts,
2092         type: {:list, :string},
2093         description: "List of hosts which will be ignored by the metadata parser.",
2094         suggestions: ["accounts.google.com", "xss.website"]
2095       },
2096       %{
2097         key: :ignore_tld,
2098         label: "Ignore TLD",
2099         type: {:list, :string},
2100         description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2101         suggestions: ["local", "localdomain", "lan"]
2102       },
2103       %{
2104         key: :parsers,
2105         type: {:list, :module},
2106         description:
2107           "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.",
2108         suggestions: [
2109           Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2110           Pleroma.Web.RichMedia.Parsers.OEmbed,
2111           Pleroma.Web.RichMedia.Parsers.OGP,
2112           Pleroma.Web.RichMedia.Parsers.TwitterCard
2113         ]
2114       },
2115       %{
2116         key: :ttl_setters,
2117         label: "TTL setters",
2118         type: {:list, :module},
2119         description:
2120           "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.",
2121         suggestions: [
2122           Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2123         ]
2124       }
2125     ]
2126   },
2127   %{
2128     group: :auto_linker,
2129     key: :opts,
2130     type: :group,
2131     description: "Configuration for the auto_linker library",
2132     children: [
2133       %{
2134         key: :class,
2135         type: [:string, false],
2136         description: "Specify the class to be added to the generated link. Disable to clear",
2137         suggestions: ["auto-linker", false]
2138       },
2139       %{
2140         key: :rel,
2141         type: [:string, false],
2142         description: "Override the rel attribute. Disable to clear",
2143         suggestions: ["ugc", "noopener noreferrer", false]
2144       },
2145       %{
2146         key: :new_window,
2147         type: :boolean,
2148         description: "Link urls will open in new window/tab"
2149       },
2150       %{
2151         key: :truncate,
2152         type: [:integer, false],
2153         description:
2154           "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2155         suggestions: [15, false]
2156       },
2157       %{
2158         key: :strip_prefix,
2159         type: :boolean,
2160         description: "Strip the scheme prefix"
2161       },
2162       %{
2163         key: :extra,
2164         type: :boolean,
2165         description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2166       }
2167     ]
2168   },
2169   %{
2170     group: :pleroma,
2171     key: Pleroma.ScheduledActivity,
2172     type: :group,
2173     description: "Scheduled activities settings",
2174     children: [
2175       %{
2176         key: :daily_user_limit,
2177         type: :integer,
2178         description:
2179           "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2180         suggestions: [25]
2181       },
2182       %{
2183         key: :total_user_limit,
2184         type: :integer,
2185         description:
2186           "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2187         suggestions: [300]
2188       },
2189       %{
2190         key: :enabled,
2191         type: :boolean,
2192         description: "Whether scheduled activities are sent to the job queue to be executed"
2193       }
2194     ]
2195   },
2196   %{
2197     group: :pleroma,
2198     key: Pleroma.ActivityExpiration,
2199     type: :group,
2200     description: "Expired activity settings",
2201     children: [
2202       %{
2203         key: :enabled,
2204         type: :boolean,
2205         description: "Whether expired activities will be sent to the job queue to be deleted"
2206       }
2207     ]
2208   },
2209   %{
2210     group: :pleroma,
2211     type: :group,
2212     description: "Authenticator",
2213     children: [
2214       %{
2215         key: Pleroma.Web.Auth.Authenticator,
2216         type: :module,
2217         suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2218       }
2219     ]
2220   },
2221   %{
2222     group: :pleroma,
2223     key: :ldap,
2224     type: :group,
2225     description:
2226       "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2227         " will be verified by trying to authenticate (bind) to a LDAP server." <>
2228         " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2229         " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2230     children: [
2231       %{
2232         key: :enabled,
2233         type: :boolean,
2234         description: "Enables LDAP authentication"
2235       },
2236       %{
2237         key: :host,
2238         type: :string,
2239         description: "LDAP server hostname",
2240         suggestions: ["localhosts"]
2241       },
2242       %{
2243         key: :port,
2244         type: :integer,
2245         description: "LDAP port, e.g. 389 or 636",
2246         suggestions: [389, 636]
2247       },
2248       %{
2249         key: :ssl,
2250         label: "SSL",
2251         type: :boolean,
2252         description: "Enable to use SSL, usually implies the port 636"
2253       },
2254       %{
2255         key: :sslopts,
2256         label: "SSL options",
2257         type: :keyword,
2258         description: "Additional SSL options",
2259         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2260         children: [
2261           %{
2262             key: :cacertfile,
2263             type: :string,
2264             description: "Path to file with PEM encoded cacerts",
2265             suggestions: ["path/to/file/with/PEM/cacerts"]
2266           },
2267           %{
2268             key: :verify,
2269             type: :atom,
2270             description: "Type of cert verification",
2271             suggestions: [:verify_peer]
2272           }
2273         ]
2274       },
2275       %{
2276         key: :tls,
2277         label: "TLS",
2278         type: :boolean,
2279         description: "Enable to use STARTTLS, usually implies the port 389"
2280       },
2281       %{
2282         key: :tlsopts,
2283         label: "TLS options",
2284         type: :keyword,
2285         description: "Additional TLS options",
2286         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2287         children: [
2288           %{
2289             key: :cacertfile,
2290             type: :string,
2291             description: "Path to file with PEM encoded cacerts",
2292             suggestions: ["path/to/file/with/PEM/cacerts"]
2293           },
2294           %{
2295             key: :verify,
2296             type: :atom,
2297             description: "Type of cert verification",
2298             suggestions: [:verify_peer]
2299           }
2300         ]
2301       },
2302       %{
2303         key: :base,
2304         type: :string,
2305         description: "LDAP base, e.g. \"dc=example,dc=com\"",
2306         suggestions: ["dc=example,dc=com"]
2307       },
2308       %{
2309         key: :uid,
2310         type: :string,
2311         description:
2312           "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2313         suggestions: ["cn"]
2314       }
2315     ]
2316   },
2317   %{
2318     group: :pleroma,
2319     key: :auth,
2320     type: :group,
2321     description: "Authentication / authorization settings",
2322     children: [
2323       %{
2324         key: :enforce_oauth_admin_scope_usage,
2325         type: :boolean,
2326         description:
2327           "OAuth admin scope requirement toggle. " <>
2328             "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2329             "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2330             "`is_admin` user flag grants access to admin-specific actions."
2331       },
2332       %{
2333         key: :auth_template,
2334         type: :string,
2335         description:
2336           "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2337         suggestions: ["show.html"]
2338       },
2339       %{
2340         key: :oauth_consumer_template,
2341         type: :string,
2342         description:
2343           "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2344             " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2345         suggestions: ["consumer.html"]
2346       },
2347       %{
2348         key: :oauth_consumer_strategies,
2349         type: {:list, :string},
2350         description:
2351           "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2352             " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2353             " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2354         suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2355       }
2356     ]
2357   },
2358   %{
2359     group: :pleroma,
2360     key: :email_notifications,
2361     type: :group,
2362     description: "Email notifications settings",
2363     children: [
2364       %{
2365         key: :digest,
2366         type: :map,
2367         description:
2368           "emails of \"what you've missed\" for users who have been inactive for a while",
2369         suggestions: [
2370           %{
2371             active: false,
2372             schedule: "0 0 * * 0",
2373             interval: 7,
2374             inactivity_threshold: 7
2375           }
2376         ],
2377         children: [
2378           %{
2379             key: :active,
2380             label: "Enabled",
2381             type: :boolean,
2382             description: "Globally enable or disable digest emails"
2383           },
2384           %{
2385             key: :schedule,
2386             type: :string,
2387             description:
2388               "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2389             suggestions: ["0 0 * * 0"]
2390           },
2391           %{
2392             key: :interval,
2393             type: :integer,
2394             description: "Minimum interval between digest emails to one user",
2395             suggestions: [7]
2396           },
2397           %{
2398             key: :inactivity_threshold,
2399             type: :integer,
2400             description: "Minimum user inactivity threshold",
2401             suggestions: [7]
2402           }
2403         ]
2404       }
2405     ]
2406   },
2407   %{
2408     group: :pleroma,
2409     key: Pleroma.Emails.UserEmail,
2410     type: :group,
2411     description: "Email template settings",
2412     children: [
2413       %{
2414         key: :logo,
2415         type: :string,
2416         description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2417         suggestions: ["some/path/logo.png"]
2418       },
2419       %{
2420         key: :styling,
2421         type: :map,
2422         description: "a map with color settings for email templates.",
2423         suggestions: [
2424           %{
2425             link_color: "#d8a070",
2426             background_color: "#2C3645",
2427             content_background_color: "#1B2635",
2428             header_color: "#d8a070",
2429             text_color: "#b9b9ba",
2430             text_muted_color: "#b9b9ba"
2431           }
2432         ],
2433         children: [
2434           %{
2435             key: :link_color,
2436             type: :string,
2437             suggestions: ["#d8a070"]
2438           },
2439           %{
2440             key: :background_color,
2441             type: :string,
2442             suggestions: ["#2C3645"]
2443           },
2444           %{
2445             key: :content_background_color,
2446             type: :string,
2447             suggestions: ["#1B2635"]
2448           },
2449           %{
2450             key: :header_color,
2451             type: :string,
2452             suggestions: ["#d8a070"]
2453           },
2454           %{
2455             key: :text_color,
2456             type: :string,
2457             suggestions: ["#b9b9ba"]
2458           },
2459           %{
2460             key: :text_muted_color,
2461             type: :string,
2462             suggestions: ["#b9b9ba"]
2463           }
2464         ]
2465       }
2466     ]
2467   },
2468   %{
2469     group: :pleroma,
2470     key: Pleroma.Emails.NewUsersDigestEmail,
2471     type: :group,
2472     description: "New users admin email digest",
2473     children: [
2474       %{
2475         key: :enabled,
2476         type: :boolean,
2477         description: "enables new users admin digest email when `true`",
2478         suggestions: [false]
2479       }
2480     ]
2481   },
2482   %{
2483     group: :pleroma,
2484     key: :oauth2,
2485     type: :group,
2486     description: "Configure OAuth 2 provider capabilities",
2487     children: [
2488       %{
2489         key: :token_expires_in,
2490         type: :integer,
2491         description: "The lifetime in seconds of the access token",
2492         suggestions: [600]
2493       },
2494       %{
2495         key: :issue_new_refresh_token,
2496         type: :boolean,
2497         description:
2498           "Keeps old refresh token or generate new refresh token when to obtain an access token"
2499       },
2500       %{
2501         key: :clean_expired_tokens,
2502         type: :boolean,
2503         description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2504       }
2505     ]
2506   },
2507   %{
2508     group: :pleroma,
2509     key: :emoji,
2510     type: :group,
2511     children: [
2512       %{
2513         key: :shortcode_globs,
2514         type: {:list, :string},
2515         description: "Location of custom emoji files. * can be used as a wildcard.",
2516         suggestions: ["/emoji/custom/**/*.png"]
2517       },
2518       %{
2519         key: :pack_extensions,
2520         type: {:list, :string},
2521         description:
2522           "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2523         suggestions: [".png", ".gif"]
2524       },
2525       %{
2526         key: :groups,
2527         type: {:keyword, :string, {:list, :string}},
2528         description:
2529           "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2530             " and the value is the location or array of locations. * can be used as a wildcard.",
2531         suggestions: [
2532           Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2533         ]
2534       },
2535       %{
2536         key: :default_manifest,
2537         type: :string,
2538         description:
2539           "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2540             " Currently only one manifest can be added (no arrays).",
2541         suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2542       },
2543       %{
2544         key: :shared_pack_cache_seconds_per_file,
2545         label: "Shared pack cache s/file",
2546         type: :integer,
2547         descpiption:
2548           "When an emoji pack is shared, the archive is created and cached in memory" <>
2549             " for this amount of seconds multiplied by the number of files.",
2550         suggestions: [60]
2551       }
2552     ]
2553   },
2554   %{
2555     group: :pleroma,
2556     key: :rate_limit,
2557     type: :group,
2558     description:
2559       "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2560     children: [
2561       %{
2562         key: :search,
2563         type: [:tuple, {:list, :tuple}],
2564         description: "For the search requests (account & status search etc.)",
2565         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566       },
2567       %{
2568         key: :timeline,
2569         type: [:tuple, {:list, :tuple}],
2570         description: "For requests to timelines (each timeline has it's own limiter)",
2571         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2572       },
2573       %{
2574         key: :app_account_creation,
2575         type: [:tuple, {:list, :tuple}],
2576         description: "For registering user accounts from the same IP address",
2577         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2578       },
2579       %{
2580         key: :relations_actions,
2581         type: [:tuple, {:list, :tuple}],
2582         description: "For actions on relationships with all users (follow, unfollow)",
2583         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2584       },
2585       %{
2586         key: :relation_id_action,
2587         type: [:tuple, {:list, :tuple}],
2588         description: "For actions on relation with a specific user (follow, unfollow)",
2589         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2590       },
2591       %{
2592         key: :statuses_actions,
2593         type: [:tuple, {:list, :tuple}],
2594         description:
2595           "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2596         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2597       },
2598       %{
2599         key: :status_id_action,
2600         type: [:tuple, {:list, :tuple}],
2601         description:
2602           "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2603         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2604       },
2605       %{
2606         key: :authentication,
2607         type: [:tuple, {:list, :tuple}],
2608         description: "For authentication create / password check / user existence check requests",
2609         suggestions: [{60_000, 15}]
2610       }
2611     ]
2612   },
2613   %{
2614     group: :esshd,
2615     type: :group,
2616     description:
2617       "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2618         "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2619     children: [
2620       %{
2621         key: :enabled,
2622         type: :boolean,
2623         description: "Enables SSH"
2624       },
2625       %{
2626         key: :priv_dir,
2627         type: :string,
2628         description: "Dir with SSH keys",
2629         suggestions: ["/some/path/ssh_keys"]
2630       },
2631       %{
2632         key: :handler,
2633         type: :string,
2634         description: "Handler module",
2635         suggestions: ["Pleroma.BBS.Handler"]
2636       },
2637       %{
2638         key: :port,
2639         type: :integer,
2640         description: "Port to connect",
2641         suggestions: [10_022]
2642       },
2643       %{
2644         key: :password_authenticator,
2645         type: :string,
2646         description: "Authenticator module",
2647         suggestions: ["Pleroma.BBS.Authenticator"]
2648       }
2649     ]
2650   },
2651   %{
2652     group: :mime,
2653     type: :group,
2654     description: "Mime types",
2655     children: [
2656       %{
2657         key: :types,
2658         type: :map,
2659         suggestions: [
2660           %{
2661             "application/xml" => ["xml"],
2662             "application/xrd+xml" => ["xrd+xml"],
2663             "application/jrd+json" => ["jrd+json"],
2664             "application/activity+json" => ["activity+json"],
2665             "application/ld+json" => ["activity+json"]
2666           }
2667         ],
2668         children: [
2669           %{
2670             key: "application/xml",
2671             type: {:list, :string},
2672             suggestions: ["xml"]
2673           },
2674           %{
2675             key: "application/xrd+xml",
2676             type: {:list, :string},
2677             suggestions: ["xrd+xml"]
2678           },
2679           %{
2680             key: "application/jrd+json",
2681             type: {:list, :string},
2682             suggestions: ["jrd+json"]
2683           },
2684           %{
2685             key: "application/activity+json",
2686             type: {:list, :string},
2687             suggestions: ["activity+json"]
2688           },
2689           %{
2690             key: "application/ld+json",
2691             type: {:list, :string},
2692             suggestions: ["activity+json"]
2693           }
2694         ]
2695       }
2696     ]
2697   },
2698   %{
2699     group: :pleroma,
2700     key: :chat,
2701     type: :group,
2702     description: "Pleroma chat settings",
2703     children: [
2704       %{
2705         key: :enabled,
2706         type: :boolean
2707       }
2708     ]
2709   },
2710   %{
2711     group: :pleroma,
2712     key: :http,
2713     type: :group,
2714     description: "HTTP settings",
2715     children: [
2716       %{
2717         key: :proxy_url,
2718         label: "Proxy URL",
2719         type: [:string, :tuple],
2720         description: "Proxy URL",
2721         suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2722       },
2723       %{
2724         key: :send_user_agent,
2725         type: :boolean
2726       },
2727       %{
2728         key: :user_agent,
2729         type: [:string, :atom],
2730         description:
2731           "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2732         suggestions: ["Pleroma", :default]
2733       },
2734       %{
2735         key: :adapter,
2736         type: :keyword,
2737         description: "Adapter specific options",
2738         suggestions: [],
2739         children: [
2740           %{
2741             key: :ssl_options,
2742             type: :keyword,
2743             label: "SSL Options",
2744             description: "SSL options for HTTP adapter",
2745             children: [
2746               %{
2747                 key: :versions,
2748                 type: {:list, :atom},
2749                 description: "List of TLS version to use",
2750                 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2751               }
2752             ]
2753           }
2754         ]
2755       }
2756     ]
2757   },
2758   %{
2759     group: :pleroma,
2760     key: :markup,
2761     type: :group,
2762     children: [
2763       %{
2764         key: :allow_inline_images,
2765         type: :boolean
2766       },
2767       %{
2768         key: :allow_headings,
2769         type: :boolean
2770       },
2771       %{
2772         key: :allow_tables,
2773         type: :boolean
2774       },
2775       %{
2776         key: :allow_fonts,
2777         type: :boolean
2778       },
2779       %{
2780         key: :scrub_policy,
2781         type: {:list, :module},
2782         description:
2783           "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2784         suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2785       }
2786     ]
2787   },
2788   %{
2789     group: :pleroma,
2790     key: :user,
2791     type: :group,
2792     children: [
2793       %{
2794         key: :deny_follow_blocked,
2795         type: :boolean
2796       }
2797     ]
2798   },
2799   %{
2800     group: :pleroma,
2801     key: :mrf_normalize_markup,
2802     label: "MRF normalize markup",
2803     description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2804     type: :group,
2805     children: [
2806       %{
2807         key: :scrub_policy,
2808         type: :module,
2809         suggestions: [Pleroma.HTML.Scrubber.Default]
2810       }
2811     ]
2812   },
2813   %{
2814     group: :pleroma,
2815     key: Pleroma.User,
2816     type: :group,
2817     children: [
2818       %{
2819         key: :restricted_nicknames,
2820         type: {:list, :string},
2821         suggestions: [
2822           ".well-known",
2823           "~",
2824           "about",
2825           "activities",
2826           "api",
2827           "auth",
2828           "check_password",
2829           "dev",
2830           "friend-requests",
2831           "inbox",
2832           "internal",
2833           "main",
2834           "media",
2835           "nodeinfo",
2836           "notice",
2837           "oauth",
2838           "objects",
2839           "ostatus_subscribe",
2840           "pleroma",
2841           "proxy",
2842           "push",
2843           "registration",
2844           "relay",
2845           "settings",
2846           "status",
2847           "tag",
2848           "user-search",
2849           "user_exists",
2850           "users",
2851           "web"
2852         ]
2853       }
2854     ]
2855   },
2856   %{
2857     group: :cors_plug,
2858     type: :group,
2859     children: [
2860       %{
2861         key: :max_age,
2862         type: :integer,
2863         suggestions: [86_400]
2864       },
2865       %{
2866         key: :methods,
2867         type: {:list, :string},
2868         suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2869       },
2870       %{
2871         key: :expose,
2872         type: {:list, :string},
2873         suggestions: [
2874           "Link",
2875           "X-RateLimit-Reset",
2876           "X-RateLimit-Limit",
2877           "X-RateLimit-Remaining",
2878           "X-Request-Id",
2879           "Idempotency-Key"
2880         ]
2881       },
2882       %{
2883         key: :credentials,
2884         type: :boolean
2885       },
2886       %{
2887         key: :headers,
2888         type: {:list, :string},
2889         suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2890       }
2891     ]
2892   },
2893   %{
2894     group: :pleroma,
2895     key: Pleroma.Plugs.RemoteIp,
2896     type: :group,
2897     description: """
2898     `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2899     **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2900     """,
2901     children: [
2902       %{
2903         key: :enabled,
2904         type: :boolean,
2905         description: "Enable/disable the plug. Default: disabled."
2906       },
2907       %{
2908         key: :headers,
2909         type: {:list, :string},
2910         description:
2911           "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]`."
2912       },
2913       %{
2914         key: :proxies,
2915         type: {:list, :string},
2916         description:
2917           "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2918       },
2919       %{
2920         key: :reserved,
2921         type: {:list, :string},
2922         description:
2923           "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2924       }
2925     ]
2926   },
2927   %{
2928     group: :pleroma,
2929     key: :web_cache_ttl,
2930     type: :group,
2931     description:
2932       "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2933     children: [
2934       %{
2935         key: :activity_pub,
2936         type: :integer,
2937         description:
2938           "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2939         suggestions: [30_000, nil]
2940       },
2941       %{
2942         key: :activity_pub_question,
2943         type: :integer,
2944         description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2945         suggestions: [30_000]
2946       }
2947     ]
2948   },
2949   %{
2950     group: :pleroma,
2951     key: :static_fe,
2952     type: :group,
2953     description:
2954       "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2955     children: [
2956       %{
2957         key: :enabled,
2958         type: :boolean,
2959         description: "Enables the rendering of static HTML. Default: disabled."
2960       }
2961     ]
2962   },
2963   %{
2964     group: :pleroma,
2965     key: :feed,
2966     type: :group,
2967     description: "Configure feed rendering",
2968     children: [
2969       %{
2970         key: :post_title,
2971         type: :map,
2972         description: "Configure title rendering.",
2973         children: [
2974           %{
2975             key: :max_length,
2976             type: :integer,
2977             description: "Maximum number of characters before truncating title.",
2978             suggestions: [100]
2979           },
2980           %{
2981             key: :omission,
2982             type: :string,
2983             description: "Replacement which will be used after truncating string.",
2984             suggestions: ["..."]
2985           }
2986         ]
2987       }
2988     ]
2989   },
2990   %{
2991     group: :pleroma,
2992     key: :mrf_object_age,
2993     type: :group,
2994     description: "Rejects or delists posts based on their age when received.",
2995     children: [
2996       %{
2997         key: :threshold,
2998         type: :integer,
2999         description: "Required age (in seconds) of a post before actions are taken.",
3000         suggestions: [172_800]
3001       },
3002       %{
3003         key: :actions,
3004         type: {:list, :atom},
3005         description:
3006           "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3007             "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3008             "`:reject` rejects the message entirely",
3009         suggestions: [:delist, :strip_followers, :reject]
3010       }
3011     ]
3012   },
3013   %{
3014     group: :pleroma,
3015     key: :modules,
3016     type: :group,
3017     description: "Custom Runtime Modules",
3018     children: [
3019       %{
3020         key: :runtime_dir,
3021         type: :string,
3022         description: "A path to custom Elixir modules (such as MRF policies)."
3023       }
3024     ]
3025   },
3026   %{
3027     group: :pleroma,
3028     key: :streamer,
3029     type: :group,
3030     description: "Settings for notifications streamer",
3031     children: [
3032       %{
3033         key: :workers,
3034         type: :integer,
3035         description: "Number of workers to send notifications.",
3036         suggestions: [3]
3037       },
3038       %{
3039         key: :overflow_workers,
3040         type: :integer,
3041         description: "Maximum number of workers created if pool is empty.",
3042         suggestions: [2]
3043       }
3044     ]
3045   },
3046   %{
3047     group: :pleroma,
3048     key: :connections_pool,
3049     type: :group,
3050     description: "Advanced settings for `gun` connections pool",
3051     children: [
3052       %{
3053         key: :checkin_timeout,
3054         type: :integer,
3055         description: "Timeout to checkin connection from pool. Default: 250ms.",
3056         suggestions: [250]
3057       },
3058       %{
3059         key: :max_connections,
3060         type: :integer,
3061         description: "Maximum number of connections in the pool. Default: 250 connections.",
3062         suggestions: [250]
3063       },
3064       %{
3065         key: :retry,
3066         type: :integer,
3067         description:
3068           "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3069         suggestions: [1]
3070       },
3071       %{
3072         key: :retry_timeout,
3073         type: :integer,
3074         description:
3075           "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3076         suggestions: [1000]
3077       },
3078       %{
3079         key: :await_up_timeout,
3080         type: :integer,
3081         description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3082         suggestions: [5000]
3083       }
3084     ]
3085   },
3086   %{
3087     group: :pleroma,
3088     key: :pools,
3089     type: :group,
3090     description: "Advanced settings for `gun` workers pools",
3091     children: [
3092       %{
3093         key: :federation,
3094         type: :keyword,
3095         description: "Settings for federation pool.",
3096         children: [
3097           %{
3098             key: :size,
3099             type: :integer,
3100             description: "Number workers in the pool.",
3101             suggestions: [50]
3102           },
3103           %{
3104             key: :max_overflow,
3105             type: :integer,
3106             description: "Number of additional workers if pool is under load.",
3107             suggestions: [10]
3108           },
3109           %{
3110             key: :timeout,
3111             type: :integer,
3112             description: "Timeout while `gun` will wait for response.",
3113             suggestions: [150_000]
3114           }
3115         ]
3116       },
3117       %{
3118         key: :media,
3119         type: :keyword,
3120         description: "Settings for media pool.",
3121         children: [
3122           %{
3123             key: :size,
3124             type: :integer,
3125             description: "Number workers in the pool.",
3126             suggestions: [50]
3127           },
3128           %{
3129             key: :max_overflow,
3130             type: :integer,
3131             description: "Number of additional workers if pool is under load.",
3132             suggestions: [10]
3133           },
3134           %{
3135             key: :timeout,
3136             type: :integer,
3137             description: "Timeout while `gun` will wait for response.",
3138             suggestions: [150_000]
3139           }
3140         ]
3141       },
3142       %{
3143         key: :upload,
3144         type: :keyword,
3145         description: "Settings for upload pool.",
3146         children: [
3147           %{
3148             key: :size,
3149             type: :integer,
3150             description: "Number workers in the pool.",
3151             suggestions: [25]
3152           },
3153           %{
3154             key: :max_overflow,
3155             type: :integer,
3156             description: "Number of additional workers if pool is under load.",
3157             suggestions: [5]
3158           },
3159           %{
3160             key: :timeout,
3161             type: :integer,
3162             description: "Timeout while `gun` will wait for response.",
3163             suggestions: [300_000]
3164           }
3165         ]
3166       },
3167       %{
3168         key: :default,
3169         type: :keyword,
3170         description: "Settings for default pool.",
3171         children: [
3172           %{
3173             key: :size,
3174             type: :integer,
3175             description: "Number workers in the pool.",
3176             suggestions: [10]
3177           },
3178           %{
3179             key: :max_overflow,
3180             type: :integer,
3181             description: "Number of additional workers if pool is under load.",
3182             suggestions: [2]
3183           },
3184           %{
3185             key: :timeout,
3186             type: :integer,
3187             description: "Timeout while `gun` will wait for response.",
3188             suggestions: [10_000]
3189           }
3190         ]
3191       }
3192     ]
3193   },
3194   %{
3195     group: :pleroma,
3196     key: :hackney_pools,
3197     type: :group,
3198     description: "Advanced settings for `hackney` connections pools",
3199     children: [
3200       %{
3201         key: :federation,
3202         type: :keyword,
3203         description: "Settings for federation pool.",
3204         children: [
3205           %{
3206             key: :max_connections,
3207             type: :integer,
3208             description: "Number workers in the pool.",
3209             suggestions: [50]
3210           },
3211           %{
3212             key: :timeout,
3213             type: :integer,
3214             description: "Timeout while `hackney` will wait for response.",
3215             suggestions: [150_000]
3216           }
3217         ]
3218       },
3219       %{
3220         key: :media,
3221         type: :keyword,
3222         description: "Settings for media pool.",
3223         children: [
3224           %{
3225             key: :max_connections,
3226             type: :integer,
3227             description: "Number workers in the pool.",
3228             suggestions: [50]
3229           },
3230           %{
3231             key: :timeout,
3232             type: :integer,
3233             description: "Timeout while `hackney` will wait for response.",
3234             suggestions: [150_000]
3235           }
3236         ]
3237       },
3238       %{
3239         key: :upload,
3240         type: :keyword,
3241         description: "Settings for upload pool.",
3242         children: [
3243           %{
3244             key: :max_connections,
3245             type: :integer,
3246             description: "Number workers in the pool.",
3247             suggestions: [25]
3248           },
3249           %{
3250             key: :timeout,
3251             type: :integer,
3252             description: "Timeout while `hackney` will wait for response.",
3253             suggestions: [300_000]
3254           }
3255         ]
3256       }
3257     ]
3258   },
3259   %{
3260     group: :pleroma,
3261     key: :restrict_unauthenticated,
3262     type: :group,
3263     description:
3264       "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3265     children: [
3266       %{
3267         key: :timelines,
3268         type: :map,
3269         description: "Settings for public and federated timelines.",
3270         children: [
3271           %{
3272             key: :local,
3273             type: :boolean,
3274             description: "Disallow view public timeline."
3275           },
3276           %{
3277             key: :federated,
3278             type: :boolean,
3279             description: "Disallow view federated timeline."
3280           }
3281         ]
3282       },
3283       %{
3284         key: :profiles,
3285         type: :map,
3286         description: "Settings for user profiles.",
3287         children: [
3288           %{
3289             key: :local,
3290             type: :boolean,
3291             description: "Disallow view local user profiles."
3292           },
3293           %{
3294             key: :remote,
3295             type: :boolean,
3296             description: "Disallow view remote user profiles."
3297           }
3298         ]
3299       },
3300       %{
3301         key: :activities,
3302         type: :map,
3303         description: "Settings for statuses.",
3304         children: [
3305           %{
3306             key: :local,
3307             type: :boolean,
3308             description: "Disallow view local statuses."
3309           },
3310           %{
3311             key: :remote,
3312             type: :boolean,
3313             description: "Disallow view remote statuses."
3314           }
3315         ]
3316       }
3317     ]
3318   },
3319   %{
3320     group: :pleroma,
3321     key: Pleroma.Web.ApiSpec.CastAndValidate,
3322     type: :group,
3323     children: [
3324       %{
3325         key: :strict,
3326         type: :boolean,
3327         description:
3328           "Enables strict input validation (useful in development, not recommended in production)",
3329         suggestions: [false]
3330       }
3331     ]
3332   }
3333 ]