aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMaksim Pechnikov <parallel588@gmail.com>2019-12-01 16:18:16 +0300
committerMaksim Pechnikov <parallel588@gmail.com>2019-12-01 16:18:16 +0300
commit88f7cf51d43181b27db5ff1807d3e706fa336bac (patch)
tree3c3f8ba3b7685290e26c3582eeba7ba55ca1d10b /docs
parent708fd234bdff5423ca6d8003232eca0df231bbc2 (diff)
parent0d24ab04c5ea779432b4ea174a1d470dac87315d (diff)
downloadpleroma-88f7cf51d43181b27db5ff1807d3e706fa336bac.tar.gz
Merge branch 'develop' into issue/1411
Diffstat (limited to 'docs')
-rw-r--r--docs/API/admin_api.md24
-rw-r--r--docs/administration/CLI_tasks/user.md5
-rw-r--r--docs/configuration/cheatsheet.md24
3 files changed, 41 insertions, 12 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 9d914c9a6..2cac317de 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -235,14 +235,6 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
-## DEPRECATED `PATCH /api/pleroma/admin/users/:nickname/activation_status`
-
-### Active or deactivate a user
-
-- Params:
- - `nickname`
- - `status` BOOLEAN field, false value means deactivation.
-
## `GET /api/pleroma/admin/users/:nickname_or_id`
### Retrive the details of a user
@@ -878,3 +870,19 @@ Compile time settings (need instance reboot):
- Authentication: required
- Params: None
- Response: JSON, "ok" and 200 status
+
+## `PATCH /api/pleroma/admin/users/confirm_email`
+
+### Confirm users' emails
+
+- Params:
+ - `nicknames`
+- Response: Array of user nicknames
+
+## `PATCH /api/pleroma/admin/users/resend_confirmation_email`
+
+### Resend confirmation email
+
+- Params:
+ - `nicknames`
+- Response: Array of user nicknames
diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md
index cf120f2c9..96b2d9e6a 100644
--- a/docs/administration/CLI_tasks/user.md
+++ b/docs/administration/CLI_tasks/user.md
@@ -15,6 +15,11 @@ $PREFIX new <nickname> <email> [<options>]
- `--admin`/`--no-admin` - whether the user should be an admin
- `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
+## List local users
+```sh
+$PREFIX list
+```
+
## Generate an invite link
```sh
$PREFIX invite [<options>]
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index d798bd692..dc2f55229 100644
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -348,7 +348,17 @@ Available caches:
* `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
* `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
-## :hackney_pools
+## HTTP client
+
+### :http
+
+* `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
+* `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
+* `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
+* `adapter`: array of hackney options
+
+
+### :hackney_pools
Advanced. Tweaks Hackney (http client) connections pools.
@@ -656,7 +666,7 @@ Feel free to adjust the priv_dir and port number. Then you will have to create t
### :admin_token
-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:
+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 or `x-admin-token` HTTP header. Example:
```elixir
config :pleroma, :admin_token, "somerandomtoken"
@@ -664,8 +674,14 @@ config :pleroma, :admin_token, "somerandomtoken"
You can then do
-```sh
-curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
+```shell
+curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
+```
+
+or
+
+```shell
+curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
```
### :auth