Packages

tay

1.6.1
1.6.1 1.6.0 1.5.3 1.5.2 1.5.1 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.6 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.0 1.0.0 1.0.0-rc.9 0.9.6 0.9.5 0.8.1 0.8.0 0.7.1 0.7.0

Phoenix LiveView dashboard and HTTP bundle for Tay

HexDocs Report package

Current section

Files

Jump to
Documentation
30 Versions
4 Dependencies
Dependants
Files
Activity
tay README.md
Raw

README.md 

# Tay

`tay` is the complete Tay web bundle. It supplies the Phoenix
LiveView dashboard, depends on `tay_http`, and transitively installs the core
`tay_core` engine and Bandit HTTP(S) transport. A host Phoenix application can mount
it with `Tay.Dashboard.Router.tay_dashboard/2`.

Installing the package does not start or expose an endpoint. In a host Phoenix
application, mounting `tay_dashboard/2` activates the UI and the host endpoint's
existing `secret_key_base` protects sessions, CSRF, and LiveView. The
standalone-only `TAY_ENABLE_DASHBOARD` and `TAY_DASHBOARD_SECRET_KEY_BASE`
environment variables are not needed in this deployment shape.

The standalone/container release owns a separate Phoenix endpoint. Its bundled
UI remains disabled until `TAY_ENABLE_DASHBOARD=true`, and enabling it requires
a stable `TAY_DASHBOARD_SECRET_KEY_BASE` of at least 64 random bytes.