sergiotarxz/Pleroma
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

config/config.md: Fill all the blanks

Browse Source
This commit is contained in:
Haelwenn (lanodan) Monnier 2018-11-08 14:27:21 +01:00
parent 0189ccd4d9
commit 79bdc3db19
No known key found for this signature in database
GPG Key ID: D5B7A8E43C997DEE
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
config/config.md
View File

@ -12,34 +12,36 @@
* `valid_schemes`: List of the scheme part that is considered valid to be an URL * `valid_schemes`: List of the scheme part that is considered valid to be an URL
## :instance ## :instance
* `name` * `name`: The instance’s name
* `email`: Email used to reach an Administrator/Moderator of the instance * `email`: Email used to reach an Administrator/Moderator of the instance
* `description` * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
* `limit`: Posts character limit * `limit`: Posts character limit (CW/Subject included in the counter)
* `upload_limit`: File size limit of uploads (except for avatar, background, banner) * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
* `avatar_upload_limit`: File size limit of user’s profile avatars * `avatar_upload_limit`: File size limit of user’s profile avatars
* `background_upload_limit`: File size limit of user’s profile backgrounds * `background_upload_limit`: File size limit of user’s profile backgrounds
* `banner_upload_limit`: File size limit of user’s profile backgrounds * `banner_upload_limit`: File size limit of user’s profile backgrounds
* `registerations_open` * `registerations_open`: Enable registerations for anyone, invitations can be used when false.
* `federating` * `federating`
* `allow_relay` * `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. * `rewrite_policy`: Message Rewrite Policy, either one or a list.
* `public` * `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. * `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 this config or in ``static/config.json`` * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML) * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
* `finmoji_enabled` * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo). * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
## :fe ## :fe
* `theme` This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
* `logo`
* `logo_mask` * `theme`: Which theme to use, they are defined in ``styles.json``
* `logo_margin` * `logo`: URL of the logo, defaults to Pleroma’s logo
* `background` * `logo_mask`: Whenether to mask the logo
* `redirect_root_no_login` * `logo_margin`: What margin to use around the logo
* `redirect_root_login` * `background`: URL of the background, unless viewing a user profile with a background that is set
* `show_instance_panel` * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
* `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
* `show_instance_panel`: Whenether to show the instance’s specific panel.
* `scope_options_enabled`: Enable setting an notice visibility when posting * `scope_options_enabled`: Enable setting an notice visibility when posting
* `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats`` * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
* `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default