mirror of
https://github.com/ash-project/ash_admin.git
synced 2024-09-19 21:03:52 +12:00
129 lines
4.3 KiB
Markdown
129 lines
4.3 KiB
Markdown
# AshAdmin
|
|
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://coveralls.io/github/ash-project/ash_admin?branch=main)
|
|
[](https://hex.pm/packages/ash_admin)
|
|
|
|
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.
|
|
|
|
```elixir
|
|
{:ash_admin, "~> 0.9.5"}
|
|
```
|
|
|
|
## Setup
|
|
|
|
Ensure your apis are configured in `config.exs`
|
|
|
|
```elixir
|
|
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`](https://hexdocs.pm/ash_admin/AshAdmin.Api.html) for more configuration options.
|
|
|
|
```elixir
|
|
# 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`](https://hexdocs.pm/ash_admin/AshAdmin.Resource.html) 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`
|
|
|
|
```elixir
|
|
# 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.
|
|
|
|
```elixir
|
|
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
|
|
|
|
```elixir
|
|
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.
|
|
|
|
```elixir
|
|
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`](https://hexdocs.pm/ash_admin/AshAdmin.Resource.html) and [`AshAdmin.Api`](https://hexdocs.pm/ash_admin/AshAdmin.Api.html) 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.build`.
|
|
|
|
## Contributors
|
|
|
|
Ash is made possible by its excellent community!
|
|
|
|
<a href="https://github.com/ash-project/ash_admin/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=ash-project/ash_admin" />
|
|
</a>
|
|
|
|
[Become a contributor](https://ash-hq.org/docs/guides/ash/latest/how_to/contribute.md)
|