Synopsis

perch init [OPTIONS]

Description

init writes a self-contained perch.yaml and initializes the SQLite database without contacting mxRaven. It is intended for local testing or for deployments where mxRaven is provisioned separately.

If –email is set, init also creates the first account and its default mailbox set. Use –self-signed to generate a local TLS certificate for LAN clients.

Notes

  • The config is written with mode 0600 and the data directory with mode 0700.
  • –force overwrites an existing configuration.

Options

OptionDescription
--config <value>configuration file (default: ~/.config/perch/perch.yaml)
--data-dir <value>data directory
--hostname <value>server hostname (default: “localhost”)
--email <value>first account email
--name <value>first account display name
--password <value>first account password (prompted when empty)
--self-signedgenerate a self-signed TLS certificate
--forceoverwrite an existing configuration
--help, -hshow help

Examples

perch init --data-dir ~/.local/share/perch --hostname localhost --email you@example.com

perch init --self-signed --hostname mail.lan --email you@example.com

See also