mix ash_authentication_phoenix.setup (ash_authentication_phoenix v3.0.0-rc.6)

View Source

Ensures Phoenix authentication infrastructure (routes, controller, sign-in page) exists

This task is idempotent and safe to run multiple times. It ensures the following exist in your Phoenix application:

  • use AshAuthentication.Phoenix.Router in your router
  • An AuthController for handling authentication callbacks
  • A LiveUserAuth module for LiveView authentication
  • An AuthOverrides module for customising authentication UI
  • Authentication routes (auth_routes, sign_in_route, sign_out_route)
  • Pipeline plugs for session and bearer token loading
  • Tailwind CSS configuration for authentication components

This task is composed automatically when adding OAuth/OIDC strategies via mix ash_authentication_phoenix.add_strategy.

Example

mix ash_authentication_phoenix.setup

Options

  • --user, -u - The user resource. Defaults to YourApp.Accounts.User
  • --accounts, -a - The accounts domain. Defaults to YourApp.Accounts

Summary

Functions

igniter(igniter)

Callback implementation for Igniter.Mix.Task.igniter/1.

setup_routes_alias(igniter)