paulknulst/affine

Affine Docker镜像文档

镜像概述

本镜像为Affine的Docker化版本，基于GitHub仓库（https://github.com/paulknulst/affine/%EF%BC%89%E7%9A%84%E6%9C%80%E6%96%B0%E4%BB%A3%E7%A0%81%E8%87%AA%E5%8A%A8%E6%9E%84%E5%BB%BA%E3%80%82Affine%E6%98%AF%E4%B8%80%E6%AC%BE%E4%B8%8B%E4%B8%80%E4%BB%A3%E5%8D%8F%E4%BD%9C%E7%9F%A5%E8%AF%86%E5%BA%93%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%9C%AC%E9%95%9C%E5%83%8F%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84%E6%9C%AC%E5%9C%B0%E9%83%A8%E7%BD%B2%E6%96%B9%E6%A1%88%EF%BC%8C%E7%9B%B4%E5%88%B0%E5%AE%98%E6%96%B9%E5%8F%91%E5%B8%83%E6%AD%A3%E5%BC%8FDocker%E7%89%88%E6%9C%AC%E5%89%8D%E4%BC%9A%E6%8C%81%E7%BB%AD%E6%9B%B4%E6%96%B0%E3%80%82

核心功能与特性

• 提供Affine协作知识库的完整运行环境
• 支持通过Docker Compose快速部署
• 包含数据库服务与Web服务组件
• 可配置多种环境变量以适应不同使用需求
• 支持本地数据存储与协作功能

使用场景

• 个人本地部署协作知识库
• 团队内部搭建私有知识管理平台
• 开发环境中快速测试Affine功能

使用方法

Docker Compose部署

以下是完整的docker-compose配置示例：

yaml
version: '3.9'
services:
  db:
    image: ghcr.io/toeverything/cloud-self-hosted:nightly-latest
    environment:
      - 'PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'
      - JWST_DEV=1
      - RUST_LOG=debug
      - SIGN_KEY=test123
      - RUST_BACKTRACE=full
    networks:
      - default
  web:
    image: paulknulst/affine
    depends_on:
      - db
    ports:
      - "8080:3000"
    networks:
      - default
    environment:
      - NEXT_PUBLIC_FIREBASE_API_KEY=
      - NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
      - NEXT_PUBLIC_FIREBASE_PROJECT_ID=
      - NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
      - NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
      - NEXT_PUBLIC_FIREBASE_APP_ID=
      - NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=
      # block suite目录的绝对路径
      - LOCAL_BLOCK_SUITE=
      # 参考next.config.js
      - API_SERVER_PROFILE=local
      # 将工作区保存到idb
      - ENABLE_IDB_PROVIDER=1
      - PREFETCH_WORKSPACE=1
      - ENABLE_BC_PROVIDER=1
      - EXPOSE_INTERNAL=1
      - ENABLE_DEBUG_PAGE=0
      - ENABLE_SUBPAGE=1
      - ENABLE_CHANGELOG=1
volumes:
  data:
networks:
  default:
    external: false

环境变量说明

db服务环境变量

• PATH: 系统路径配置
• JWST_DEV: 开发模式开关（1为开启）
• RUST_LOG: Rust日志级别（设为debug）
• SIGN_KEY: 签名密钥（示例为test123）
• RUST_BACKTRACE: Rust回溯设置（full为完整回溯）

web服务环境变量

• NEXT_PUBLIC_FIREBASE_*: Firebase相关配置（如API密钥、项目ID等，根据实际情况填写）
• LOCAL_BLOCK_SUITE: block suite目录的绝对路径
• API_SERVER_PROFILE: API服务器配置文件（设为local表示本地模式）
• ENABLE_IDB_PROVIDER: 启用IDB存储工作区（1为启用）
• PREFETCH_WORKSPACE: 预加载工作区（1为启用）
• ENABLE_BC_PROVIDER: 启用BC提供器（1为启用）
• EXPOSE_INTERNAL: 暴露内部接口（1为启用）
• ENABLE_DEBUG_PAGE: 启用调试页面（0为禁用）
• ENABLE_SUBPAGE: 启用子页面功能（1为启用）
• ENABLE_CHANGELOG: 启用更新日志（1为启用）

部署步骤

1. 创建docker-compose.yml文件，复制上述配置内容
2. 根据实际需求修改环境变量（特别是Firebase相关配置）
3. 执行命令启动服务：docker-compose up -d
4. 访问http://localhost:8080即可使用Affine

注意事项

• 本镜像基于社区维护的GitHub fork构建，非官方版本
• 随着Affine官方代码更新，镜像会持续同步更新
• 更多配置细节和更新信息请参考GitHub仓库：https://github.com/paulknulst/affine/