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 versions 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. It 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 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: :follow_handshake_timeout,
1794         type: :integer,
1795         description: "Following handshake timeout",
1796         suggestions: [500]
1797       }
1798     ]
1799   },
1800   %{
1801     group: :pleroma,
1802     key: :http_security,
1803     type: :group,
1804     description: "HTTP security settings",
1805     children: [
1806       %{
1807         key: :enabled,
1808         type: :boolean,
1809         description: "Whether the managed content security policy is enabled"
1810       },
1811       %{
1812         key: :sts,
1813         label: "STS",
1814         type: :boolean,
1815         description: "Whether to additionally send a Strict-Transport-Security header"
1816       },
1817       %{
1818         key: :sts_max_age,
1819         label: "STS max age",
1820         type: :integer,
1821         description: "The maximum age for the Strict-Transport-Security header if sent",
1822         suggestions: [31_536_000]
1823       },
1824       %{
1825         key: :ct_max_age,
1826         label: "CT max age",
1827         type: :integer,
1828         description: "The maximum age for the Expect-CT header if sent",
1829         suggestions: [2_592_000]
1830       },
1831       %{
1832         key: :referrer_policy,
1833         type: :string,
1834         description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1835         suggestions: ["same-origin", "no-referrer"]
1836       },
1837       %{
1838         key: :report_uri,
1839         label: "Report URI",
1840         type: :string,
1841         description: "Adds the specified url to report-uri and report-to group in CSP header",
1842         suggestions: ["https://example.com/report-uri"]
1843       }
1844     ]
1845   },
1846   %{
1847     group: :web_push_encryption,
1848     key: :vapid_details,
1849     type: :group,
1850     description:
1851       "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1852     children: [
1853       %{
1854         key: :subject,
1855         type: :string,
1856         description:
1857           "A mailto link for the administrative contact." <>
1858             " 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," <>
1859             " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1860         suggestions: ["Subject"]
1861       },
1862       %{
1863         key: :public_key,
1864         type: :string,
1865         description: "VAPID public key",
1866         suggestions: ["Public key"]
1867       },
1868       %{
1869         key: :private_key,
1870         type: :string,
1871         description: "VAPID private key",
1872         suggestions: ["Private key"]
1873       }
1874     ]
1875   },
1876   %{
1877     group: :pleroma,
1878     key: Pleroma.Captcha,
1879     type: :group,
1880     description: "Captcha-related settings",
1881     children: [
1882       %{
1883         key: :enabled,
1884         type: :boolean,
1885         description: "Whether the captcha should be shown on registration"
1886       },
1887       %{
1888         key: :method,
1889         type: :module,
1890         description: "The method/service to use for captcha",
1891         suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1892       },
1893       %{
1894         key: :seconds_valid,
1895         type: :integer,
1896         description: "The time in seconds for which the captcha is valid",
1897         suggestions: [60]
1898       }
1899     ]
1900   },
1901   %{
1902     group: :pleroma,
1903     key: Pleroma.Captcha.Kocaptcha,
1904     type: :group,
1905     description:
1906       "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1907         " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1908     children: [
1909       %{
1910         key: :endpoint,
1911         type: :string,
1912         description: "The kocaptcha endpoint to use",
1913         suggestions: ["https://captcha.kotobank.ch"]
1914       }
1915     ]
1916   },
1917   %{
1918     group: :pleroma,
1919     type: :group,
1920     description:
1921       "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",
1922     children: [
1923       %{
1924         key: :admin_token,
1925         type: :string,
1926         description: "Token",
1927         suggestions: ["We recommend a secure random string or UUID"]
1928       }
1929     ]
1930   },
1931   %{
1932     group: :pleroma_job_queue,
1933     key: :queues,
1934     type: :group,
1935     description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1936   },
1937   %{
1938     group: :pleroma,
1939     key: Pleroma.Web.Federator.RetryQueue,
1940     type: :group,
1941     description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1942     children: [
1943       %{
1944         key: :max_retries,
1945         type: :integer,
1946         description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1947       }
1948     ]
1949   },
1950   %{
1951     group: :pleroma,
1952     key: Oban,
1953     type: :group,
1954     description: """
1955     [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1956
1957     Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1958       it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1959       otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1960       (see https://github.com/sorentwo/oban/issues/52).
1961     """,
1962     children: [
1963       %{
1964         key: :repo,
1965         type: :module,
1966         description: "Application's Ecto repo",
1967         suggestions: [Pleroma.Repo]
1968       },
1969       %{
1970         key: :verbose,
1971         type: {:dropdown, :atom},
1972         description: "Logs verbose mode",
1973         suggestions: [false, :error, :warn, :info, :debug]
1974       },
1975       %{
1976         key: :prune,
1977         type: [:atom, :tuple],
1978         description:
1979           "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1980         suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1981       },
1982       %{
1983         key: :queues,
1984         type: {:keyword, :integer},
1985         description:
1986           "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1987         suggestions: [
1988           activity_expiration: 10,
1989           attachments_cleanup: 5,
1990           background: 5,
1991           federator_incoming: 50,
1992           federator_outgoing: 50,
1993           mailer: 10,
1994           scheduled_activities: 10,
1995           transmogrifier: 20,
1996           web_push: 50
1997         ],
1998         children: [
1999           %{
2000             key: :activity_expiration,
2001             type: :integer,
2002             description: "Activity expiration queue",
2003             suggestions: [10]
2004           },
2005           %{
2006             key: :attachments_cleanup,
2007             type: :integer,
2008             description: "Attachment deletion queue",
2009             suggestions: [5]
2010           },
2011           %{
2012             key: :background,
2013             type: :integer,
2014             description: "Background queue",
2015             suggestions: [5]
2016           },
2017           %{
2018             key: :federator_incoming,
2019             type: :integer,
2020             description: "Incoming federation queue",
2021             suggestions: [50]
2022           },
2023           %{
2024             key: :federator_outgoing,
2025             type: :integer,
2026             description: "Outgoing federation queue",
2027             suggestions: [50]
2028           },
2029           %{
2030             key: :mailer,
2031             type: :integer,
2032             description: "Email sender queue, see Pleroma.Emails.Mailer",
2033             suggestions: [10]
2034           },
2035           %{
2036             key: :scheduled_activities,
2037             type: :integer,
2038             description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2039             suggestions: [10]
2040           },
2041           %{
2042             key: :transmogrifier,
2043             type: :integer,
2044             description: "Transmogrifier queue",
2045             suggestions: [20]
2046           },
2047           %{
2048             key: :web_push,
2049             type: :integer,
2050             description: "Web push notifications queue",
2051             suggestions: [50]
2052           }
2053         ]
2054       }
2055     ]
2056   },
2057   %{
2058     group: :pleroma,
2059     key: :workers,
2060     type: :group,
2061     description: "Includes custom worker options not interpretable directly by `Oban`",
2062     children: [
2063       %{
2064         key: :retries,
2065         type: {:keyword, :integer},
2066         description: "Max retry attempts for failed jobs, per `Oban` queue",
2067         suggestions: [
2068           federator_incoming: 5,
2069           federator_outgoing: 5
2070         ]
2071       }
2072     ]
2073   },
2074   %{
2075     group: :pleroma,
2076     key: Pleroma.Web.Metadata,
2077     type: :group,
2078     description: "Metadata-related settings",
2079     children: [
2080       %{
2081         key: :providers,
2082         type: {:list, :module},
2083         description: "List of metadata providers to enable",
2084         suggestions: [
2085           Pleroma.Web.Metadata.Providers.OpenGraph,
2086           Pleroma.Web.Metadata.Providers.TwitterCard,
2087           Pleroma.Web.Metadata.Providers.RelMe,
2088           Pleroma.Web.Metadata.Providers.Feed
2089         ]
2090       },
2091       %{
2092         key: :unfurl_nsfw,
2093         label: "Unfurl NSFW",
2094         type: :boolean,
2095         description: "When enabled NSFW attachments will be shown in previews"
2096       }
2097     ]
2098   },
2099   %{
2100     group: :pleroma,
2101     key: :rich_media,
2102     type: :group,
2103     description:
2104       "If enabled the instance will parse metadata from attached links to generate link previews.",
2105     children: [
2106       %{
2107         key: :enabled,
2108         type: :boolean,
2109         description: "Enables/disables RichMedia."
2110       },
2111       %{
2112         key: :ignore_hosts,
2113         type: {:list, :string},
2114         description: "List of hosts which will be ignored by the metadata parser.",
2115         suggestions: ["accounts.google.com", "xss.website"]
2116       },
2117       %{
2118         key: :ignore_tld,
2119         label: "Ignore TLD",
2120         type: {:list, :string},
2121         description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2122         suggestions: ["local", "localdomain", "lan"]
2123       },
2124       %{
2125         key: :parsers,
2126         type: {:list, :module},
2127         description: "List of Rich Media parsers.",
2128         suggestions: [
2129           Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2130           Pleroma.Web.RichMedia.Parsers.OEmbed,
2131           Pleroma.Web.RichMedia.Parsers.OGP,
2132           Pleroma.Web.RichMedia.Parsers.TwitterCard
2133         ]
2134       },
2135       %{
2136         key: :ttl_setters,
2137         label: "TTL setters",
2138         type: {:list, :module},
2139         description: "List of rich media TTL setters.",
2140         suggestions: [
2141           Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2142         ]
2143       }
2144     ]
2145   },
2146   %{
2147     group: :pleroma,
2148     key: :fetch_initial_posts,
2149     type: :group,
2150     description: "Fetching initial posts settings",
2151     children: [
2152       %{
2153         key: :enabled,
2154         type: :boolean,
2155         description:
2156           "Fetch posts when a new user is federated with"
2157       },
2158       %{
2159         key: :pages,
2160         type: :integer,
2161         description: "The amount of pages to fetch",
2162         suggestions: [5]
2163       }
2164     ]
2165   },
2166   %{
2167     group: :auto_linker,
2168     key: :opts,
2169     type: :group,
2170     description: "Configuration for the auto_linker library",
2171     children: [
2172       %{
2173         key: :class,
2174         type: [:string, false],
2175         description: "Specify the class to be added to the generated link. Disable to clear",
2176         suggestions: ["auto-linker", false]
2177       },
2178       %{
2179         key: :rel,
2180         type: [:string, false],
2181         description: "Override the rel attribute. Disable to clear",
2182         suggestions: ["ugc", "noopener noreferrer", false]
2183       },
2184       %{
2185         key: :new_window,
2186         type: :boolean,
2187         description: "Link urls will open in new window/tab"
2188       },
2189       %{
2190         key: :truncate,
2191         type: [:integer, false],
2192         description:
2193           "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2194         suggestions: [15, false]
2195       },
2196       %{
2197         key: :strip_prefix,
2198         type: :boolean,
2199         description: "Strip the scheme prefix"
2200       },
2201       %{
2202         key: :extra,
2203         type: :boolean,
2204         description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2205       }
2206     ]
2207   },
2208   %{
2209     group: :pleroma,
2210     key: Pleroma.ScheduledActivity,
2211     type: :group,
2212     description: "Scheduled activities settings",
2213     children: [
2214       %{
2215         key: :daily_user_limit,
2216         type: :integer,
2217         description:
2218           "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2219         suggestions: [25]
2220       },
2221       %{
2222         key: :total_user_limit,
2223         type: :integer,
2224         description:
2225           "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2226         suggestions: [300]
2227       },
2228       %{
2229         key: :enabled,
2230         type: :boolean,
2231         description: "Whether scheduled activities are sent to the job queue to be executed"
2232       }
2233     ]
2234   },
2235   %{
2236     group: :pleroma,
2237     key: Pleroma.ActivityExpiration,
2238     type: :group,
2239     description: "Expired activity settings",
2240     children: [
2241       %{
2242         key: :enabled,
2243         type: :boolean,
2244         description: "Whether expired activities will be sent to the job queue to be deleted"
2245       }
2246     ]
2247   },
2248   %{
2249     group: :pleroma,
2250     type: :group,
2251     description: "Authenticator",
2252     children: [
2253       %{
2254         key: Pleroma.Web.Auth.Authenticator,
2255         type: :module,
2256         suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2257       }
2258     ]
2259   },
2260   %{
2261     group: :pleroma,
2262     key: :ldap,
2263     type: :group,
2264     description:
2265       "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2266         " will be verified by trying to authenticate (bind) to a LDAP server." <>
2267         " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2268         " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2269     children: [
2270       %{
2271         key: :enabled,
2272         type: :boolean,
2273         description: "Enables LDAP authentication"
2274       },
2275       %{
2276         key: :host,
2277         type: :string,
2278         description: "LDAP server hostname",
2279         suggestions: ["localhosts"]
2280       },
2281       %{
2282         key: :port,
2283         type: :integer,
2284         description: "LDAP port, e.g. 389 or 636",
2285         suggestions: [389, 636]
2286       },
2287       %{
2288         key: :ssl,
2289         label: "SSL",
2290         type: :boolean,
2291         description: "Enable to use SSL, usually implies the port 636"
2292       },
2293       %{
2294         key: :sslopts,
2295         label: "SSL options",
2296         type: :keyword,
2297         description: "Additional SSL options",
2298         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2299         children: [
2300           %{
2301             key: :cacertfile,
2302             type: :string,
2303             description: "Path to file with PEM encoded cacerts",
2304             suggestions: ["path/to/file/with/PEM/cacerts"]
2305           },
2306           %{
2307             key: :verify,
2308             type: :atom,
2309             description: "Type of cert verification",
2310             suggestions: [:verify_peer]
2311           }
2312         ]
2313       },
2314       %{
2315         key: :tls,
2316         label: "TLS",
2317         type: :boolean,
2318         description: "Enable to use STARTTLS, usually implies the port 389"
2319       },
2320       %{
2321         key: :tlsopts,
2322         label: "TLS options",
2323         type: :keyword,
2324         description: "Additional TLS options",
2325         suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2326         children: [
2327           %{
2328             key: :cacertfile,
2329             type: :string,
2330             description: "Path to file with PEM encoded cacerts",
2331             suggestions: ["path/to/file/with/PEM/cacerts"]
2332           },
2333           %{
2334             key: :verify,
2335             type: :atom,
2336             description: "Type of cert verification",
2337             suggestions: [:verify_peer]
2338           }
2339         ]
2340       },
2341       %{
2342         key: :base,
2343         type: :string,
2344         description: "LDAP base, e.g. \"dc=example,dc=com\"",
2345         suggestions: ["dc=example,dc=com"]
2346       },
2347       %{
2348         key: :uid,
2349         type: :string,
2350         description:
2351           "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2352         suggestions: ["cn"]
2353       }
2354     ]
2355   },
2356   %{
2357     group: :pleroma,
2358     key: :auth,
2359     type: :group,
2360     description: "Authentication / authorization settings",
2361     children: [
2362       %{
2363         key: :enforce_oauth_admin_scope_usage,
2364         type: :boolean,
2365         description:
2366           "OAuth admin scope requirement toggle. " <>
2367             "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2368             "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2369             "`is_admin` user flag grants access to admin-specific actions."
2370       },
2371       %{
2372         key: :auth_template,
2373         type: :string,
2374         description:
2375           "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2376         suggestions: ["show.html"]
2377       },
2378       %{
2379         key: :oauth_consumer_template,
2380         type: :string,
2381         description:
2382           "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2383             " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2384         suggestions: ["consumer.html"]
2385       },
2386       %{
2387         key: :oauth_consumer_strategies,
2388         type: {:list, :string},
2389         description:
2390           "The list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2391             " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2392             " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2393         suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2394       }
2395     ]
2396   },
2397   %{
2398     group: :pleroma,
2399     key: :email_notifications,
2400     type: :group,
2401     description: "Email notifications settings",
2402     children: [
2403       %{
2404         key: :digest,
2405         type: :map,
2406         description:
2407           "emails of \"what you've missed\" for users who have been inactive for a while",
2408         suggestions: [
2409           %{
2410             active: false,
2411             schedule: "0 0 * * 0",
2412             interval: 7,
2413             inactivity_threshold: 7
2414           }
2415         ],
2416         children: [
2417           %{
2418             key: :active,
2419             type: :boolean,
2420             description: "Globally enable or disable digest emails"
2421           },
2422           %{
2423             key: :schedule,
2424             type: :string,
2425             description:
2426               "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2427             suggestions: ["0 0 * * 0"]
2428           },
2429           %{
2430             key: :interval,
2431             type: :integer,
2432             description: "Minimum interval between digest emails to one user",
2433             suggestions: [7]
2434           },
2435           %{
2436             key: :inactivity_threshold,
2437             type: :integer,
2438             description: "Minimum user inactivity threshold",
2439             suggestions: [7]
2440           }
2441         ]
2442       }
2443     ]
2444   },
2445   %{
2446     group: :pleroma,
2447     key: Pleroma.Emails.UserEmail,
2448     type: :group,
2449     description: "Email template settings",
2450     children: [
2451       %{
2452         key: :logo,
2453         type: :string,
2454         description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2455         suggestions: ["some/path/logo.png"]
2456       },
2457       %{
2458         key: :styling,
2459         type: :map,
2460         description: "a map with color settings for email templates.",
2461         suggestions: [
2462           %{
2463             link_color: "#d8a070",
2464             background_color: "#2C3645",
2465             content_background_color: "#1B2635",
2466             header_color: "#d8a070",
2467             text_color: "#b9b9ba",
2468             text_muted_color: "#b9b9ba"
2469           }
2470         ],
2471         children: [
2472           %{
2473             key: :link_color,
2474             type: :string,
2475             suggestions: ["#d8a070"]
2476           },
2477           %{
2478             key: :background_color,
2479             type: :string,
2480             suggestions: ["#2C3645"]
2481           },
2482           %{
2483             key: :content_background_color,
2484             type: :string,
2485             suggestions: ["#1B2635"]
2486           },
2487           %{
2488             key: :header_color,
2489             type: :string,
2490             suggestions: ["#d8a070"]
2491           },
2492           %{
2493             key: :text_color,
2494             type: :string,
2495             suggestions: ["#b9b9ba"]
2496           },
2497           %{
2498             key: :text_muted_color,
2499             type: :string,
2500             suggestions: ["#b9b9ba"]
2501           }
2502         ]
2503       }
2504     ]
2505   },
2506   %{
2507     group: :pleroma,
2508     key: :oauth2,
2509     type: :group,
2510     description: "Configure OAuth 2 provider capabilities",
2511     children: [
2512       %{
2513         key: :token_expires_in,
2514         type: :integer,
2515         description: "The lifetime in seconds of the access token",
2516         suggestions: [600]
2517       },
2518       %{
2519         key: :issue_new_refresh_token,
2520         type: :boolean,
2521         description:
2522           "Keeps old refresh token or generate new refresh token when to obtain an access token"
2523       },
2524       %{
2525         key: :clean_expired_tokens,
2526         type: :boolean,
2527         description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2528       }
2529     ]
2530   },
2531   %{
2532     group: :pleroma,
2533     key: :emoji,
2534     type: :group,
2535     children: [
2536       %{
2537         key: :shortcode_globs,
2538         type: {:list, :string},
2539         description: "Location of custom emoji files. * can be used as a wildcard.",
2540         suggestions: ["/emoji/custom/**/*.png"]
2541       },
2542       %{
2543         key: :pack_extensions,
2544         type: {:list, :string},
2545         description:
2546           "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2547         suggestions: [".png", ".gif"]
2548       },
2549       %{
2550         key: :groups,
2551         type: {:keyword, :string, {:list, :string}},
2552         description:
2553           "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2554             " and the value is the location or array of locations. * can be used as a wildcard.",
2555         suggestions: [
2556           Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2557         ]
2558       },
2559       %{
2560         key: :default_manifest,
2561         type: :string,
2562         description:
2563           "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2564             " Currently only one manifest can be added (no arrays).",
2565         suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2566       },
2567       %{
2568         key: :shared_pack_cache_seconds_per_file,
2569         label: "Shared pack cache s/file",
2570         type: :integer,
2571         descpiption:
2572           "When an emoji pack is shared, the archive is created and cached in memory" <>
2573             " for this amount of seconds multiplied by the number of files.",
2574         suggestions: [60]
2575       }
2576     ]
2577   },
2578   %{
2579     group: :pleroma,
2580     key: :database,
2581     type: :group,
2582     description: "Database related settings",
2583     children: [
2584       %{
2585         key: :rum_enabled,
2586         type: :boolean,
2587         description: "If RUM indexes should be used. Default: disabled"
2588       }
2589     ]
2590   },
2591   %{
2592     group: :pleroma,
2593     key: :rate_limit,
2594     type: :group,
2595     description:
2596       "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2597     children: [
2598       %{
2599         key: :search,
2600         type: [:tuple, {:list, :tuple}],
2601         description: "For the search requests (account & status search etc.)",
2602         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2603       },
2604       %{
2605         key: :app_account_creation,
2606         type: [:tuple, {:list, :tuple}],
2607         description: "For registering user accounts from the same IP address",
2608         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2609       },
2610       %{
2611         key: :relations_actions,
2612         type: [:tuple, {:list, :tuple}],
2613         description: "For actions on relations with all users (follow, unfollow)",
2614         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2615       },
2616       %{
2617         key: :relation_id_action,
2618         type: [:tuple, {:list, :tuple}],
2619         description: "For actions on relation with a specific user (follow, unfollow)",
2620         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2621       },
2622       %{
2623         key: :statuses_actions,
2624         type: [:tuple, {:list, :tuple}],
2625         description:
2626           "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2627         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2628       },
2629       %{
2630         key: :status_id_action,
2631         type: [:tuple, {:list, :tuple}],
2632         description:
2633           "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2634         suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2635       },
2636       %{
2637         key: :authentication,
2638         type: [:tuple, {:list, :tuple}],
2639         description: "For authentication create / password check / user existence check requests",
2640         suggestions: [{60_000, 15}]
2641       }
2642     ]
2643   },
2644   %{
2645     group: :esshd,
2646     type: :group,
2647     description:
2648       "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2649         "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2650     children: [
2651       %{
2652         key: :enabled,
2653         type: :boolean,
2654         description: "Enables SSH"
2655       },
2656       %{
2657         key: :priv_dir,
2658         type: :string,
2659         description: "Dir with SSH keys",
2660         suggestions: ["/some/path/ssh_keys"]
2661       },
2662       %{
2663         key: :handler,
2664         type: :string,
2665         description: "Handler module",
2666         suggestions: ["Pleroma.BBS.Handler"]
2667       },
2668       %{
2669         key: :port,
2670         type: :integer,
2671         description: "Port to connect",
2672         suggestions: [10_022]
2673       },
2674       %{
2675         key: :password_authenticator,
2676         type: :string,
2677         description: "Authenticator module",
2678         suggestions: ["Pleroma.BBS.Authenticator"]
2679       }
2680     ]
2681   },
2682   %{
2683     group: :mime,
2684     type: :group,
2685     description: "Mime types",
2686     children: [
2687       %{
2688         key: :types,
2689         type: :map,
2690         suggestions: [
2691           %{
2692             "application/xml" => ["xml"],
2693             "application/xrd+xml" => ["xrd+xml"],
2694             "application/jrd+json" => ["jrd+json"],
2695             "application/activity+json" => ["activity+json"],
2696             "application/ld+json" => ["activity+json"]
2697           }
2698         ],
2699         children: [
2700           %{
2701             key: "application/xml",
2702             type: {:list, :string},
2703             suggestions: ["xml"]
2704           },
2705           %{
2706             key: "application/xrd+xml",
2707             type: {:list, :string},
2708             suggestions: ["xrd+xml"]
2709           },
2710           %{
2711             key: "application/jrd+json",
2712             type: {:list, :string},
2713             suggestions: ["jrd+json"]
2714           },
2715           %{
2716             key: "application/activity+json",
2717             type: {:list, :string},
2718             suggestions: ["activity+json"]
2719           },
2720           %{
2721             key: "application/ld+json",
2722             type: {:list, :string},
2723             suggestions: ["activity+json"]
2724           }
2725         ]
2726       }
2727     ]
2728   },
2729   %{
2730     group: :tesla,
2731     type: :group,
2732     description: "Tesla settings",
2733     children: [
2734       %{
2735         key: :adapter,
2736         type: :module,
2737         description: "Tesla adapter",
2738         suggestions: [Tesla.Adapter.Hackney]
2739       }
2740     ]
2741   },
2742   %{
2743     group: :pleroma,
2744     key: :chat,
2745     type: :group,
2746     description: "Pleroma chat settings",
2747     children: [
2748       %{
2749         key: :enabled,
2750         type: :boolean
2751       }
2752     ]
2753   },
2754   %{
2755     group: :prometheus,
2756     key: Pleroma.Web.Endpoint.MetricsExporter,
2757     type: :group,
2758     description: "Prometheus settings",
2759     children: [
2760       %{
2761         key: :path,
2762         type: :string,
2763         description: "API endpoint with metrics",
2764         suggestions: ["/api/pleroma/app_metrics"]
2765       }
2766     ]
2767   },
2768   %{
2769     group: :http_signatures,
2770     type: :group,
2771     description: "HTTP Signatures settings",
2772     children: [
2773       %{
2774         key: :adapter,
2775         type: :module,
2776         suggestions: [Pleroma.Signature]
2777       }
2778     ]
2779   },
2780   %{
2781     group: :pleroma,
2782     key: :http,
2783     type: :group,
2784     description: "HTTP settings",
2785     children: [
2786       %{
2787         key: :proxy_url,
2788         label: "Proxy URL",
2789         type: [:string, :tuple],
2790         description: "Proxy URL",
2791         suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2792       },
2793       %{
2794         key: :send_user_agent,
2795         type: :boolean
2796       },
2797       %{
2798         key: :user_agent,
2799         type: [:string, :atom],
2800         description:
2801           "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2802         suggestions: ["Pleroma", :default]
2803       },
2804       %{
2805         key: :adapter,
2806         type: :keyword,
2807         description: "Adapter specific options",
2808         suggestions: [],
2809         children: [
2810           %{
2811             key: :ssl_options,
2812             type: :keyword,
2813             label: "SSL Options",
2814             description: "SSL options for HTTP adapter",
2815             children: [
2816               %{
2817                 key: :versions,
2818                 type: {:list, :atom},
2819                 description: "List of TLS version to use",
2820                 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2821               }
2822             ]
2823           }
2824         ]
2825       }
2826     ]
2827   },
2828   %{
2829     group: :pleroma,
2830     key: :markup,
2831     type: :group,
2832     children: [
2833       %{
2834         key: :allow_inline_images,
2835         type: :boolean
2836       },
2837       %{
2838         key: :allow_headings,
2839         type: :boolean
2840       },
2841       %{
2842         key: :allow_tables,
2843         type: :boolean
2844       },
2845       %{
2846         key: :allow_fonts,
2847         type: :boolean
2848       },
2849       %{
2850         key: :scrub_policy,
2851         type: {:list, :module},
2852         suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2853       }
2854     ]
2855   },
2856   %{
2857     group: :pleroma,
2858     key: :user,
2859     type: :group,
2860     children: [
2861       %{
2862         key: :deny_follow_blocked,
2863         type: :boolean
2864       }
2865     ]
2866   },
2867   %{
2868     group: :pleroma,
2869     key: :mrf_normalize_markup,
2870     label: "MRF normalize markup",
2871     description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2872     type: :group,
2873     children: [
2874       %{
2875         key: :scrub_policy,
2876         type: :module,
2877         suggestions: [Pleroma.HTML.Scrubber.Default]
2878       }
2879     ]
2880   },
2881   %{
2882     group: :pleroma,
2883     key: Pleroma.User,
2884     type: :group,
2885     children: [
2886       %{
2887         key: :restricted_nicknames,
2888         type: {:list, :string},
2889         suggestions: [
2890           ".well-known",
2891           "~",
2892           "about",
2893           "activities",
2894           "api",
2895           "auth",
2896           "check_password",
2897           "dev",
2898           "friend-requests",
2899           "inbox",
2900           "internal",
2901           "main",
2902           "media",
2903           "nodeinfo",
2904           "notice",
2905           "oauth",
2906           "objects",
2907           "ostatus_subscribe",
2908           "pleroma",
2909           "proxy",
2910           "push",
2911           "registration",
2912           "relay",
2913           "settings",
2914           "status",
2915           "tag",
2916           "user-search",
2917           "user_exists",
2918           "users",
2919           "web"
2920         ]
2921       }
2922     ]
2923   },
2924   %{
2925     group: :cors_plug,
2926     type: :group,
2927     children: [
2928       %{
2929         key: :max_age,
2930         type: :integer,
2931         suggestions: [86_400]
2932       },
2933       %{
2934         key: :methods,
2935         type: {:list, :string},
2936         suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2937       },
2938       %{
2939         key: :expose,
2940         type: {:list, :string},
2941         suggestions: [
2942           "Link",
2943           "X-RateLimit-Reset",
2944           "X-RateLimit-Limit",
2945           "X-RateLimit-Remaining",
2946           "X-Request-Id",
2947           "Idempotency-Key"
2948         ]
2949       },
2950       %{
2951         key: :credentials,
2952         type: :boolean
2953       },
2954       %{
2955         key: :headers,
2956         type: {:list, :string},
2957         suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2958       }
2959     ]
2960   },
2961   %{
2962     group: :pleroma,
2963     key: Pleroma.Plugs.RemoteIp,
2964     type: :group,
2965     description: """
2966     `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2967     **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2968     """,
2969     children: [
2970       %{
2971         key: :enabled,
2972         type: :boolean,
2973         description: "Enable/disable the plug. Default: disabled."
2974       },
2975       %{
2976         key: :headers,
2977         type: {:list, :string},
2978         description:
2979           "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]`."
2980       },
2981       %{
2982         key: :proxies,
2983         type: {:list, :string},
2984         description:
2985           "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2986       },
2987       %{
2988         key: :reserved,
2989         type: {:list, :string},
2990         description:
2991           "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2992       }
2993     ]
2994   },
2995   %{
2996     group: :pleroma,
2997     key: :web_cache_ttl,
2998     type: :group,
2999     description:
3000       "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3001     children: [
3002       %{
3003         key: :activity_pub,
3004         type: :integer,
3005         description:
3006           "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3007         suggestions: [30_000, nil]
3008       },
3009       %{
3010         key: :activity_pub_question,
3011         type: :integer,
3012         description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3013         suggestions: [30_000]
3014       }
3015     ]
3016   },
3017   %{
3018     group: :pleroma,
3019     key: :static_fe,
3020     type: :group,
3021     description:
3022       "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3023     children: [
3024       %{
3025         key: :enabled,
3026         type: :boolean,
3027         description: "Enables the rendering of static HTML. Default: disabled."
3028       }
3029     ]
3030   },
3031   %{
3032     group: :pleroma,
3033     key: :feed,
3034     type: :group,
3035     description: "Configure feed rendering.",
3036     children: [
3037       %{
3038         key: :post_title,
3039         type: :map,
3040         description: "Configure title rendering.",
3041         children: [
3042           %{
3043             key: :max_length,
3044             type: :integer,
3045             description: "Maximum number of characters before truncating title.",
3046             suggestions: [100]
3047           },
3048           %{
3049             key: :omission,
3050             type: :string,
3051             description: "Replacement which will be used after truncating string.",
3052             suggestions: ["..."]
3053           }
3054         ]
3055       }
3056     ]
3057   },
3058   %{
3059     group: :pleroma,
3060     key: :mrf_object_age,
3061     type: :group,
3062     description: "Rejects or delists posts based on their age when received.",
3063     children: [
3064       %{
3065         key: :threshold,
3066         type: :integer,
3067         description: "Required age (in seconds) of a post before actions are taken.",
3068         suggestions: [172_800]
3069       },
3070       %{
3071         key: :actions,
3072         type: {:list, :atom},
3073         description:
3074           "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3075             "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3076             "`:reject` rejects the message entirely",
3077         suggestions: [:delist, :strip_followers, :reject]
3078       }
3079     ]
3080   },
3081   %{
3082     group: :pleroma,
3083     key: :modules,
3084     type: :group,
3085     description: "Custom Runtime Modules.",
3086     children: [
3087       %{
3088         key: :runtime_dir,
3089         type: :string,
3090         description: "A path to custom Elixir modules (such as MRF policies)."
3091       }
3092     ]
3093   },
3094   %{
3095     group: :pleroma,
3096     type: :group,
3097     description: "Allow instance configuration from database.",
3098     children: [
3099       %{
3100         key: :configurable_from_database,
3101         type: :boolean,
3102         description:
3103           "Allow transferring configuration to DB with the subsequent customization from Admin api. Default: disabled"
3104       }
3105     ]
3106   }
3107 ]