Skip to content

A Phoenix LiveDashboard page for inspecting your Lamina configurations

License

Notifications You must be signed in to change notification settings

jimsynz/lamina_dashboard

Repository files navigation

Lamina.Dashboard

Build Status Hex.pm Hippocratic License HL3-FULL

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, "~> 1.0.0"}
  ]
end

Documentation for the latest release can be found on HexDocs.

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.

Github Mirror

This repository is mirrored on Github from it's primary location on my Forgejo instance. Feel free to raise issues and open PRs on Github.

License

This software is licensed under the terms of the HL3-FULL, see the LICENSE.md file included with this package for the terms.

This license actively proscribes this software being used by and for some industries, countries and activities. If your usage of this software doesn't comply with the terms of this license, then contact me with the details of your use-case to organise the purchase of a license - the cost of which may include a donation to a suitable charity or NGO.

About

A Phoenix LiveDashboard page for inspecting your Lamina configurations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages