机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

Appwrite

<b>The open-source cloud for agents and developers. Appwrite is an MCP and agent-first platform for building and scaling apps. Give your agents Auth, Databases, Storage, Functions, Messaging, Realtime, and Hosting, all in one place.</b>
<br />
<br />

English | 简体中文

Appwrite 是一个以代理为先的 MCP 和开源平台，用于构建和扩展应用程序。MCP 已包含在内，因此编写代码的代理可以在实时 Appwrite 项目上操作。Appwrite 可作为托管云平台使用，也可以在您控制的基础设施上自托管。

它旨在为您的工作流程中的 AI 代理以及开发人员提供服务。通过托管的 MCP 服务器连接 Cursor、Claude Code、Codex 和其他代理，或将 SDK 集成到您的应用中。从第一个原型到生产规模，模块化产品保持统一。

了解更多信息请访问 https://appwrite.io 。

目录：

• 产品
• 安装与设置
• 自我托管
  • Unix
  • Windows
  • CMD
  • PowerShell
  • Docker API 版本不匹配
  • 从旧版本升级
• 一键设置
• 入门
  • 代理
  • SDKs
  • 客户
  • 服务器
• 架构
• 贡献
• 安全
• 关注我们
• 许可证

产品

• Appwrite Auth - 通过电子邮件、短信、OAuth、匿名会话和魔术链接安全地验证用户。

• Appwrite Databases - 使用 Appwrite 数据库或托管的 PostgreSQL 和 MySQL 进行建模、查询和扩展，以满足您的用例和团队需求。

• Appwrite Storage - 存储文件，同时支持压缩、加密、图像转换和访问控制。

• Appwrite Functions - 部署无服务器函数，提供安全隔离的运行环境和事件驱动执行。

• Appwrite Sites - 从 Git 部署静态、SSR 和 CSR 前端，并提供即时预览和 Appwrite 支持。

• Appwrite Messaging - 通过统一的消息服务发送电子邮件、短信和推送通知。

• Appwrite Firewall - 根据每个项目的流量规则、滥用控制和边缘安全保护应用。

• Appwrite Realtime - 在发生事件时订阅并响应整个项目的事件。

• Appwrite MCP - 将代理连接到您的 Appwrite 项目、API 和文档。云端包含 MCP，无需本地安装。

安装与设置

开始使用 Appwrite 的最简单方法是 注册 Appwrite Cloud。云平台包括 免费计划，可立即开始构建，并在需要扩展时选择付费计划。

自托管

Appwrite 在设计之初就考虑了自托管。您可以在任何可以运行 Docker CLI 的操作系统上安装和运行 Appwrite。运行服务器就像在终端中运行一个命令一样简单。

在运行安装命令之前，请确保您的计算机上已安装 Docker。安装向导监听端口 20080，并且只在本地主机上发布。它还会将一次性安装密钥打印到 STDOUT — 打开打印的 URL（或发送 x-appwrite-installer-secret）以完成安装。对于远程主机，请 SSH 隧道到 127.0.0.1:20080，而不是在所有接口上发布端口。

Unix

docker run -it --rm \
    --publish 127.0.0.1:20080:20080 \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:2.3.0

窗口

命令提示符

docker run -it --rm ^
    --publish 127.0.0.1:20080:20080 ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:2.3.0

PowerShell

docker run -it --rm `
    --publish 127.0.0.1:20080:20080 `
    --volume /var/run/docker.sock:/var/run/docker.sock `
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
    --entrypoint="install" `
    appwrite/appwrite:2.3.0

一旦安装程序运行，打开终端中打印的 URL（其中包含一次性密钥）以完成设置向导。安装完成后，访问 http://localhost 以通过浏览器进入 Appwrite 控制台。请注意，在非 Linux 原生主机上，安装完成后服务器可能需要几分钟才能启动。

Docker API 版本不匹配

如果安装或升级失败并出现类似 client version 1.52 is too new. Maximum supported API version is 1.42 的错误，说明 Appwrite 镜像中的 Docker CLI 比主机 Docker Engine 更新。将 DOCKER_API_VERSION 设置为错误中显示的最大 API 版本（或升级主机上的 Docker）：

docker run -it --rm \
    --env DOCKER_API_VERSION=1.42 \
    --publish 127.0.0.1:20080:20080 \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:2.3.0

在升级时，将 --env DOCKER_API_VERSION=... 标志与 --entrypoint="upgrade" 一起使用。

对于高级生产和自定义安装，请查看我们的 Docker 环境变量 文档。您还可以使用我们的公共 docker-compose.yml 和 .env 文件手动设置环境。

