From ee41dbeca5e57f013a924625d641801b849f432d Mon Sep 17 00:00:00 2001 From: "Haelwenn (lanodan) Monnier" Date: Fri, 2 Nov 2018 10:13:29 +0100 Subject: [PATCH] config/config.md: Create --- config/config.md | 32 ++++++++++++++++++++++++++++++++ mix.exs | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 config/config.md diff --git a/config/config.md b/config/config.md new file mode 100644 index 000000000..b75ff2aa8 --- /dev/null +++ b/config/config.md @@ -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 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`` +* `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). diff --git a/mix.exs b/mix.exs index a5b3c33bb..ded414da9 100644 --- a/mix.exs +++ b/mix.exs @@ -20,7 +20,7 @@ defmodule Pleroma.Mixfile do homepage_url: "https://pleroma.social/", docs: [ logo: "priv/static/static/logo.png", - extras: ["README.md"], + extras: ["README.md", "config/config.md"], main: "readme" ] ]