aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2019-02-19 19:10:55 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2019-02-19 19:10:55 +0300
commitc0ecbf6669948740a091bdf5b5441fb6ee55f4fc (patch)
tree9ad9fadc6855b1529df7ce8403683c32f776265b /docs
parentd3fe2c8ec6116fbc3058f7a795ef59564bddfb08 (diff)
parent1dd718e83c76db218f12a98344b568fe10ecbefe (diff)
downloadpleroma-c0ecbf6669948740a091bdf5b5441fb6ee55f4fc.tar.gz
[#468] Merged `upstream/develop`.
Diffstat (limited to 'docs')
-rw-r--r--docs/Differences-in-MastodonAPI-Responses.md11
-rw-r--r--docs/Pleroma-API.md14
-rw-r--r--docs/config.md31
3 files changed, 49 insertions, 7 deletions
diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md
new file mode 100644
index 000000000..f6a5b6461
--- /dev/null
+++ b/docs/Differences-in-MastodonAPI-Responses.md
@@ -0,0 +1,11 @@
+# Differences in Mastodon API responses from vanilla Mastodon
+
+A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
+
+## Flake IDs
+
+Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are sortable strings
+
+## Attachment cap
+
+Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md
index e1448d3f0..379d3dbed 100644
--- a/docs/Pleroma-API.md
+++ b/docs/Pleroma-API.md
@@ -94,3 +94,17 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
## `/api/pleroma/admin/`…
See [Admin-API](Admin-API.md)
+
+## `/api/v1/pleroma/flavour/:flavour`
+* Method `POST`
+* Authentication: required
+* Response: JSON string. Returns the user flavour or the default one on success, otherwise returns `{"error": "error_msg"}`
+* Example response: "glitch"
+* Note: This is intended to be used only by mastofe
+
+## `/api/v1/pleroma/flavour`
+* Method `GET`
+* Authentication: required
+* Response: JSON string. Returns the user flavour or the default one.
+* Example response: "glitch"
+* Note: This is intended to be used only by mastofe
diff --git a/docs/config.md b/docs/config.md
index 0c1051dee..6647549a2 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -36,14 +36,15 @@ This filter replaces the filename (not the path) of an upload. For complete obfu
An example for Sendgrid adapter:
-```
+```exs
config :pleroma, Pleroma.Mailer,
adapter: Swoosh.Adapters.Sendgrid,
api_key: "YOUR_API_KEY"
```
An example for SMTP adapter:
-```
+
+```exs
config :pleroma, Pleroma.Mailer,
adapter: Swoosh.Adapters.SMTP,
relay: "smtp.gmail.com",
@@ -209,7 +210,7 @@ their ActivityPub ID.
An example:
-```
+```exs
config :pleroma, :mrf_user_allowlist,
"example.org": ["https://example.org/users/admin"]
```
@@ -238,18 +239,34 @@ the source code is here: https://github.com/koto-bank/kocaptcha. The default end
Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the 'admin_token' parameter. Example:
-```
+```exs
config :pleroma, :admin_token, "somerandomtoken"
```
You can then do
-```
+
+```sh
curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
```
-## Pleroma.Web.Federator
+## Pleroma.Jobs
+
+A list of job queues and their settings.
+
+Job queue settings:
+
+* `max_jobs`: The maximum amount of parallel jobs running at the same time.
+
+Example:
+
+```exs
+config :pleroma, Pleroma.Jobs,
+ federator_incoming: [max_jobs: 50],
+ federator_outgoing: [max_jobs: 50]
+```
+
+This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
-* `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
## Pleroma.Web.Federator.RetryQueue