diff options
author | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
---|---|---|
committer | Alex Gleason <alex@alexgleason.me> | 2020-12-30 17:10:02 -0600 |
commit | cbce88007672dc810cb345bb9872a009cbdc93d8 (patch) | |
tree | 45be2517812f2a598d9b6133554038a87d4b9f46 /docs/administration/CLI_tasks/config.md | |
parent | 83770b7b391fdf8bdc22f63047b1cf444a7b16ce (diff) | |
parent | 38924166eb3228deb71a2e23f1e8fd3255c6bd85 (diff) | |
download | pleroma-cbce88007672dc810cb345bb9872a009cbdc93d8.tar.gz pleroma-cbce88007672dc810cb345bb9872a009cbdc93d8.zip |
Merge remote-tracking branch 'upstream/develop' into aliases
Diffstat (limited to 'docs/administration/CLI_tasks/config.md')
-rw-r--r-- | docs/administration/CLI_tasks/config.md | 110 |
1 files changed, 109 insertions, 1 deletions
diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md index 0923004b5..000ed4d98 100644 --- a/docs/administration/CLI_tasks/config.md +++ b/docs/administration/CLI_tasks/config.md @@ -32,7 +32,7 @@ config :pleroma, configurable_from_database: false ``` -To delete transfered settings from database optional flag `-d` can be used. `<env>` is `prod` by default. +To delete transferred settings from database optional flag `-d` can be used. `<env>` is `prod` by default. === "OTP" ```sh @@ -43,3 +43,111 @@ To delete transfered settings from database optional flag `-d` can be used. `<en ```sh mix pleroma.config migrate_from_db [--env=<env>] [-d] ``` + +## Dump all of the config settings defined in the database + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config dump + ``` + +=== "From Source" + + ```sh + mix pleroma.config dump + ``` + +## List individual configuration groups in the database + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config groups + ``` + +=== "From Source" + + ```sh + mix pleroma.config groups + ``` + +## Dump the saved configuration values for a specific group or key + +e.g., this shows all the settings under `config :pleroma` + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config dump pleroma + ``` + +=== "From Source" + + ```sh + mix pleroma.config dump pleroma + ``` + +To get values under a specific key: + +e.g., this shows all the settings under `config :pleroma, :instance` + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config dump pleroma instance + ``` + +=== "From Source" + + ```sh + mix pleroma.config dump pleroma instance + ``` + +## Delete the saved configuration values for a specific group or key + +e.g., this deletes all the settings under `config :tesla` + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config delete [--force] tesla + ``` + +=== "From Source" + + ```sh + mix pleroma.config delete [--force] tesla + ``` + +To delete values under a specific key: + +e.g., this deletes all the settings under `config :phoenix, :stacktrace_depth` + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config delete [--force] phoenix stacktrace_depth + ``` + +=== "From Source" + + ```sh + mix pleroma.config delete [--force] phoenix stacktrace_depth + ``` + +## Remove all settings from the database + +This forcibly removes all saved values in the database. + +=== "OTP" + + ```sh + ./bin/pleroma_ctl config [--force] reset + ``` + +=== "From Source" + + ```sh + mix pleroma.config [--force] reset + ``` |