Skip to content

Jeric-X/SyncClipboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SyncClipboard

build

中文 | English

目录

功能

  • 剪贴板同步,支持文字、图片和文件。服务器/客户端架构,可以使用客户端内置服务器、独立部署服务器,也可以使用支持WebDAV的网盘作为服务器
  • 优化图片类型的剪贴板,功能有:
    • 从任意位置复制图片时,可以直接向文件系统粘贴图片文件,反之亦然
    • 从浏览器复制图片后,后台下载原图到本地,解决无法从浏览器拷贝动态图的问题(大多网站有认证,适用范围有限,支持bilibili动态图片)
    • 从文件系统复制较新格式类型的图片文件时(webp/heic等),在剪贴板内储存gif或jpg格式,用于直接向支持图片的文本框粘贴图片

服务器

独立服务器

SyncClipboard.Server支持跨平台运行,依赖ASP.NET Core 6.0,安装ASP.NET Core 运行时后,通过以下命令运行

dotnet /path/to/SyncClipboard.Server.dll --contentRoot ./

工作目录与dll所在目录一致,会产生临时文件,在appsettings.json中可以修改绑定的ip和端口,以及客户端认证需要的用户名和密码
如需修改工作目录,拷贝一份appsettings.json到新工作目录并修改--contentRoot后的路径

用户名和密码支持使用环境变量配置,当环境变量SYNCCLIPBOARD_USERNAMESYNCCLIPBOARD_PASSWORD均不为空时,将优先使用这两个环境变量作为用户名和密码

注意:

  • 默认用户名是admin,密码是admin,端口号是5033
  • 客户端处填写http://ip:端口号http不可省略
  • http使用明文传输(包括本软件用于认证使用的基于Basic Auth的账号密码),在公网部署考虑使用反向代理工具配置SSL
  • 内置服务器并不是WebDAV实现

Docker

docker run -d \
  --name=syncclipboard-server \
  -p 5033:5033 \
  -e SYNCCLIPBOARD_USERNAME=your_username \
  -e SYNCCLIPBOARD_PASSWORD=your_password \
  --restart unless-stopped \
  jericx/syncclipboard-server:latest

Docker Compose

在宿主机中拷贝一份docker-compose.yml

curl -sL https://github.com/Jeric-X/SyncClipboard/raw/master/src/SyncClipboard.Server/docker-compose.yml > docker-compose.yml

docker-compose.yml文件中的SYNCCLIPBOARD_USERNAMESYNCCLIPBOARD_PASSWORD等号后边修改为你的用户名和密码,或使用其他方式覆盖这两个环境变量
执行

docker compose up -d

注意:

Arch Linux

可以直接从 AUR 安装(由 @devome 维护):

paru -Sy syncclipboard-server

然后按需编辑其配置文件 /etc/syncclipboard/appsettings.json,用户名和密码一定要修改。修改后启动即可(强烈建议配置反代并启用https):

sudo systemctl enable --now syncclipboard.service

客户端内置服务器

桌面客户端(Windows/Linux/macOS)内置了服务器,可以使用可视界面配置,注意事项同上

WebDAV服务器

可以使用支持WebDAV协议的网盘作为服务器
测试过的服务器:

客户端

桌面客户端(Windows/Linux/macOS)运行在后台时将自动同步剪贴板

展开/折叠截图

Windows

下载地址:Release页面中的SyncClipboard.zip,解压缩后运行SyncClipboard.exe

依赖:

注意:

  • 删除软件时,配置文件目录不会被删除,配置文件储存在%AppData%\SyncClipboard\,需要彻底删除软件时请手动删除整个目录

Linux, macOS

下载地址:SyncClipboard.Desktop,根据系统选择你需要的安装包

注意:

  • 名称中带有no-self-contained:依赖.NET 6.0桌面运行时ASP.NET Core 6.0运行时
  • 名称中带有self-contained:通常可以直接运行
  • 删除软件时,配置文件目录不会被删除,配置文件储存在~/.config/SyncClipboard/(Linux),~/Library/Application Support/SyncClipboard/(macOS),需要彻底删除软件时请手动删除整个目录
  • 使用debrpm安装包时,每次更新版本需要先删除旧版,再安装新版,不支持直接更新
  • Linux: 快捷键在Wayland不可用
  • Linux: 无法自动识别语言,默认为英语
  • macOS: “SyncClipboard”已损坏,无法打开,在终端中执行sudo xattr -d com.apple.quarantine /Applications/SyncClipboard.app
  • macOS: 快捷键依赖辅助功能权限(Accessibility),软件在需要时会弹窗提示(所有快捷键为空时则不需要),每个新版本需要重新授予权限

