Pleroma v1.1.9-10-g42f76306+dev mix pleroma.instance View Source

Manages Pleroma instance.

Generate a new instance config.

mix pleroma.instance gen [OPTION...]

If any 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 ADMIN_EMAIL - the email address of the instance admin
  • --notify-email NOTIFY_EMAIL - email address for notifications
  • --dbhost HOSTNAME - the hostname of the PostgreSQL database to use
  • --dbname DBNAME - the name of the database to use
  • --dbuser DBUSER - the user (aka role) to use for the database connection
  • --dbpass DBPASS - 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
  • --uploads-dir - the directory uploads go in when using a local uploader
  • --static-dir - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
  • --listen-ip - the ip the app should listen to, defaults to 127.0.0.1
  • --listen-port - the port the app should listen to, defaults to 4000

Link to this section Summary

Functions

A task needs to implement run which receives a list of command line args.

Link to this section Functions

A task needs to implement run which receives a list of command line args.

Callback implementation for Mix.Task.run/1.

Built using ExDoc (v0.21.2), designed by Friedel Ziegelmayer.