Twoblade 项目启动与配置教程

1. 项目的目录结构及介绍

Twoblade 是一个基于 SHARP（Self-Hosted Address Routing Protocol）协议的开源邮件系统。项目的目录结构如下：

• SHARP：包含 SHARP 协议服务器的代码和相关文件。
• website：包含网站前端代码和相关文件。
• .gitattributes：定义 Git 仓库中文件的属性。
• .gitignore：定义 Git 忽略的文件和目录。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• build.sh：构建脚本，用于初始化 Docker 容器。
• docker-compose.yml：Docker Compose 配置文件，用于定义和运行多容器 Docker 应用。

2. 项目的启动文件介绍

项目的启动主要涉及 SHARP 目录和 website 目录。

SHARP 服务器启动

在 SHARP 目录中，执行以下步骤启动服务器：

1. 初始化数据库：

   bash database/init.sh
   

2. 运行服务器：

   cd ..
   bun run .
   

网站启动

在 website 目录中，执行以下步骤启动网站：

1. 安装依赖：

   npm install
   

2. 配置环境变量： 在 website 目录下创建 .env 文件，并添加以下配置（根据实际情况替换）：

   PUBLIC_DOMAIN=yourdomain.com
   DATABASE_URL=postgres://user:password@host:port/database
   JWT_SECRET=your_jwt_secret
   

3. 运行开发服务器：

   npm run dev -- --open
   

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件进行。

SHARP 服务器配置

在 SHARP 目录下的 .env 文件中，可以配置以下变量：

• DATABASE_URL：数据库连接字符串。
• SHARP_PORT：SHARP 服务器端口。
• HTTP_PORT：HTTP 服务器端口。
• DOMAIN_NAME：域名。

网站配置

在 website 目录下的 .env 文件中，可以配置以下变量：

• PUBLIC_DOMAIN：公共域名。
• DATABASE_URL：数据库连接字符串。
• PUBLIC_WEBSOCKET_URL：WebSocket 服务器地址。
• JWT_SECRET：JWT 密钥。
• PRIVATE_B2_KEY_ID、PRIVATE_B2_APP_KEY、PRIVATE_B2_BUCKET、PRIVATE_B2_REGION、PRIVATE_B2_ENDPOINT：Backblaze B2 或其他 S3 兼容存储的配置。
• TEST_AUTH_TOKEN：测试用的认证令牌。
• REDIS_URL：Redis 连接字符串。
• PUBLIC_TURNSTILE_SITE_KEY：turnstile 验证码的站点密钥。

确保所有配置信息正确无误，以保障项目正常运行。