git.squeep.com Git - akkoma/blob - config/description.exs

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