summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Strizhakov <alex.strizhakov@gmail.com>2020-01-27 19:48:20 +0300
committerAlexander Strizhakov <alex.strizhakov@gmail.com>2020-01-27 19:48:20 +0300
commit7c6e5c541de808957be8a1948fa7a20eba8734df (patch)
treef7d141750c5becc2f837ea45a8140152341878ba
parentac97d01fb6c3eae653ee626e21a62f74362e07cc (diff)
downloadpleroma-7c6e5c541de808957be8a1948fa7a20eba8734df.tar.gz
pleroma-7c6e5c541de808957be8a1948fa7a20eba8734df.zip
docs update
-rw-r--r--docs/API/admin_api.md13
-rw-r--r--docs/admin/config.md19
2 files changed, 25 insertions, 7 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 07aa7ec3f..2c0c5f46b 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -665,6 +665,19 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- 404 Not Found `"Not found"`
- On success: 200 OK `{}`
+## `GET /api/pleroma/admin/restart`
+
+### Restarts pleroma application
+
+- Params: none
+- Response:
+ - On failure:
+ - 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
+
+```json
+{}
+```
+
## `GET /api/pleroma/admin/config/migrate_from_db`
### Run mix task pleroma.config migrate_from_db
diff --git a/docs/admin/config.md b/docs/admin/config.md
index 35e43b6a9..b39a73961 100644
--- a/docs/admin/config.md
+++ b/docs/admin/config.md
@@ -6,11 +6,7 @@ config :pleroma, configurable_from_database: true
```
## How it works
-Settings are stored in database and are applied in `runtime` after each change. Most of the settings take effect immediately, except some, which need instance reboot. These settings are needed in `compile time`, that's why settings are duplicated to the file.
-
-File with duplicated settings is located in `config/{env}.exported_from_db.exs` if pleroma is runned from source. For prod env it will be `config/prod.exported_from_db.exs`.
-
-For releases: `/etc/pleroma/prod.exported_from_db.secret.exs` or `PLEROMA_CONFIG_PATH/prod.exported_from_db.exs`.
+Settings are stored in database and are applied in `runtime` after each change. Most of the settings take effect immediately, except some, which need instance reboot.
## How to set it up
You need to migrate your existing settings to the database. This task will migrate only added by user settings.
@@ -25,7 +21,7 @@ You can do this with mix task (all config files will remain untouched):
mix pleroma.config migrate_to_db
```
-Now you can change settings in admin interface. After each save, settings from database are duplicated to the `config/{env}.exported_from_db.exs` file.
+Now you can change settings in admin interface. If `reboot time` settings were changed, pleroma must be rebooted.
<span style="color:red">**ATTENTION**</span>
@@ -35,10 +31,19 @@ Now you can change settings in admin interface. After each save, settings from d
- all settings inside these keys:
- `:hackney_pools`
- `:chat`
+ - `Oban`
+ - `:rate_limit`
+ - `:markup`
+ - `:streamer`
- partially settings inside these keys:
- `:seconds_valid` in `Pleroma.Captcha`
- `:proxy_remote` in `Pleroma.Upload`
- `:upload_limit` in `:instance`
+ - `:digest` in `:email_notifications`
+ - `:clean_expired_tokens` in `:oauth2`
+ - `:enabled` in `Pleroma.ActivityExpiration`
+ - `:enabled` in `Pleroma.ScheduledActivity`
+ - `:enabled` in `:gopher`
## How to dump settings from database to file
@@ -59,7 +64,7 @@ mix pleroma.config migrate_from_db [-d]
```sql
TRUNCATE TABLE config;
```
-2. Delete `config/{env}.exported_from_db.exs`.
+2. If migrate_from_db task was runned, backup and delete `config/{env}.exported_from_db.exs`.
For `prod` env:
```bash