41 KiB
Configuration Cheat Sheet
This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
Pleroma configuration works by first importing the base config (config/config.exs
on source installs, compiled-in on OTP releases), then overriding it by the environment config (config/$MIX_ENV.exs
on source installs, N/A to OTP releases) and then overriding it by user config (config/$MIX_ENV.secret.exs
on source installs, typically /etc/pleroma/config.exs
on OTP releases).
You shouldn't edit the base config directly to avoid breakages and merge conflicts, but it can be used as a reference if you don't understand how an option is supposed to be formatted, the latest version of it can be viewed here.
:instance
name
: The instance’s name.email
: Email used to reach an Administrator/Moderator of the instance.notify_email
: Email used for notifications.description
: The instance’s description, can be seen in nodeinfo and/api/v1/instance
.limit
: Posts character limit (CW/Subject included in the counter).chat_limit
: Character limit of the instance chat messages.remote_limit
: Hard character limit beyond which remote posts will be dropped.upload_limit
: File size limit of uploads (except for avatar, background, banner).avatar_upload_limit
: File size limit of user’s profile avatars.background_upload_limit
: File size limit of user’s profile backgrounds.banner_upload_limit
: File size limit of user’s profile banners.poll_limits
: A map with poll limits for local polls.max_options
: Maximum number of options.max_option_chars
: Maximum number of characters per option.min_expiration
: Minimum expiration time (in seconds).max_expiration
: Maximum expiration time (in seconds).
registrations_open
: Enable registrations for anyone, invitations can be enabled when false.invites_enabled
: Enable user invitations for admins (depends onregistrations_open: false
).account_activation_required
: Require users to confirm their emails before signing in.federating
: Enable federation with other instances.federation_incoming_replies_max_depth
: Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while fetching very long threads. If set tonil
, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.federation_reachability_timeout_days
: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.allow_relay
: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.rewrite_policy
: Message Rewrite Policy, either one or a list. Here are the ones available by default:Pleroma.Web.ActivityPub.MRF.NoOpPolicy
: Doesn’t modify activities (default).Pleroma.Web.ActivityPub.MRF.DropPolicy
: Drops all activities. It generally doesn’t makes sense to use in production.Pleroma.Web.ActivityPub.MRF.SimplePolicy
: Restrict the visibility of activities from certains instances (See:mrf_simple
).Pleroma.Web.ActivityPub.MRF.TagPolicy
: Applies policies to individual users based on tags, which can be set using pleroma-fe/admin-fe/any other app that supports Pleroma Admin API. For example it allows marking posts from individual users nsfw (sensitive).Pleroma.Web.ActivityPub.MRF.SubchainPolicy
: Selectively runs other MRF policies when messages match (See:mrf_subchain
).Pleroma.Web.ActivityPub.MRF.RejectNonPublic
: Drops posts with non-public visibility settings (See:mrf_rejectnonpublic
).Pleroma.Web.ActivityPub.MRF.EnsureRePrepended
: Rewrites posts to ensure that replies to posts with subjects do not have an identical subject and instead begin with re:.Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy
: Rejects posts from likely spambots by rejecting posts from new users that contain links.Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy
: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.Pleroma.Web.ActivityPub.MRF.MentionPolicy
: Drops posts mentioning configurable users. (See:mrf_mention
).Pleroma.Web.ActivityPub.MRF.VocabularyPolicy
: Restricts activities to a configured set of vocabulary. (See:mrf_vocabulary
).Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy
: Rejects or delists posts based on their age when received. (See:mrf_object_age
).
public
: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.quarantined_instances
: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.managed_config
: Whenether the config for pleroma-fe is configured in :frontend_configurations or instatic/config.json
.allowed_post_formats
: MIME-type list of formats allowed to be posted (transformed into HTML).mrf_transparency
: Make the content of your Message Rewrite Facility settings public (via nodeinfo).mrf_transparency_exclusions
: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.extended_nickname_format
: Set totrue
to use extended local nicknames format (allows underscores/dashes). This will break federation with older software for theses nicknames.max_pinned_statuses
: The maximum number of pinned statuses.0
will disable the feature.autofollowed_nicknames
: Set to nicknames of (local) users that every new user should automatically follow.no_attachment_links
: Set to true to disable automatically adding attachment link text to statuses.welcome_message
: A message that will be send to a newly registered users as a direct message.welcome_user_nickname
: The nickname of the local user that sends the welcome message.max_report_comment_size
: The maximum size of the report comment (Default:1000
).safe_dm_mentions
: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). Default:false
.healthcheck
: If set to true, system data will be shown on/api/pleroma/healthcheck
.remote_post_retention_days
: The default amount of days to retain remote posts when pruning the database.user_bio_length
: A user bio maximum length (default:5000
).user_name_length
: A user name maximum length (default:100
).skip_thread_containment
: Skip filter out broken threads. The default isfalse
.limit_to_local_content
: Limit unauthenticated users to search for local statutes and users only. Possible values::unauthenticated
,:all
andfalse
. The default is:unauthenticated
.max_account_fields
: The maximum number of custom fields in the user profile (default:10
).max_remote_account_fields
: The maximum number of custom fields in the remote user profile (default:20
).account_field_name_length
: An account field name maximum length (default:512
).account_field_value_length
: An account field value maximum length (default:2048
).external_user_synchronization
: Enabling following/followers counters synchronization for external users.cleanup_attachments
: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
Federation
MRF policies
!!! note
Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in rewrite_policy
under :instance section.
:mrf_simple
media_removal
: List of instances to remove media from.media_nsfw
: List of instances to put media as NSFW(sensitive) from.federated_timeline_removal
: List of instances to remove from Federated (aka The Whole Known Network) Timeline.reject
: List of instances to reject any activities from.accept
: List of instances to accept any activities from.report_removal
: List of instances to reject reports from.avatar_removal
: List of instances to strip avatars from.banner_removal
: List of instances to strip banners from.
:mrf_subchain
This policy processes messages through an alternate pipeline when a given message matches certain criteria. All criteria are configured as a map of regular expressions to lists of policy modules.
match_actor
: Matches a series of regular expressions against the actor field.
Example:
config :pleroma, :mrf_subchain,
match_actor: %{
~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
}
:mrf_rejectnonpublic
allow_followersonly
: whether to allow followers-only posts.allow_direct
: whether to allow direct messages.
:mrf_hellthread
delist_threshold
: Number of mentioned users after which the message gets delisted (the message can still be seen, but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.reject_threshold
: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
:mrf_keyword
reject
: A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.federated_timeline_removal
: A list of patterns which result in message being removed from federated timelines (a.k.a unlisted), each pattern can be a string or a regular expression.replace
: A list of tuples containing{pattern, replacement}
,pattern
can be a string or a regular expression.
:mrf_mention
actors
: A list of actors, for which to drop any posts mentioning.
:mrf_vocabulary
accept
: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.reject
: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
:mrf_user_allowlist
The keys in this section are the domain names that the policy should apply to. Each key should be assigned a list of users that should be allowed through by their ActivityPub ID.
An example:
config :pleroma, :mrf_user_allowlist,
"example.org": ["https://example.org/users/admin"]
:mrf_object_age
threshold
: Required age (in seconds) of a post before actions are taken.actions
: A list of actions to apply to the post::delist
removes the post from public timelines:strip_followers
removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines:reject
rejects the message entirely
:activitypub
unfollow_blocked
: Whether blocks result in people getting unfollowedoutgoing_blocks
: Whether to federate blocks to other instancesdeny_follow_blocked
: Whether to disallow following an account that has blocked the user in questionsign_object_fetches
: Sign object fetches with HTTP signaturesauthorized_fetch_mode
: Require HTTP signatures for AP fetches
:fetch_initial_posts
enabled
: if enabled, when a new user is federated with, fetch some of their latest postspages
: the amount of pages to fetch
Pleroma.ScheduledActivity
daily_user_limit
: the number of scheduled activities a user is allowed to create in a single day (Default:25
)total_user_limit
: the number of scheduled activities a user is allowed to create in total (Default:300
)enabled
: whether scheduled activities are sent to the job queue to be executed
Pleroma.ActivityExpiration
enabled
: whether expired activities will be sent to the job queue to be deleted
Frontends
:frontend_configurations
This 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. You can find the documentation for pleroma_fe
configuration into Pleroma-FE configuration and customization for instance administrators.
Frontends can access these settings at /api/pleroma/frontend_configurations
To add your own configuration for PleromaFE, use it like this:
config :pleroma, :frontend_configurations,
pleroma_fe: %{
theme: "pleroma-dark",
# ... see /priv/static/static/config.json for the available keys.
},
masto_fe: %{
showInstanceSpecificPanel: true
}
These settings need to be complete, they will override the defaults.
:static_fe
Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
Available options:
enabled
- Enables the rendering of static HTML. Defaults tofalse
.
:assets
This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend
mascots
: KeywordList of mascots, each element MUST contain both aurl
and amime_type
key.default_mascot
: An element frommascots
- This will be used as the default mascot on MastoFE (default::pleroma_fox_tan
).
:manifest
This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
-
icons
: Describe the icons of the app, this a list of maps describing icons in the same way as the spec describes it.Example:
config :pleroma, :manifest, icons: [ %{ src: "/static/logo.png" }, %{ src: "/static/icon.png", type: "image/png" }, %{ src: "/static/icon.ico", sizes: "72x72 96x96 128x128 256x256" } ]
-
theme_color
: Describe the theme color of the app. (Example:"#282c37"
,"rebeccapurple"
). -
background_color
: Describe the background color of the app. (Example:"#191b22"
,"aliceblue"
).
:emoji
shortcode_globs
: Location of custom emoji files.*
can be used as a wildcard. Example["/emoji/custom/**/*.png"]
pack_extensions
: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example[".png", ".gif"]
groups
: Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname and the value the location or array of locations.*
can be used as a wildcard. Example[Custom: ["/emoji/*.png", "/emoji/custom/*.png"]]
default_manifest
: Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download. Currently only one manifest can be added (no arrays).shared_pack_cache_seconds_per_file
: When an emoji pack is shared, the archive is created and cached in memory for this amount of seconds multiplied by the number of files.
:media_proxy
enabled
: Enables proxying of remote media to the instance’s proxybase_url
: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.proxy_opts
: All options defined inPleroma.ReverseProxy
documentation, defaults to[max_body_length: (25*1_048_576)]
.whitelist
: List of domains to bypass the mediaproxy
Link previews
Pleroma.Web.Metadata (provider)
providers
: a list of metadata providers to enable. Providers available:Pleroma.Web.Metadata.Providers.OpenGraph
Pleroma.Web.Metadata.Providers.TwitterCard
Pleroma.Web.Metadata.Providers.RelMe
- add links from user bio with rel=me into the<header>
as<link rel=me>
.Pleroma.Web.Metadata.Providers.Feed
- add a link to a user's Atom feed into the<header>
as<link rel=alternate>
.
unfurl_nsfw
: If set totrue
nsfw attachments will be shown in previews.
:rich_media (consumer)
enabled
: if enabled the instance will parse metadata from attached links to generate link previews.ignore_hosts
: list of hosts which will be ignored by the metadata parser. For example["accounts.google.com", "xss.website"]
, defaults to[]
.ignore_tld
: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].parsers
: list of Rich Media parsers.
HTTP server
Pleroma.Web.Endpoint
!!! note
Phoenix
endpoint configuration, all configuration options can be viewed here, only common options are listed here.
http
- a list containing http protocol configuration, all configuration options can be viewed here, only common options are listed here. For deployment using docker, you need to set this to[ip: {0,0,0,0}, port: 4000]
to make pleroma accessible from other containers (such as your nginx server).ip
- a tuple consisting of 4 integersport
url
- a list containing the configuration for generating urls, acceptshost
- the host without the scheme and a post (e.gexample.com
, nothttps://example.com:2020
)scheme
- e.ghttp
,https
port
path
extra_cookie_attrs
- a list ofKey=Value
strings to be added as non-standard cookie attributes. Defaults to["SameSite=Lax"]
. See the SameSite article on OWASP for more info.
Example:
config :pleroma, Pleroma.Web.Endpoint,
url: [host: "example.com", port: 2020, scheme: "https"],
http: [
port: 8080,
ip: {127, 0, 0, 1}
]
This will make Pleroma listen on 127.0.0.1
port 8080
and generate urls starting with https://example.com:2020
:http_security
enabled
: Whether the managed content security policy is enabled.sts
: Whether to additionally send aStrict-Transport-Security
header.sts_max_age
: The maximum age for theStrict-Transport-Security
header if sent.ct_max_age
: The maximum age for theExpect-CT
header if sent.referrer_policy
: The referrer policy to use, either"same-origin"
or"no-referrer"
.report_uri
: Adds the specified url toreport-uri
andreport-to
group in CSP header.
Pleroma.Plugs.RemoteIp
!!! warning If your instance is not behind at least one reverse proxy, you should not enable this plug.
Pleroma.Plugs.RemoteIp
is a shim to call RemoteIp
but with runtime configuration.
Available options:
enabled
- Enable/disable the plug. Defaults tofalse
.headers
- A list of strings naming thereq_headers
to use when deriving theremote_ip
. Order does not matter. Defaults to["x-forwarded-for"]
.proxies
- A list of strings in CIDR notation specifying the IPs of known proxies. Defaults to[]
.reserved
- Defaults to localhost and private network.
:rate_limit
!!! note
If your instance is behind a reverse proxy ensure Pleroma.Plugs.RemoteIp
is enabled (it is enabled by default).
A keyword list of rate limiters where a key is a limiter name and value is the limiter configuration. The basic configuration is a tuple where:
- The first element:
scale
(Integer). The time scale in milliseconds. - The second element:
limit
(Integer). How many requests to limit in the time scale provided.
It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated.
For example:
config :pleroma, :rate_limit,
authentication: {60_000, 15},
search: [{1000, 10}, {1000, 30}]
Means that:
- In 60 seconds, 15 authentication attempts can be performed from the same IP address.
- In 1 second, 10 search requests can be performed from the same IP adress by unauthenticated users, while authenticated users can perform 30 search requests per second.
Supported rate limiters:
:search
- Account/Status search.:app_account_creation
- Account registration from the API.:relations_actions
- Following/Unfollowing in general.:relation_id_action
- Following/Unfollowing for a specific user.:statuses_actions
- Status actions such as: (un)repeating, (un)favouriting, creating, deleting.:status_id_action
- (un)Repeating/(un)Favouriting a particular status.:authentication
- Authentication actions, i.e getting an OAuth token.:password_reset
- Requesting password reset emails.:account_confirmation_resend
- Requesting resending account confirmation emails.:ap_routes
- Requesting statuses via ActivityPub.
:web_cache_ttl
The expiration time for the web responses cache. Values should be in milliseconds or nil
to disable expiration.
Available caches:
:activity_pub
- activity pub routes (except question activities). Defaults tonil
(no expiration).:activity_pub_question
- activity pub routes (question activities). Defaults to30_000
(30 seconds).
HTTP client
:http
proxy_url
: an upstream proxy to fetch posts and/or media with, (default:nil
)send_user_agent
: should we include a user agent with HTTP requests? (default:true
)user_agent
: what user agent should we use? (default::default
), must be string or:default
adapter
: array of hackney options
:hackney_pools
Advanced. Tweaks Hackney (http client) connections pools.
There's three pools used:
:federation
for the federation jobs. You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.:media
for rich media, media proxy:upload
for uploaded media (if using a remote uploader andproxy_remote: true
)
For each pool, the options are:
max_connections
- how much connections a pool can holdtimeout
- retention duration for connections
Captcha
Pleroma.Captcha
enabled
: Whether the captcha should be shown on registration.method
: The method/service to use for captcha.seconds_valid
: The time in seconds for which the captcha is valid.
Captcha providers
Pleroma.Captcha.Native
A built-in captcha provider. Enabled by default.
Pleroma.Captcha.Kocaptcha
Kocaptcha is a very simple captcha service with a single API endpoint,
the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
https://captcha.kotobank.ch
is hosted by the developer.
endpoint
: the Kocaptcha endpoint to use.
Uploads
Pleroma.Upload
uploader
: Which one of the uploaders to use.filters
: List of upload filters to use.link_name
: When enabled Pleroma will add aname
parameter to the url of the upload, for examplehttps://instance.tld/media/corndog.png?name=corndog.png
. This is needed to provide the correct filename in Content-Disposition headers when using filters likePleroma.Upload.Filter.Dedupe
base_url
: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.proxy_remote
: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.proxy_opts
: Proxy options, seePleroma.ReverseProxy
documentation.
!!! warning
strip_exif
has been replaced by Pleroma.Upload.Filter.Mogrify
.
Uploaders
Pleroma.Uploaders.Local
uploads
: Which directory to store the user-uploads in, relative to pleroma’s working directory.
Pleroma.Uploaders.S3
bucket
: S3 bucket name.bucket_namespace
: S3 bucket namespace.public_endpoint
: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")truncated_namespace
: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc. For example, when using CDN to S3 virtual host format, set "". At this time, write CNAME to CDN in public_endpoint.streaming_enabled
: 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.
Upload filters
Pleroma.Upload.Filter.Mogrify
args
: List of actions for themogrify
command like"strip"
or["strip", "auto-orient", {"implode", "1"}]
.
Pleroma.Upload.Filter.Dedupe
No specific configuration.
Pleroma.Upload.Filter.AnonymizeFilename
This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
Pleroma.Upload.Filter.Dedupe
before AnonymizeFilename.
text
: Text to replace filenames in links. If empty,{random}.extension
will be used. You can get the original filename extension by using{extension}
, for examplecustom-file-name.{extension}
.
Pleroma.Emails.Mailer
adapter
: one of the mail adapters listed in Swoosh readme, orSwoosh.Adapters.Local
for in-memory mailbox.api_key
/password
and / or other adapter-specific settings, per the above documentation.enabled
: Allows enable/disable send emails. Default:false
.
An example for Sendgrid adapter:
config :pleroma, Pleroma.Emails.Mailer,
enabled: true,
adapter: Swoosh.Adapters.Sendgrid,
api_key: "YOUR_API_KEY"
An example for SMTP adapter:
config :pleroma, Pleroma.Emails.Mailer,
enabled: true,
adapter: Swoosh.Adapters.SMTP,
relay: "smtp.gmail.com",
username: "YOUR_USERNAME@gmail.com",
password: "YOUR_SMTP_PASSWORD",
port: 465,
ssl: true,
auth: :always
:email_notifications
Email notifications settings.
- digest - emails of "what you've missed" for users who have been
inactive for a while.
- active: globally enable or disable digest emails
- schedule: When to send digest email, in crontab format. "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
- interval: Minimum interval between digest emails to one user
- inactivity_threshold: Minimum user inactivity threshold
Pleroma.Emails.UserEmail
:logo
- a path to a custom logo. Set it tonil
to use the default Pleroma logo.:styling
- a map with color settings for email templates.
Pleroma.Emails.NewUsersDigestEmail
:enabled
- a boolean, enables new users admin digest email whentrue
. Defaults tofalse
.
Background jobs
Oban
Oban asynchronous job processor configuration.
Configuration options described in Oban readme:
repo
- app's Ecto repo (Pleroma.Repo
)verbose
- logs verbosityprune
- non-retryable jobs pruning settings (:disabled
/{:maxlen, value}
/{:maxage, value}
)queues
- job queues (see below)crontab
- periodic jobs, seeOban.Cron
Pleroma has the following queues:
activity_expiration
- Activity expirationfederator_outgoing
- Outgoing federationfederator_incoming
- Incoming federationmailer
- Email sender, seePleroma.Emails.Mailer
transmogrifier
- Transmogrifierweb_push
- Web push notificationsscheduled_activities
- Scheduled activities, seePleroma.ScheduledActivity
Oban.Cron
Pleroma has these periodic job workers:
Pleroma.Workers.Cron.ClearOauthTokenWorker
- a job worker to cleanup expired oauth tokens.
Example:
config :pleroma, Oban,
repo: Pleroma.Repo,
verbose: false,
prune: {:maxlen, 1500},
queues: [
federator_incoming: 50,
federator_outgoing: 50
],
crontab: [
{"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker}
]
This config contains two queues: federator_incoming
and federator_outgoing
. Both have the number of max concurrent jobs set to 50
.
Migrating pleroma_job_queue
settings
config :pleroma_job_queue, :queues
is replaced by config :pleroma, Oban, :queues
and uses the same format (keys are queues' names, values are max concurrent jobs numbers).
:workers
Includes custom worker options not interpretable directly by Oban
.
retries
— keyword lists where keys areOban
queues (see above) and values are numbers of max attempts for failed jobs.
Example:
config :pleroma, :workers,
retries: [
federator_incoming: 5,
federator_outgoing: 5
]
Migrating Pleroma.Web.Federator.RetryQueue
settings
max_retries
is replaced withconfig :pleroma, :workers, retries: [federator_outgoing: 5]
enabled: false
corresponds toconfig :pleroma, :workers, retries: [federator_outgoing: 1]
- deprecated options:
max_jobs
,initial_timeout
Pleroma.Scheduler
Configuration for Quantum jobs scheduler.
See Quantum readme for the list of supported options.
Example:
config :pleroma, Pleroma.Scheduler,
global: true,
overlap: true,
timezone: :utc,
jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
The above example defines a single job which invokes Pleroma.Web.Websub.refresh_subscriptions()
every 6 hours ("0 */6 * * * *", crontab format).
:web_push_encryption, :vapid_details
Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair
to generate it.
subject
: a mailto link for the administrative contact. It’s best if this email is not a personal email address, but rather a group email so that if a person leaves an organization, is unavailable for an extended period, or otherwise can’t respond, someone else on the list can.public_key
: VAPID public keyprivate_key
: VAPID private key
:logger
backends
::console
is used to send logs to stdout,{ExSyslogger, :ex_syslogger}
to log to syslog, andQuack.Logger
to log to Slack
An example to enable ONLY ExSyslogger (f/ex in prod.secret.exs
) with info and debug suppressed:
config :logger,
backends: [{ExSyslogger, :ex_syslogger}]
config :logger, :ex_syslogger,
level: :warn
Another example, keeping console output and adding the pid to syslog output:
config :logger,
backends: [:console, {ExSyslogger, :ex_syslogger}]
config :logger, :ex_syslogger,
level: :warn,
option: [:pid, :ndelay]
See: logger’s documentation and ex_syslogger’s documentation
An example of logging info to local syslog, but warn to a Slack channel:
config :logger,
backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
level: :info
config :logger, :ex_syslogger,
level: :info,
ident: "pleroma",
format: "$metadata[$level] $message"
config :quack,
level: :warn,
meta: [:all],
webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
See the Quack Github for more details
Database options
RUM indexing for full text search
!!! warning It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
rum_enabled
: If RUM indexes should be used. Defaults tofalse
.
RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. While they may eventually be mainlined, for now they have to be installed as a PostgreSQL extension from https://github.com/postgrespro/rum.
Their advantage over the standard GIN indexes is that they allow efficient ordering of search results by timestamp, which makes search queries a lot faster on larger servers, by one or two orders of magnitude. They take up around 3 times as much space as GIN indexes.
To enable them, both the rum_enabled
flag has to be set and the following special migration has to be run:
mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/
This will probably take a long time.
Alternative client protocols
BBS / SSH access
To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
app_dir = File.cwd!
priv_dir = Path.join([app_dir, "priv/ssh_keys"])
config :esshd,
enabled: true,
priv_dir: priv_dir,
handler: "Pleroma.BBS.Handler",
port: 10_022,
password_authenticator: "Pleroma.BBS.Authenticator"
Feel free to adjust the priv_dir and port number. Then you will have to create the key for the keys (in the example priv/ssh_keys
) and create the host keys with ssh-keygen -m PEM -N "" -b 2048 -t rsa -f ssh_host_rsa_key
. After restarting, you should be able to connect to your Pleroma instance with ssh username@server -p $PORT
:gopher
enabled
: Enables the gopher interfaceip
: IP address to bind toport
: Port to bind todstport
: Port advertised in urls (optional, defaults toport
)
Authentication
:admin_token
Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the admin_token
parameter or x-admin-token
HTTP header. Example:
config :pleroma, :admin_token, "somerandomtoken"
You can then do
curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
or
curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
:auth
Pleroma.Web.Auth.PleromaAuthenticator
: default database authenticator.Pleroma.Web.Auth.LDAPAuthenticator
: LDAP authentication.
Authentication / authorization settings.
auth_template
: authentication form template. By default it'sshow.html
which corresponds tolib/pleroma/web/templates/o_auth/o_auth/show.html.eex
.oauth_consumer_template
: OAuth consumer mode authentication form template. By default it'sconsumer.html
which corresponds tolib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex
.oauth_consumer_strategies
: the list of enabled OAuth consumer strategies; by default it's set byOAUTH_CONSUMER_STRATEGIES
environment variable. Each entry in this space-delimited string should be of format<strategy>
or<strategy>:<dependency>
(e.g.twitter
orkeycloak:ueberauth_keycloak_strategy
in case dependency is named differently thanueberauth_<strategy>
).
Pleroma.Web.Auth.Authenticator
Pleroma.Web.Auth.PleromaAuthenticator
: default database authenticator.Pleroma.Web.Auth.LDAPAuthenticator
: LDAP authentication.
:ldap
Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password will be verified by trying to authenticate (bind) to an LDAP server. If a user exists in the LDAP directory but there is no account with the same name yet on the Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.
enabled
: enables LDAP authenticationhost
: LDAP server hostnameport
: LDAP port, e.g. 389 or 636ssl
: true to use SSL, usually implies the port 636sslopts
: additional SSL optionstls
: true to start TLS, usually implies the port 389tlsopts
: additional TLS optionsbase
: LDAP base, e.g. "dc=example,dc=com"uid
: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
OAuth consumer mode
OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.). Implementation is based on Ueberauth; see the list of available strategies.
!!! note
Each strategy is shipped as a separate dependency; in order to get the strategies, run OAUTH_CONSUMER_STRATEGIES="..." mix deps.get
, e.g. OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get
. The server should also be started with OAUTH_CONSUMER_STRATEGIES="..." mix phx.server
in case you enable any strategies.
!!! note Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
!!! note
Make sure that "SameSite=Lax"
is set in extra_cookie_attrs
when you have this feature enabled. OAuth consumer mode will not work with "SameSite=Strict"
-
For Twitter, register an app, configure callback URL to https://<your_host>/oauth/twitter/callback
-
For Facebook, register an app, configure callback URL to https://<your_host>/oauth/facebook/callback, enable Facebook Login service at https://developers.facebook.com/apps/<app_id>/fb-login/settings/
-
For Google, register an app, configure callback URL to https://<your_host>/oauth/google/callback
-
For Microsoft, register an app, configure callback URL to https://<your_host>/oauth/microsoft/callback
Once the app is configured on external OAuth provider side, add app's credentials and strategy-specific settings (if any — e.g. see Microsoft below) to config/prod.secret.exs
,
per strategy's documentation (e.g. ueberauth_twitter). Example config basing on environment variables:
# Twitter
config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
# Facebook
config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
client_id: System.get_env("FACEBOOK_APP_ID"),
client_secret: System.get_env("FACEBOOK_APP_SECRET"),
redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
# Google
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
client_id: System.get_env("GOOGLE_CLIENT_ID"),
client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
# Microsoft
config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
client_id: System.get_env("MICROSOFT_CLIENT_ID"),
client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
config :ueberauth, Ueberauth,
providers: [
microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
]
# Keycloak
# Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
site: keycloak_url,
authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
token_method: :post
config :ueberauth, Ueberauth,
providers: [
keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
]
OAuth 2.0 provider - :oauth2
Configure OAuth 2 provider capabilities:
token_expires_in
- The lifetime in seconds of the access token.issue_new_refresh_token
- Keeps old refresh token or generate new refresh token when to obtain an access token.clean_expired_tokens
- Enable a background job to clean expired oauth tokens. Defaults tofalse
. Interval settings sets in configuration periodic jobsOban.Cron
Link parsing
:uri_schemes
valid_schemes
: List of the scheme part that is considered valid to be an URL.
:auto_linker
Configuration for the auto_linker
library:
class: "auto-linker"
- specify the class to be added to the generated link. false to clear.rel: "noopener noreferrer"
- override the rel attribute. false to clear.new_window: true
- set to false to removetarget='_blank'
attribute.scheme: false
- Set to true to link urls with schemahttp://google.com
.truncate: false
- Set to a number to truncate urls longer then the number. Truncated urls will end in..
.strip_prefix: true
- Strip the scheme prefix.extra: false
- link urls with rarely used schemes (magnet, ipfs, irc, etc.).
Example:
config :auto_linker,
opts: [
scheme: true,
extra: true,
class: false,
strip_prefix: false,
new_window: false,
rel: "ugc"
]
Custom Runtime Modules (:modules
)
runtime_dir
: A path to custom Elixir modules (such as MRF policies).
:configurable_from_database
Boolean, enables/disables in-database configuration. Read Transfering the config to/from the database for more information.