1 # Managing instance configuration
3 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
5 ## Generate a new configuration file
9 ./bin/pleroma_ctl instance gen [option ...]
15 mix pleroma.instance gen [option ...]
19 If any of the options are left unspecified, you will be prompted interactively.
22 - `-f`, `--force` - overwrite any output files
23 - `-o <path>`, `--output <path>` - the output file for the generated configuration
24 - `--output-psql <path>` - the output file for the generated PostgreSQL setup
25 - `--domain <domain>` - the domain of your instance
26 - `--instance-name <instance_name>` - the name of your instance
27 - `--admin-email <email>` - the email address of the instance admin
28 - `--notify-email <email>` - email address for notifications
29 - `--dbhost <hostname>` - the hostname of the PostgreSQL database to use
30 - `--dbname <database_name>` - the name of the database to use
31 - `--dbuser <username>` - the user (aka role) to use for the database connection
32 - `--dbpass <password>` - the password to use for the database connection
33 - `--rum <Y|N>` - Whether to enable RUM indexes
34 - `--indexable <Y|N>` - Allow/disallow indexing site by search engines
35 - `--db-configurable <Y|N>` - Allow/disallow configuring instance from admin part
36 - `--uploads-dir <path>` - the directory uploads go in when using a local uploader
37 - `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
38 - `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
39 - `--listen-port <port>` - the port the app should listen to, defaults to 4000
40 - `--strip-uploads-location <Y|N>` - use ExifTool to strip uploads of sensitive location data
41 - `--read-uploads-description <Y|N>` - use ExifTool to read image descriptions from uploads
42 - `--anonymize-uploads <Y|N>` - randomize uploaded filenames
43 - `--dedupe-uploads <Y|N>` - store files based on their hash to reduce data storage requirements if duplicates are uploaded with different filenames
44 - `--skip-release-env` - skip generation the release environment file
45 - `--release-env-file` - release environment file path