projects
/
akkoma
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Avoid `use Phoenix.Swoosh` to prevent recompiling the Endpoint
[akkoma]
/
config
/
description.exs
diff --git
a/config/description.exs
b/config/description.exs
index 54b5fd5d60e9bea2e1f6f2998dece5fbc00c98f7..d9b15e68418eeed6e515e2a6fb871b9ef49d1759 100644
(file)
--- a/
config/description.exs
+++ b/
config/description.exs
@@
-99,7
+99,8
@@
config :pleroma, :config_description, [
key: :base_url,
label: "Base URL",
type: :string,
key: :base_url,
label: "Base URL",
type: :string,
- description: "Base URL for the uploads, needed if you use CDN",
+ description:
+ "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
suggestions: [
"https://cdn-host.com"
]
suggestions: [
"https://cdn-host.com"
]
@@
-214,31
+215,31
@@
config :pleroma, :config_description, [
type: :group,
description: "Mailer-related settings",
children: [
type: :group,
description: "Mailer-related settings",
children: [
+ %{
+ key: :enabled,
+ label: "Mailer Enabled",
+ type: :boolean
+ },
%{
key: :adapter,
type: :module,
description:
"One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
suggestions: [
%{
key: :adapter,
type: :module,
description:
"One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
suggestions: [
- Swoosh.Adapters.SMTP,
- Swoosh.Adapters.Sendgrid,
- Swoosh.Adapters.Sendmail,
- Swoosh.Adapters.Mandrill,
+ Swoosh.Adapters.AmazonSES,
+ Swoosh.Adapters.Dyn,
+ Swoosh.Adapters.Gmail,
Swoosh.Adapters.Mailgun,
Swoosh.Adapters.Mailjet,
Swoosh.Adapters.Mailgun,
Swoosh.Adapters.Mailjet,
+ Swoosh.Adapters.Mandrill,
Swoosh.Adapters.Postmark,
Swoosh.Adapters.Postmark,
- Swoosh.Adapters.S
parkPost
,
- Swoosh.Adapters.
AmazonSES
,
- Swoosh.Adapters.
Dyn
,
+ Swoosh.Adapters.S
MTP
,
+ Swoosh.Adapters.
Sendgrid
,
+ Swoosh.Adapters.
Sendmail
,
Swoosh.Adapters.SocketLabs,
Swoosh.Adapters.SocketLabs,
- Swoosh.Adapters.
Gmail
+ Swoosh.Adapters.
SparkPost
]
},
]
},
- %{
- key: :enabled,
- type: :boolean,
- description: "Pleroma Email sending capability"
- },
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
key: :relay,
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
key: :relay,
@@
-250,7
+251,8
@@
config :pleroma, :config_description, [
group: {:subgroup, Swoosh.Adapters.SMTP},
key: :port,
type: :integer,
group: {:subgroup, Swoosh.Adapters.SMTP},
key: :port,
type: :integer,
- description: "SMTP port"
+ description: "SMTP port",
+ suggestions: ["1025"]
},
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
},
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
@@
-271,7
+273,7
@@
config :pleroma, :config_description, [
key: :ssl,
label: "Use SSL",
type: :boolean,
key: :ssl,
label: "Use SSL",
type: :boolean,
- description: "Use
i
mplicit SSL/TLS. e.g. port 465"
+ description: "Use
I
mplicit SSL/TLS. e.g. port 465"
},
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
},
%{
group: {:subgroup, Swoosh.Adapters.SMTP},
@@
-299,139
+301,130
@@
config :pleroma, :config_description, [
%{
group: {:subgroup, Swoosh.Adapters.Sendgrid},
key: :api_key,
%{
group: {:subgroup, Swoosh.Adapters.Sendgrid},
key: :api_key,
- label: "
API k
ey",
+ label: "
SendGrid API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["YOUR_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_path,
type: :string,
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_path,
type: :string,
- description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
suggestions: ["/usr/bin/sendmail"]
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_args,
type: :string,
suggestions: ["/usr/bin/sendmail"]
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_args,
type: :string,
- description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
suggestions: ["-N delay,failure,success"]
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :qmail,
suggestions: ["-N delay,failure,success"]
},
%{
group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :qmail,
-
type: :boolean
,
- description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
+
label: "Qmail compat mode"
,
+ type: :boolean
},
%{
group: {:subgroup, Swoosh.Adapters.Mandrill},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.Mandrill},
key: :api_key,
- label: "
API k
ey",
+ label: "
Mandrill API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["YOUR_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :api_key,
- label: "
API k
ey",
+ label: "
Mailgun API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["YOUR_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :domain,
type: :string,
},
%{
group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :domain,
type: :string,
- description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
- suggestions: ["pleroma.com"]
+ suggestions: ["YOUR_DOMAIN_NAME"]
},
%{
group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :api_key,
- label: "
API k
ey",
+ label: "
MailJet Public API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["MJ_APIKEY_PUBLIC"]
},
%{
group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :secret,
},
%{
group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :secret,
+ label: "MailJet Private API Key",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
- suggestions: ["my-secret-key"]
+ suggestions: ["MJ_APIKEY_PRIVATE"]
},
%{
group: {:subgroup, Swoosh.Adapters.Postmark},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.Postmark},
key: :api_key,
- label: "
API k
ey",
+ label: "
Postmark API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Postmark` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["X-Postmark-Server-Token"]
},
%{
group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :api_key,
- label: "API key",
+ label: "
SparkPost
API key",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["YOUR_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :endpoint,
type: :string,
},
%{
group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :endpoint,
type: :string,
- description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
suggestions: ["https://api.sparkpost.com/api/v1"]
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
suggestions: ["https://api.sparkpost.com/api/v1"]
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
- key: :region,
+ key: :access_key,
+ label: "AWS Access Key",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
- suggestions: ["us-east-1", "us-east-2"]
+ suggestions: ["AWS_ACCESS_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
- key: :access_key,
+ key: :secret,
+ label: "AWS Secret Key",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
- suggestions: ["aws-access-key"]
+ suggestions: ["AWS_SECRET_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
},
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
- key: :secret,
+ key: :region,
+ label: "AWS Region",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
- suggestions: ["aws-secret-key"]
+ suggestions: ["us-east-1", "us-east-2"]
},
%{
group: {:subgroup, Swoosh.Adapters.Dyn},
key: :api_key,
},
%{
group: {:subgroup, Swoosh.Adapters.Dyn},
key: :api_key,
- label: "
API k
ey",
+ label: "
Dyn API K
ey",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Dyn` adapter specific setting",
- suggestions: ["my-api-key"]
+ suggestions: ["apikey"]
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
- key: :server_id,
+ key: :api_key,
+ label: "SocketLabs API Key",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
+ suggestions: ["INJECTION_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
- key: :
api_key
,
- label: "
API key
",
+ key: :
server_id
,
+ label: "
Server ID
",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
+ suggestions: ["SERVER_ID"]
},
%{
group: {:subgroup, Swoosh.Adapters.Gmail},
key: :access_token,
},
%{
group: {:subgroup, Swoosh.Adapters.Gmail},
key: :access_token,
+ label: "GMail API Access Token",
type: :string,
type: :string,
- description: "`Swoosh.Adapters.Gmail` adapter specific setting"
+ suggestions: ["GMAIL_API_ACCESS_TOKEN"]
}
]
},
}
]
},
@@
-1516,7
+1509,8
@@
config :pleroma, :config_description, [
%{
key: :max_body_length,
type: :integer,
%{
key: :max_body_length,
type: :integer,
- description: "Maximum file size allowed through the Pleroma MediaProxy cache."
+ description:
+ "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
},
%{
key: :max_read_duration,
},
%{
key: :max_read_duration,
@@
-1566,7
+1560,7
@@
config :pleroma, :config_description, [
key: :min_content_length,
type: :integer,
description:
key: :min_content_length,
type: :integer,
description:
- "Min content length
to perform preview, in bytes. If greater than 0, media smaller in size will be served as is,
without thumbnailing."
+ "Min content length
(in bytes) to perform preview. Media smaller in size will be served
without thumbnailing."
}
]
},
}
]
},
@@
-1614,6
+1608,7
@@
config :pleroma, :config_description, [
},
%{
key: :url_format,
},
%{
key: :url_format,
+ label: "URL Format",
type: :string,
description:
"Optional URL format preprocessing. Only required for Apache's htcacheclean.",
type: :string,
description:
"Optional URL format preprocessing. Only required for Apache's htcacheclean.",
@@
-2859,7
+2854,7
@@
config :pleroma, :config_description, [
type: :integer,
description:
"Activity pub routes (except question activities). Default: `nil` (no expiration).",
type: :integer,
description:
"Activity pub routes (except question activities). Default: `nil` (no expiration).",
- suggestions: [
30_000,
nil]
+ suggestions: [nil]
},
%{
key: :activity_pub_question,
},
%{
key: :activity_pub_question,
@@
-3297,9
+3292,9
@@
config :pleroma, :config_description, [
},
%{
key: :ip_whitelist,
},
%{
key: :ip_whitelist,
+ label: "IP Whitelist",
type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
- description:
- "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
+ description: "Restrict access of app metrics endpoint to the specified IP addresses."
},
%{
key: :auth,
},
%{
key: :auth,