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