Knowledge Base updated: 2026-11-19
Appwrite knowledge base
Orientation
Appwrite is a self-hostable backend platform. Its primary runtime exposes HTTP, GraphQL, realtime, S3-compatible, MQTT, and CLI entrypoints, with modules implementing product APIs and workers handling asynchronous execution.
The repository also contains the Console web application in apps/console, which provides user, organization, project, product, and operational interfaces over platform services.
Reusable PHP packages under packages/ supply independently consumable primitives such as queues, validation, storage, HTTP, authentication, messaging, scheduling, and transport adapters. Persistent platform and project resources are configured through app/config, initialized through app/init, and operated through module APIs and workers.
flowchart TD
Console[Console web application] --> HTTP[HTTP API entrypoint]
Clients[SDKs and clients] --> HTTP
Clients --> GraphQL[GraphQL gateway]
Clients --> RT[Realtime service]
Clients --> S3[S3-compatible API]
Clients --> MQTT[MQTT gateway]
HTTP --> Modules[Platform modules]
GraphQL --> Modules
S3 --> Storage[Storage services]
MQTT --> Messaging[Messaging services]
Modules --> DB[(Project and platform data)]
Modules --> Queue[Queue and event dispatch]
Queue --> Workers[Worker job families]
Workers --> DB
Workers --> Providers[External providers]
Modules --> Packages[Reusable packages]
Workers --> Packages
Glossary
- Console: The standalone Appwrite web application used to manage organizations, projects, services, and operational views.
- Platform module: A service-area implementation under
src/Appwrite/Platform/Modulesthat defines API behavior and domain operations. - Worker: A background command that consumes or coordinates asynchronous platform work.
- Project context: The selected project and its configuration, resources, permissions, and service state used to scope an operation.
- Rendition: A generated media output variant associated with a video source and delivery profile.
Invariants
- API behavior is organized by platform module rather than by a single monolithic controller layer; evidence:
src/Appwrite/Platform/Modules/**/Http/**. - Application configuration and initialization remain separate concerns; evidence:
app/config/**andapp/init/**. - Asynchronous service work is coordinated through workers and reusable queue abstractions; evidence:
src/Appwrite/Platform/Workers/**andpackages/queue/**. - Reusable package APIs remain independently scoped beneath
packages/<package>/; evidence: packages/…/composer.json. - Console routes and page implementations remain paired under the Console application; evidence:
apps/console/src/routes/**andapps/console/src/components/pages/**.
Routing table
src/Appwrite/Platform/Modules/**/Http/**-> docs/api-platform.mdsrc/Appwrite/Platform/Modules/Account/**-> docs/account-authentication.mdsrc/Appwrite/Platform/Modules/Databases/**-> docs/database-data-api.mdsrc/Appwrite/Platform/Modules/Storage/**-> docs/storage-files-api.mdsrc/Appwrite/Platform/Modules/Functions/**-> docs/functions-execution-api.mdsrc/Appwrite/Platform/Modules/Messaging/**-> docs/messaging-api.mdsrc/Appwrite/Platform/Modules/Realtime/**-> docs/realtime-subscriptions.mdsrc/Appwrite/Platform/Modules/GraphQL/**-> docs/graphql-api.mdsrc/Appwrite/Platform/Modules/Storage/S3/**-> docs/s3-compatible-api.mdsrc/Appwrite/Platform/Modules/Messaging/MQTT/**-> docs/mqtt-protocol-gateway.mdsrc/Appwrite/Platform/Modules/Project/**-> docs/project-administration.mdsrc/Appwrite/Platform/Modules/Project/Http/Project/**-> docs/project-lifecycle.mdapp/config/**-> docs/platform-configuration.mdsrc/Appwrite/Platform/Workers/**-> docs/background-processing.md- src/…/*.php -> docs/worker-job-families.md
src/Appwrite/Platform/Tasks/**-> docs/scheduling-and-maintenance.mdsrc/Appwrite/Platform/Events/**-> docs/eventing-and-integrations.md- src/…/Webhooks.php -> docs/event-bus-and-webhooks.md
- app/http.php -> docs/application-bootstrap.md
app/init/**-> docs/initialization-and-request-wiring.mdpackages/*/**-> docs/reusable-platform-packages.mdpackages/agent/**-> docs/ai-agent-provider-integration.mdpackages/bus/**-> docs/reusable-event-bus.mdpackages/lock/**-> docs/distributed-locking.mdpackages/psr7/**-> docs/psr7-http-primitives.mdpackages/compression/**-> docs/compression-library.mdpackages/smtp/**-> docs/smtp-client-library.mdpackages/system/**-> docs/system-resource-library.mdpackages/telemetry/**-> docs/telemetry-library.mdpackages/cache/**-> docs/cache-library.mdpackages/circuit-breaker/**-> docs/circuit-breaker-library.mdpackages/client/**-> docs/http-client-library.mdpackages/detector/**-> docs/runtime-detector-library.mdpackages/image/**-> docs/image-processing-library.mdpackages/locale/**-> docs/locale-library.mdpackages/messaging/**-> docs/messaging-transport-library.mdpackages/openapi/**-> docs/openapi-library.mdpackages/pools/**-> docs/connection-pools-library.mdpackages/span/**-> docs/span-tracing-library.mdpackages/user-agent/**-> docs/user-agent-library.mdpackages/websocket/**-> docs/websocket-library.mdpackages/auth/**-> docs/authentication-library.mdpackages/balancer/**-> docs/load-balancing-library.mdpackages/cdn/**-> docs/cdn-library.mdpackages/mqtt/**-> docs/mqtt-library.mdpackages/query/**-> docs/query-library.mdpackages/schedule/**-> docs/scheduling-library.mdpackages/storage/**-> docs/storage-library.mdpackages/validators/**-> docs/validation-library.mdpackages/di/**-> docs/dependency-injection-library.mdpackages/registry/**-> docs/registry-library.mdpackages/queue/**-> docs/queue-library.mdapps/console/**-> docs/console-application.mdapps/console/src/components/pages/**-> docs/console-authentication-and-project-experience.mdsrc/Appwrite/Platform/Modules/Alerts/**-> docs/alerts-and-usage-monitors.mdsrc/Appwrite/Platform/Modules/Teams/Http/Transfers/**-> docs/organization-transfer-api.mdsrc/Appwrite/Platform/Modules/VCS/**-> docs/code-review-api.mdsrc/Appwrite/Platform/Modules/Videos/**-> docs/video-processing-api.md