CrossDesk Server

June 3, 2026 · View on GitHub

Platform License: LGPL v3 GitHub last commit Build Status
Docker Pulls GitHub issues GitHub stars GitHub forks

[ English / 中文 ]

为 CrossDesk 设计的服务端，支持WSS加密连接，使用SQLite3存储用户信息。

如何编译

依赖：

编译

git clone https://github.com/kunkundi/crossdesk-server.git

cd crossdesk-server

xmake b crossdesk_server

关于 Xmake

编译选项

# 切换编译模式
xmake f -m debug/release

# 可选编译参数
-r ：重新构建目标
-v ：显示详细的构建日志
-y ：自动确认提示

# 示例
xmake b -vy crossdesk_server

更多使用方法可参考 Xmake官方文档 。

构建镜像

cd docker

sudo docker build -t image-name .

运行容器

启动命令

sudo docker run -d \
  --name crossdesk_server \
  --network host \
  -e EXTERNAL_IP=xxx.xxx.xxx.xxx \
  -e INTERNAL_IP=xxx.xxx.xxx.xxx \
  -e CROSSDESK_SERVER_PORT=xxxx \
  -e COTURN_PORT=xxxx \
  -e MIN_PORT=xxxxx \
  -e MAX_PORT=xxxxx \
  -v /var/lib/crossdesk:/var/lib/crossdesk \
  -v /var/log/crossdesk:/var/log/crossdesk \
  crossdesk/crossdesk-server:v1.1.3

上述命令中，用户需注意的参数如下：

参数

  • EXTERNAL_IP：服务器公网 IP , 对应 CrossDesk 客户端自托管服务器配置中填写的服务器地址
  • INTERNAL_IP：服务器内网 IP
  • CROSSDESK_SERVER_PORT：自托管服务使用的端口，对应 CrossDesk 客户端自托管服务器配置中填写的服务器端口
  • COTURN_PORT: COTURN 服务使用的端口, 对应 CrossDesk 客户端自托管服务器配置中填写的中继服务端口
  • MIN_PORT/MAX_PORT：COTURN 服务使用的端口范围，例如：MIN_PORT=50000, MAX_PORT=60000，范围可根据客户端数量调整。
  • -v /var/lib/crossdesk:/var/lib/crossdesk：持久化数据库和证书文件到宿主机
  • -v /var/log/crossdesk:/var/log/crossdesk：持久化日志文件到宿主机

示例：

sudo docker run -d \
  --name crossdesk_server \
  --network host \
  -e EXTERNAL_IP=114.114.114.114 \
  -e INTERNAL_IP=10.0.0.1 \
  -e CROSSDESK_SERVER_PORT=9099 \
  -e COTURN_PORT=3478 \
  -e MIN_PORT=50000 \
  -e MAX_PORT=60000 \
  -v /var/lib/crossdesk:/var/lib/crossdesk \
  -v /var/log/crossdesk:/var/log/crossdesk \
  crossdesk/crossdesk-server:v1.1.3

注意：

  • 服务器需开放端口：COTURN_PORT/udp，COTURN_PORT/tcp，MIN_PORT-MAX_PORT/udp，CROSSDESK_SERVER_PORT/tcp。
  • 如果不挂载 volume，容器删除后数据会丢失
  • 证书文件会在首次启动时自动生成并持久化到宿主机的 /var/lib/crossdesk/certs 路径下
  • 数据库文件会自动创建并持久化到宿主机的 /var/lib/crossdesk/db/crossdesk-server.db 路径下
  • 日志文件会自动创建并持久化到宿主机的 /var/log/crossdesk/ 路径下

权限注意：如果 Docker 自动创建的目录权限不足（属于 root），容器内用户无法写入，会导致：

  • 证书生成失败，容器启动脚本会报错退出
  • 数据库目录创建失败，程序会抛出异常并崩溃
  • 日志目录创建失败，日志文件无法写入（但程序可能继续运行）

解决方案：在启动容器前手动设置权限：

sudo mkdir -p /var/lib/crossdesk /var/log/crossdesk
sudo chown -R $(id -u):$(id -g) /var/lib/crossdesk /var/log/crossdesk

服务状态接口

服务启动后，可通过同一 HTTPS 端口读取运行状态：

官方 CA 部署示例：

curl https://your-domain.example.com:9090/stats

自签证书部署示例：

curl --cacert /var/lib/crossdesk/certs/api.crossdesk.cn_root.crt \
  https://your-server-ip:9090/stats

说明：

  • 官方 CA 证书通常已被系统信任，curl 无需额外指定 --cacert
  • 自签证书需要显式指定根证书 api.crossdesk.cn_root.crt
  • 请求地址必须与服务端证书中的域名或 IP 一致，不能随意替换为 127.0.0.1

也支持路径 /api/stats，返回示例：

