sam/pleroma
sam/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pleroma/docs/admin/config.md
Alexander Strizhakov 7c6e5c541d
docs update
2020-01-27 19:48:20 +03:00

2.7 KiB
Raw Blame History

Configuring instance

You can configure your instance from admin interface. You need account with admin rights and little change in config file, which will allow settings configuration from database.

config :pleroma, configurable_from_database: true

How it works

Settings are stored in database and are applied in runtime after each change. Most of the settings take effect immediately, except some, which need instance reboot.

How to set it up

You need to migrate your existing settings to the database. This task will migrate only added by user settings. For example you add settings to prod.secret.exs file, only these settings will be migrated to database. For release it will be /etc/pleroma/config.exs or PLEROMA_CONFIG_PATH. You can do this with mix task (all config files will remain untouched):

 ./bin/pleroma_ctl config migrate_to_db

mix pleroma.config migrate_to_db

Now you can change settings in admin interface. If reboot time settings were changed, pleroma must be rebooted.

ATTENTION

Be careful while changing the settings. Every inaccurate configuration change can break the federation or the instance load.

Compile time settings, which require instance reboot and can break instance loading:

  • all settings inside these keys:
    • :hackney_pools
    • :chat
    • Oban
    • :rate_limit
    • :markup
    • :streamer
  • partially settings inside these keys:
    • :seconds_valid in Pleroma.Captcha
    • :proxy_remote in Pleroma.Upload
    • :upload_limit in :instance
    • :digest in :email_notifications
    • :clean_expired_tokens in :oauth2
    • :enabled in Pleroma.ActivityExpiration
    • :enabled in Pleroma.ScheduledActivity
    • :enabled in :gopher

How to dump settings from database to file

Adding -d flag will delete migrated settings from database table.

 ./bin/pleroma_ctl config migrate_from_db [-d]

mix pleroma.config migrate_from_db [-d]

How to completely remove it

  1. Truncate or delete all values from config table
TRUNCATE TABLE config;
  1. If migrate_from_db task was runned, backup and delete config/{env}.exported_from_db.exs.

For prod env:

cd /opt/pleroma
cp config/prod.exported_from_db.exs config/exported_from_db.back
rm -rf config/prod.exported_from_db.exs

If you don't want to backup settings, you can skip step with cp command.

  1. Set configurable_from_database to false.
config :pleroma, configurable_from_database: false
  1. Restart pleroma instance
sudo service pleroma restart