AkkomaGang/akkoma
AkkomaGang/akkoma
15
65
Fork 92
Code Issues 177 Pull requests 24 Projects 2 Releases 14 Packages Wiki Activity

config/config.md: Complete it [WIP]

Browse source
This commit is contained in:
Haelwenn (lanodan) Monnier 2018-11-02 10:32:43 +01:00
parent ee41dbeca5
commit 0189ccd4d9
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE
1 changed files with 52 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
config/config.md
View file

@ -5,28 +5,59 @@
* `strip_exif`: boolean, uses ImageMagick(!) to strip exif.
## Pleroma.Uploaders.Local
* `uploads``: Which directory to store the user-uploads in, relative to pleroma’s working directory
* `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
* `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.
## ``:uri_schemes``
## :uri_schemes
* `valid_schemes`: List of the scheme part that is considered valid to be an URL
## ``:instance``
* ``name``
* ``email``: Email used to reach an Administrator/Moderator of the instance
* ``description``
* ``limit``: Posts character limit
* ``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 backgrounds
* ``registerations_open``
* ``federating``
* ``allow_relay``
* ``rewrite_policy``: Message Rewrite Policy, either one or a list.
* ``public``
* ``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``
* ``allowed_post_formats``: MIME-type list of formats allowed to be posted (transformed into HTML)
* ``finmoji_enabled``
* ``mrf_transparency``: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
## :instance
* `name`
* `email`: Email used to reach an Administrator/Moderator of the instance
* `description`
* `limit`: Posts character limit
* `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 backgrounds
* `registerations_open`
* `federating`
* `allow_relay`
* `rewrite_policy`: Message Rewrite Policy, either one or a list.
* `public`
* `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``
* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
* `finmoji_enabled`
* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
## :fe
* `theme`
* `logo`
* `logo_mask`
* `logo_margin`
* `background`
* `redirect_root_no_login`
* `redirect_root_login`
* `show_instance_panel`
* `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``
* `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
* `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
* `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
## :mrf_simple
* `media_removal`: List of instances to remove medias from
* `media_nsfw`: List of instances to put medias 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
## :media_proxy
* `enabled`: Enables proxying of remote media to the instance’s proxy
* `redirect_on_failure`: Use the original URL when Media Proxy fails to get it
## :gopher
* `enabled`: Enables the gopher interface
* `ip`: IP address to bind to
* `port`: Port to bind to