git.squeep.com Git - akkoma/blob - docs/administration/CLI_tasks/instance.md

   1 # Managing instance configuration
   2
   3 Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl instance` and in case of source installs it's `mix pleroma.instance`.
   4
   5 ## Generate a new configuration file
   6 ```sh
   7 $PREFIX gen [<options>]
   8 ```
   9
  10 If any of the options are left unspecified, you will be prompted interactively.
  11
  12 ### Options
  13 - `-f`, `--force` - overwrite any output files
  14 - `-o <path>`, `--output <path>` - the output file for the generated configuration
  15 - `--output-psql <path>` - the output file for the generated PostgreSQL setup
  16 - `--domain <domain>` - the domain of your instance
  17 - `--instance-name <instance_name>` - the name of your instance
  18 - `--admin-email <email>` - the email address of the instance admin
  19 - `--notify-email <email>` - email address for notifications
  20 - `--dbhost <hostname>` - the hostname of the PostgreSQL database to use
  21 - `--dbname <database_name>` - the name of the database to use
  22 - `--dbuser <username>` - the user (aka role) to use for the database connection
  23 - `--dbpass <password>` - the password to use for the database connection
  24 - `--rum <Y|N>` - Whether to enable RUM indexes
  25 - `--indexable <Y|N>` - Allow/disallow indexing site by search engines
  26 - `--db-configurable <Y|N>` - Allow/disallow configuring instance from admin part
  27 - `--uploads-dir <path>` - the directory uploads go in when using a local uploader
  28 - `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
  29 - `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
  30 - `--listen-port <port>` - the port the app should listen to, defaults to 4000