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