{
  "online_device_count": 12,
  "online_web_client_count": 2,
  "active_connection_count": 3,
  "online_duration_seconds": 86400,
  "total_online_seconds": 259200,
  "total_control_seconds": 3600,
  "total_controlled_seconds": 7200
}
  • online_device_count：当前在线设备数，不包含临时 web-* 客户端和 C-* 分身客户端
  • online_web_client_count：当前在线 Web 客户端数，仅统计临时 web-* 客户端
  • active_connection_count：当前处于连接中的会话数，按各 host 当前连接的 guest 数汇总；guest 自身登录或加入产生的连接不另行计数
  • online_duration_seconds：当前在线设备本次在线时长的总和，不包含临时 web-* 客户端和 C-* 分身客户端
  • total_online_seconds：设备累计在线时长的总和，包含当前仍在线设备的本次在线时长
  • total_control_seconds：设备作为控制端的累计远控时长总和，包含当前仍在进行的远控会话
  • total_controlled_seconds：设备作为被控端的累计远控时长总和，包含当前仍在进行的远控会话
  • 响应已带 Access-Control-Allow-Origin: *，可直接被网页端 fetch 调用

证书文件

如果使用项目自带的自签证书方案，可在宿主机的 /var/lib/crossdesk/certs 路径下找到根证书 api.crossdesk.cn_root.crt，下载到你的客户端主机，并在客户端的自托管服务器设置中选择相应的证书文件路径。

如果使用官方 CA 证书，则通常不需要单独分发上述根证书，客户端和 curl 会直接使用系统信任链校验证书。

后台管理页面

服务端可以在同一个 HTTPS 端口提供内置后台管理页面，访问路径为 /admin。

启动前同时设置以下两个环境变量即可启用后台管理：

ADMIN_USERNAME=admin
ADMIN_PASSWORD=change-this-password

Docker 示例：

sudo docker run -d \
  --name crossdesk_server \
  --network host \
  -e EXTERNAL_IP=114.114.114.114 \
  -e INTERNAL_IP=10.0.0.1 \
  -e CROSSDESK_SERVER_PORT=9099 \
  -e COTURN_PORT=3478 \
  -e MIN_PORT=50000 \
  -e MAX_PORT=60000 \
  -e ADMIN_USERNAME=admin \
  -e ADMIN_PASSWORD=change-this-password \
  -v /var/lib/crossdesk:/var/lib/crossdesk \
  -v /var/log/crossdesk:/var/log/crossdesk \
  crossdesk/crossdesk-server:v1.1.3

启动后打开：

https://your-domain.example.com:9090/admin

后台页面会显示在线设备数、在线 Web 客户端数、活动远控会话、累计在线时长、累计控制时长和累计被控时长，并支持断开选中的远控会话。页面包含中国用户分布地图，可用颜色深浅查看各省份用户数量，国外用户会单独汇总展示。客户端状态列表默认展示在线设备，并提供在线、远控中、离线、全部和 Web 客户端筛选；列表支持搜索、分页、排序和展开详情，并显示当前在线连接 IP 解析出的地理位置。客户端 IP 和地理位置只作为在线状态保存在内存中，不作为设备资料持久化到数据库；客户端在线时本次在线时长会实时刷新，下线后保留记录并显示最后在线时间点。

公网 IP 的地理位置默认不访问外部服务，内网、回环和 Docker 私有网段会显示为 Private network。如需开启公网 GeoIP 查询，可设置 CROSSDESK_GEOIP_LOOKUP=1 并通过 CROSSDESK_GEOIP_KEY 配置 IP2Location API key；默认请求 https://api.ip2location.io/?key={key}&ip={ip}。解析会读取 country_name、country_code、region_name 和 city_name，并拼出类似 Mountain View, California, United States of America 的位置文本。查询端点可通过 CROSSDESK_GEOIP_SCHEME、CROSSDESK_GEOIP_HOST、CROSSDESK_GEOIP_PORT 和 CROSSDESK_GEOIP_PATH 配置，其中路径里的 {ip} 和 {key} 会被替换。查询超时时间可通过 CROSSDESK_GEOIP_TIMEOUT_MS 调整，默认 1200ms。成功 IP 结果会缓存；失败结果不作为设备位置缓存，而是由后台 IP 队列按 IP 去重并按退避重新入队。重试时如果已没有在线设备使用该 IP，任务会直接丢弃。退避默认从 60000ms 开始翻倍，最高 1800000ms，可通过 CROSSDESK_GEOIP_FAILURE_TTL_MS 和 CROSSDESK_GEOIP_FAILURE_MAX_TTL_MS 调整。

后台前端资源位于 src/admin/web，容器内默认复制到 /crossdesk-server/admin；如需使用自定义前端目录，可设置 CROSSDESK_ADMIN_WEB_DIR。中国地图边界数据 china-provinces.json 由 ISC 许可的 china-map-geojson@1.0.4 省级 GeoJSON 数据生成。