Tay.Dashboard.Router (tay v1.3.2)

Copy Markdown View Source

Phoenix router integration for Tay Dashboard.

Import this module into a Phoenix router and call tay_dashboard/2 inside a scope. The surrounding pipeline must provide sessions, LiveView support, and the application's administrator access policy.

Summary

Functions

tay_dashboard(path, options \\ [])

Mounts Tay Dashboard at path.

Functions

tay_dashboard(path, options \\ [])

(macro)

Mounts Tay Dashboard at path.

The optional :engine value is the registered name of the Tay Engine to inspect. It defaults to Tay.default_name/0. No other option is accepted.

scope "/admin" do
  pipe_through [:browser, :require_admin]
  tay_dashboard "/tay", engine: MyApp.TayEngine
end

The macro creates overview, job list, job detail, and queue routes. It does not create or modify a pipeline and does not provide authentication.