3c3f6928217a3c0d59be76a7e30066269e9b87d6
[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`
16 * `email`: Email used to reach an Administrator/Moderator of the instance
17 * `description`
18 * `limit`: Posts character limit
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`
24 * `federating`
25 * `allow_relay`
26 * `rewrite_policy`: Message Rewrite Policy, either one or a list.
27 * `public`
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`
32 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
33
34 ## :fe
35 * `theme`
36 * `logo`
37 * `logo_mask`
38 * `logo_margin`
39 * `background`
40 * `redirect_root_no_login`
41 * `redirect_root_login`
42 * `show_instance_panel`
43 * `scope_options_enabled`: Enable setting an notice visibility when posting
44 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
45 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
46 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
47 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
48
49 ## :mrf_simple
50 * `media_removal`: List of instances to remove medias from
51 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
52 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
53 * `reject`: List of instances to reject any activities from
54 * `accept`: List of instances to accept any activities from
55
56 ## :media_proxy
57 * `enabled`: Enables proxying of remote media to the instance’s proxy
58 * `redirect_on_failure`: Use the original URL when Media Proxy fails to get it
59
60 ## :gopher
61 * `enabled`: Enables the gopher interface
62 * `ip`: IP address to bind to
63 * `port`: Port to bind to