Arch Linux

Arch Linux 用户可以直接从 AUR 安装:

paru -Sy syncclipboard-desktop

安装后从菜单中启动即可,如果要从命令行中启动,请注意需要英文环境,即以 LANG=en_US.UTF-8 syncclipboard-desktop 来启动,启动后可以在软件内设置语言为中文。配置保存路径为:~/.config/SyncClipboard

IOS

  • 手动同步,导入这个快捷指令,手动触发上传或下载
  • 自动同步,导入这个快捷指令,运行后设备会自动在后台同步剪贴板内容,此快捷指令将执行无限时长,需要手动关闭,你还可以手动修改同步后是否发送系统通知、查询的间隔秒数
  • 自动上传短信验证码,参考这个帖子中的视频教程 #60

Android

导入这个配置文件,修改变量中的UserNameUserTokenurlurl不要以斜线分隔符/结尾。HTTP Request Shortcuts支持从下拉菜单、桌面组件、桌面图标、分享菜单中使用

导入配置文件后修改配置图示

使用Autox.js

  • 自动同步,使用这个js文件。由于安卓系统限制,在安卓10及以上的系统应用无法在后台读取剪贴板,但可以使用基于Root权限的工具(Magisk/Xposed)解除应用后台读取剪贴版的权限,如Riru-ClipboardWhitelistClipboard Whitelist。由于在安卓13及以上的系统应用必须由用户手动授权才被允许访问系统日志(剪贴板),也可以使用Xposed自动为应用授权访问系统日志的权限,如DisableLogRequest/禁用日志访问请求
  • 自动上传验证码,使用这个js文件,这个脚本运行在后台时将读取所有通知消息,在识别到验证码类信息时将证码上传到服务器

导入js文件、修改每个文件头部的用户配置后,手动点击运行,或者为每个js文件设置触发方式,例如:开机时触发

  • 自动上传验证码, #109

使用Tasker

Tasker是一款安卓系统上非常强大的自动化工具软件,你可以根据SyncClipboard的API创建适合自己的配置文件,如果你认为你的配置文件非常通用并希望分享出来,欢迎联系我置于此处

客户端配置说明

全平台依赖三条必要配置(配置的拼写可能会有所不同,含义相同)。

  • user
  • password
  • url,格式为http(s)://ip(或者域名):port。使用WebDav服务器时,url需要具体到一个已存在的文件夹作为工作目录,例如https://domain.com/dav/folder1/working%20folder,特殊符号需要使用url转义字符代替,不要使用这个文件夹存储其他文件。不使用桌面客户端(Windows/Linux/macOS)时需在工作目录中再创建file文件夹以同步文件,桌面客户端会在设置服务器时自动创建file文件夹。url尽量不要以斜线分隔符/结尾,在部分客户端中会出现问题。

API

API基于WebDAV,在独立服务器运行环境下设定环境变量ASPNETCORE_ENVIRONMENT为Development后运行服务器,或桌面客户端打开服务器并打开设置里的诊断模式后, 访问http://ip:端口/swagger/index.html可以打开API页面,以下是部分关键API

获取/上传剪贴板(文字)

GET /SyncClipboard.json
PUT /SyncClipboard.json

获取/上传剪贴板(图片/文件)

GET  /SyncClipboard.json
HEAD /file/filename         // optional
GET  /file/filename

PUT /file/filename
PUT /SyncClipboard.json

SyncClipboard.json

{
    "Type" : "Text"
    "Clipboard" : "Content",
    "File":""
}

{
    "Type": "Image", // or "File", "Group"
    "Clipboard": "hash, optional",
    "File": "filename"
}

项目依赖

Magick.NET
.NET Community Toolkit
H.NotifyIcon
WinUIEx
moq
Avalonia
FluentAvalonia.BreadcrumbBar
FluentAvalonia
Vanara
Tmds.DBus
SharpHook
DotNetZip.Semverd

About

跨平台剪贴板同步方案 / Cross-Platform Cipboard Syncing Solution

Resources

License

Stars

Watchers

Forks

Languages