config/config.md: Create

This commit is contained in:
Haelwenn (lanodan) Monnier 2018-11-02 10:13:29 +01:00
parent 8b2541e4e7
commit ee41dbeca5
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE
2 changed files with 33 additions and 1 deletions

32
config/config.md Normal file
View file

@ -0,0 +1,32 @@
# Configuration
## Pleroma.Upload
* `uploader`: Select which `Pleroma.Uploaders` to use
* `strip_exif`: boolean, uses ImageMagick(!) to strip exif.
## Pleroma.Uploaders.Local
* `uploads``: Which directory to store the user-uploads in, relative to pleromas 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``
* `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 users profile avatars
* ``background_upload_limit``: File size limit of users profile backgrounds
* ``banner_upload_limit``: File size limit of users 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).

View file

@ -20,7 +20,7 @@ defmodule Pleroma.Mixfile do
homepage_url: "https://pleroma.social/", homepage_url: "https://pleroma.social/",
docs: [ docs: [
logo: "priv/static/static/logo.png", logo: "priv/static/static/logo.png",
extras: ["README.md"], extras: ["README.md", "config/config.md"],
main: "readme" main: "readme"
] ]
] ]