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