config/config.md: scope_options_enabled also addresses subject
[akkoma] / config / config.md
1 # Configuration
2
3 ## Pleroma.Upload
4 * `uploader`: Select which `Pleroma.Uploaders` to use
5 * `strip_exif`: boolean, uses ImageMagick(!) to strip exif.
6
7 ## Pleroma.Uploaders.Local
8 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
9 * `uploads_url`: The URL to access a user-uploaded file, ``{{base_url}}`` is replaced to the instance URL and ``{{file}}`` to the filename. Useful when you want to proxy the media files via another host.
10
11 ## :uri_schemes
12 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
13
14 ## :instance
15 * `name`: The instance’s name
16 * `email`: Email used to reach an Administrator/Moderator of the instance
17 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
18 * `limit`: Posts character limit (CW/Subject included in the counter)
19 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
20 * `avatar_upload_limit`: File size limit of user’s profile avatars
21 * `background_upload_limit`: File size limit of user’s profile backgrounds
22 * `banner_upload_limit`: File size limit of user’s profile backgrounds
23 * `registerations_open`: Enable registerations for anyone, invitations can be used when false.
24 * `federating`
25 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
26 * `rewrite_policy`: Message Rewrite Policy, either one or a list.
27 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
28 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
29 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
30 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
31 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
32 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
33
34 ## :fe
35 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
36
37 * `theme`: Which theme to use, they are defined in ``styles.json``
38 * `logo`: URL of the logo, defaults to Pleroma’s logo
39 * `logo_mask`: Whenether to mask the logo
40 * `logo_margin`: What margin to use around the logo
41 * `background`: URL of the background, unless viewing a user profile with a background that is set
42 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
43 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
44 * `show_instance_panel`: Whenether to show the instance’s specific panel.
45 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
46 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
47 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
48 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
49 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
50
51 ## :mrf_simple
52 * `media_removal`: List of instances to remove medias from
53 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
54 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
55 * `reject`: List of instances to reject any activities from
56 * `accept`: List of instances to accept any activities from
57
58 ## :media_proxy
59 * `enabled`: Enables proxying of remote media to the instance’s proxy
60 * `redirect_on_failure`: Use the original URL when Media Proxy fails to get it
61
62 ## :gopher
63 * `enabled`: Enables the gopher interface
64 * `ip`: IP address to bind to
65 * `port`: Port to bind to