Skip to content

Jonnyan404/cloud-clipboard-go

Repository files navigation

Cloud Clipboard Go

English Readme license release downloads

一个跨平台的云剪贴板工具,支持文本、图片、文件实时发送到云端或本地服务器。


📸 截图预览

💻 桌面端

Desktop Preview

📱 移动端

Mobile Preview

📡 路由器

OpenWrt Preview


🎯 优势特性

特性 说明
🔒 隐私安全 可部署在本地或自有服务器,数据完全可控
📦 易于部署 支持 Docker、源代码、二进制、Homebrew、OpenWrt等多种方式
🌍 跨平台 支持 Windows、macOS、Linux、Android、iOS
高效同步 实时同步,无延迟
🔐 认证保护 支持密码和 Token 认证
💾 灵活存储 支持配置历史记录和文件过期时间
🚀 轻量高效 资源占用少,即使在低配设备也能流畅运行
🔍 快捷指令 Android/iOS 快捷指令支持

🚀 快速开始

1️⃣ 使用 Docker(最推荐)

# 方式一:Docker Compose(推荐)
docker-compose up -d

# 方式二:Docker 命令行
docker run -d \
  --name=cloud-clipboard-go \
  -p 9501:9501 \
  -v /path/to/data:/app/server-node/data \
  jonnyan404/cloud-clipboard-go

然后访问:http://localhost:9501

2️⃣ 使用二进制文件

前往 Releases 下载对应平台的文件:

# Linux/macOS
./cloud-clipboard-go -port 9501

# Windows
cloud-clipboard-go.exe -port 9501

3️⃣ 使用 Android 应用(移动设备)

对于在 Android 手机/平板上直接部署服务器的场景:

  1. 前往 Releases 下载 .apk 文件
  2. 在 Android 设备上安装 APK
  3. 打开应用,设置监听端口(默认 9501)
  4. 设置访问密码(可选)
  5. 点击"启动服务"

然后在其他设备访问:http://你的安卓设备IP:9501

优点

  • 📱 无需电脑,在手机上直接运行服务器
  • 🚀 开箱即用,无需额外依赖
  • 💾 支持数据持久化

4️⃣ 使用 Homebrew(macOS)

brew install Jonnyan404/tap/cloud-clipboard-go
brew services start cloud-clipboard-go

5️⃣ 使用 OpenWrt(路由器)

opkg update
opkg install cloud-clipboard-go_*_platform.ipk
opkg install cloud-clipboard-go_*_all.ipk

6️⃣ 从源代码构建

# 前置要求:Node.js >= 22.12、Go >= 1.22

# 1. 构建前端
cd client
npm install
npm run build

# 2. 运行后端
cd ../cloud-clip
go mod tidy
go run -tags embed .

7️⃣ 使用 Cloudflare(云端部署)

对于需要云端部署的场景,支持一键部署到 Cloudflare Workers + Pages:

# 前置要求:Node.js >= 22.12、Wrangler CLI

# 1. 安装 Wrangler CLI
npm install -g wrangler

# 2. 登录 Cloudflare
wrangler login

# 3. 执行部署脚本
cd cloudflare
./deploy.sh

部署包含

  • Cloudflare Workers (API 后端)
  • Cloudflare D1 (数据库)
  • Cloudflare R2 (文件存储)
  • Cloudflare Pages (前端界面)

优点

  • 🌐 全球 CDN 加速
  • 🚀 无需服务器维护
  • 💾 自动备份和扩展
  • 🔒 Cloudflare 安全防护

注意事项

  • 需要 Cloudflare 账号
  • 免费额度内使用(Workers: 100,000 请求/天,D1: 500MB 存储,R2: 10GB 存储)
  • 部署完成后会显示访问 URL

详见:Cloudflare 部署文档


📋 部署指南

Docker Compose 配置

创建 docker-compose.yml

version: '3.8'

