aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEkaterina Vaartis <vaartis@cock.li>2018-12-15 22:12:20 +0300
committerEkaterina Vaartis <vaartis@cock.li>2018-12-15 22:12:20 +0300
commit98e10c0d4f9d0aa32e34d706c9aa5919a64c2db2 (patch)
treeee37175a56facb7024d0fcb745ea48896c5b764c
parent23549d39521386f217a57ef1aeb3d660eff06860 (diff)
downloadpleroma-98e10c0d4f9d0aa32e34d706c9aa5919a64c2db2.tar.gz
Add captcha documentation to config.md
-rw-r--r--config/config.exs1
-rw-r--r--config/config.md12
2 files changed, 11 insertions, 2 deletions
diff --git a/config/config.exs b/config/config.exs
index b7d439e9d..5149e9c41 100644
--- a/config/config.exs
+++ b/config/config.exs
@@ -14,7 +14,6 @@ config :pleroma, Pleroma.Captcha,
enabled: false,
method: Pleroma.Captcha.Kocaptcha
-# Kocaptcha is a very simple captcha service, the source code is here: https://github.com/koto-bank/kocaptcha
config :pleroma, Pleroma.Captcha.Kocaptcha, endpoint: "http://localhost:9093"
# Upload configuration
diff --git a/config/config.md b/config/config.md
index 8282eab14..e8b5e52cb 100644
--- a/config/config.md
+++ b/config/config.md
@@ -7,7 +7,7 @@ If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherw
* `uploader`: Select which `Pleroma.Uploaders` to use
* `filters`: List of `Pleroma.Upload.Filter` to use.
* `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
-* `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
+* `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
* `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
@@ -163,3 +163,13 @@ Web Push Notifications configuration. You can use the mix task `mix web_push.gen
* ``subject``: a mailto link for the administrative contact. It’s best if this email is not a personal email address, but rather a group email so that if a person leaves an organization, is unavailable for an extended period, or otherwise can’t respond, someone else on the list can.
* ``public_key``: VAPID public key
* ``private_key``: VAPID private key
+
+## Pleroma.Captcha
+* `enabled`: Whether the captcha should be shown on registration
+* `method`: The method/service to use for captcha
+
+### Pleroma.Captcha.Kocaptcha
+Kocaptcha is a very simple captcha service with a single API endpoint,
+the source code is here: https://github.com/koto-bank/kocaptcha
+
+* `endpoint`: the kocaptcha endpoint to use \ No newline at end of file