fedi/akkoma
1
0
Fork 0
mirror of https://akkoma.dev/AkkomaGang/akkoma.git synced 2024-11-30 17:11:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
akkoma/docs/administration/CLI_tasks/instance.md
rinpatch 4fcf272717 Docs: Fix the way tabs are declared 
Since python doesn't have a way to lock deps for a particlar project
by default, I didn't bother with it. This resulted in mkdocs updating at
some point, bringing a breaking change to how tabs are declared and
broken tabs on docs-develop.pleroma.social. I've learned my lesson
and locked deps with pipenv in pleroma/docs!5. This MR updates Pleroma
docs to use the new tab style, fortunately my editor did most of it.

Closes #2045
2020-08-15 09:55:59 +03:00

1.7 KiB
Raw Blame History

Managing instance configuration

{! backend/administration/CLI_tasks/general_cli_task_info.include !}

Generate a new configuration file

=== "OTP"

```sh
 ./bin/pleroma_ctl instance gen [option ...]
```

=== "From Source"

```sh
mix pleroma.instance gen [option ...]
```

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