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