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