diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Admin-API.md | 35 | ||||
| -rw-r--r-- | docs/Clients.md | 20 | ||||
| -rw-r--r-- | docs/Differences-in-MastodonAPI-Responses.md | 10 | ||||
| -rw-r--r-- | docs/config.md | 6 |
4 files changed, 30 insertions, 41 deletions
diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 407647645..2edb31f3c 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -7,36 +7,11 @@ Authentication is required and the user must be an admin. ### List users - Method `GET` -- Params: - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) -- Response: - -```JSON -{ - "page_size": integer, - "count": integer, - "users": [ - { - "deactivated": bool, - "id": integer, - "nickname": string - }, - ... - ] -} -``` - -## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}` - -### Search users by name or nickname - -- Method `GET` -- Params: - - `query`: **string** search term - - `local`: **bool** whether to return only local users - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) +- Query Params: + - `query`: **string** *optional* search term + - `local_only`: **bool** *optional* whether to return only local users + - `page`: **integer** *optional* page number + - `page_size`: **integer** *optional* number of users per page (default is `50`) - Response: ```JSON diff --git a/docs/Clients.md b/docs/Clients.md index c3d776488..dc3e83bcc 100644 --- a/docs/Clients.md +++ b/docs/Clients.md @@ -4,8 +4,8 @@ Feel free to contact us to be added to this list! ## Desktop ### Roma for Desktop -- Homepage: <http://www.pleroma.com/desktop-app/> -- Source Code: ??? +- Homepage: <https://www.pleroma.com/#desktopApp> +- Source Code: <https://github.com/roma-apps/roma-desktop> - Platforms: Windows, Mac, (Linux?) - Features: Streaming Ready @@ -30,6 +30,12 @@ Feel free to contact us to be added to this list! - Platforms: iOS - Features: No Streaming +### Fedilab +- Source Code: <https://gitlab.com/tom79/mastalab/> +- Contact: [@tom79@mastodon.social](https://mastodon.social/users/tom79) +- Platforms: Android +- Features: Streaming Ready + ### Nekonium - Homepage: [F-Droid Repository](https://repo.gdgd.jp.net/), [Google Play](https://play.google.com/store/apps/details?id=com.apps.nekonium), [Amazon](https://www.amazon.co.jp/dp/B076FXPRBC/) - Source: <https://git.gdgd.jp.net/lin/nekonium/> @@ -37,15 +43,9 @@ Feel free to contact us to be added to this list! - Platforms: Android - Features: Streaming Ready -### Mastalab -- Source Code: <https://gitlab.com/tom79/mastalab/> -- Contact: [@tom79@mastodon.social](https://mastodon.social/users/tom79) -- Platforms: Android -- Features: Streaming Ready - ### Roma -- Homepage: <http://www.pleroma.com/> -- Source Code: ??? +- Homepage: <https://www.pleroma.com/#mobileApps> +- Source Code: [iOS](https://github.com/roma-apps/roma-ios), [Android](https://github.com/roma-apps/roma-android) - Platforms: iOS, Android - Features: No Streaming diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 3026e1173..7b11fe90f 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -13,3 +13,13 @@ Some apps operate under the assumption that no more than 4 attachments can be re ## Timelines Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users. + +## Statuses + +Has these additional fields under the `pleroma` object: + +- `local`: true if the post was made on the local instance. + +## Accounts + +- `/api/v1/accounts/:id`: The `id` parameter can also be the `nickname` of the user. This only works in this endpoint, not the deeper nested ones for following etc. diff --git a/docs/config.md b/docs/config.md index d1bf2a6f4..a09ea95f3 100644 --- a/docs/config.md +++ b/docs/config.md @@ -129,7 +129,7 @@ See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_s ## :frontend_configurations -This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` are configured. +This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. Frontends can access these settings at `/api/pleroma/frontend_configurations` @@ -285,6 +285,10 @@ This config contains two queues: `federator_incoming` and `federator_outgoing`. ## :rich_media * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews +## :fetch_initial_posts +* `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts +* `pages`: the amount of pages to fetch + ## :hackney_pools Advanced. Tweaks Hackney (http client) connections pools. |