diff options
| author | lain <lain@soykaf.club> | 2019-08-08 16:04:20 +0200 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2019-08-08 16:04:20 +0200 |
| commit | a2b98f6d58218c5806247743aa0a2a600c9959ab (patch) | |
| tree | 49914ac1e30561e1180651ad6b0fef5d96ecfb5c /docs/api | |
| parent | e4a01d253ef7ab09d028198e5e39b9aba357486c (diff) | |
| parent | b18234e04c76daa564e0d8157dcd09566485da24 (diff) | |
| download | pleroma-a2b98f6d58218c5806247743aa0a2a600c9959ab.tar.gz | |
Merge remote-tracking branch 'origin/develop' into pleroma-conversations
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/admin_api.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index ca9303227..7ccb90836 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -575,6 +575,29 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - 404 Not Found `"Not found"` - On success: 200 OK `{}` + +## `/api/pleroma/admin/config/migrate_to_db` +### Run mix task pleroma.config migrate_to_db +Copy settings on key `:pleroma` to DB. +- Method `GET` +- Params: none +- Response: + +```json +{} +``` + +## `/api/pleroma/admin/config/migrate_from_db` +### Run mix task pleroma.config migrate_from_db +Copy all settings from DB to `config/prod.exported_from_db.secret.exs` with deletion from DB. +- Method `GET` +- Params: none +- Response: + +```json +{} +``` + ## `/api/pleroma/admin/config` ### List config settings List config settings only works with `:pleroma => :instance => :dynamic_configuration` setting to `true`. @@ -604,6 +627,9 @@ Tuples can be passed as `{"tuple": ["first_val", Pleroma.Module, []]}`. Keywords can be passed as lists with 2 child tuples, e.g. `[{"tuple": ["first_val", Pleroma.Module]}, {"tuple": ["second_val", true]}]`. +If value contains list of settings `[subkey: val1, subkey2: val2, subkey3: val3]`, it's possible to remove only subkeys instead of all settings passing `subkeys` parameter. E.g.: +{"group": "pleroma", "key": "some_key", "delete": "true", "subkeys": [":subkey", ":subkey3"]}. + Compile time settings (need instance reboot): - all settings by this keys: - `:hackney_pools` @@ -622,6 +648,7 @@ Compile time settings (need instance reboot): - `key` (string or string with leading `:` for atoms) - `value` (string, [], {} or {"tuple": []}) - `delete` = true (optional, if parameter must be deleted) + - `subkeys` [(string with leading `:` for atoms)] (optional, works only if `delete=true` parameter is passed, otherwise will be ignored) ] - Request (example): |