# Docs

- [Introduction](/docs): Auth UI is a drop-in authentication interface for Appwrite. One script tag gives you every sign-in method, MFA, session management and account settings as web components that run on your own domain.
- [Getting started](/docs/getting-started): Install Auth UI, point it at your Appwrite project and open the sign-in modal.
- [Comparison](/docs/comparison): How Auth UI compares to Clerk Components, Auth0 Universal Login, Supabase Auth UI, and hand-rolled Appwrite forms.

- **Concepts**
- [How it works](/docs/how-it-works): Why Auth UI runs on your origin, how sessions are stored, and how email links and OAuth return to your page.
- [Configuration](/docs/configuration): Every option Auth UI accepts, as JavaScript or as attributes on <authui-config>.
- [Sign-in methods](/docs/sign-in-methods): What each method does, what Appwrite needs for it, and how the user experiences it.
- [Multi-factor authentication](/docs/mfa): Challenges during sign in, authenticator enrollment, recovery codes and step-up verification.
- [Account management](/docs/account-management): The self-service account screen and what each tab does.
- [Theming](/docs/theming): Design tokens, dark mode, radius, custom colours and string overrides.

- **Components**
- [<authui-config>](/docs/components/config): Declarative configuration element. Invisible; configures the global store from attributes.
- [<authui-modal>](/docs/components/modal): Dialog that hosts the sign-in and account screens.
- [<authui-button>](/docs/components/button): A button that opens the modal on a chosen screen.
- [<authui-user-button>](/docs/components/user-button): Avatar with an account menu while signed in, a sign-in button otherwise.
- [<authui-sign-in>](/docs/components/sign-in): The full sign-in experience as an inline panel.
- [<authui-account>](/docs/components/account): Self-service account management as an inline panel.
- [<authui-show>](/docs/components/show): Render children only while the authentication status matches.

- **Frameworks**
- [React](/docs/react): Hooks and wrapper components from @getauthui/core/react.
- [Vue, Svelte, Angular and plain HTML](/docs/frameworks): Web components work everywhere. Import once, then use the tags.

- **Guides**
- [Guides](/docs/guides): Step by step tutorials that take a real app from zero to signed in.
- [Sync Nullboard across devices](/docs/guides/nullboard): Add sign in to the Nullboard kanban board and keep every board in Appwrite user preferences, so nothing is lost and it follows you to any device.
- [Keep your 2048 best score](/docs/guides/2048): Add sign in to the classic 2048 game and store the best score in Appwrite user preferences, so it survives a cleared browser and shows up on every device.
- [Continue where you left off in SilverBullet](/docs/guides/silverbullet): Add Appwrite sign in to a self-hosted SilverBullet notebook with a Space Lua script, and reopen the page you were reading on any device.
- [Back up OpenHabitTracker to Appwrite](/docs/guides/openhabittracker): Add Appwrite sign in to the OpenHabitTracker Blazor PWA and keep a private backup of every habit, task and note in Appwrite Storage.
- [Back up WeekToDo to Appwrite](/docs/guides/weektodo): Add Appwrite sign in to the WeekToDo Vue planner and keep a private .wtdb backup in Appwrite Storage, using the same export format the app already ships.

- **More**
- [Preview mode](/docs/guides/preview-mode): Explore every screen without a backend. Any email, password or code is accepted and nothing is sent anywhere.
- [AI agents](/docs/guides/ai-agents): Give your coding agent everything it needs to add Auth UI to a project.
- [Migrating from Auth UI v1](/docs/guides/migrating-from-v1): Moving from the hosted login page to the embedded component library.
- [Security notes](/docs/guides/security): What Auth UI does and does not do with credentials and sessions.
- [Common mistakes](/docs/common-mistakes): Fixes for the setup mistakes that waste the most time with Auth UI and Appwrite.

- **API Reference**
- [AuthUI](/docs/api/authui): The top-level imperative API exported from @getauthui/core.
- [AuthStore](/docs/api/store): Every operation the components use, available for headless integrations.
- [Events](/docs/api/events): Store events, window events and component events.
- [Types](/docs/api/types): TypeScript types exported from @getauthui/core.