mix forja.install (Forja v0.4.0)

View Source

Install and configure Forja for use in an application.

This task will:

  • Generate the forja_events database migration
  • Add Forja to your application's supervision tree
  • Add :forja_events and :forja_reconciliation queues to your Oban config
  • Optionally configure the ReconciliationWorker crontab

Example

Install using the default Ecto repo:

mix forja.install

Specify a repo explicitly:

mix forja.install --repo MyApp.Repo

Skip reconciliation crontab setup:

mix forja.install --no-reconciliation

Options

  • --repo or -r - Specify the Ecto repo to use (auto-detected if not provided)
  • --reconciliation or -R - Include ReconciliationWorker crontab (default: true)
  • --pubsub or -p - Specify the PubSub module (auto-inferred if not provided)