diff options
| author | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
| commit | 4fe2af3b2d6b0701de2ae88f9932e4b6039ced11 (patch) | |
| tree | 95dfb9f82ee8a3259f0f8d1d6ce27cc562819fb6 /docs/administration/CLI_tasks/instance.md | |
| parent | c5e937b156ea1f8f96ade7d9104fc2c5fd1dd9cd (diff) | |
| parent | b2f2012a4f34cfe8151e62d045f0eab3d165791a (diff) | |
| download | pleroma-4fe2af3b2d6b0701de2ae88f9932e4b6039ced11.tar.gz | |
Merge branch 'mkdocs-migration-prep' into 'develop'
MkDocs migration preparation
See merge request pleroma/pleroma!1774
Diffstat (limited to 'docs/administration/CLI_tasks/instance.md')
| -rw-r--r-- | docs/administration/CLI_tasks/instance.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/instance.md b/docs/administration/CLI_tasks/instance.md new file mode 100644 index 000000000..ab0b68ad0 --- /dev/null +++ b/docs/administration/CLI_tasks/instance.md @@ -0,0 +1,30 @@ +# Managing instance configuration + +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`. + +## Generate a new configuration file +```sh +$PREFIX gen [<options>] +``` + +If any of the options are left unspecified, you will be prompted interactively. + +### Options +- `-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 |