services:
  cloud-clipboard-go:
    image: jonnyan404/cloud-clipboard-go:latest
    container_name: cloud-clipboard-go
    restart: always
    ports:
      - "9501:9501"
    environment:
      - LISTEN_IP= #默认为0.0.0.0,可设置为 127.0.0.1 不懂勿动
      - LISTEN_IP6= #默认为空,ipv6地址,可设置为::,不懂勿动
      - LISTEN_PORT= #默认为9501,可设置为其他端口
      - PREFIX= #子路径,可配合nginx使用,格式: /cloud-clipboard
      - MESSAGE_NUM= #历史记录的数量,默认为10
      - AUTH_PASSWORD= #访问密码,默认为false,可自定义字符串密码
      - TEXT_LIMIT= #文本长度限制,默认为4096(2048个汉字),可设置为其他长度
      - FILE_EXPIRE= #文件过期时间,默认为3600(1小时),可设置为其他时间,单位为秒
      - FILE_LIMIT= #文件大小限制,默认为104857600(100MB),可设置为其他大小,单位为字节
      - MKCERT_DOMAIN_OR_IP= #mkcert域名或IP,默认为空,可设置为其他域名或IP,多个用空格分隔,仅域名支持通配符*
      - MANUAL_KEY_PATH= #手动设置证书路径,默认为空,该参数优先级高于MKCERT_DOMAIN_OR_IP
      - MANUAL_CERT_PATH= #手动设置证书路径,默认为空,该参数优先级高于MKCERT_DOMAIN_OR_IP
      - ROOM_LIST= #是否启用房间列表展示功能,默认false
    volumes:
      - ./data:/app/server-node/data  # 数据持久化
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:9501"]
      interval: 30s
      timeout: 10s
      retries: 3

运行:

docker-compose up -d

二进制文件参数

# 参数优先级:命令行 > 配置文件 > 默认值

-host string
    服务器监听地址 (默认 "0.0.0.0")

-port int
    服务器监听端口 (默认 9501)

-auth string
    访问密码

-config string
    配置文件路径

-static string
    外部前端文件路径

示例:

./cloud-clipboard-go -host 127.0.0.1 -port 8080 -auth mypassword123

📱 客户端使用

📲 Android 快捷指令

  1. 下载 HTTP Shortcuts
  2. 下载 快捷指令文件
  3. 在 HTTP Shortcuts 中导入文件
  4. 配置变量:
    • url: 你的服务器地址 (如:http://192.168.1.100:9501)
    • room: 房间名称(可选)
    • auth: 认证密码(可选)

🖥️ 桌面端应用

  • Clipboard Sync(仅提供给捐赠用户)
    • 双向同步剪贴板
    • 支持 Windows/macOS/Linux

💻 UI 辅助工具

下载 Cloud Clipboard Go Launcher,无需命令行操作。


🌐 API 接口

获取最新内容

GET /content/latest

返回最新的一条剪贴板内容。

参数

  • room (可选):房间名称

示例

curl http://localhost:9501/content/latest
curl http://localhost:9501/content/latest?room=work

完整 API 文档:API.md


🐳 Docker 镜像

镜像来源

来源 仓库
Docker Hub jonnyan404/cloud-clipboard-go
GitHub Container Registry ghcr.io/jonnyan404/cloud-clipboard-go

拉取最新镜像

docker pull jonnyan404/cloud-clipboard-go:latest

📚 详细文档


🔄 支持的平台

平台 二进制 Docker 源代码 说明
Linux 主要支持
macOS Intel/Apple Silicon
Windows 需要 Visual C++ Build Tools
Android - 服务端APK/快捷指令
iOS - - - 快捷指令
OpenWrt 路由器系统

📦 衍生项目


☕ 支持项目

如果这个项目对你有帮助,欢迎通过以下方式支持我们:

💰 赞赏捐助

你的支持是我们继续维护和改进项目的动力!

方式 二维码
微信 微信赞赏码

🌟 其他支持方式

📝 赞赏者名单

感谢以下用户的支持:

  • 🥇 xxxxxxxx(赞赏 ¥199)
  • 🥈 xxxxxxxx(赞赏 ¥99)
  • 🥉 xxxxxxxx(赞赏 ¥50)

如果你也想出现在这里,请在赞赏时备注你的名字或昵称!


🙏 致谢

本项目前端(client)和后端(cloud-clip) fork以下开源项目修改而来:


📊 Star 历史

Star History Chart


📄 许可证

MIT License - 详见 LICENSE

💬 交流反馈


最后更新: 2025年11月25日 | 📖 English Version

About

在局域网内自用的在线剪贴板,支持传输纯文本和文件

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •