2019-10-03 06:02:48 +00:00
|
|
|
# Managing instance configuration
|
|
|
|
|
|
2019-12-09 01:07:16 +00:00
|
|
|
{! backend/administration/CLI_tasks/general_cli_task_info.include !}
|
2019-10-03 06:02:48 +00:00
|
|
|
|
|
|
|
|
## Generate a new configuration file
|
2019-12-09 01:07:16 +00:00
|
|
|
```sh tab="OTP"
|
|
|
|
|
./bin/pleroma_ctl instance gen [<options>]
|
2019-10-03 06:02:48 +00:00
|
|
|
```
|
|
|
|
|
|
2019-12-09 01:07:16 +00:00
|
|
|
```sh tab="From Source"
|
|
|
|
|
mix pleroma.instance gen [<options>]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
2019-10-03 06:02:48 +00:00
|
|
|
If any of the options are left unspecified, you will be prompted interactively.
|
|
|
|
|
|
2019-10-03 06:36:35 +00:00
|
|
|
### Options
|
2019-10-03 06:02:48 +00:00
|
|
|
- `-f`, `--force` - overwrite any output files
|
|
|
|
|
- `-o <path>`, `--output <path>` - the output file for the generated configuration
|
|
|
|
|
- `--output-psql <path>` - the output file for the generated PostgreSQL setup
|
|
|
|
|
- `--domain <domain>` - the domain of your instance
|
|
|
|
|
- `--instance-name <instance_name>` - the name of your instance
|
|
|
|
|
- `--admin-email <email>` - the email address of the instance admin
|
|
|
|
|
- `--notify-email <email>` - email address for notifications
|
|
|
|
|
- `--dbhost <hostname>` - the hostname of the PostgreSQL database to use
|
|
|
|
|
- `--dbname <database_name>` - the name of the database to use
|
|
|
|
|
- `--dbuser <username>` - the user (aka role) to use for the database connection
|
|
|
|
|
- `--dbpass <password>` - the password to use for the database connection
|
|
|
|
|
- `--rum <Y|N>` - Whether to enable RUM indexes
|
|
|
|
|
- `--indexable <Y|N>` - Allow/disallow indexing site by search engines
|
|
|
|
|
- `--db-configurable <Y|N>` - Allow/disallow configuring instance from admin part
|
|
|
|
|
- `--uploads-dir <path>` - the directory uploads go in when using a local uploader
|
|
|
|
|
- `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
|
|
|
|
|
- `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
|
|
|
|
|
- `--listen-port <port>` - the port the app should listen to, defaults to 4000
|
