# `mix squatch_mail.install`
[🔗](https://github.com/Axio-Intelligence/Squatch-Mail/blob/v0.1.1/lib/mix/tasks/squatch_mail.install.ex#L41)

Install and configure SquatchMail for use in this application.

Adds SquatchMail's configuration to your `config.exs`, generates a
migration that creates its tables (in their own `squatch_mail` Postgres
schema), and mounts the dashboard in your Phoenix router.

Safe to re-run: existing configuration, migrations, and router mounts are
detected and left untouched.

## Example

```bash
mix squatch_mail.install
```

## Options

* `--dashboard-path` or `-d` - the path to mount the dashboard at.
  Defaults to `/squatch`.
* `--no-dashboard` - skip mounting the dashboard router. Useful for
  telemetry-capture-only installs where the dashboard will be mounted
  by hand later (see the "Manual installation" section of the README).

---

*Consult [api-reference.md](api-reference.md) for complete listing*