Sign inSign up

birdxs/pebble-web

By birdxs

•Updated 3 months ago

Image
0

1.9K

birdxs/pebble-web repository overview

⁠Pebble Web

中文 | English⁠

Pebble Web 是一个可自托管的 Web 邮件客户端，基于桌面端 Pebble⁠ 改造而来，默认面向中文用户编写文档，支持 Docker 部署和浏览器访问。

⁠主要功能

  • 多账户邮件管理：收件箱、文件夹、会话、星标、归档、回收站
  • 邮件撰写：富文本、Markdown、HTML、附件、回复、转发、草稿
  • 邮件同步：支持 IMAP/SMTP，后台自动同步，可配置同步间隔
  • 全文搜索：基于 Tantivy，支持常用邮件检索条件
  • 批量操作：归档、删除、标记已读/未读、星标
  • 标签与看板：自定义标签、邮件任务看板、上下文备注
  • 稍后处理：邮件延后提醒和待处理列表
  • 邮件翻译：支持 DeepLX、DeepL、通用翻译服务和 LLM 翻译配置
  • 隐私保护：默认阻止远程图片，可维护可信发件人
  • 附件管理：上传暂存、下载、内联附件展示
  • 云端配置备份：通过 WebDAV 备份和恢复设置
  • 双语界面：中文和 English

⁠快速开始

⁠一键部署

在已安装 Docker 和 Docker Compose 的 Linux 服务器上运行：

curl -fsSL https://raw.githubusercontent.com/QingJ01/Pebble-Web/master/scripts/deploy.sh | bash

脚本会自动拉取项目、生成 .env、构建镜像并启动服务。默认安装目录为 ~/pebble-web，默认端口为 8080。

如需自定义目录、端口或登录密码：

curl -fsSL https://raw.githubusercontent.com/QingJ01/Pebble-Web/master/scripts/deploy.sh | env PEBBLE_INSTALL_DIR=/opt/pebble-web PEBBLE_PORT=8080 PEBBLE_PASSWORD='change-me' bash
⁠Docker Compose

推荐使用 Docker Compose 部署：

git clone https://github.com/QingJ01/Pebble-Web.git
cd Pebble-Web
cp .env.example .env

编辑 .env，至少设置：

PEBBLE_PASSWORD=请替换为登录密码
PEBBLE_JWT_SECRET=请替换为至少32位的随机字符串

启动服务：

docker-compose up -d

浏览器访问：

http://localhost:8080
⁠手动构建

环境要求：

  • Rust 1.80+
  • Node.js 20+
  • npm
cd frontend
npm install
npm run build
cd ..

cargo build --release

运行前设置环境变量：

export PEBBLE_PASSWORD=your-password
export PEBBLE_JWT_SECRET=your-random-secret-at-least-32-chars
export PEBBLE_DATA_DIR=./data
export PEBBLE_STATIC_DIR=./frontend/dist

./target/release/pebble-web

Windows PowerShell 示例：

$env:PEBBLE_PASSWORD="your-password"
$env:PEBBLE_JWT_SECRET="your-random-secret-at-least-32-chars"
$env:PEBBLE_DATA_DIR="./data"
$env:PEBBLE_STATIC_DIR="./frontend/dist"

.\target\release\pebble-web.exe

⁠本地开发

后端：

cargo run

前端：

cd frontend
npm install
npm run dev

开发服务器会把前端请求代理到后端服务。

⁠配置项

变量必填默认值说明
PEBBLE_PASSWORD是无Web 登录密码
PEBBLE_JWT_SECRET是无登录令牌签名密钥，至少 32 字符
PEBBLE_PORT否8080服务端口
PEBBLE_DATA_DIR否/data数据目录
PEBBLE_STATIC_DIR否./frontend/dist前端静态文件目录
PEBBLE_SYNC_INTERVAL否300邮件同步间隔，单位秒
PEBBLE_ENCRYPTION_KEY否自动生成32 字节 Hex 编码加密密钥

安全建议：

  • 不要使用 .env.example 中的占位密码和密钥。
  • 生产环境请使用 HTTPS 反向代理。
  • 请定期备份 PEBBLE_DATA_DIR。

⁠数据目录

默认数据目录结构：

data/
├─ pebble.db
├─ index/
├─ attachments/
│  └─ staging/
└─ encryption.key

其中：

  • pebble.db 保存账户、邮件元数据、文件夹、标签、规则等信息。
  • index/ 保存全文搜索索引。
  • attachments/ 保存附件和上传暂存文件。
  • encryption.key 用于本地敏感数据加密，丢失后无法解密已有凭据。

⁠技术栈

模块技术
前端React 19、TypeScript、Vite、Tailwind CSS、Zustand、TanStack Query
编辑器TipTap、Markdown 支持
后端Rust、Axum、Tokio
存储SQLite、rusqlite
搜索Tantivy
邮件IMAP、SMTP
加密AES-256-GCM、Argon2、JWT
部署Docker、Docker Compose

⁠项目结构

Pebble-Web/
├─ src/                 # Rust Web 后端
├─ crates/              # Rust workspace 子包
├─ frontend/            # React 前端
├─ Dockerfile
├─ docker-compose.yml
├─ .env.example
├─ README.md
├─ README_EN.md
└─ LICENSE

⁠友情链接

  • LINUX DO⁠ — 真诚、友善、团结、专业，共建你我引以为荣的社区

⁠许可协议

本项目基于 GNU Affero General Public License v3.0⁠ 开源，SPDX 标识为 AGPL-3.0-only。

Tag summary

Content type

Image

Digest

sha256:9e8351297…

Size

14.5 MB

Last updated

3 months ago

docker pull birdxs/pebble-web