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:
 641           "Enable registrations for anyone. Invitations require this setting to be disabled."
 642       },
 643       %{
 644         key: :invites_enabled,
 645         type: :boolean,
 646         description:
 647           "Enable user invitations for admins (depends on `registrations_open` being disabled)."
 648       },
 649       %{
 650         key: :account_activation_required,
 651         type: :boolean,
 652         description: "Require users to confirm their emails before signing in."
 653       },
 654       %{
 655         key: :federating,
 656         type: :boolean,
 657         description: "Enable federation with other instances."
 658       },
 659       %{
 660         key: :federation_incoming_replies_max_depth,
 661         label: "Fed. incoming replies max depth",
 662         type: :integer,
 663         description:
 664           "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
 665             " 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.",
 666         suggestions: [
 667           100
 668         ]
 669       },
 670       %{
 671         key: :federation_reachability_timeout_days,
 672         label: "Fed. reachability timeout days",
 673         type: :integer,
 674         description:
 675           "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
 676         suggestions: [
 677           7
 678         ]
 679       },
 680       %{
 681         key: :federation_publisher_modules,
 682         type: {:list, :module},
 683         description: "List of modules for federation publishing",
 684         suggestions: [
 685           Pleroma.Web.ActivityPub.Publisher
 686         ]
 687       },
 688       %{
 689         key: :allow_relay,
 690         type: :boolean,
 691         description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
 692       },
 693       %{
 694         key: :rewrite_policy,
 695         type: [:module, {:list, :module}],
 696         description: "A list of MRF policies enabled",
 697         suggestions:
 698           Generator.list_modules_in_dir(
 699             "lib/pleroma/web/activity_pub/mrf",
 700             "Elixir.Pleroma.Web.ActivityPub.MRF."
 701           )
 702       },
 703       %{
 704         key: :public,
 705         type: :boolean,
 706         description:
 707           "Makes the client API in authentificated mode-only except for user-profiles." <>
 708             " Useful for disabling the Local Timeline and The Whole Known Network."
 709       },
 710       %{
 711         key: :quarantined_instances,
 712         type: {:list, :string},
 713         description:
 714           "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
 715         suggestions: [
 716           "quarantined.com",
 717           "*.quarantined.com"
 718         ]
 719       },
 720       %{
 721         key: :managed_config,
 722         type: :boolean,
 723         description:
 724           "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
 725       },
 726       %{
 727         key: :static_dir,
 728         type: :string,
 729         description: "Instance static directory",
 730         suggestions: [
 731           "instance/static/"
 732         ]
 733       },
 734       %{
 735         key: :allowed_post_formats,
 736         type: {:list, :string},
 737         description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
 738         suggestions: [
 739           "text/plain",
 740           "text/html",
 741           "text/markdown",
 742           "text/bbcode"
 743         ]
 744       },
 745       %{
 746         key: :mrf_transparency,
 747         label: "MRF transparency",
 748         type: :boolean,
 749         description:
 750           "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
 751       },
 752       %{
 753         key: :mrf_transparency_exclusions,
 754         label: "MRF transparency exclusions",
 755         type: {:list, :string},
 756         description:
 757           "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
 758         suggestions: [
 759           "exclusion.com"
 760         ]
 761       },
 762       %{
 763         key: :extended_nickname_format,
 764         type: :boolean,
 765         description:
 766           "Enable to use extended local nicknames format (allows underscores/dashes)." <>
 767             " This will break federation with older software for theses nicknames."
 768       },
 769       %{
 770         key: :cleanup_attachments,
 771         type: :boolean,
 772         description: """
 773         "Enable to remove associated attachments when status is removed.
 774         This will not affect duplicates and attachments without status.
 775         Enabling this will increase load to database when deleting statuses on larger instances.
 776         """
 777       },
 778       %{
 779         key: :max_pinned_statuses,
 780         type: :integer,
 781         description: "The maximum number of pinned statuses. 0 will disable the feature.",
 782         suggestions: [
 783           0,
 784           1,
 785           3
 786         ]
 787       },
 788       %{
 789         key: :autofollowed_nicknames,
 790         type: {:list, :string},
 791         description:
 792           "Set to nicknames of (local) users that every new user should automatically follow",
 793         suggestions: [
 794           "lain",
 795           "kaniini",
 796           "lanodan",
 797           "rinpatch"
 798         ]
 799       },
 800       %{
 801         key: :attachment_links,
 802         type: :boolean,
 803         description: "Enable to automatically add attachment link text to statuses"
 804       },
 805       %{
 806         key: :welcome_message,
 807         type: :string,
 808         description:
 809           "A message that will be sent to a newly registered users as a direct message",
 810         suggestions: [
 811           "Hi, @username! Welcome on board!"
 812         ]
 813       },
 814       %{
 815         key: :welcome_user_nickname,
 816         type: :string,
 817         description: "The nickname of the local user that sends the welcome message",
 818         suggestions: [
 819           "lain"
 820         ]
 821       },
 822       %{
 823         key: :max_report_comment_size,
 824         type: :integer,
 825         description: "The maximum size of the report comment. Default: 1000.",
 826         suggestions: [
 827           1_000
 828         ]
 829       },
 830       %{
 831         key: :safe_dm_mentions,
 832         type: :boolean,
 833         description:
 834           "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
 835             " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
 836             " Default: disabled"
 837       },
 838       %{
 839         key: :healthcheck,
 840         type: :boolean,
 841         description: "If enabled, system data will be shown on /api/pleroma/healthcheck"
 842       },
 843       %{
 844         key: :remote_post_retention_days,
 845         type: :integer,
 846         description:
 847           "The default amount of days to retain remote posts when pruning the database",
 848         suggestions: [
 849           90
 850         ]
 851       },
 852       %{
 853         key: :user_bio_length,
 854         type: :integer,
 855         description: "A user bio maximum length. Default: 5000.",
 856         suggestions: [
 857           5_000
 858         ]
 859       },
 860       %{
 861         key: :user_name_length,
 862         type: :integer,
 863         description: "A user name maximum length. Default: 100.",
 864         suggestions: [
 865           100
 866         ]
 867       },
 868       %{
 869         key: :skip_thread_containment,
 870         type: :boolean,
 871         description: "Skip filtering out broken threads. Default: enabled"
 872       },
 873       %{
 874         key: :limit_to_local_content,
 875         type: {:dropdown, :atom},
 876         description:
 877           "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
 878         suggestions: [
 879           :unauthenticated,
 880           :all,
 881           false
 882         ]
 883       },
 884       %{
 885         key: :max_account_fields,
 886         type: :integer,
 887         description: "The maximum number of custom fields in the user profile. Default: 10.",
 888         suggestions: [
 889           10
 890         ]
 891       },
 892       %{
 893         key: :max_remote_account_fields,
 894         type: :integer,
 895         description:
 896           "The maximum number of custom fields in the remote user profile. Default: 20.",
 897         suggestions: [
 898           20
 899         ]
 900       },
 901       %{
 902         key: :account_field_name_length,
 903         type: :integer,
 904         description: "An account field name maximum length. Default: 512.",
 905         suggestions: [
 906           512
 907         ]
 908       },
 909       %{
 910         key: :account_field_value_length,
 911         type: :integer,
 912         description: "An account field value maximum length. Default: 2048.",
 913         suggestions: [
 914           2048
 915         ]
 916       },
 917       %{
 918         key: :external_user_synchronization,
 919         type: :boolean,
 920         description: "Enabling following/followers counters synchronization for external users"
 921       }
 922     ]
 923   },
 924   %{
 925     group: :logger,
 926     type: :group,
 927     description: "Logger-related settings",
 928     children: [
 929       %{
 930         key: :backends,
 931         type: [:atom, :tuple, :module],
 932         description:
 933           "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
 934         suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
 935       }
 936     ]
 937   },
 938   %{
 939     group: :logger,
 940     type: :group,
 941     key: :ex_syslogger,
 942     description: "ExSyslogger-related settings",
 943     children: [
 944       %{
 945         key: :level,
 946         type: {:dropdown, :atom},
 947         description: "Log level",
 948         suggestions: [:debug, :info, :warn, :error]
 949       },
 950       %{
 951         key: :ident,
 952         type: :string,
 953         description:
 954           "A string that's prepended to every message, and is typically set to the app name",
 955         suggestions: ["pleroma"]
 956       },
 957       %{
 958         key: :format,
 959         type: :string,
 960         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
 961         suggestions: ["$metadata[$level] $message"]
 962       },
 963       %{
 964         key: :metadata,
 965         type: {:list, :atom},
 966         suggestions: [:request_id]
 967       }
 968     ]
 969   },
 970   %{
 971     group: :logger,
 972     type: :group,
 973     key: :console,
 974     description: "Console logger settings",
 975     children: [
 976       %{
 977         key: :level,
 978         type: {:dropdown, :atom},
 979         description: "Log level",
 980         suggestions: [:debug, :info, :warn, :error]
 981       },
 982       %{
 983         key: :format,
 984         type: :string,
 985         description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
 986         suggestions: ["$metadata[$level] $message"]
 987       },
 988       %{
 989         key: :metadata,
 990         type: {:list, :atom},
 991         suggestions: [:request_id]
 992       }
 993     ]
 994   },
 995   %{
 996     group: :quack,
 997     type: :group,
 998     description: "Quack-related settings",
 999     children: [
1000       %{
1001         key: :level,
1002         type: {:dropdown, :atom},
1003         description: "Log level",
1004         suggestions: [:debug, :info, :warn, :error]
1005       },
1006       %{
1007         key: :meta,
1008         type: {:list, :atom},
1009         description: "Configure which metadata you want to report on",
1010         suggestions: [
1011           :application,
1012           :module,
1013           :file,
1014           :function,
1015           :line,
1016           :pid,
1017           :crash_reason,
1018           :initial_call,
1019           :registered_name,
1020           :all,
1021           :none
1022         ]
1023       },
1024       %{
1025         key: :webhook_url,
1026         type: :string,
1027         description: "Configure the Slack incoming webhook",
1028         suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1029       }
1030     ]
1031   },
1032   %{
1033     group: :pleroma,
1034     key: :frontend_configurations,
1035     type: :group,
1036     description:
1037       "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1038         "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1039         "add your own configuration your settings all fields must be complete.",
1040     children: [
1041       %{
1042         key: :pleroma_fe,
1043         label: "Pleroma FE",
1044         type: :map,
1045         description: "Settings for Pleroma FE",
1046         suggestions: [
1047           %{
1048             theme: "pleroma-dark",
1049             logo: "/static/logo.png",
1050             background: "/images/city.jpg",
1051             redirectRootNoLogin: "/main/all",
1052             redirectRootLogin: "/main/friends",
1053             showInstanceSpecificPanel: true,
1054             scopeOptionsEnabled: false,
1055             formattingOptionsEnabled: false,
1056             collapseMessageWithSubject: false,
1057             hidePostStats: false,
1058             hideUserStats: false,
1059             scopeCopy: true,
1060             subjectLineBehavior: "email",
1061             alwaysShowSubjectInput: true,
1062             logoMask: false,
1063             logoMargin: ".1em",
1064             stickers: false,
1065             enableEmojiPicker: false
1066           }
1067         ],
1068         children: [
1069           %{
1070             key: :theme,
1071             type: :string,
1072             description: "Which theme to use, they are defined in styles.json",
1073             suggestions: ["pleroma-dark"]
1074           },
1075           %{
1076             key: :logo,
1077             type: :string,
1078             description: "URL of the logo, defaults to Pleroma's logo",
1079             suggestions: ["/static/logo.png"]
1080           },
1081           %{
1082             key: :background,
1083             type: :string,
1084             description:
1085               "URL of the background, unless viewing a user profile with a background that is set",
1086             suggestions: ["/images/city.jpg"]
1087           },
1088           %{
1089             key: :redirectRootNoLogin,
1090             label: "Redirect root no login",
1091             type: :string,
1092             description:
1093               "Relative URL which indicates where to redirect when a user isn't logged in",
1094             suggestions: ["/main/all"]
1095           },
1096           %{
1097             key: :redirectRootLogin,
1098             label: "Redirect root login",
1099             type: :string,
1100             description:
1101               "Relative URL which indicates where to redirect when a user is logged in",
1102             suggestions: ["/main/friends"]
1103           },
1104           %{
1105             key: :showInstanceSpecificPanel,
1106             label: "Show instance specific panel",
1107             type: :boolean,
1108             description: "Whenether to show the instance's specific panel"
1109           },
1110           %{
1111             key: :scopeOptionsEnabled,
1112             label: "Scope options enabled",
1113             type: :boolean,
1114             description: "Enable setting a notice visibility and subject/CW when posting"
1115           },
1116           %{
1117             key: :formattingOptionsEnabled,
1118             label: "Formatting options enabled",
1119             type: :boolean,
1120             description:
1121               "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1122           },
1123           %{
1124             key: :collapseMessageWithSubject,
1125             label: "Collapse message with subject",
1126             type: :boolean,
1127             description:
1128               "When a message has a subject (aka Content Warning), collapse it by default"
1129           },
1130           %{
1131             key: :hidePostStats,
1132             label: "Hide post stats",
1133             type: :boolean,
1134             description: "Hide notices statistics (repeats, favorites, ...)"
1135           },
1136           %{
1137             key: :hideUserStats,
1138             label: "Hide user stats",
1139             type: :boolean,
1140             description:
1141               "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1142           },
1143           %{
1144             key: :scopeCopy,
1145             label: "Scope copy",
1146             type: :boolean,
1147             description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1148           },
1149           %{
1150             key: :subjectLineBehavior,
1151             label: "Subject line behavior",
1152             type: :string,
1153             description: "Allows changing the default behaviour of subject lines in replies.
1154           `email`: copy and preprend re:, as in email,
1155           `masto`: copy verbatim, as in Mastodon,
1156           `noop`: don't copy the subject.",
1157             suggestions: ["email", "masto", "noop"]
1158           },
1159           %{
1160             key: :alwaysShowSubjectInput,
1161             label: "Always show subject input",
1162             type: :boolean,
1163             description: "When disabled, auto-hide the subject field if it's empty"
1164           },
1165           %{
1166             key: :logoMask,
1167             label: "Logo mask",
1168             type: :boolean,
1169             description:
1170               "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1171                 "If you want a colorful logo you must disable logoMask."
1172           },
1173           %{
1174             key: :logoMargin,
1175             label: "Logo margin",
1176             type: :string,
1177             description:
1178               "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1179                 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1180             suggestions: [".1em"]
1181           },
1182           %{
1183             key: :stickers,
1184             type: :boolean,
1185             description: "Enables stickers."
1186           },
1187           %{
1188             key: :enableEmojiPicker,
1189             label: "Emoji picker",
1190             type: :boolean,
1191             description: "Enables emoji picker."
1192           }
1193         ]
1194       },
1195       %{
1196         key: :masto_fe,
1197         label: "Masto FE",
1198         type: :map,
1199         description: "Settings for Masto FE",
1200         suggestions: [
1201           %{
1202             showInstanceSpecificPanel: true
1203           }
1204         ],
1205         children: [
1206           %{
1207             key: :showInstanceSpecificPanel,
1208             label: "Show instance specific panel",
1209             type: :boolean,
1210             description: "Whenether to show the instance's specific panel"
1211           }
1212         ]
1213       }
1214     ]
1215   },
1216   %{
1217     group: :pleroma,
1218     key: :assets,
1219     type: :group,
1220     description:
1221       "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1222     children: [
1223       %{
1224         key: :mascots,
1225         type: {:keyword, :map},
1226         description:
1227           "Keyword of mascots, each element must contain both an url and a mime_type key",
1228         suggestions: [
1229           pleroma_fox_tan: %{
1230             url: "/images/pleroma-fox-tan-smol.png",
1231             mime_type: "image/png"
1232           },
1233           pleroma_fox_tan_shy: %{
1234             url: "/images/pleroma-fox-tan-shy.png",
1235             mime_type: "image/png"
1236           }
1237         ]
1238       },
1239       %{
1240         key: :default_mascot,
1241         type: :atom,
1242         description:
1243           "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1244         suggestions: [
1245           :pleroma_fox_tan
1246         ]
1247       }
1248     ]
1249   },
1250   %{
1251     group: :pleroma,
1252     key: :manifest,
1253     type: :group,
1254     description:
1255       "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1256     children: [
1257       %{
1258         key: :icons,
1259         type: {:list, :map},
1260         description: "Describe the icons of the app",
1261         suggestion: [
1262           %{
1263             src: "/static/logo.png"
1264           },
1265           %{
1266             src: "/static/icon.png",
1267             type: "image/png"
1268           },
1269           %{
1270             src: "/static/icon.ico",
1271             sizes: "72x72 96x96 128x128 256x256"
1272           }
1273         ]
1274       },
1275       %{
1276         key: :theme_color,
1277         type: :string,
1278         description: "Describe the theme color of the app",
1279         suggestions: ["#282c37", "mediumpurple"]
1280       },
1281       %{
1282         key: :background_color,
1283         type: :string,
1284         description: "Describe the background color of the app",
1285         suggestions: ["#191b22", "aliceblue"]
1286       }
1287     ]
1288   },
1289   %{
1290     group: :pleroma,
1291     key: :mrf_simple,
1292     label: "MRF simple",
1293     type: :group,
1294     description: "Message Rewrite Facility",
1295     children: [
1296       %{
1297         key: :media_removal,
1298         type: {:list, :string},
1299         description: "List of instances to remove medias from",
1300         suggestions: ["example.com", "*.example.com"]
1301       },
1302       %{
1303         key: :media_nsfw,
1304         label: "Media NSFW",
1305         type: {:list, :string},
1306         description: "List of instances to put medias as NSFW (sensitive) from",
1307         suggestions: ["example.com", "*.example.com"]
1308       },
1309       %{
1310         key: :federated_timeline_removal,
1311         type: {:list, :string},
1312         description:
1313           "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1314         suggestions: ["example.com", "*.example.com"]
1315       },
1316       %{
1317         key: :reject,
1318         type: {:list, :string},
1319         description: "List of instances to reject any activities from",
1320         suggestions: ["example.com", "*.example.com"]
1321       },
1322       %{
1323         key: :accept,
1324         type: {:list, :string},
1325         description: "List of instances to accept any activities from",
1326         suggestions: ["example.com", "*.example.com"]
1327       },
1328       %{
1329         key: :report_removal,
1330         type: {:list, :string},
1331         description: "List of instances to reject reports from",
1332         suggestions: ["example.com", "*.example.com"]
1333       },
1334       %{
1335         key: :avatar_removal,
1336         type: {:list, :string},
1337         description: "List of instances to strip avatars from",
1338         suggestions: ["example.com", "*.example.com"]
1339       },
1340       %{
1341         key: :banner_removal,
1342         type: {:list, :string},
1343         description: "List of instances to strip banners from",
1344         suggestions: ["example.com", "*.example.com"]
1345       }
1346     ]
1347   },
1348   %{
1349     group: :pleroma,
1350     key: :mrf_subchain,
1351     label: "MRF subchain",
1352     type: :group,
1353     description:
1354       "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1355         " All criteria are configured as a map of regular expressions to lists of policy modules.",
1356     children: [
1357       %{
1358         key: :match_actor,
1359         type: :map,
1360         description: "Matches a series of regular expressions against the actor field",
1361         suggestions: [
1362           %{
1363             ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1364           }
1365         ]
1366       }
1367     ]
1368   },
1369   %{
1370     group: :pleroma,
1371     key: :mrf_rejectnonpublic,
1372     description:
1373       "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1374     label: "MRF reject non public",
1375     type: :group,
1376     children: [
1377       %{
1378         key: :allow_followersonly,
1379         label: "Allow followers-only",
1380         type: :boolean,
1381         description: "Whether to allow followers-only posts"
1382       },
1383       %{
1384         key: :allow_direct,
1385         type: :boolean,
1386         description: "Whether to allow direct messages"
1387       }
1388     ]
1389   },
1390   %{
1391     group: :pleroma,
1392     key: :mrf_hellthread,
1393     label: "MRF hellthread",
1394     type: :group,
1395     description: "Block messages with too much mentions",
1396     children: [
1397       %{
1398         key: :delist_threshold,
1399         type: :integer,
1400         description:
1401           "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1402             " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1403         suggestions: [10]
1404       },
1405       %{
1406         key: :reject_threshold,
1407         type: :integer,
1408         description:
1409           "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1410         suggestions: [20]
1411       }
1412     ]
1413   },
1414   %{
1415     group: :pleroma,
1416     key: :mrf_keyword,
1417     label: "MRF keyword",
1418     type: :group,
1419     description: "Reject or Word-Replace messages with a keyword or regex",
1420     children: [
1421       %{
1422         key: :reject,
1423         type: [:string, :regex],
1424         description:
1425           "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.",
1426         suggestions: ["foo", ~r/foo/iu]
1427       },
1428       %{
1429         key: :federated_timeline_removal,
1430         type: [:string, :regex],
1431         description:
1432           "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.",
1433         suggestions: ["foo", ~r/foo/iu]
1434       },
1435       %{
1436         key: :replace,
1437         type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1438         description:
1439           "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1440         suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1441       }
1442     ]
1443   },
1444   %{
1445     group: :pleroma,
1446     key: :mrf_mention,
1447     label: "MRF mention",
1448     type: :group,
1449     description: "Block messages which mention a user",
1450     children: [
1451       %{
1452         key: :actors,
1453         type: {:list, :string},
1454         description: "A list of actors, for which to drop any posts mentioning",
1455         suggestions: ["actor1", "actor2"]
1456       }
1457     ]
1458   },
1459   %{
1460     group: :pleroma,
1461     key: :mrf_vocabulary,
1462     label: "MRF vocabulary",
1463     type: :group,
1464     description: "Filter messages which belong to certain activity vocabularies",
1465     children: [
1466       %{
1467         key: :accept,
1468         type: {:list, :string},
1469         description:
1470           "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1471         suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1472       },
1473       %{
1474         key: :reject,
1475         type: {:list, :string},
1476         description:
1477           "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1478         suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1479       }
1480     ]
1481   },
1482   # %{
1483   #   group: :pleroma,
1484   #   key: :mrf_user_allowlist,
1485   #   type: :group,
1486   #   description:
1487   #     "The keys in this section are the domain names that the policy should apply to." <>
1488   #       " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1489   #   children: [
1490   #     ["example.org": ["https://example.org/users/admin"]],
1491   #     suggestions: [
1492   #       ["example.org": ["https://example.org/users/admin"]]
1493   #     ]
1494   #   ]
1495   # },
1496   %{
1497     group: :pleroma,
1498     key: :media_proxy,
1499     type: :group,
1500     description: "Media proxy",
1501     children: [
1502       %{
1503         key: :enabled,
1504         type: :boolean,
1505         description: "Enables proxying of remote media to the instance's proxy"
1506       },
1507       %{
1508         key: :base_url,
1509         type: :string,
1510         description:
1511           "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1512         suggestions: ["https://example.com"]
1513       },
1514       %{
1515         key: :proxy_opts,
1516         type: :keyword,
1517         description: "Options for Pleroma.ReverseProxy",
1518         suggestions: [
1519           redirect_on_failure: false,
1520           max_body_length: 25 * 1_048_576,
1521           http: [
1522             follow_redirect: true,
1523             pool: :media
1524           ]
1525         ],
1526         children: [
1527           %{
1528             key: :redirect_on_failure,
1529             type: :boolean,
1530             description:
1531               "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1532                 "Any error during body processing will not be redirected as the response is chunked."
1533           },
1534           %{
1535             key: :max_body_length,
1536             type: :integer,
1537             description:
1538               "Limits the content length to be approximately the " <>
1539                 "specified length. It is validated with the `content-length` header and also verified when proxying."
1540           },
1541           %{
1542             key: :http,
1543             type: :keyword,
1544             description: "HTTP options",
1545             children: [
1546               %{
1547                 key: :adapter,
1548                 type: :keyword,
1549                 description: "Adapter specific options",
1550                 children: [
1551                   %{
1552                     key: :ssl_options,
1553                     type: :keyword,
1554                     label: "SSL Options",
1555                     description: "SSL options for HTTP adapter",
1556                     children: [
1557                       %{
1558                         key: :versions,
1559                         type: {:list, :atom},
1560                         description: "List of TLS version to use",
1561                         suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1562                       }
1563                     ]
1564                   }
1565                 ]
1566               },
1567               %{
1568                 key: :proxy_url,
1569                 label: "Proxy URL",
1570                 type: [:string, :tuple],
1571                 description: "Proxy URL",
1572                 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1573               }
1574             ]
1575           }
1576         ]
1577       },
1578       %{
1579         key: :whitelist,
1580         type: {:list, :string},
1581         description: "List of domains to bypass the mediaproxy",
1582         suggestions: ["example.com"]
1583       }
1584     ]
1585   },
1586   %{
1587     group: :pleroma,
1588     key: :gopher,
1589     type: :group,
1590     description: "Gopher settings",
1591     children: [
1592       %{
1593         key: :enabled,
1594         type: :boolean,
1595         description: "Enables the gopher interface"
1596       },
1597       %{
1598         key: :ip,
1599         type: :tuple,
1600         description: "IP address to bind to",
1601         suggestions: [{0, 0, 0, 0}]
1602       },
1603       %{
1604         key: :port,
1605         type: :integer,
1606         description: "Port to bind to",
1607         suggestions: [9999]
1608       },
1609       %{
1610         key: :dstport,
1611         type: :integer,
1612         description: "Port advertised in urls (optional, defaults to port)",
1613         suggestions: [9999]
1614       }
1615     ]
1616   },
1617   %{
1618     group: :pleroma,
1619     key: Pleroma.Web.Endpoint,
1620     type: :group,
1621     description: "Phoenix endpoint configuration",
1622     children: [
1623       %{
1624         key: :http,
1625         label: "HTTP",
1626         type: {:keyword, :integer, :tuple},
1627         description: "http protocol configuration",
1628         suggestions: [
1629           port: 8080,
1630           ip: {127, 0, 0, 1}
1631         ],
1632         children: [
1633           %{
1634             key: :dispatch,
1635             type: {:list, :tuple},
1636             description: "dispatch settings",
1637             suggestions: [
1638               {:_,
1639                [
1640                  {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1641                  {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1642                   {Phoenix.Transports.WebSocket,
1643                    {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1644                  {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1645                ]}
1646               # end copied from config.exs
1647             ]
1648           },
1649           %{
1650             key: :ip,
1651             label: "IP",
1652             type: :tuple,
1653             description: "ip",
1654             suggestions: [
1655               {0, 0, 0, 0}
1656             ]
1657           },
1658           %{
1659             key: :port,
1660             type: :integer,
1661             description: "port",
1662             suggestions: [
1663               2020
1664             ]
1665           }
1666         ]
1667       },
1668       %{
1669         key: :url,
1670         label: "URL",
1671         type: {:keyword, :string, :integer},
1672         description: "configuration for generating urls",
1673         suggestions: [
1674           host: "example.com",
1675           port: 2020,
1676           scheme: "https"
1677         ],
1678         children: [
1679           %{
1680             key: :host,
1681             type: :string,
1682             description: "Host",
1683             suggestions: [
1684               "example.com"
1685             ]
1686           },
1687           %{
1688             key: :port,
1689             type: :integer,
1690             description: "port",
1691             suggestions: [
1692               2020
1693             ]
1694           },
1695           %{
1696             key: :scheme,
1697             type: :string,
1698             description: "Scheme",
1699             suggestions: [
1700               "https",
1701               "https"
1702             ]
1703           }
1704         ]
1705       },
1706       %{
1707         key: :instrumenters,
1708         type: {:list, :module},
1709         suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1710       },
1711       %{
1712         key: :protocol,
1713         type: :string,
1714         suggestions: ["https"]
1715       },
1716       %{
1717         key: :secret_key_base,
1718         type: :string,
1719         suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1720       },
1721       %{
1722         key: :signing_salt,
1723         type: :string,
1724         suggestions: ["CqaoopA2"]
1725       },
1726       %{
1727         key: :render_errors,
1728         type: :keyword,
1729         suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1730         children: [
1731           %{
1732             key: :view,
1733             type: :module,
1734             suggestions: [Pleroma.Web.ErrorView]
1735           },
1736           %{
1737             key: :accepts,
1738             type: {:list, :string},
1739             suggestions: ["json"]
1740           }
1741         ]
1742       },
1743       %{
1744         key: :pubsub,
1745         type: :keyword,
1746         suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1747         children: [
1748           %{
1749             key: :name,
1750             type: :module,
1751             suggestions: [Pleroma.PubSub]
1752           },
1753           %{
1754             key: :adapter,
1755             type: :module,
1756             suggestions: [Phoenix.PubSub.PG2]
1757           }
1758         ]
1759       },
1760       %{
1761         key: :secure_cookie_flag,
1762         type: :boolean
1763       },
1764       %{
1765         key: :extra_cookie_attrs,
1766         type: {:list, :string},
1767         suggestions: ["SameSite=Lax"]
1768       }
1769     ]
1770   },
1771   %{
1772     group: :pleroma,
1773     key: :activitypub,
1774     type: :group,
1775     description: "ActivityPub-related settings",
1776     children: [
1777       %{
1778         key: :unfollow_blocked,
1779         type: :boolean,
1780         description: "Whether blocks result in people getting unfollowed"
1781       },
1782       %{
1783         key: :outgoing_blocks,
1784         type: :boolean,
1785         description: "Whether to federate blocks to other instances"
1786       },
1787       %{
1788         key: :sign_object_fetches,
1789         type: :boolean,
1790         description: "Sign object fetches with HTTP signatures"
1791       },
1792       %{
1793         key: :note_replies_output_limit,
1794         type: :integer,
1795         description:
1796           "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1797       },
1798       %{
1799         key: :follow_handshake_timeout,
1800         type: :integer,
1801         description: "Following handshake timeout",
1802         suggestions: [500]
1803       }
1804     ]
1805   },
1806   %{
1807     group: :pleroma,
1808     key: :http_security,
1809     type: :group,
1810     description: "HTTP security settings",
1811     children: [
1812       %{
1813         key: :enabled,
1814         type: :boolean,
1815         description: "Whether the managed content security policy is enabled"
1816       },
1817       %{
1818         key: :sts,
1819         label: "STS",
1820         type: :boolean,
1821         description: "Whether to additionally send a Strict-Transport-Security header"
1822       },
1823       %{
1824         key: :sts_max_age,
1825         label: "STS max age",
1826         type: :integer,
1827         description: "The maximum age for the Strict-Transport-Security header if sent",
1828         suggestions: [31_536_000]
1829       },
1830       %{
1831         key: :ct_max_age,
1832         label: "CT max age",
1833         type: :integer,
1834         description: "The maximum age for the Expect-CT header if sent",
1835         suggestions: [2_592_000]
1836       },
1837       %{
1838         key: :referrer_policy,
1839         type: :string,
1840         description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1841         suggestions: ["same-origin", "no-referrer"]
1842       },
1843       %{
1844         key: :report_uri,
1845         label: "Report URI",
1846         type: :string,
1847         description: "Adds the specified url to report-uri and report-to group in CSP header",
1848         suggestions: ["https://example.com/report-uri"]
1849       }
1850     ]
1851   },
1852   %{
1853     group: :web_push_encryption,
1854     key: :vapid_details,
1855     type: :group,
1856     description:
1857       "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1858     children: [
1859       %{
1860         key: :subject,
1861         type: :string,
1862         description:
1863           "A mailto link for the administrative contact." <>
1864             " 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," <>
1865             " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1866         suggestions: ["Subject"]
1867       },
1868       %{
1869         key: :public_key,
1870         type: :string,
1871         description: "VAPID public key",
1872         suggestions: ["Public key"]
1873       },
1874       %{
1875         key: :private_key,
1876         type: :string,
1877         description: "VAPID private key",
1878         suggestions: ["Private key"]
1879       }
1880     ]
1881   },
1882   %{
1883     group: :pleroma,
1884     key: Pleroma.Captcha,
1885     type: :group,
1886     description: "Captcha-related settings",
1887     children: [
1888       %{
1889         key: :enabled,
1890         type: :boolean,
1891         description: "Whether the captcha should be shown on registration"
1892       },
1893       %{
1894         key: :method,
1895         type: :module,
1896         description: "The method/service to use for captcha",
1897         suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1898       },
1899       %{
1900         key: :seconds_valid,
1901         type: :integer,
1902         description: "The time in seconds for which the captcha is valid",
1903         suggestions: [60]
1904       }
1905     ]
1906   },
1907   %{
1908     group: :pleroma,
1909     key: Pleroma.Captcha.Kocaptcha,
1910     type: :group,
1911     description:
1912       "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1913         " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1914     children: [
1915       %{
1916         key: :endpoint,
1917         type: :string,
1918         description: "The kocaptcha endpoint to use",
1919         suggestions: ["https://captcha.kotobank.ch"]
1920       }
1921     ]
1922   },
1923   %{
1924     group: :pleroma,
1925     type: :group,
1926     description:
1927       "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",
1928     children: [
1929       %{
1930         key: :admin_token,
1931         type: :string,
1932         description: "Token",
1933         suggestions: ["some_random_token"]
1934       }
1935     ]
1936   },
1937   %{
1938     group: :pleroma_job_queue,
1939     key: :queues,
1940     type: :group,
1941     description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1942   },
1943   %{
1944     group: :pleroma,
1945     key: Pleroma.Web.Federator.RetryQueue,
1946     type: :group,
1947     description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1948     children: [
1949       %{
1950         key: :max_retries,
1951         type: :integer,
1952         description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1953       }
1954     ]
1955   },
1956   %{
1957     group: :pleroma,
1958     key: Oban,
1959     type: :group,
1960     description: """
1961     [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1962
1963     Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1964       it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1965       otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1966       (see https://github.com/sorentwo/oban/issues/52).
1967     """,
1968     children: [
1969       %{
1970         key: :repo,
1971         type: :module,
1972         description: "Application's Ecto repo",
1973         suggestions: [Pleroma.Repo]
1974       },
1975       %{
1976         key: :verbose,
1977         type: {:dropdown, :atom},
1978         description: "Logs verbose mode",
1979         suggestions: [false, :error, :warn, :info, :debug]
1980       },
1981       %{
1982         key: :prune,
1983         type: [:atom, :tuple],
1984         description:
1985           "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1986         suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1987       },
1988       %{
1989         key: :queues,
1990         type: {:keyword, :integer},
1991         description:
1992           "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1993         suggestions: [
1994           activity_expiration: 10,
1995           background: 5,
1996           federator_incoming: 50,
1997           federator_outgoing: 50,
1998           mailer: 10,
1999           scheduled_activities: 10,
2000           transmogrifier: 20,
2001           web_push: 50
2002         ],
2003         children: [
2004           %{
2005             key: :activity_expiration,
2006             type: :integer,
2007             description: "Activity expiration queue",
2008             suggestions: [10]
2009           },
2010           %{
2011             key: :background,
2012             type: :integer,
2013             description: "Background queue",
2014             suggestions: [5]
2015           },
2016           %{
2017             key: :federator_incoming,
2018             type: :integer,
2019             description: "Incoming federation queue",
2020             suggestions: [50]
2021           },
2022           %{
2023             key: :federator_outgoing,
2024             type: :integer,
2025             description: "Outgoing federation queue",
2026             suggestions: [50]
2027           },
2028           %{
2029             key: :mailer,
2030             type: :integer,
2031             description: "Email sender queue, see Pleroma.Emails.Mailer",
2032             suggestions: [10]
2033           },
2034           %{
2035             key: :scheduled_activities,
2036             type: :integer,
2037             description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2038             suggestions: [10]
2039           },
2040           %{
2041             key: :transmogrifier,
2042             type: :integer,
2043             description: "Transmogrifier queue",
2044             suggestions: [20]
2045           },
2046           %{
2047             key: :web_push,
2048             type: :integer,
2049             description: "Web push notifications queue",
2050             suggestions: [50]
2051           }
2052         ]
2053       }
2054     ]
2055   },
2056   %{
2057     group: :pleroma,
2058     key: :workers,
2059     type: :group,
2060     description: "Includes custom worker options not interpretable directly by `Oban`",
2061     children: [
2062       %{
2063         key: :retries,
2064         type: {:keyword, :integer},
2065         description: "Max retry attempts for failed jobs, per `Oban` queue",
2066         suggestions: [
2067           federator_incoming: 5,
2068           federator_outgoing: 5
2069         ]
2070       }
2071     ]
2072   },
2073   %{
2074     group: :pleroma,
2075     key: Pleroma.Web.Metadata,
2076     type: :group,
2077     description: "Metadata-related settings",
2078     children: [
2079       %{
2080         key: :providers,
2081         type: {:list, :module},
2082         description: "List of metadata providers to enable",
2083         suggestions: [
2084           Pleroma.Web.Metadata.Providers.OpenGraph,
2085           Pleroma.Web.Metadata.Providers.TwitterCard,
2086           Pleroma.Web.Metadata.Providers.RelMe,
2087           Pleroma.Web.Metadata.Providers.Feed
2088         ]
2089       },
2090       %{
2091         key: :unfurl_nsfw,
2092         label: "Unfurl NSFW",
2093         type: :boolean,
2094         description: "When enabled NSFW attachments will be shown in previews"
2095       }
2096     ]
2097   },
2098   %{
2099     group: :pleroma,
2100     key: :rich_media,
2101     type: :group,
2102     description:
2103       "If enabled the instance will parse metadata from attached links to generate link previews.",
2104     children: [
2105       %{
2106         key: :enabled,
2107         type: :boolean,
2108         description: "Enables/disables RichMedia."
2109       },
2110       %{
2111         key: :ignore_hosts,
2112         type: {:list, :string},
2113         description: "List of hosts which will be ignored by the metadata parser.",
2114         suggestions: ["accounts.google.com", "xss.website"]
2115       },
2116       %{
2117         key: :ignore_tld,
2118         label: "Ignore TLD",
2119         type: {:list, :string},
2120         description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2121         suggestions: ["local", "localdomain", "lan"]
2122       },
2123       %{
2124         key: :parsers,
2125         type: {:list, :module},
2126         description: "List of Rich Media parsers.",
2127         suggestions: [
2128           Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2129           Pleroma.Web.RichMedia.Parsers.OEmbed,
2130           Pleroma.Web.RichMedia.Parsers.OGP,
2131           Pleroma.Web.RichMedia.Parsers.TwitterCard
2132         ]
2133       },
2134       %{
2135         key: :ttl_setters,
2136         label: "TTL setters",
2137         type: {:list, :module},
2138         description: "List of rich media TTL setters.",
2139         suggestions: [
2140           Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2141         ]
2142       }
2143     ]
2144   },
2145   %{
2146     group: :pleroma,
2147     key: :fetch_initial_posts,
2148     type: :group,
2149     description: "Fetching initial posts settings",
2150     children: [
2151       %{
2152         key: :enabled,
2153         type: :boolean,
2154         description:
2155           "If enabled, when a new user is federated with, fetch some of their latest posts"
2156       },
2157       %{
2158         key: :pages,
2159         type: :integer,
2160         description: "The amount of pages to fetch",
2161         suggestions: [5]
2162       }
2163     ]
2164   },
2165   %{
2166     group: :auto_linker,
2167     key: :opts,
2168     type: :group,
2169     description: "Configuration for the auto_linker library",
2170     children: [
2171       %{
2172         key: :class,
2173         type: [:string, false],
2174         description: "Specify the class to be added to the generated link. `False` to clear",
2175         suggestions: ["auto-linker", false]
2176       },
2177       %{
2178         key: :rel,
2179         type: [:string, false],
2180         description: "Override the rel attribute. `False` to clear",
2181         suggestions: ["ugc", "noopener noreferrer", false]
2182       },
2183       %{
2184         key: :new_window,
2185         type: :boolean,
2186         description: "Link urls will open in new window/tab"
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 enabled, 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   },
2530   %{
2531     group: :pleroma,
2532     key: :emoji,
2533     type: :group,
2534     children: [
2535       %{
2536         key: :shortcode_globs,
2537         type: {:list, :string},
2538         description: "Location of custom emoji files. * can be used as a wildcard.",
2539         suggestions: ["/emoji/custom/**/*.png"]
2540       },
2541       %{
2542         key: :pack_extensions,
2543         type: {:list, :string},
2544         description:
2545           "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2546         suggestions: [".png", ".gif"]
2547       },
2548       %{
2549         key: :groups,
2550         type: {:keyword, :string, {:list, :string}},
2551         description:
2552           "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2553             " and the value is the location or array of locations. * can be used as a wildcard.",
2554         suggestions: [
2555           Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2556         ]
2557       },
2558       %{
2559         key: :default_manifest,
2560         type: :string,
2561         description:
2562           "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2563             " Currently only one manifest can be added (no arrays).",
2564         suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2565       },
2566       %{
2567         key: :shared_pack_cache_seconds_per_file,
2568         label: "Shared pack cache s/file",
2569         type: :integer,
2570         descpiption:
2571           "When an emoji pack is shared, the archive is created and cached in memory" <>
2572             " for this amount of seconds multiplied by the number of files.",
2573         suggestions: [60]
2574       }
2575     ]
2576   },
2577   %{
2578     group: :pleroma,
2579     key: :database,
2580     type: :group,
2581     description: "Database related settings",
2582     children: [
2583       %{
2584         key: :rum_enabled,
2585         type: :boolean,
2586         description: "If RUM indexes should be used. Default: `false`"
2587       }
2588     ]
2589   },
2590   %{
2591     group: :pleroma,
2592     key: :rate_limit,
2593     type: :group,
2594     description:
2595       "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2596     children: [
2597       %{
2598         key: :search,
2599         type: [:tuple, {:list, :tuple}],
2600         description: "For the search requests (account & status search etc.)",
2601         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2602       },
2603       %{
2604         key: :app_account_creation,
2605         type: [:tuple, {:list, :tuple}],
2606         description: "For registering user accounts from the same IP address",
2607         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2608       },
2609       %{
2610         key: :relations_actions,
2611         type: [:tuple, {:list, :tuple}],
2612         description: "For actions on relations with all users (follow, unfollow)",
2613         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2614       },
2615       %{
2616         key: :relation_id_action,
2617         type: [:tuple, {:list, :tuple}],
2618         description: "For actions on relation with a specific user (follow, unfollow)",
2619         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2620       },
2621       %{
2622         key: :statuses_actions,
2623         type: [:tuple, {:list, :tuple}],
2624         description:
2625           "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2626         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2627       },
2628       %{
2629         key: :status_id_action,
2630         type: [:tuple, {:list, :tuple}],
2631         description:
2632           "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2633         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2634       },
2635       %{
2636         key: :authentication,
2637         type: [:tuple, {:list, :tuple}],
2638         description: "For authentication create / password check / user existence check requests",
2639         suggestions: [{60_000, 15}]
2640       }
2641     ]
2642   },
2643   %{
2644     group: :esshd,
2645     type: :group,
2646     description:
2647       "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2648         "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2649     children: [
2650       %{
2651         key: :enabled,
2652         type: :boolean,
2653         description: "Enables SSH"
2654       },
2655       %{
2656         key: :priv_dir,
2657         type: :string,
2658         description: "Dir with SSH keys",
2659         suggestions: ["/some/path/ssh_keys"]
2660       },
2661       %{
2662         key: :handler,
2663         type: :string,
2664         description: "Handler module",
2665         suggestions: ["Pleroma.BBS.Handler"]
2666       },
2667       %{
2668         key: :port,
2669         type: :integer,
2670         description: "Port to connect",
2671         suggestions: [10_022]
2672       },
2673       %{
2674         key: :password_authenticator,
2675         type: :string,
2676         description: "Authenticator module",
2677         suggestions: ["Pleroma.BBS.Authenticator"]
2678       }
2679     ]
2680   },
2681   %{
2682     group: :mime,
2683     type: :group,
2684     description: "Mime types",
2685     children: [
2686       %{
2687         key: :types,
2688         type: :map,
2689         suggestions: [
2690           %{
2691             "application/xml" => ["xml"],
2692             "application/xrd+xml" => ["xrd+xml"],
2693             "application/jrd+json" => ["jrd+json"],
2694             "application/activity+json" => ["activity+json"],
2695             "application/ld+json" => ["activity+json"]
2696           }
2697         ],
2698         children: [
2699           %{
2700             key: "application/xml",
2701             type: {:list, :string},
2702             suggestions: ["xml"]
2703           },
2704           %{
2705             key: "application/xrd+xml",
2706             type: {:list, :string},
2707             suggestions: ["xrd+xml"]
2708           },
2709           %{
2710             key: "application/jrd+json",
2711             type: {:list, :string},
2712             suggestions: ["jrd+json"]
2713           },
2714           %{
2715             key: "application/activity+json",
2716             type: {:list, :string},
2717             suggestions: ["activity+json"]
2718           },
2719           %{
2720             key: "application/ld+json",
2721             type: {:list, :string},
2722             suggestions: ["activity+json"]
2723           }
2724         ]
2725       }
2726     ]
2727   },
2728   %{
2729     group: :tesla,
2730     type: :group,
2731     description: "Tesla settings",
2732     children: [
2733       %{
2734         key: :adapter,
2735         type: :module,
2736         description: "Tesla adapter",
2737         suggestions: [Tesla.Adapter.Hackney]
2738       }
2739     ]
2740   },
2741   %{
2742     group: :pleroma,
2743     key: :chat,
2744     type: :group,
2745     description: "Pleroma chat settings",
2746     children: [
2747       %{
2748         key: :enabled,
2749         type: :boolean
2750       }
2751     ]
2752   },
2753   %{
2754     group: :prometheus,
2755     key: Pleroma.Web.Endpoint.MetricsExporter,
2756     type: :group,
2757     description: "Prometheus settings",
2758     children: [
2759       %{
2760         key: :path,
2761         type: :string,
2762         description: "API endpoint with metrics",
2763         suggestions: ["/api/pleroma/app_metrics"]
2764       }
2765     ]
2766   },
2767   %{
2768     group: :http_signatures,
2769     type: :group,
2770     description: "HTTP Signatures settings",
2771     children: [
2772       %{
2773         key: :adapter,
2774         type: :module,
2775         suggestions: [Pleroma.Signature]
2776       }
2777     ]
2778   },
2779   %{
2780     group: :pleroma,
2781     key: :http,
2782     type: :group,
2783     description: "HTTP settings",
2784     children: [
2785       %{
2786         key: :proxy_url,
2787         label: "Proxy URL",
2788         type: [:string, :tuple],
2789         description: "Proxy URL",
2790         suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2791       },
2792       %{
2793         key: :send_user_agent,
2794         type: :boolean
2795       },
2796       %{
2797         key: :user_agent,
2798         type: [:string, :atom],
2799         description:
2800           "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2801         suggestions: ["Pleroma", :default]
2802       },
2803       %{
2804         key: :adapter,
2805         type: :keyword,
2806         description: "Adapter specific options",
2807         suggestions: [],
2808         children: [
2809           %{
2810             key: :ssl_options,
2811             type: :keyword,
2812             label: "SSL Options",
2813             description: "SSL options for HTTP adapter",
2814             children: [
2815               %{
2816                 key: :versions,
2817                 type: {:list, :atom},
2818                 description: "List of TLS version to use",
2819                 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2820               }
2821             ]
2822           }
2823         ]
2824       }
2825     ]
2826   },
2827   %{
2828     group: :pleroma,
2829     key: :markup,
2830     type: :group,
2831     children: [
2832       %{
2833         key: :allow_inline_images,
2834         type: :boolean
2835       },
2836       %{
2837         key: :allow_headings,
2838         type: :boolean
2839       },
2840       %{
2841         key: :allow_tables,
2842         type: :boolean
2843       },
2844       %{
2845         key: :allow_fonts,
2846         type: :boolean
2847       },
2848       %{
2849         key: :scrub_policy,
2850         type: {:list, :module},
2851         suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2852       }
2853     ]
2854   },
2855   %{
2856     group: :pleroma,
2857     key: :user,
2858     type: :group,
2859     children: [
2860       %{
2861         key: :deny_follow_blocked,
2862         type: :boolean
2863       }
2864     ]
2865   },
2866   %{
2867     group: :pleroma,
2868     key: :mrf_normalize_markup,
2869     label: "MRF normalize markup",
2870     description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2871     type: :group,
2872     children: [
2873       %{
2874         key: :scrub_policy,
2875         type: :module,
2876         suggestions: [Pleroma.HTML.Scrubber.Default]
2877       }
2878     ]
2879   },
2880   %{
2881     group: :pleroma,
2882     key: Pleroma.User,
2883     type: :group,
2884     children: [
2885       %{
2886         key: :restricted_nicknames,
2887         type: {:list, :string},
2888         suggestions: [
2889           ".well-known",
2890           "~",
2891           "about",
2892           "activities",
2893           "api",
2894           "auth",
2895           "check_password",
2896           "dev",
2897           "friend-requests",
2898           "inbox",
2899           "internal",
2900           "main",
2901           "media",
2902           "nodeinfo",
2903           "notice",
2904           "oauth",
2905           "objects",
2906           "ostatus_subscribe",
2907           "pleroma",
2908           "proxy",
2909           "push",
2910           "registration",
2911           "relay",
2912           "settings",
2913           "status",
2914           "tag",
2915           "user-search",
2916           "user_exists",
2917           "users",
2918           "web"
2919         ]
2920       }
2921     ]
2922   },
2923   %{
2924     group: :cors_plug,
2925     type: :group,
2926     children: [
2927       %{
2928         key: :max_age,
2929         type: :integer,
2930         suggestions: [86_400]
2931       },
2932       %{
2933         key: :methods,
2934         type: {:list, :string},
2935         suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2936       },
2937       %{
2938         key: :expose,
2939         type: {:list, :string},
2940         suggestions: [
2941           "Link",
2942           "X-RateLimit-Reset",
2943           "X-RateLimit-Limit",
2944           "X-RateLimit-Remaining",
2945           "X-Request-Id",
2946           "Idempotency-Key"
2947         ]
2948       },
2949       %{
2950         key: :credentials,
2951         type: :boolean
2952       },
2953       %{
2954         key: :headers,
2955         type: {:list, :string},
2956         suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2957       }
2958     ]
2959   },
2960   %{
2961     group: :pleroma,
2962     key: Pleroma.Plugs.RemoteIp,
2963     type: :group,
2964     description: """
2965     `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2966     **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2967     """,
2968     children: [
2969       %{
2970         key: :enabled,
2971         type: :boolean,
2972         description: "Enable/disable the plug. Default: `false`."
2973       },
2974       %{
2975         key: :headers,
2976         type: {:list, :string},
2977         description:
2978           "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]`."
2979       },
2980       %{
2981         key: :proxies,
2982         type: {:list, :string},
2983         description:
2984           "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2985       },
2986       %{
2987         key: :reserved,
2988         type: {:list, :string},
2989         description:
2990           "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2991       }
2992     ]
2993   },
2994   %{
2995     group: :pleroma,
2996     key: :web_cache_ttl,
2997     type: :group,
2998     description:
2999       "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3000     children: [
3001       %{
3002         key: :activity_pub,
3003         type: :integer,
3004         description:
3005           "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3006         suggestions: [30_000, nil]
3007       },
3008       %{
3009         key: :activity_pub_question,
3010         type: :integer,
3011         description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3012         suggestions: [30_000]
3013       }
3014     ]
3015   },
3016   %{
3017     group: :pleroma,
3018     key: :static_fe,
3019     type: :group,
3020     description:
3021       "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3022     children: [
3023       %{
3024         key: :enabled,
3025         type: :boolean,
3026         description: "Enables the rendering of static HTML. Defaults to `false`."
3027       }
3028     ]
3029   },
3030   %{
3031     group: :pleroma,
3032     key: :feed,
3033     type: :group,
3034     description: "Configure feed rendering.",
3035     children: [
3036       %{
3037         key: :post_title,
3038         type: :map,
3039         description: "Configure title rendering.",
3040         children: [
3041           %{
3042             key: :max_length,
3043             type: :integer,
3044             description: "Maximum number of characters before truncating title.",
3045             suggestions: [100]
3046           },
3047           %{
3048             key: :omission,
3049             type: :string,
3050             description: "Replacement which will be used after truncating string.",
3051             suggestions: ["..."]
3052           }
3053         ]
3054       }
3055     ]
3056   },
3057   %{
3058     group: :pleroma,
3059     key: :mrf_object_age,
3060     type: :group,
3061     description: "Rejects or delists posts based on their age when received.",
3062     children: [
3063       %{
3064         key: :threshold,
3065         type: :integer,
3066         description: "Required age (in seconds) of a post before actions are taken.",
3067         suggestions: [172_800]
3068       },
3069       %{
3070         key: :actions,
3071         type: {:list, :atom},
3072         description:
3073           "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3074             "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3075             "`:reject` rejects the message entirely",
3076         suggestions: [:delist, :strip_followers, :reject]
3077       }
3078     ]
3079   },
3080   %{
3081     group: :pleroma,
3082     key: :modules,
3083     type: :group,
3084     description: "Custom Runtime Modules.",
3085     children: [
3086       %{
3087         key: :runtime_dir,
3088         type: :string,
3089         description: "A path to custom Elixir modules (such as MRF policies)."
3090       }
3091     ]
3092   },
3093   %{
3094     group: :pleroma,
3095     type: :group,
3096     description: "Allow instance configuration from database.",
3097     children: [
3098       %{
3099         key: :configurable_from_database,
3100         type: :boolean,
3101         description:
3102           "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"
3103       }
3104     ]
3105   }
3106 ]