# Agent-first open-source admin panel framework

> Build robust and powerful agentic back-office panels for your projects while maintaining full control over the code.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Getting Started](https://adminforth.dev/docs/tutorial/001-gettingStarted.md): Step-by-step guide to creating an AdminForth app with the CLI (bootstrapping), understanding the generated project structure, running migrations, a...
- [Hello world app without CLI](https://adminforth.dev/docs/tutorial/hello-world.md): Manual code way walkthrough (alternative to CLI) for building a minimal AdminForth app without the CLI, including project setup, resources, authent...
- [Glossary](https://adminforth.dev/docs/tutorial/02-glossary.md): Reference page defining core AdminForth terms such as data sources, resources, columns, records, actions, views, and other concepts used throughout...
- [Branding and Theming](https://adminforth.dev/docs/tutorial/03-Customization/01-branding.md): Guide to customizing AdminForth branding and theming, including logos, titles, sidebar presentation, colors, fonts, and single-theme setups.
- [Custom record field rendering](https://adminforth.dev/docs/tutorial/03-Customization/02-customFieldRendering.md): Guide to replacing default field rendering with custom Vue components for list, show, create, edit, and filter views, including props and third-par...
- [Virtual columns](https://adminforth.dev/docs/tutorial/03-Customization/03-virtualColumns.md): Guide to defining virtual columns for list, show, filter, edit, and create flows, including raw SQL and raw NoSQL query examples.
- [Hooks](https://adminforth.dev/docs/tutorial/03-Customization/04-hooks.md): Guide to AdminForth lifecycle hooks for list, show, create, edit, and delete flows, including request interception, response shaping, and save-time...
- [Limiting actions access](https://adminforth.dev/docs/tutorial/03-Customization/05-limitingAccess.md): Guide to AdminForth access control with allowed actions, role-based rules, field visibility, and resource-specific restrictions based on users or r...
- [Custom pages](https://adminforth.dev/docs/tutorial/03-Customization/06-customPages.md): Guide to adding custom AdminForth pages, custom APIs, public or protected routes, menu entries, and page metadata for custom Vue pages.
- [Alerts and confirmations](https://adminforth.dev/docs/tutorial/03-Customization/07-alert.md): Guide to using the Frontend API for alerts, confirmations, and announcement banners inside custom AdminForth pages and Vue components.
- [Page Injections](https://adminforth.dev/docs/tutorial/03-Customization/08-pageInjections.md): Guide to injecting custom Vue UI into AdminForth login, list, show, edit, and create pages, including dropdown items, custom action icons, and row ...
- [Actions](https://adminforth.dev/docs/tutorial/03-Customization/09-Actions.md): Guide to defining AdminForth actions for single records and bulk flows, including UI options, handlers, confirmation dialogs, and custom execution ...
- [Menu & Header](https://adminforth.dev/docs/tutorial/03-Customization/10-menuConfiguration.md): Guide to configuring the AdminForth sidebar and header, including icons, grouping, visibility rules, gaps, dividers, and custom links.
- [Data API](https://adminforth.dev/docs/tutorial/03-Customization/11-dataApi.md): Guide to the AdminForth Data API for querying, creating, updating, and deleting records programmatically, including filters, sorting, aggregations,...
- [Security](https://adminforth.dev/docs/tutorial/03-Customization/12-security.md): Guide to AdminForth security settings, including session lifetime, password policies, trusted proxy configuration, HTTPS, CSRF scope, and hardening...
- [Standard pages tuning](https://adminforth.dev/docs/tutorial/03-Customization/13-standardPagesTuning.md): Guide to tuning standard AdminForth list, show, edit, and create pages with field groups, sorting, sticky columns, conditional display, defaults, a...
- [AdminForth Components Library](https://adminforth.dev/docs/tutorial/03-Customization/15-afcl.md): Reference page for the AdminForth Components Library, covering reusable UI components such as buttons, links, badges, inputs, tables, and other bui...
- [Websocket](https://adminforth.dev/docs/tutorial/03-Customization/16-websocket.md): Guide to AdminForth WebSocket usage, including client subscriptions, publish authorization, initial loading, and real-time updates for custom pages...
- [Connectors](https://adminforth.dev/docs/tutorial/04-connectors.md): Connectors setup for AdminForth with peer dependency installation and datasource configuration.
- [Deploy in Docker](https://adminforth.dev/docs/tutorial/05-deploy.md): Guide to deploying AdminForth in Docker, including Dockerfile setup, image builds, CI automation, SSL termination, and SQLite-specific notes.
- [Email Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/01-email-adapters.md): Reference page for AdminForth email adapters, with setup instructions for AWS SES and Mailgun integrations used by plugins that send transactional ...
- [OAuth2 Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/02-oauth2-adapters.md): Reference page for AdminForth OAuth2 adapters, including provider setup for Google, GitHub, Facebook, Keycloak, Microsoft, and Twitch sign-in flows.
- [Image Generation Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/03-image-generation-adapters.md): Reference page for AdminForth image generation adapters, including OpenAI and Gemini integrations used by plugins that create images from prompts.
- [Storage Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/04-storage-adapters.md): Reference page for AdminForth storage adapters, covering Amazon S3 and local file storage backends used by upload and media workflows.
- [AI Completion Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/05-ai-completion-adapters.md): Reference page for AdminForth AI completion adapters, including the shared completion interface, structured output, streaming, reasoning events, an...
- [Image Analysis Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/06-image-analysis-adapters.md): Reference page for AdminForth image analysis adapters, covering OpenAI Vision setup for plugins that read or describe image content.
- [Key-value Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/07-key-value-adapters.md): Reference page for prebuilt key-value adapters created by AdminForth team, including simplest RAM Adapter (in-memory, no dependencies but ephemeral...
- [Captcha Adapters](https://adminforth.dev/docs/tutorial/06-Adapters/08-captcha-adapters.md): Reference page for AdminForth captcha adapters, including Cloudflare Turnstile and Google reCAPTCHA setup for login protection flows.
- [Telegram Chat Surface Adapter](https://adminforth.dev/tutorial/Adapters/chat-surface-adapter-telegram.md): Reference page for AdminForth Agent chat surface adapters, including Telegram bot setup and webhook configuration.
- [CLI Commands](https://adminforth.dev/docs/tutorial/07-CLICommands.md): Reference page for the AdminForth CLI, including create-app, create-plugin, generate-models, bundle, and other commands used to scaffold and mainta...
- [Usage of the logger](https://adminforth.dev/docs/tutorial/08-UsageOfLogger.md): Guide to the AdminForth logger, including custom log messages, log levels, and SPA debugging for frontend troubleshooting.
- [Agent](https://adminforth.dev/tutorial/Plugins/agent.md): Guide to the AdminForth Agent plugin, including installation, model and mode configuration, self-hosted usage, session storage, skills, and custom ...
- [Two-Factor Authentication Plugin](https://adminforth.dev/tutorial/Plugins/two-factors-auth.md): Guide to the Two-Factor Authentication plugin, including installation, TOTP or passkey setup, rollout rules, and per-user exceptions for stronger a...
- [Foreign Inline List](https://adminforth.dev/tutorial/Plugins/foreign-inline-list.md): Guide to the Foreign Inline List plugin, which embeds related resource lists inside a show page with filters, foreign-key setup, and cascade-delete...
- [Audit Log](https://adminforth.dev/tutorial/Plugins/audit-log.md): Guide to the Audit Log plugin, including installation, log table setup, resource wiring, and tracking of admin changes, custom actions, and client ...
- [Upload](https://adminforth.dev/tutorial/Plugins/upload.md): Guide to the Upload plugin, including storage adapter setup, file and image fields, previews, transformations, and image generation integration.
- [Upload API](https://adminforth.dev/docs/tutorial/09-Plugins/05-1-upload-api.md): Reference page for the Upload plugin API, covering backend buffer uploads, uploads to new or existing records, and presigned browser upload flows.
- [Markdown](https://adminforth.dev/tutorial/Plugins/markdown.md): Guide to the Markdown plugin, including editor setup, image handling, top-panel customization, and show-page rendering options.
- [Email Password Reset](https://adminforth.dev/tutorial/Plugins/email-password-reset.md): Guide to the Email Password Reset plugin, including SES or Mailgun setup, reset-flow wiring, and password reset page customization.
- [Import Export](https://adminforth.dev/tutorial/Plugins/import-export.md): Guide to the Import-Export plugin for CSV-based data transfer, including installation, import flow, export flow, and resource-level usage.
- [Open Signup](https://adminforth.dev/tutorial/Plugins/open-signup.md): Guide to the Open Signup plugin, including public registration flow, installation, basic setup, and optional email verification.
- [Internationalization (i18n)](https://adminforth.dev/tutorial/Plugins/i18n.md): Guide to the Internationalization plugin, including installation, primary language configuration, translated fields, and support for custom compone...
- [OAuth Authentication](https://adminforth.dev/tutorial/Plugins/oauth.md): Guide to the OAuth Authentication plugin, including provider setup, plugin configuration, email confirmation, and login flows for external identity...
- [Inline Create](https://adminforth.dev/tutorial/Plugins/inline-create.md): Guide to the Inline Create plugin, which lets users create records directly from the list page and configure which resources use the inline form.
- [List In-Place Edit](https://adminforth.dev/tutorial/Plugins/list-in-place-edit.md): Guide to the List In-Place Edit plugin, which makes selected list fields editable directly in the table without opening the edit page.
- [Text Complete](https://adminforth.dev/tutorial/Plugins/text-complete.md): Guide to the Text Complete plugin, including LLM adapter setup, prompt configuration, and AI-assisted text generation for resource fields.
- [Foreign Inline Show](https://adminforth.dev/tutorial/Plugins/foreign-inline-show.md): Guide to the Foreign Inline Show plugin, which embeds a related record show view inside another resource's show page using foreign-key relationships.
- [Email Invite](https://adminforth.dev/tutorial/Plugins/email-invite.md): Guide to the Email Invite plugin, including SES or Mailgun setup, invitation sending flows, email confirmation handling, and basic usage.
- [Bulk AI Flow](https://adminforth.dev/tutorial/Plugins/bulk-ai-flow.md): Guide to the Bulk AI Flow plugin, including text and vision modes, prompt configuration, per-record context, editable prompts, and batch content ge...
- [Universal Search (Legacy)](https://adminforth.dev/tutorial/Plugins/universal-search.md): Guide to the legacy Universal Search plugin, including installation, options, debounce behavior, and how it searches across configured fields.
- [Login Captcha](https://adminforth.dev/tutorial/Plugins/login-captcha.md): Guide to the Login Captcha plugin, including adapter setup, login form protection, and captcha-verified authentication flow.
- [User Soft Delete](https://adminforth.dev/tutorial/Plugins/user-soft-delete.md): Guide to the User Soft Delete plugin, including schema changes, setup, and deactivating admin users without permanently deleting their accounts.
- [Clone Row](https://adminforth.dev/tutorial/Plugins/clone-row.md): Guide to the Clone Row plugin, which opens the create flow with values copied from an existing record so users can duplicate rows quickly.
- [Many to Many](https://adminforth.dev/tutorial/Plugins/many2many.md): Guide to the Many2Many plugin, including junction-table setup, editable relationships on both resources, and cleanup behavior for related records.
- [Background Jobs](https://adminforth.dev/tutorial/Plugins/background-jobs.md): Guide to the Background Jobs plugin, including job setup, execution, UI monitoring, custom state rendering, and frontend APIs for job details.
- [Quick Filters](https://adminforth.dev/tutorial/Plugins/quick-filters.md): Guide to the Quick Filters plugin, which adds one-click predefined filters or search inputs to list pages for faster navigation across common recor...
- [Auto Remove Plugin](https://adminforth.dev/tutorial/Plugins/auto-remove.md): Guide to the Auto Remove plugin, including count-based and time-based cleanup rules for logs, temporary records, demo data, and other disposable re...
- [Rich Editor](https://adminforth.dev/tutorial/Plugins/rich-editor.md): Guide to the Rich Editor plugin, including editor setup, multiple editors in one resource, completion features, and image handling in rich-text fie...
- [Dashboard plugin](https://adminforth.dev/tutorial/Plugins/dashboard.md): Documentation for the Dashboard plugin.
- [Dashboard Query Reference](https://adminforth.dev/tutorial/Plugins/dashboard-reference.md): Reference for Dashboard widget queries, calculations, custom filters, and configuration DSL.
- [CRUD Approve Plugin](https://adminforth.dev/tutorial/Plugins/CRUDApprove.md): Guide to the CRUD Approve plugin, including installation, approval storage resource setup, wiring protected resources, approval flow, reviewer acce...
- [JSON Form](https://adminforth.dev/tutorial/Plugins/json-form.md): Guide to the JSON Form plugin — render a rich, schema-driven form for a JSON column instead of a raw text area, using a JSON Schema extended with x...
- [Plugin development guide](https://adminforth.dev/docs/tutorial/10-Advanced/01-plugin-development.md): Guide to developing AdminForth plugins, including plugin concepts, boilerplate, implementation structure, installation, and activation order.
- [Working without direct database connection](https://adminforth.dev/docs/tutorial/10-Advanced/02-working-without-direct-database-connection.md): Guide to using AdminForth without a direct database connection by exposing resources through custom connectors or API-backed data access.