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

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