Introducing a new way to review your PRs.

Read the announcement

appwrite / appwrite

The open-source cloud for agents & devs. Including Auth, Databases, Storage, Functions, Messaging, Hosting, Realtime, WAF and more

View on GitHub

59 documents · Updated Nov 20, 2026

overview

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/Modules that 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/** and app/init/**.
  • Asynchronous service work is coordinated through workers and reusable queue abstractions; evidence: src/Appwrite/Platform/Workers/** and packages/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/** and apps/console/src/components/pages/**.

Routing table