从旧版本升级

如果您要从旧版本升级 Appwrite 服务器，应在完成设置后使用 Appwrite 迁移工具。有关详细信息，请查看 迁移说明。

一键安装

除了在本地运行 Appwrite，您还可以使用预配置的市场应用启动 Appwrite，实现即时安装。

从以下提供商中选择:

对于在云提供商或 PaaS 上的自定义部署，请参阅 AWS、DigitalOcean、Google Cloud、Azure、Coolify 和 Dokploy 的指南。

快速开始

使用 Appwrite 入门就像创建一个新项目、连接代理或将 SDK 集成到代码中一样简单。您可以从命令提示符、快速入门教程或托管的 MCP 服务器开始。

代理

为您的工作流中的 AI 代理设计。查询数据库、绘制流量图或发布更改：您的代理将在实时 Appwrite 项目上执行这些操作。托管的 MCP 服务器使用 OAuth，因此您无需创建或管理 API 密钥。对于自托管实例，请改为使用 本地 MCP 服务器。

将远程服务器添加到 Cursor、Claude Code、Codex、VS Code 和其他 MCP 客户端：

{
    "mcpServers": {
        "appwrite": {
            "url": "https://mcp.appwrite.io/"
        }
    }
}

您还可以通过一次点击将 MCP 服务器添加到 Cursor。

安装特定语言的 代理技能，以便模型生成正确的 SDK 调用：

npx skills add appwrite/agent-skills

浏览 快速入门提示，为你的仓库生成一个 AGENTS.md 文件，或查看 AI 工具文档 以进行 IDE 和 vibe 编码设置。

如何开始使用你选择的平台也在下面的教程中涵盖。

软件开发工具包

以下是当前支持的平台和语言列表。如果你希望帮助我们为你选择的平台添加支持，可以访问我们的 SDK 生成器 项目并查看我们的 贡献指南。

客户端

• :white_check_mark:   网页
• :white_check_mark:   Flutter
• :white_check_mark:   苹果
• :white_check_mark:   安卓
• :white_check_mark:   React Native

服务器

• :white_check_mark:   Node.js
• :white_check_mark:   Python
• :white_check_mark:   Dart
• :white_check_mark:   PHP
• :white_check_mark:   红宝石
• :white_check_mark:   .NET
• :white_check_mark:   前往
• :white_check_mark:   Swift
• :white_check_mark:   Kotlin
• :white_check_mark:   Rust

想要更多的 SDK 吗？ - 通过向我们的 SDK 生成器 提交拉取请求来帮助我们！

架构

flowchart TB
  Console & Flutter & iOS & Android & Web & Agents & MCP & CLI & SDKs & Terraform --> Appwrite
  Appwrite --> REST & Realtime & GraphQL & S3
  REST & Realtime & GraphQL & S3 --> securityLayer[Security layer]
  securityLayer --> services
  subgraph services [Services]
    Auth
    Databases
    Functions
    Sites
    Messaging
    Storage
    Avatars
    Locale
  end
  services --> Executor & Queue & Cache & Browser & SMTP & Embeddings
  Cache --> Database
  Queue --> Workers
  Executor --> openRuntimes[Open Runtimes]

Appwrite 使用了一种混合的单体-微服务架构，旨在实现轻松的扩展和职责分配。此外，Appwrite 支持多种 API，例如 REST、WebSocket 和 GraphQL，使您能够利用现有的知识和所选择的协议与资源进行交互。

Appwrite API 层设计得非常快，通过利用内存缓存并将任何繁重的任务委派给 Appwrite 后台工作者。后台工作者还允许您使用消息队列处理负载，从而精确控制计算能力和成本。您可以在 AGENTS.md 中了解更多有关我们架构的信息。

贡献

所有代码贡献，包括具有提交权限的人的贡献，都必须通过拉取请求并在合并前由核心开发者批准。这是为了确保对所有代码进行适当的审查。

我们真的 :heart: 拉取请求！如果您希望提供帮助，可以在 贡献指南 中了解更多有关如何为该项目做出贡献的信息。

安全

请参阅 SECURITY.md 以了解如何报告漏洞。不要为安全报告打开公开的 GitHub 问题。

关注我们

加入我们在世界各地不断壮大的社区！阅读 博客，或在 Discord、GitHub、X、LinkedIn、YouTube、daily.dev、Bluesky、TikTok 和 Instagram 上关注我们。

许可

该仓库可在 BSD 3-Clause License 下使用。