summaryrefslogtreecommitdiff
path: root/config/description.exs
diff options
context:
space:
mode:
Diffstat (limited to 'config/description.exs')
-rw-r--r--config/description.exs277
1 files changed, 156 insertions, 121 deletions
diff --git a/config/description.exs b/config/description.exs
index bb1f43305..5f8add8a4 100644
--- a/config/description.exs
+++ b/config/description.exs
@@ -1,4 +1,4 @@
-use Mix.Config
+import Config
websocket_config = [
path: "/websocket",
@@ -497,6 +497,27 @@ config :pleroma, :config_description, [
},
%{
group: :pleroma,
+ key: :delete_context_objects,
+ type: :group,
+ description: "`delete_context_objects` background migration settings",
+ children: [
+ %{
+ key: :fault_rate_allowance,
+ type: :float,
+ description:
+ "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if context object deletion failed for all records.",
+ suggestions: [0.01]
+ },
+ %{
+ key: :sleep_interval_ms,
+ type: :integer,
+ description:
+ "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
+ }
+ ]
+ },
+ %{
+ group: :pleroma,
key: :instance,
type: :group,
description: "Instance-related settings",
@@ -537,17 +558,18 @@ config :pleroma, :config_description, [
]
},
%{
- key: :limit,
- type: :integer,
- description: "Posts character limit (CW/Subject included in the counter)",
+ key: :short_description,
+ type: :string,
+ description:
+ "Shorter version of instance description. It can be seen on `/api/v1/instance`",
suggestions: [
- 5_000
+ "Cool instance"
]
},
%{
- key: :chat_limit,
+ key: :limit,
type: :integer,
- description: "Character limit of the instance chat messages",
+ description: "Posts character limit (CW/Subject included in the counter)",
suggestions: [
5_000
]
@@ -561,6 +583,14 @@ config :pleroma, :config_description, [
]
},
%{
+ key: :max_media_attachments,
+ type: :integer,
+ description: "Maximum number of post media attachments",
+ suggestions: [
+ 1_000_000
+ ]
+ },
+ %{
key: :upload_limit,
type: :integer,
description: "File size limit of uploads (except for avatar, background, banner)",
@@ -682,7 +712,8 @@ config :pleroma, :config_description, [
%{
key: :allow_relay,
type: :boolean,
- description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
+ description:
+ "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
},
%{
key: :public,
@@ -694,12 +725,14 @@ config :pleroma, :config_description, [
},
%{
key: :quarantined_instances,
- type: {:list, :string},
+ type: {:list, :tuple},
+ key_placeholder: "instance",
+ value_placeholder: "reason",
description:
- "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
+ "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
suggestions: [
- "quarantined.com",
- "*.quarantined.com"
+ {"quarantined.com", "Reason"},
+ {"*.quarantined.com", "Reason"}
]
},
%{
@@ -748,6 +781,16 @@ config :pleroma, :config_description, [
]
},
%{
+ key: :max_endorsed_users,
+ type: :integer,
+ description: "The maximum number of recommended accounts. 0 will disable the feature.",
+ suggestions: [
+ 0,
+ 1,
+ 3
+ ]
+ },
+ %{
key: :autofollowed_nicknames,
type: {:list, :string},
description:
@@ -773,6 +816,13 @@ config :pleroma, :config_description, [
]
},
%{
+ key: :report_strip_status,
+ label: "Report strip status",
+ type: :boolean,
+ description:
+ "Strip associated statuses in reports to ids when closed/resolved, otherwise keep a copy"
+ },
+ %{
key: :safe_dm_mentions,
label: "Safe DM mentions",
type: :boolean,
@@ -941,6 +991,76 @@ config :pleroma, :config_description, [
key: :show_reactions,
type: :boolean,
description: "Let favourites and emoji reactions be viewed through the API."
+ },
+ %{
+ key: :profile_directory,
+ type: :boolean,
+ description: "Enable profile directory."
+ },
+ %{
+ key: :admin_privileges,
+ type: {:list, :atom},
+ suggestions: [
+ :users_read,
+ :users_manage_invites,
+ :users_manage_activation_state,
+ :users_manage_tags,
+ :users_manage_credentials,
+ :users_delete,
+ :messages_read,
+ :messages_delete,
+ :instances_delete,
+ :reports_manage_reports,
+ :moderation_log_read,
+ :announcements_manage_announcements,
+ :emoji_manage_emoji,
+ :statistics_read
+ ],
+ description:
+ "What extra privileges to allow admins (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
+ },
+ %{
+ key: :moderator_privileges,
+ type: {:list, :atom},
+ suggestions: [
+ :users_read,
+ :users_manage_invites,
+ :users_manage_activation_state,
+ :users_manage_tags,
+ :users_manage_credentials,
+ :users_delete,
+ :messages_read,
+ :messages_delete,
+ :instances_delete,
+ :reports_manage_reports,
+ :moderation_log_read,
+ :announcements_manage_announcements,
+ :emoji_manage_emoji,
+ :statistics_read
+ ],
+ description:
+ "What extra privileges to allow moderators (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
+ },
+ %{
+ key: :birthday_required,
+ type: :boolean,
+ description: "Require users to enter their birthday."
+ },
+ %{
+ key: :birthday_min_age,
+ type: :integer,
+ description:
+ "Minimum required age (in days) for users to create account. Only used if birthday is required.",
+ suggestions: [6570]
+ },
+ %{
+ key: :languages,
+ type: {:list, :string},
+ description:
+ "Languages to be exposed in /api/v1/instance. Should be in the format of BCP47 language codes.",
+ suggestions: [
+ "en"
+ ]
}
]
},
@@ -1125,51 +1245,12 @@ config :pleroma, :config_description, [
]
},
%{
- group: :quack,
- type: :group,
- label: "Quack Logger",
- description: "Quack-related settings",
- children: [
- %{
- key: :level,
- type: {:dropdown, :atom},
- description: "Log level",
- suggestions: [:debug, :info, :warn, :error]
- },
- %{
- key: :meta,
- type: {:list, :atom},
- description: "Configure which metadata you want to report on",
- suggestions: [
- :application,
- :module,
- :file,
- :function,
- :line,
- :pid,
- :crash_reason,
- :initial_call,
- :registered_name,
- :all,
- :none
- ]
- },
- %{
- key: :webhook_url,
- label: "Webhook URL",
- type: :string,
- description: "Configure the Slack incoming webhook",
- suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
- }
- ]
- },
- %{
group: :pleroma,
key: :frontend_configurations,
type: :group,
description:
"This form can be used to configure a keyword list that keeps the configuration data for any " <>
- "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
+ "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
"add your own configuration your settings all fields must be complete.",
children: [
%{
@@ -1182,7 +1263,6 @@ config :pleroma, :config_description, [
alwaysShowSubjectInput: true,
background: "/static/aurora_borealis.jpg",
collapseMessageWithSubject: false,
- disableChat: false,
greentext: false,
hideFilteredStatuses: false,
hideMutedPosts: false,
@@ -1230,12 +1310,6 @@ config :pleroma, :config_description, [
"When a message has a subject (aka Content Warning), collapse it by default"
},
%{
- key: :disableChat,
- label: "PleromaFE Chat",
- type: :boolean,
- description: "Disables PleromaFE Chat component"
- },
- %{
key: :greentext,
label: "Greentext",
type: :boolean,
@@ -1376,25 +1450,6 @@ config :pleroma, :config_description, [
suggestions: ["pleroma-dark"]
}
]
- },
- %{
- key: :masto_fe,
- label: "Masto FE",
- type: :map,
- description: "Settings for Masto FE",
- suggestions: [
- %{
- showInstanceSpecificPanel: true
- }
- ],
- children: [
- %{
- key: :showInstanceSpecificPanel,
- label: "Show instance specific panel",
- type: :boolean,
- description: "Whenether to show the instance's specific panel"
- }
- ]
}
]
},
@@ -1702,11 +1757,21 @@ config :pleroma, :config_description, [
description: "Whether to federate blocks to other instances"
},
%{
+ key: :blockers_visible,
+ type: :boolean,
+ description: "Whether a user can see someone who has blocked them"
+ },
+ %{
key: :sign_object_fetches,
type: :boolean,
description: "Sign object fetches with HTTP signatures"
},
%{
+ key: :authorized_fetch_mode,
+ type: :boolean,
+ description: "Require HTTP signatures for AP fetches"
+ },
+ %{
key: :note_replies_output_limit,
type: :integer,
description:
@@ -2564,45 +2629,6 @@ config :pleroma, :config_description, [
]
},
%{
- group: :esshd,
- label: "ESSHD",
- type: :group,
- description:
- "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
- "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
- children: [
- %{
- key: :enabled,
- type: :boolean,
- description: "Enables SSH"
- },
- %{
- key: :priv_dir,
- type: :string,
- description: "Dir with SSH keys",
- suggestions: ["/some/path/ssh_keys"]
- },
- %{
- key: :handler,
- type: :string,
- description: "Handler module",
- suggestions: ["Pleroma.BBS.Handler"]
- },
- %{
- key: :port,
- type: :integer,
- description: "Port to connect",
- suggestions: [10_022]
- },
- %{
- key: :password_authenticator,
- type: :string,
- description: "Authenticator module",
- suggestions: ["Pleroma.BBS.Authenticator"]
- }
- ]
- },
- %{
group: :mime,
label: "Mime Types",
type: :group,
@@ -2652,13 +2678,22 @@ config :pleroma, :config_description, [
},
%{
group: :pleroma,
- key: :chat,
+ key: :shout,
type: :group,
- description: "Pleroma chat settings",
+ description: "Pleroma shout settings",
children: [
%{
key: :enabled,
- type: :boolean
+ type: :boolean,
+ description: "Enables the backend Shoutbox chat feature."
+ },
+ %{
+ key: :limit,
+ type: :integer,
+ description: "Shout message character limit.",
+ suggestions: [
+ 5_000
+ ]
}
]
},
@@ -2703,7 +2738,7 @@ config :pleroma, :config_description, [
key: :versions,
type: {:list, :atom},
description: "List of TLS version to use",
- suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
+ suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2", ":tlsv1.3"]
}
]
}