lamina_dashboard/README.md

1.2 KiB

Lamina.Dashboard

Lamina.Dashboard is a tool to visualise the current runtime configuration of the system.

It works as an additional page for Phoenix LiveDashboard.

Installation

Lamina.Dashboard is available in Hex, the package can be installed by adding lamina_dashboard to your list of dependencies in mix.exs:

def deps do
  [
    {:lamina_dashboard, "~> 0.2.2"}
  ]
end

Documentation for the latest release can be found on HexDocs and for the main branch here.

Integration with LiveDashboard

You can add this page to your Phoenix LiveDashboard by adding it as a page in the live_dashboard macro in your router file:

  live_dashboard "/dashboard",
    additional_pages: [lamina: Lamina.Dashboard]

Once configured, you will be able to access Lamina.Dashboard at /dashboard/lamina.

Distribution

You can use Lamina.Dashboard to view the configuration on remote nodes by simply adding the lamina_dashboard package as a dependency of your remote nodes.