Hydroxide 开源项目使用教程
1. 项目介绍
Hydroxide 是一个第三方的开源 ProtonMail 桥接工具,旨在为高级用户提供服务,特别适合在服务器上运行。Hydroxide 支持 CardDAV、IMAP 和 SMTP 协议,允许用户使用自己喜欢的电子邮件客户端和 git-send-email
与 ProtonMail 进行交互。
Hydroxide 的主要特点包括:
- 无图形界面:仅提供命令行界面(CLI),适合在无头环境中运行。
- 标准兼容:不依赖于 Microsoft Outlook 等特定客户端。
- 完全开源:用户可以自由查看和修改源代码。
2. 项目快速启动
安装
首先,确保你已经安装了 Go 语言环境。然后,按照以下步骤安装 Hydroxide:
# 克隆项目仓库
git clone https://github.com/emersion/hydroxide.git
# 进入项目目录
cd hydroxide
# 构建项目
go build ./cmd/hydroxide
登录 ProtonMail
安装完成后,你需要通过 Hydroxide 登录你的 ProtonMail 账户:
# 使用你的 ProtonMail 用户名登录
./hydroxide auth <username>
登录成功后,Hydroxide 会生成一个“桥接密码”,这个密码将用于配置你的电子邮件客户端。
启动服务
Hydroxide 支持多种模式,建议使用 serve
命令启动服务:
# 启动 Hydroxide 服务
./hydroxide serve
此命令将启动 SMTP、IMAP 和 CardDAV 服务,分别使用端口 1025、1143 和 8080。
3. 应用案例和最佳实践
使用电子邮件客户端
配置你的电子邮件客户端以使用 Hydroxide 提供的 SMTP 服务:
- Hostname:
localhost
- Port:
1025
- Security:
none
- Username: 你的 ProtonMail 用户名
- Password: 桥接密码(不是你的 ProtonMail 密码)
使用 CardDAV
Hydroxide 支持 CardDAV,但需要配置一个 HTTPS 反向代理来转发请求。以下是一个简单的 Nginx 配置示例:
server {
listen 443 ssl;
server_name yourdomain.com;
ssl_certificate /path/to/your/certificate.crt;
ssl_certificate_key /path/to/your/private.key;
location / {
proxy_pass http://localhost:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
使用 IMAP
IMAP 功能目前仍在开发中,仅支持本地未加密连接。你可以通过以下命令启动 IMAP 服务:
./hydroxide imap
4. 典型生态项目
ProtonMail
Hydroxide 的主要目标是与 ProtonMail 集成,提供一个开源的桥接解决方案,使用户能够通过标准协议访问 ProtonMail 服务。
Evolution
Evolution 是一个流行的电子邮件和日历客户端,支持 CardDAV 和 IMAP。通过 Hydroxide,用户可以在 Evolution 中无缝使用 ProtonMail 服务。
DAVDroid
DAVDroid 是一个 Android 应用程序,支持 CardDAV 和 CalDAV。通过 Hydroxide,用户可以在 Android 设备上管理他们的 ProtonMail 联系人。
通过以上步骤,你可以快速上手并使用 Hydroxide 项目,享受开源社区带来的便利和灵活性。