Appwrite 镜像文档

1. 镜像概述和主要用途

Appwrite 镜像是一个端到端的后端服务器解决方案，专为前端和移动应用开发者设计。它集成了完整的后端基础设施，使开发者无需从零构建后端服务，即可快速实现用户认证、数据存储、文件管理等核心功能，从而专注于前端应用的开发与优化。

2. 核心功能和特性

• 全栈后端支持：提供一站式后端服务，覆盖数据存储、用户认证、文件管理、实时通信等核心需求。
• 标准化 API 接口：通过 RESTful API 暴露功能，兼容各类前端框架（如 React、Vue、Angular）和移动开发平台（iOS、Android、Flutter）。
• 多环境适配：支持开发、测试、生产等多环境配置，满足从原型验证到正式部署的全生命周期需求。
• 安全内置：集成数据加密、访问控制、防注入等安全机制，降低后端安全维护成本。
• 可扩展性：支持自定义函数、插件扩展，适应不同规模应用的个性化需求。

3. 使用场景和适用范围

• 前端开发者：无需后端开发经验，快速搭建功能完整的后端服务。
• 移动应用开发：为 iOS、Android 或跨平台移动应用提供稳定的后端支撑。
• 快速原型验证：在产品早期阶段，快速部署后端服务验证业务逻辑和用户体验。
• 中小型应用：作为生产环境的后端解决方案，支持应用从上线到规模化运营。

4. 使用方法和配置说明

4.1 快速启动（Docker Run）

通过以下命令快速启动 Appwrite 容器（适用于开发环境快速测试）：

bash
docker run -it --rm \
  --volume /var/run/docker.sock:/var/run/docker.sock \
  --volume appwrite-data:/usr/src/code/appwrite/data \
  --volume appwrite-config:/usr/src/code/appwrite/config \
  --publish 80:80 \
  --publish 443:443 \
  appwrite/appwrite:latest

4.2 Docker Compose 部署（推荐）

生产环境建议使用 docker-compose 部署，创建 docker-compose.yml 文件如下：

yaml
version: '3'

services:
  appwrite:
    image: appwrite/appwrite:latest
    restart: unless-stopped
    ports:
      - "80:80"   # HTTP 端口
      - "443:443" # HTTPS 端口
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - appwrite-data:/usr/src/code/appwrite/data       # 数据持久化
      - appwrite-config:/usr/src/code/appwrite/config   # 配置文件存储
    environment:
      - _APP_ENV=production               # 运行环境（development/production）
      - _APP_DOMAIN=your-domain.com       # 应用域名（如 example.com）
      - _APP_PORT=443                     # 服务端口（HTTPS 建议使用 443）
      - _APP_SECRET=your-secure-secret    # 应用密钥（用于加密操作，建议自定义复杂字符串）
      - _APP_OPENSSL_KEY_V1=your-openssl-key # OpenSSL 加密密钥（建议自定义）
      - _APP_DB_HOST=mariadb              # 数据库地址（对应下方 mariadb 服务名）
      - _APP_REDIS_HOST=redis             # Redis 地址（对应下方 redis 服务名）
    depends_on:
      - mariadb  # 数据库依赖
      - redis    # 缓存依赖

  mariadb:
    image: mariadb:10.7
    restart: unless-stopped
    environment:
      - MYSQL_ROOT_PASSWORD=your-mysql-root-pwd  # MySQL 根密码
      - MYSQL_DATABASE=appwrite                  # 数据库名称
      - MYSQL_USER=appwrite                      # 数据库用户名
      - MYSQL_PASSWORD=your-mysql-user-pwd       # 数据库用户密码
    volumes:
      - mariadb-data:/var/lib/mysql              # 数据库数据持久化

  redis:
    image: redis:alpine
    restart: unless-stopped
    volumes:
      - redis-data:/data                         # Redis 数据持久化

volumes:
  appwrite-data:
  appwrite-config:
  mariadb-data:
  redis-data:

启动服务：

bash
docker-compose up -d

4.3 核心配置参数（环境变量）

4.4 服务访问与初始化

部署完成后，通过浏览器访问 http://<服务器IP>:<端口> 或 https://<域名>（如配置 HTTPS），进入 Appwrite 控制台：

1. 创建管理员账户
2. 创建应用并获取 API 密钥
3. 集成 SDK 到前端/移动应用，调用后端 API

5. 更多信息

完整配置说明、API 文档及更新日志，请访问 GitHub 仓库。