use Mix.Config
-alias Pleroma.Docs.Formatter
+alias Pleroma.Docs.Generator
websocket_config = [
path: "/websocket",
type: :module,
description: "Module which will be used for uploads",
suggestions: [
- Formatter.uploaders_list()
+ Generator.uploaders_list()
]
},
%{
type: {:list, :module},
description: "List of filter modules for uploads",
suggestions: [
- Formatter.filters_list()
+ Generator.filters_list()
]
},
%{
key: :link_name,
type: :boolean,
- description: "If enabled Pleroma will add name parameter to the url off the upload",
+ description:
+ "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`",
suggestions: [
true,
false
%{
key: :proxy_remote,
type: :boolean,
- description: "If enabled, Pleroma will proxy media requests instead of redirecting to it",
+ description:
+ "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected.",
suggestions: [
true,
false
%{
key: :proxy_opts,
type: :keyword,
- description: "Proxy options, see `Pleroma.ReverseProxy` documentation",
- suggestions: ["somehow created link to Pleroma.ReverseProxy options"]
+ description: "Proxy options, see `Pleroma.ReverseProxy` documentation"
}
]
},
children: [
%{
key: :bucket,
- type: :strings,
+ type: :string,
description: "S3 bucket",
suggestions: [
"bucket"
description: "A list of MRF policies enabled",
suggestions: [
Pleroma.Web.ActivityPub.MRF.NoOpPolicy,
- Formatter.mrf_list()
+ Generator.mrf_list()
]
},
%{
type: {:list, :module},
description: "list of Rich Media parsers",
suggestions: [
- Formatter.richmedia_parsers()
+ Generator.richmedia_parsers()
]
},
%{
suggestions: [["Authorization", "Content-Type", "Idempotency-Key"]]
}
]
+ },
+ %{
+ group: :pleroma,
+ key: :web_cache_ttl,
+ type: :group,
+ description:
+ "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
+ children: [
+ %{
+ key: :activity_pub,
+ type: :integer,
+ description:
+ "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
+ suggestions: [30_000, nil]
+ },
+ %{
+ key: :activity_pub_question,
+ type: :integer,
+ description:
+ "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
+ suggestions: [30_000]
+ }
+ ]
}
]