chenqiyux/lan-clip

云剪贴板服务 Docker 镜像文档

镜像概述和主要用途

本镜像为局域网云剪贴板服务的精简版本，基于 https://github.com/TransparentLC/cloud-clipboard 项目构建。主要用于在局域网内实现跨设备的文本和文件快速共享，支持配置自定义，并修复了服务重启后数据无法存储的问题。

核心功能和特性

• 跨设备共享：支持局域网内多设备间文本和文件的实时共享
• 自定义配置：可通过配置文件调整监听地址、端口、存储限制等参数
• 精简轻量：镜像体积小，资源占用低，适合本地部署
• 数据持久化：修复重启后数据无法存储的问题，确保历史记录和文件持久化
• 安全控制：支持密码认证功能，可配置连接时的身份验证

使用场景和适用范围

• 家庭局域网内多设备（电脑、手机、平板）间快速共享文本内容
• 办公环境中临时文件传输，无需依赖外部云服务
• 开发测试环境中跨设备数据传递，提高工作效率

使用方法和配置说明

快速部署

通过以下命令快速启动容器：

bash
docker container run -d --name localpaste -p 9501:9501 chenqiyux/lan-clip

• -d：后台运行容器
• --name localpaste：指定容器名称为localpaste
• -p 9501:9501：映射容器内9501端口到宿主机9501端口

配置文件修改

容器内配置文件路径为：/app/server-node/config.json

默认配置内容如下：

json
{
    "server": {
        "host": [
            "127.0.0.1",
            "::1"
        ],
        "port": 9501,
        "key": "localhost-key.pem",
        "cert": "localhost.pem",
        "history": 10,
        "auth": false
    },
    "text": {
        "limit": 4096
    },
    "file": {
        "expire": 3600,
        "chunk": 1048576,
        "limit": 104857600
    }
}

配置参数详解

server 配置

• host：监听的IP地址，数组形式。省略或设为null则监听所有网卡的IP地址
• port：服务端口号，默认9501
• key：HTTPS私钥文件路径，用于启用HTTPS
• cert：HTTPS证书文件路径，用于启用HTTPS
• history：消息历史记录数量，默认10条
• auth：是否启用密码认证，false表示不启用，true时需额外配置认证密码

text 配置

• limit：文本内容长度限制，单位为字符，默认4096

file 配置

• expire：上传文件的有效期，单位为秒，默认3600秒（1小时），超过后自动删除
• chunk：文件上传分片大小，单位为字节，不能超过5MB，默认***字节（1MB）
• limit：单个文件大小限制，单位为字节，默认***字节（100MB）

注意事项

• 修改配置文件时，需删除所有注释后保存，否则可能导致服务无法启动
• 若修改配置后容器无法正常启动，可尝试重置容器：docker rm -f localpaste 后重新运行启动命令
• 启用HTTPS时，需确保key和cert路径指向容器内有效的证书文件，可通过挂载宿主机证书文件实现