Dashboard

A web UI for managing documents and testing search. The dashboard consists of multiple pages accessible via sidebar navigation.

Setup

Add the dashboard route to your router:

# lib/my_app_web/router.ex
import ArcanaWeb.Router

scope "/" do
  pipe_through :browser

  arcana_dashboard "/arcana"
end

Visit http://localhost:4000/arcana to access the dashboard (redirects to Documents page).

Options

arcana_dashboard "/arcana",
  repo: MyApp.Repo,                    # Override repo
  on_mount: [MyAppWeb.Auth],           # Add authentication
  live_socket_path: "/live"            # Custom LiveView socket path

Authentication

Protect the dashboard with your existing authentication:

arcana_dashboard "/arcana",
  on_mount: [MyAppWeb.RequireAdmin]

Pages

Documents (/arcana/documents)

• View documents - Browse all ingested documents with pagination
• View chunks - See how documents are chunked
• Ingest text - Paste content directly with format selection
• Upload files - Upload .txt, .md, or .pdf files
• Filter by collection - View documents from specific collections

Ask (/arcana/ask)

• Simple mode - Basic RAG question answering
• Agentic mode - Full pipeline with query expansion, decomposition, and self-correction
• Collection selection - Choose which collections to search (or let the LLM select)
• Pipeline options - Toggle expand, decompose, rerank, and self-correct steps

Search (/arcana/search)

• Test queries - Try searches against your documents
• View results - See retrieved chunks with similarity scores and expandable details
• Compare modes - Test semantic, full-text, and hybrid search
• Filter by collection - Search within specific collections

Collections (/arcana/collections)

• View collections - Browse all collections with document counts
• Create collections - Add new collections with descriptions
• Edit collections - Update collection descriptions
• Delete collections - Remove empty collections

Evaluation (/arcana/evaluation)

• View test cases - See questions and their relevant chunks
• Run evaluations - Execute evaluation runs
• View metrics - See MRR, Precision, Recall scores
• Compare runs - Track changes over time

Maintenance (/arcana/maintenance)

• Rebuild embeddings - Re-embed all chunks (useful after model changes)
• Orphan cleanup - Find and remove chunks without parent documents
• Database operations - Maintenance tasks for the vector store

Info (/arcana/info)

• Configuration - View current Arcana settings
• Embedding model - See which model is in use
• Statistics - Document and chunk counts

Deployment

The dashboard uses Phoenix LiveView. Ensure your production configuration includes:

# config/runtime.exs
config :my_app, MyAppWeb.Endpoint,
  url: [host: "example.com", port: 443],
  check_origin: ["//example.com"]

Assets

Dashboard assets (CSS, JS) are served inline - no build step required.

Security Considerations

The dashboard provides full access to your Arcana data:

1. Always add authentication in production
2. Restrict to admin users who need access
3. Consider IP allowlisting for sensitive deployments

# Example: Admin-only access
defmodule MyAppWeb.RequireAdmin do
  import Phoenix.LiveView

  def on_mount(:default, _params, session, socket) do
    case session["current_user"] do
      %{admin: true} -> {:cont, socket}
      _ -> {:halt, redirect(socket, to: "/")}
    end
  end
end