ghcr.io/tryghost/activitypub:sha-c9e5f64

ActivityPub

一个基于Fedify构建的多租户ActivityPub服务器，用于Ghost。此服务使独立网站能够直接将其内容发布到Fediverse，实现向开放社交网络的网络化发布。

本地开发运行

所有发往/.ghost/activitypub/*、/.well-known/webfinger和/.well-known/nodeinfo的请求通过nginx代理到此ActivityPub服务。所有其他请求转发至Ghost。此设置仅在macOS上使用Docker for Mac和OrbStack进行过测试。

/.ghost/activitypub/* /.well-known/webfinger /.well-known/nodeinfo

安装设置

• 按照“从源代码安装”说明安装Ghost
  Install from source
• 使用Tailscale（或***）暴露本地端口80（nginx）
  使用tailscale funnel 80或ngrok http 80暴露本地端口80（不是2368！），nginx将在此端口运行
• 使用tailscale funnel 80或ngrok http 80暴露本地端口80（不是2368！），nginx将在此端口运行
  tailscale funnel 80 ngrok http 80
• 配置Ghost
  在Ghost monorepo中，在ghost/core/config.local.json下创建config.local.json文件，包含以下配置：{ "url": }
• 在Ghost monorepo中，在ghost/core/config.local.json下创建config.local.json文件，包含以下配置：
  config.local.json ghost/core/config.local.json

{
"url":
}

• 启动ActivityPub服务
  在本项目的根目录中运行pnpm dev && pnpm logs
• 在本项目的根目录中运行pnpm dev && pnpm logs
pnpm dev && pnpm logs
• 启动Ghost
  在Ghost monorepo中运行yarn dev
  如果您已在本地运行Ghost，请确保重启它！
• 在Ghost monorepo中运行yarn dev
yarn dev
• 如果您已在本地运行Ghost，请确保重启它！

🏗️ 架构与开发指南

对于AI助手：请参阅AGENTS.md获取包含代码示例的全面指导。对于开发人员：请参阅/adr中的架构决策记录以了解详细原理。

对于AI助手：请参阅AGENTS.md获取包含代码示例的全面指导。对于开发人员：请参阅/adr中的架构决策记录以了解详细原理。

/adr

核心架构模式

此服务遵循领域驱动设计，并采用特定模式：

• 带事件的不可变实体（ADR-0003）- 实体返回带有领域事件的新实例
• 结果类型模式（ADR-0004）- 使用Result进行显式错误处理
• 结果中的错误对象（ADR-0005）- 增强的Result类型，包含上下文错误对象
• 基于类的架构（ADR-0006）- 所有组件使用带依赖注入的类
• 仓储模式（ADR-0007）- 服务编排逻辑，仓储处理数据访问
• 读取视图模式（ADR-0008）- 与写入路径分离的优化读取查询
• 基于哈希的查找（ADR-0009）⚠️ - ActivityPub ID使用SHA256哈希
• 装饰器路由（ADR-0010）- 通过装饰器定义路由

项目结构

src/
├── account/ # 不可变实体
├── post/ # 正在迁移为不可变
├── activity-handlers/ # 基于类的处理器
├── http/api/ # REST控制器
├── core/ # 共享工具
└── dispatchers.ts # 遗留代码 - 不要在此添加内容

⚠️ 关键注意事项

1. 数据库查找必须使用SHA256哈希（ADR-0009）

• 绝不要使用where('ap_id', apId) - 它会静默返回空结果！
  where('ap_id', apId)
• 始终使用whereRaw('ap_id_hash = UNHEX(SHA2(?, 256))', [apId])
whereRaw('ap_id_hash = UNHEX(SHA2(?, 256))', [apId])
• 适用于：ap_id、domain（需配合LOWER）、ap_inbox_url（需配合LOWER）
  ap_id domain ap_inbox_url

2. 结果类型需要辅助函数

• 使用isError(result)、getValue(result)、getError(result)
isError(result) getValue(result) getError(result)
• 绝不要直接解构为[error, value]
[error, value]

3. 服务必须使用仓储

• 视图可直接查询数据库（读取优化）
• 服务必须通过仓储（写入路径）

4. 依赖注入名称必须匹配

• 参数accountService → 注册为'accountService'
accountService 'accountService'
• 参数db → 注册为'db'
db 'db'

5. 避免这些反模式：

• 向dispatchers.ts添加内容 → 创建新的处理器类
  dispatchers.ts
• 使用AccountType → 使用Account实体
  AccountType Account
• 在服务中直接查询数据库 → 使用仓储
• 对AP ID进行字符串比较 → 使用哈希查找

有关演示正确模式的完整代码示例，请参阅AGENTS.md。

代码格式化与 linting

我们使用Biome进行代码格式化和linting。

如果您使用VS Code，可以安装Biome扩展以获取内联反馈。

要启用保存时自动格式化，您需要将默认格式化程序设置为Biome，并在VS Code设置中启用“保存时格式化”。

Biome Format on Save

🏗️ 架构与开发指南

对于AI助手：请参阅AGENTS.md获取包含代码示例的全面指南。 对于开发人员：请参阅/adr目录中的架构决策记录以了解详细原理。

核心架构模式

本服务遵循领域驱动设计，并采用以下特定模式：

• 带事件的不可变实体 (ADR-0003) - 实体返回包含领域事件的新实例
• 结果类型模式 (ADR-0004) - 使用Result进行显式错误处理
• 结果中的错误对象 (ADR-0005) - 增强型Result类型，包含上下文错误对象
• 基于类的架构 (ADR-0006) - 所有组件使用带依赖注入的类
• 仓储模式 (ADR-0007) - 服务编排逻辑，仓储处理数据访问
• 读取视图模式 (ADR-0008) - 与写入路径分离的优化读取查询
• 基于哈希的查找 (ADR-0009) ⚠️ - ActivityPub ID使用SHA256哈希
• 装饰器路由 (ADR-0010) - 通过装饰器定义路由

项目结构

src/
├── account/ # 不可变实体
├── post/ # 正在迁移为不可变实体
├── activity-handlers/ # 基于类的处理器
├── http/api/ # REST控制器
├── core/ # 共享工具
└── dispatchers.ts # 遗留文件 - 请勿在此添加内容

⚠️ 关键注意事项

1. 数据库查找必须使用SHA256哈希 (ADR-0009)

• 绝不要使用where('ap_id', apId) - 它会静默返回空结果！
• 始终使用whereRaw('ap_id_hash = UNHEX(SHA2(?, 256))', [apId])
• 适用于：ap_id、domain（需配合LOWER）、ap_inbox_url（需配合LOWER）

2. 结果类型需要辅助函数

• 使用isError(result)、getValue(result)、getError(result)
• 绝不要直接解构，如[error, value]

3. 服务必须使用仓储

• 视图可直接查询数据库（读取优化）
• 服务必须通过仓储访问（写入路径）

4. 依赖注入名称必须匹配

• 参数accountService → 注册为'accountService'
• 参数db → 注册为'db'

5. 避免以下反模式：

• 向dispatchers.ts添加内容 → 创建新的处理器类
• 使用AccountType → 使用Account实体
• 在服务中直接查询数据库 → 使用仓储
• 对AP ID进行字符串比较 → 使用哈希查找

有关演示正确模式的完整代码示例，请参阅AGENTS.md。

代码格式化与 linting

我们使用Biome进行代码格式化和 linting。

如果使用VS Code，可安装https://marketplace.visualstudio.com/items?itemName=biomejs.biome%E4%BB%A5%E8%8E%B7%E5%8F%96%E8%A1%8C%E5%86%85%E5%8F%8D%E9%A6%88%E3%80%82

要启用保存时自动格式化，需将默认格式化程序设置为Biome，并在VS Code设置中启用Format on Save。

运行测试

测试在Docker Compose堆栈中运行。常用命令：

• pnpm test — 运行所有测试（类型检查、单元测试、集成测试和端到端测试）；速度较慢
• pnpm test:unit — 仅运行单元测试；速度快
• pnpm test:integration — 仅运行集成测试
• pnpm test:cucumber — 端到端（Cucumber）测试
• pnpm test:single 'path/to/test' — 运行单个单元测试或集成测试
• pnpm test:types — 使用tsc进行类型检查

完整命令列表和测试约定请参阅AGENTS.md。

迁移

运行pnpm migrate可将待处理的up迁移应用到开发数据库（pnpm dev时也会自动执行）。对于测试数据库，使用docker compose run migrate-testing up。

要运行其他migrate命令，可通过docker compose exec -it migrate /bin/bash（或migrate-testing）进入shell。其中提供migrate二进制文件，以及格式正确的MYSQL_DB环境变量，可直接用于-database参数。

 

版权与许可

版权所有 (c) 2013-2026 Ghost Foundation - 基于MIT许可发布。Ghost及Ghost徽标是Ghost Foundation Ltd.的商标。有关可接受使用方式的信息，请参阅我们的https://ghost.org/trademark/%E3%80%82