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