Paste Sync

一个简单高效的基于 Web 的工具，用于在局域网内的设备之间共享文本和文件。

English README

功能特性

• 共享剪贴板：在手机、平板和电脑之间即时共享文本。
• 文件共享：轻松上传和下载文件。
• 深色模式：支持浅色、深色和基于系统设置的主题切换。
• Docker 支持：支持使用 Docker Compose 快速部署。

快速开始

前提条件

• Docker 和 Docker Compose

安装与运行

1. 克隆仓库：

   git clone https://github.com/AlakaSquasho/paste_sync.git
   cd paste_sync

2. 启动应用：

   docker-compose up -d --build

3. 访问应用：

   • 前端界面：http://localhost:8080
   • 后端 API：http://localhost:3000

Nginx 公网反代模板（含 WebSocket）

项目已提供可直接参考的反代模板：

• nginx.reverse-proxy.template.conf

该模板适用于“公网 Nginx 直接按前后端端口分流”的部署方式，并已包含 WebSocket 所需的升级头与长连接超时配置。其路由链路如下：

• 外层 Nginx 将 / 转发到 127.0.0.1:8080（前端）
• 外层 Nginx 将 /api、/ws 转发到 127.0.0.1:3000（后端）

使用步骤：

1. 将模板中的 DOMAIN_NAME 替换为你的域名。
2. 按需添加 HTTPS 证书配置（listen 443 ssl、证书路径等）。
3. 确保 Docker 映射端口与 docker-compose.yml 保持一致（默认 8080:80）。
4. 重载 Nginx 配置。

安全特性

为保障公网部署的安全性，本项目已集成以下防护措施：

• 频率限制 (Rate Limiting)：针对登录接口及全局 API 进行了频率限制，防止暴力破解。
• 防爆破延迟：登录验证引入了人为延迟，增加攻击者时间成本。
• Bcrypt 支持：支持在环境变量中使用 Bcrypt 哈希值作为密码。
• 访问审计日志：自动记录所有访问者的 IP、请求路径及状态，日志存储在服务器本地（server/logs/access.log）。

配置说明

您可以在 docker-compose.yml 中自定义以下环境变量：

• SHARED_PASSWORD：访问所需的密码。支持明文或 Bcrypt 哈希值（推荐）。
• JWT_SECRET：用于身份验证 Token 的密钥。请务必修改。
• IPINFO_API_KEY：用于访问 IP 归属地服务的 API Key。配置后访问日志会记录具体区域。

生成安全密码哈希

建议使用哈希值而非明文：

node -e "console.log(require('bcryptjs').hashSync('你的密码', 10))"

将生成的 $2a$... 字符串填入 SHARED_PASSWORD。

技术栈

• 前端：React, TypeScript, Tailwind CSS, Vite.
• 后端：Node.js, Express, Prisma.
• 数据库：SQLite.
• 部署：Nginx, Docker.

开源协议

本项目采用 MIT 协议。