config: add default parameters for CSPPlug
[akkoma] / config / config.md
1 # Configuration
2
3 This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
4 If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.
5
6 ## Pleroma.Upload
7 * `uploader`: Select which `Pleroma.Uploaders` to use
8 * `strip_exif`: boolean, uses ImageMagick(!) to strip exif.
9
10 ## Pleroma.Uploaders.Local
11 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
12 * `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.
13
14 ## :uri_schemes
15 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
16
17 ## :instance
18 * `name`: The instance’s name
19 * `email`: Email used to reach an Administrator/Moderator of the instance
20 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
21 * `limit`: Posts character limit (CW/Subject included in the counter)
22 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
23 * `avatar_upload_limit`: File size limit of user’s profile avatars
24 * `background_upload_limit`: File size limit of user’s profile backgrounds
25 * `banner_upload_limit`: File size limit of user’s profile backgrounds
26 * `registerations_open`: Enable registerations for anyone, invitations can be used when false.
27 * `federating`
28 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
29 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
30 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
31 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
32 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
33 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
34 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
35 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
36 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
37 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
38 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
39 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
40
41 ## :fe
42 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
43
44 * `theme`: Which theme to use, they are defined in ``styles.json``
45 * `logo`: URL of the logo, defaults to Pleroma’s logo
46 * `logo_mask`: Whenether to mask the logo
47 * `logo_margin`: What margin to use around the logo
48 * `background`: URL of the background, unless viewing a user profile with a background that is set
49 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
50 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
51 * `show_instance_panel`: Whenether to show the instance’s specific panel.
52 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
53 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
54 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
55 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
56 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
57
58 ## :mrf_simple
59 * `media_removal`: List of instances to remove medias from
60 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
61 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
62 * `reject`: List of instances to reject any activities from
63 * `accept`: List of instances to accept any activities from
64
65 ## :mrf_rejectnonpublic
66 * `allow_followersonly`: whether to allow followers-only posts
67 * `allow_direct`: whether to allow direct messages
68
69 ## :media_proxy
70 * `enabled`: Enables proxying of remote media to the instance’s proxy
71 * `redirect_on_failure`: Use the original URL when Media Proxy fails to get it
72
73 ## :gopher
74 * `enabled`: Enables the gopher interface
75 * `ip`: IP address to bind to
76 * `port`: Port to bind to
77
78 ## :activitypub
79 * ``accept_blocks``: Whether to accept incoming block activities from other instances
80 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
81 * ``outgoing_blocks``: Whether to federate blocks to other instances
82 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
83
84 ## :csp
85 * ``enabled``: Whether the managed content security policy is enabled
86 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
87 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent