git.squeep.com Git - akkoma/blob - docs/configuration/howto_database_config.md

   1 # How to activate Pleroma in-database configuration
   2 ## Explanation
   3
   4 The configuration of Pleroma has traditionally been managed with a config file, e.g. `config/prod.secret.exs`. This method requires a restart of the application for any configuration changes to take effect. We have made it possible to control most settings in the AdminFE interface after running a migration script.
   5
   6 ## Migration to database config
   7
   8 1. Run the mix task to migrate to the database. You'll receive some debugging output and a few messages informing you of what happened.
   9
  10   **Source:**
  11
  12   ```
  13   $ mix pleroma.config migrate_to_db
  14   ```
  15
  16   or
  17
  18   **OTP:**
  19
  20   *Note: OTP users need Pleroma to be running for `pleroma_ctl` commands to work*
  21
  22   ```
  23   $ ./bin/pleroma_ctl config migrate_to_db
  24   ```
  25
  26   ```
  27   10:04:34.155 [debug] QUERY OK source="config" db=1.6ms decode=2.0ms queue=33.5ms idle=0.0ms
  28 SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 []
  29 Migrating settings from file: /home/pleroma/config/dev.secret.exs
  30
  31   10:04:34.240 [debug] QUERY OK db=4.5ms queue=0.3ms idle=92.2ms
  32 TRUNCATE config; []
  33
  34   10:04:34.244 [debug] QUERY OK db=2.8ms queue=0.3ms idle=97.2ms
  35 ALTER SEQUENCE config_id_seq RESTART; []
  36
  37   10:04:34.256 [debug] QUERY OK source="config" db=0.8ms queue=1.4ms idle=109.8ms
  38 SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 WHERE ((c0."group" = $1) AND (c0."key" = $2)) [":pleroma", ":instance"]
  39
  40   10:04:34.292 [debug] QUERY OK db=2.6ms queue=1.7ms idle=137.7ms
  41 INSERT INTO "config" ("group","key","value","inserted_at","updated_at") VALUES ($1,$2,$3,$4,$5) RETURNING "id" [":pleroma", ":instance", <<131, 108, 0, 0, 0, 1, 104, 2, 100, 0, 4, 110, 97, 109, 101, 109, 0, 0, 0, 7, 66, 108, 101, 114, 111, 109, 97, 106>>, ~N[2020-07-12 15:04:34], ~N[2020-07-12 15:04:34]]
  42   Settings for key instance migrated.
  43   Settings for group :pleroma migrated.
  44   ```
  45
  46 2. It is recommended to backup your config file now.
  47   ```
  48   cp config/dev.secret.exs config/dev.secret.exs.orig
  49   ```
  50
  51 3. Edit your Pleroma config to enable database configuration:
  52
  53   ```
  54   config :pleroma, configurable_from_database: true
  55   ```
  56
  57 4. ⚠️ **THIS IS NOT REQUIRED** ⚠️
  58
  59   Now you can edit your config file and strip it down to the only settings which are not possible to control in the database. e.g., the Postgres (Repo) and webserver (Endpoint) settings cannot be controlled in the database because the application needs the settings to start up and access the database.
  60
  61   Any settings in the database will override those in the config file, but you may find it less confusing if the setting is only declared in one place.
  62
  63   A non-exhaustive list of settings that are only possible in the config file include the following:
  64
  65   * config :pleroma, Pleroma.Web.Endpoint
  66   * config :pleroma, Pleroma.Repo
  67   * config :pleroma, configurable\_from\_database
  68   * config :pleroma, :database, rum_enabled
  69   * config :pleroma, :connections_pool
  70
  71   Here is an example of a server config stripped down after migration:
  72
  73   ```
  74   use Mix.Config
  75
  76   config :pleroma, Pleroma.Web.Endpoint,
  77     url: [host: "cool.pleroma.site", scheme: "https", port: 443]
  78
  79   config :pleroma, Pleroma.Repo,
  80     adapter: Ecto.Adapters.Postgres,
  81     username: "pleroma",
  82     password: "MySecretPassword",
  83     database: "pleroma_prod",
  84     hostname: "localhost"
  85
  86   config :pleroma, configurable_from_database: true
  87   ```
  88
  89 5. Restart instance you can now access the Settings tab in AdminFE.
  90
  91
  92 ## Reverting back from database config
  93
  94 1. Stop your Pleroma instance.
  95
  96 2. Run the mix task to migrate back from the database. You'll receive some debugging output and a few messages informing you of what happened.
  97
  98   **Source:**
  99
 100   ```
 101   $ mix pleroma.config migrate_from_db
 102   ```
 103
 104   or
 105
 106   **OTP:**
 107
 108   ```
 109   $ ./bin/pleroma_ctl config migrate_from_db
 110   ```
 111
 112   ```
 113   10:26:30.593 [debug] QUERY OK source="config" db=9.8ms decode=1.2ms queue=26.0ms idle=0.0ms
 114 SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 []
 115
 116   10:26:30.659 [debug] QUERY OK source="config" db=1.1ms idle=80.7ms
 117 SELECT c0."id", c0."key", c0."group", c0."value", c0."inserted_at", c0."updated_at" FROM "config" AS c0 []
 118 Database configuration settings have been saved to config/dev.exported_from_db.secret.exs
 119 ```
 120
 121 3. The in-database configuration still exists, but it will not be used if you remove `config :pleroma, configurable_from_database: true` from your config.
 122
 123 ## Debugging
 124
 125 ### Clearing database config
 126 You can clear the database config by truncating the `config` table in the database. e.g.,
 127
 128 ```
 129 psql -d pleroma_dev
 130 pleroma_dev=# TRUNCATE config;
 131 TRUNCATE TABLE
 132 ```
 133
 134 Additionally, every time you migrate the configuration to the database the config table is automatically truncated to ensure a clean migration.
 135
 136 ### Manually removing a setting
 137 If you encounter a situation where the server cannot run properly because of an invalid setting in the database and this is preventing you from accessing AdminFE, you can manually remove the offending setting if you know which one it is.
 138
 139 e.g., here is an example showing a minimal configuration in the database. Only the `config :pleroma, :instance` settings are in the table:
 140
 141 ```
 142 psql -d pleroma_dev
 143 pleroma_dev=# select * from config;
 144  id |    key    |                           value                            |     inserted_at     |     updated_at      |  group
 145 ----+-----------+------------------------------------------------------------+---------------------+---------------------+----------
 146   1 | :instance | \x836c0000000168026400046e616d656d00000007426c65726f6d616a | 2020-07-12 15:33:29 | 2020-07-12 15:33:29 | :pleroma
 147 (1 row)
 148 pleroma_dev=# delete from config where key = ':instance' and group = ':pleroma';
 149 DELETE 1
 150 ```
 151
 152 Now the `config :pleroma, :instance` settings have been removed from the database.