Installation

View Source

Beacon LiveAdmin is a Phoenix LiveView application to manage running sites, allowing you to build your site by creating resources like layouts, pages, components, and more.

It runs as a library in your Phoenix LiveView application, either in a new or an existing application.

Beacon LiveAdmin can be installed along with Beacon in the same application/node or in a separated application/node if you need to isolate it for performance or security reasons.

It will find all running sites in the cluster as long as the nodes are connected to each other, which can be achieved with libs like libcluster or dns_cluster.

If you already have a Phoenix LiveView application up and running that meet the minimum requirements for Beacon and Beacon LiveAdmin, you can directly to step 5 - adding the :beacon_live_admin dependency.

Steps

  1. Install Elixir v1.14 or later

Check out the official Elixir install guide for more info.

  1. Update Hex
  mix local.hex

If that command fails or Elixir version is outdated, please follow the Elixir Install guide to set up your environment correctly.

  1. Install Phoenix v1.7 or later
  mix archive.install hex phx_new

Check out the official Phoenix install guide for more info.

  1. Generate a new Phoenix application
  mix phx.new --install admin

Note that BeaconLiveAdmin supports Umbrella applications as well.

  1. Add :beacon_live_admin dependency to mix.exs
  + {:beacon_live_admin, ">= 0.0.0"},
  1. Add :beacon_live_admin into :import_deps in file .formatter.exs
  - import_deps: [:ecto, :ecto_sql, :phoenix],
  + import_deps: [:ecto, :ecto_sql, :phoenix, :beacon_live_admin],
  1. Add beacon_live_admin to your application router.ex file:
  use Beacon.LiveAdmin.Router # <- add this line

  pipeline :browser do
    # ...
    # ommited for brevity
    plug Beacon.LiveAdmin.Plug # <- add this line
  end

  # add the following scope before any beacon_site
  scope "/admin" do
    pipe_through :browser
    beacon_live_admin "/"
  end

Note that route precedence is important, make sure the there are no conflicts with other routes otherwise Beacon LiveAdmin will not work properly.

For example, if a site is mounted at / then you should add the admin scope before so /admin is handled by Beacon LiveAdmin, otherwise Beacon will try to find a page for /admin defined in the site. The same may happen with other routes on your application.

  1. Install deps
  mix deps.get