An admin ui for Ash Resources
Go to file
Zach Daniel eba8a81e13 chore: release version v0.10.6 2024-02-20 15:45:55 -05:00
.github chore: run ci on PR 2023-03-25 21:08:56 -04:00
assets fix: ensure tenant stays set after navigating from page 2024-01-04 14:43:49 -05:00
config chore: update ash 2023-09-25 10:21:39 -04:00
dev fix: fix lists of values in deeply nested embeds 2024-02-20 15:45:13 -05:00
documentation/dsls chore: docs 2024-02-04 10:42:01 -05:00
lib fix: fix lists of values in deeply nested embeds 2024-02-20 15:45:13 -05:00
logos chore: package setup + formatting + sobelow 2021-03-22 00:05:49 -04:00
priv/static fix: fix lists of values in deeply nested embeds 2024-02-20 15:45:13 -05:00
test chore: fix build 2023-07-25 22:19:55 -04:00
.check.exs fix: don't call into ash_postgres for tables anymore 2022-09-08 13:25:45 -04:00
.credo.exs feat: draw the rest of the owl 2021-03-22 02:41:22 -04:00
.formatter.exs improvement: Adds show_sensitive_fields option to Resource to allow unredacting se… (#86) 2024-01-05 10:08:56 -05:00
.gitignore Use CoreComponent input (#70) 2023-08-09 06:34:17 -07:00
.tool-versions chore: tool versions 2024-02-04 10:48:48 -05:00
CHANGELOG.md chore: release version v0.10.6 2024-02-20 15:45:55 -05:00
LICENSE chore: package setup + formatting + sobelow 2021-03-22 00:05:49 -04:00
README.md chore: release version v0.10.6 2024-02-20 15:45:55 -05:00
dev.exs fix: fix issues w/ admin UI not rendering 2022-03-16 23:34:52 -04:00
mix.exs chore: release version v0.10.6 2024-02-20 15:45:55 -05:00
mix.lock improvement: update to phoenix_html 4.0 2024-02-01 17:06:43 -05:00

README.md

AshAdmin

Elixir CI License: MIT Coverage Status Hex version badge

An admin UI for Ash resources. Built with Phoenix LiveView.

Demo

https://www.youtube.com/watch?v=aFMLz3cpQ8c

Usage

First, ensure you've added ash_admin to your mix.exs file.

{:ash_admin, "~> 0.10.6"}

Setup

Ensure your apis are configured in config.exs

config :my_app, ash_apis: [MyApp.Foo, MyApp.Bar]

Add the admin extension to each api you want to show in AshAdmin dashboard, and configure it to show. See AshAdmin.Api for more configuration options.

# In your Api(s)
use Ash.Api,
  extensions: [AshAdmin.Api]

admin do
  show? true
end

Resources in each Api will be automagically included in AshAdmin. See AshAdmin.Resource for more resource configuration options. Specifically, if you app has an actor you will want to configure that. Ash Admin allows you to change actors and therefore doesn't rely on Ash.set_actor

# In your resource that acts as an actor (e.g. User)
use Ash.Resource,
  extensions: [AshAdmin.Resource]

  admin do
    actor?(true)
  end

Modify your router to add AshAdmin at whatever path you'd like to serve it at.

defmodule MyAppWeb.Router do
  use Phoenix.Router

  import AshAdmin.Router

  # AshAdmin requires a Phoenix LiveView `:browser` pipeline
  # If you DO NOT have a `:browser` pipeline already, then AshAdmin has a `:browser` pipeline
  # Most applications will not need this:
  admin_browser_pipeline :browser

  scope "/" do
    # Pipe it through your browser pipeline
    pipe_through [:browser]

    ash_admin "/admin"
  end
end

Note: there is no builtin security for your AshAdmin (except your apps normal policies). In most cases you will want to secure your AshAdmin routes in some way to prevent them from being public

Now start your project (usually by running mix phx.server in a terminal) and visit /admin in your browser (or whatever path you gave to ash_admin in your router).

Content Security Policy

If your app specifies a content security policy header, eg. via

plug :put_secure_browser_headers, %{"content-security-policy" => "default-src 'self'"}

in your router, then all of the styles and JavaScript used to power AshAdmin will be blocked by your browser.

To avoid this, you can add the specific AshAdmin nonces to the default-src allowlist, ie.

plug :put_secure_browser_headers, %{"content-security-policy" => "default-src 'nonce-ash_admin-Ed55GFnX' 'self'"}

This will allow AshAdmin-generated inline CSS and JS blocks to execute normally.

Configuration

See the documentation in AshAdmin.Resource and AshAdmin.Api for information on the available configuration.

Troubleshooting

If your Admin UI is not responding as expected. Check your browser's developer console for content-security-policy violations (see above).

Development

To work on ash_admin, you'll want to be able to run the dev app. You'll need to have postgres setup locally, at which point you can do the following:

  1. mix ash_postgres.create
  2. mix migrate
  3. mix migrate_tenants
  4. mix setup

Then, you can start the app with: mix dev

If you make changes to the resources, you can generate migrations with mix generate_migrations

If you make changes to any of the assets (CSS or JavaScript), including updating dependencies that include assets such as LiveView, you will need to recompile the assets with mix assets.deploy.

Contributors

Ash is made possible by its excellent community!

Become a contributor