agentifui

Documentation

AgentifUI is an enterprise-oriented Agent UI, not an agent-building or model-hosting platform. Connect an existing Dify application or a compatible LangChain Agent service; AgentifUI supplies the website, identity, application access, conversation history and supported interactions.

Use the documentation bundled with the source tag or commit you install. Documents on main can describe features and migrations newer than the latest release. The guides describe implemented capabilities, not the full capabilities of every upstream service or every event allowed by AG-UI.

New to self-hosting AgentifUI? Follow from installation to your first conversation for the complete path and core concepts. Use the detailed runbooks below for commands.

Install And Operate Your Own Instance

1. Choose Docker Compose or host/PM2 deployment. These are alternative application installation paths, not sequential steps.
2. Set private environment values using the configuration guide and the matching .env*.example template. Both paths need PostgreSQL, Redis, S3-compatible storage and access to the chosen Agent backend.
3. Complete account bootstrap and application setup in the administrator guide.
4. Follow operations and troubleshooting for health checks, upgrades, backups, recovery and incident handoff.

Start with one Web and one API service. If usage requires more capacity, use manual Docker capacity for the optional host-network Docker mode, or the PM2 performance reference. Neither is an automatic scaling system or a required first-install step.

Compatibility, Security And Versions

• Compatibility and capabilities: application paths, persistence owners, feature differences, service targets and version/upgrade navigation. A backend’s native feature is not automatically a product feature.
• Deployment security and data handling: local/external data flow, secrets, public exposure, retention/deletion and current limits.
• Security policy: privately reporting a vulnerability and remediation/version-support boundaries.
• GitHub Releases: published change notes. Use the selected tag’s docs rather than assuming main is a release.

Manage Or Use An Instance

Reader	Start here	Covers
Administrator	Administrator guide	Providers, applications, credentials, users, groups, access and content
End user	User guide	Sign-in, choosing an application, chat, history, human confirmation and settings
Server operator	Operations	Routine checks, failure diagnosis, deployment handoff and recovery

Administrators configure application records through the website; operators configure server secrets, networking and deployment. The website is not a general editor for server environment files.

Current Feature Map

Area	Current functionality	Guide
Accounts	Email/password, configurable GitHub/SSO/phone OTP, verification and password-reset email	User access, auth configuration
Application catalog	Search, categories/tags, grid/list and favorites; permitted model/app entry points	Choosing applications
Conversations	Streaming messages, shared rich rendering, copy and path-specific edit/regeneration/feedback	Conversation use
History	Sidebar/history list, title/last-preview search, rename and deletion	History
Task interaction	Supported tool summaries and opt-in LangChain approve/reject confirmation	Human input
Structured applications	Dify workflows/text generation, supported forms, progress, result viewers and execution history	Application capabilities
Personalization	Editable profile/avatar, theme, display timezone and ten interface locales	Settings
Application administration	Dify/LangChain providers, instances, encrypted keys, categories and supported protocol choices	Application setup
Access management	User roles/status, groups/membership and application visibility/group permissions	Groups/access, users
Public pages	Home/About structure, localized copy, images, responsive preview and explicit translation	Content management
Operations	Docker/PM2, optional manual capacity changes, health/errors, persistent content, upgrade/backup/recovery guidance	Operations

Availability depends on backend, application mode and deployment configuration. General file-artifact lifecycle, arbitrary human-input forms, universal crash recovery, A2UI/MCP Apps and new Agent backends are not implied by this table.

Integration And Development References

• Developer guide: local setup, source map, daily editing, debugging, validation and backend/AG-UI extension boundaries.
• Contributing: forks/branches, PRs, checks, hooks and safe publication.
• Dify integration: supported Service API modes and limits.
• LangChain integration: required service contract and optional native human-input profile; an arbitrary LangChain endpoint is not enough.
• AG-UI integration: shared product interaction and protocol boundaries.
• Generation governance: authorization, moderation, admission, submission identity and quota behavior.
• Architecture and database design: runtime boundaries, persistence, migrations and RLS.
• Test environments: isolated data services, synthetic integration coverage and CI parity.
• Publishing safely: public code versus private configuration.
• Fonts: frontend font configuration.

Documentation Boundaries

Examples use fictional domains, accounts and paths. Replace them privately; never publish credentials, database exports, user conversations or deployment-specific configuration in issues or pull requests. An enabled UI option is not proof of upstream compatibility. Check the chosen backend’s guide before advertising files, human input, cancellation or recovery to users.

This site is open source. Improve this page.