twoblade 的安装和配置教程

1. 项目基础介绍

twoblade 是一个开源项目，它实现了 SHARP（Self-Hosted Address Routing Protocol）协议。这是一个去中心化的电子邮件系统，使用 # 符号进行地址寻址（例如，user#domain.com）。该系统旨在提供一个界面和参考实现，允许用户自我托管邮件服务。

该项目主要使用的编程语言包括 Svelte、TypeScript、JavaScript、PLpgSQL、CSS 和 Shell 脚本。

2. 项目使用的关键技术和框架

• Svelte: 一个现代的 JavaScript 框架，用于构建用户界面。
• TypeScript: JavaScript 的一个超集，添加了静态类型选项。
• JavaScript: 一种高级的、解释执行的编程语言。
• PLpgSQL: PostgreSQL 的过程语言。
• CSS: 用于网页设计的样式表语言。
• Shell 脚本: 用于自动化操作系统任务的脚本语言。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统已经安装了以下依赖项：

• Node.js
• npm 或 Yarn
• Docker (用于数据库和服务部署)
• PostgreSQL (如果选择不使用 Docker 部署数据库)

安装步骤

步骤 1: 克隆项目

首先，您需要在本地克隆项目仓库：

git clone https://github.com/outpoot/twoblade.git
cd twoblade

步骤 2: 安装依赖

在项目根目录下安装 Node.js 依赖项：

npm install

或者如果您使用 Yarn：

yarn install

步骤 3: 配置环境变量

在项目根目录下创建一个 .env 文件，并根据您的配置添加以下变量：

DATABASE_URL=postgres://user:password@host:port/database
SHARP_PORT=5000
HTTP_PORT=5001
DOMAIN_NAME=yourdomain.com
JWT_SECRET=your_secret_key
PRIVATE_B2_KEY_ID=your_key_id
PRIVATE_B2_APP_KEY=your_app_key
PRIVATE_B2_BUCKET=your_bucket_name
PRIVATE_B2_REGION=your_region
PRIVATE_B2_ENDPOINT=https://s3.your_region.backblazeb2.com

请将 user, password, host, port, database, yourdomain.com, your_secret_key, your_key_id, your_app_key, your_bucket_name, your_region 替换为您自己的配置。

步骤 4: 初始化数据库

在 SHARP 目录下运行以下命令来初始化数据库：

bash database/init.sh

步骤 5: 运行服务

回到项目根目录，运行以下命令以启动服务：

bun run .

步骤 6: 配置 DNS

在您的 DNS 提供商处添加 SRV 记录，以便其他 SHARP 用户可以发现您的服务器。具体记录取决于您的配置，以下是一个示例：

_sharp._tcp.yourdomain.com. 86400 IN SRV 10 0 5000 yourdomain.com.

将 yourdomain.com 替换为您自己的域名，并将 5000 替换为您在 .env 文件中定义的 SHARP_PORT。

完成以上步骤后，您的 twoblade 应该已经成功安装并配置完毕，可以开始使用了。