Vulnerabilities | |||||
---|---|---|---|---|---|
Version | Suggest | Low | Medium | High | Critical |
0.8.4 | 0 | 0 | 0 | 0 | 0 |
0.8.3 | 0 | 0 | 0 | 0 | 0 |
0.8.2 | 0 | 0 | 0 | 0 | 0 |
0.8.1 | 0 | 0 | 0 | 0 | 0 |
0.8.0 | 0 | 0 | 0 | 0 | 0 |
0.7.2 | 0 | 0 | 0 | 0 | 0 |
0.7.1 | 0 | 0 | 0 | 0 | 0 |
0.7.0 | 0 | 0 | 0 | 0 | 0 |
0.6.5 | 0 | 0 | 0 | 0 | 0 |
0.6.4 | 0 | 0 | 0 | 0 | 0 |
0.6.3 | 0 | 0 | 0 | 0 | 0 |
0.6.2 | 0 | 0 | 0 | 0 | 0 |
0.6.1 | 0 | 0 | 0 | 0 | 0 |
0.6.0 | 0 | 0 | 0 | 0 | 0 |
0.5.3 | 0 | 0 | 0 | 0 | 0 |
0.5.2 | 0 | 0 | 0 | 0 | 0 |
0.5.1 | 0 | 0 | 0 | 0 | 0 |
0.5.0 | 0 | 0 | 0 | 0 | 0 |
0.4.0 | 0 | 0 | 0 | 0 | 0 |
0.3.6 | 0 | 0 | 0 | 0 | 0 |
0.3.5 | 0 | 0 | 0 | 0 | 0 |
0.3.4 | 0 | 0 | 0 | 0 | 0 |
0.3.3 | 0 | 0 | 0 | 0 | 0 |
0.3.2 | 0 | 0 | 0 | 0 | 0 |
0.3.1 | 0 | 0 | 0 | 0 | 0 |
0.3.0 | 0 | 0 | 0 | 0 | 0 |
0.2.10 | 0 | 0 | 0 | 0 | 0 |
0.2.9 | 0 | 0 | 0 | 0 | 0 |
0.2.8 | 0 | 0 | 0 | 0 | 0 |
0.2.7 | 0 | 0 | 0 | 0 | 0 |
0.2.6 | 0 | 0 | 0 | 0 | 0 |
0.2.5 | 0 | 0 | 0 | 0 | 0 |
0.2.4 | 0 | 0 | 0 | 0 | 0 |
0.2.3 | 0 | 0 | 0 | 0 | 0 |
0.2.2 | 0 | 0 | 0 | 0 | 0 |
0.2.1 | 0 | 0 | 0 | 0 | 0 |
0.2.0 | 0 | 0 | 0 | 0 | 0 |
0.1.1 | 0 | 0 | 0 | 0 | 0 |
0.1.0 | 0 | 0 | 0 | 0 | 0 |
0.8.4 - This version is safe to use because it has no known security vulnerabilities at this time. Find out if your coding project uses this component and get notified of any reported security vulnerabilities with Meterian-X Open Source Security Platform
Maintain your licence declarations and avoid unwanted licences to protect your IP the way you intended.
MIT - MIT LicenseLiveDashboard provides real-time performance monitoring and debugging tools for Phoenix developers. It provides the following modules:
Home - See general information about the system
OS Data - See general information about OS, such as CPU, Memory and Disk usage
Metrics - See how your application performs under different conditions by visualizing :telemetry
events with real-time charts
Request logging - See everything that was logged for certain requests
Applications - See, filter, and search applications in the current node and view their processes in a supervision tree
Processes - See, filter, and search processes in the current node
Ports - See, filter, and search ports (responsible for I/O) in the current node
Sockets - See, filter, and search sockets (responsible for tcp/udp) in the current node
ETS - See, filter, and search ETS tables (in-memory storage) in the current node
Ecto Stats - Shows index, table, and general usage about the underlying Ecto Repo storage
The dashboard also works across nodes. If your nodes are connected via Distributed Erlang, then you can access information from node B while accessing the dashboard on node A.
The LiveDashboard is built on top of LiveView. Both LiveView and LiveDashboard ship by default as part of Phoenix. But if you skipped them, you can LiveDashboard in three steps:
phoenix_live_dashboard
dependencyAdd the following to your mix.exs
and run mix deps.get
:
def deps do
[
{:phoenix_live_dashboard, "~> 0.7"}
]
end
First, update your endpoint's configuration to include a signing salt:
# config/config.exs
config :my_app, MyAppWeb.Endpoint,
live_view: [signing_salt: "SECRET_SALT"]
Then add the Phoenix.LiveView.Socket
declaration to your endpoint:
socket "/live", Phoenix.LiveView.Socket
And you are good to go!
Once installed, update your router's configuration to forward requests to a LiveDashboard with a unique name
of your choosing:
# lib/my_app_web/router.ex
use MyAppWeb, :router
import Phoenix.LiveDashboard.Router
...
if Mix.env() == :dev do
scope "/" do
pipe_through :browser
live_dashboard "/dashboard"
end
end
This is all. Run mix phx.server
and access the "/dashboard" to configure the necessary modules.
If you want to use the LiveDashboard in production, you should put authentication in front of it. For example, if you use mix phx.gen.auth
to generate an Admin resource, you could use the following code:
# lib/my_app_web/router.ex
use MyAppWeb, :router
import Phoenix.LiveDashboard.Router
...
pipeline :admins_only do
plug :fetch_current_admin
plug :require_authenticated_admin
end
scope "/" do
pipe_through [:browser, :admins_only]
live_dashboard "/dashboard"
end
If you'd rather have some quick and dirty HTTP Authentication, the following code can be used as a starting point:
# lib/my_app_web/router.ex
use MyAppWeb, :router
import Phoenix.LiveDashboard.Router
...
pipeline :admins_only do
plug :admin_basic_auth
end
scope "/" do
pipe_through [:browser, :admins_only]
live_dashboard "/dashboard"
end
defp admin_basic_auth(conn, _opts) do
username = System.fetch_env!("AUTH_USERNAME")
password = System.fetch_env!("AUTH_PASSWORD")
Plug.BasicAuth.basic_auth(conn, username: username, password: password)
end
If you are running your application behind a proxy or a webserver, you also have to make sure they are configured for allowing WebSocket upgrades. For example, here is an article on how to configure Nginx with Phoenix and WebSockets.
For those planning to contribute to this project, you can run a dev version of the dashboard with the following commands:
$ mix setup
$ mix dev
Additionally, you may pass some options to enable Ecto testing. For example, to enable the PostgreSQL repo:
$ mix dev --postgres
...and to enable the MySQL repo:
$ mix dev --mysql
...and to enable the SQLite repo:
$ mix dev --sqlite
Alternatively, run iex -S mix dev [flags]
if you also want a shell.
Before submitting a pull request, discard any changes that were made to the dist
directory.
For example, to rollback using git restore:
$ git restore dist
MIT License. Copyright (c) 2019 Michael Crumm, Chris McCord, José Valim.