Move config task docs to a separate file and mark it as WIP
This commit is contained in:
parent
e00403af23
commit
1cae564b5d
|
@ -0,0 +1,19 @@
|
||||||
|
# Transfering the config to/from the database
|
||||||
|
|
||||||
|
!!! danger
|
||||||
|
This is a Work In Progress, not usable just yet.
|
||||||
|
|
||||||
|
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl config` and in case of source installs it's
|
||||||
|
`mix pleroma.config`.
|
||||||
|
|
||||||
|
## Transfer config from file to DB.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$PREFIX migrate_to_db
|
||||||
|
```
|
||||||
|
|
||||||
|
## Transfer config from DB to `config/env.exported_from_db.secret.exs`
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$PREFIX migrate_from_db <env>
|
||||||
|
```
|
|
@ -131,13 +131,17 @@ config :pleroma, Pleroma.Emails.Mailer,
|
||||||
* `user_name_length`: A user name maximum length (default: `100`)
|
* `user_name_length`: A user name maximum length (default: `100`)
|
||||||
* `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
|
* `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
|
||||||
* `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
|
* `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
|
||||||
* `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
|
|
||||||
* `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`)
|
* `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`)
|
||||||
* `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`)
|
* `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`)
|
||||||
* `account_field_name_length`: An account field name maximum length (default: `512`)
|
* `account_field_name_length`: An account field name maximum length (default: `512`)
|
||||||
* `account_field_value_length`: An account field value maximum length (default: `2048`)
|
* `account_field_value_length`: An account field value maximum length (default: `2048`)
|
||||||
* `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
|
* `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
|
||||||
|
|
||||||
|
!!! danger
|
||||||
|
This is a Work In Progress, not usable just yet
|
||||||
|
|
||||||
|
* `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## :logger
|
## :logger
|
||||||
|
|
|
@ -8,18 +8,7 @@ defmodule Mix.Tasks.Pleroma.Config do
|
||||||
alias Pleroma.Repo
|
alias Pleroma.Repo
|
||||||
alias Pleroma.Web.AdminAPI.Config
|
alias Pleroma.Web.AdminAPI.Config
|
||||||
@shortdoc "Manages the location of the config"
|
@shortdoc "Manages the location of the config"
|
||||||
@moduledoc """
|
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
|
||||||
Manages the location of the config.
|
|
||||||
|
|
||||||
## Transfers config from file to DB.
|
|
||||||
|
|
||||||
mix pleroma.config migrate_to_db
|
|
||||||
|
|
||||||
## Transfers config from DB to file `config/env.exported_from_db.secret.exs`
|
|
||||||
|
|
||||||
mix pleroma.config migrate_from_db ENV
|
|
||||||
"""
|
|
||||||
|
|
||||||
def run(["migrate_to_db"]) do
|
def run(["migrate_to_db"]) do
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue