sctg/sctgdesk-server

SCTGDesk Server 镜像文档

镜像概述

SCTGDesk Server是RustDesk Server的修改版，免费开源。该镜像在原版基础上新增了多项功能，包括RustDesk Server Pro版的tcp模式、API服务器初步实现及简单webconsole，适用于需要自建远程控制服务器并进行地址簿管理的场景。

核心功能与特性

主要差异与增强

1. 包含Pro版tcp模式：集成了RustDesk Server Pro版本中的新tcp模式，提升连接稳定性与性能。
2. API服务器初步实现：
   • 支持个人地址簿管理
   • 支持群组级共享地址簿（权限包括：只读、读写、管理员）
   • 支持用户级共享地址簿（权限包括：只读、读写、管理员）
3. 简单webconsole：提供基础的网页控制台，便于服务器管理操作。

使用场景与适用范围

适用于需要自建RustDesk远程控制服务器的个人或团队，尤其适合需要管理个人及共享地址簿、进行精细化权限控制的场景，可满足远程设备管理、团队协作控制等需求。

使用方法与配置说明

快速启动（TL;DR）

可通过以下docker-compose.yml文件启动服务器：

yaml
version: '3'

networks:
  sctgdesk-net:
    external: false

services:
  hbbs:
    container_name: hbbs
    ports:
      - 21114:21114
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21118:21118
    image: sctg/sctgdesk-server:latest
    command: hbbs -r sctgdesk.example.com:21117
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    ports:
      - 21117:21117
      - 21119:21119
    image: sctg/sctgdesk-server:latest
    command: hbbr
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    restart: unless-stopped

服务配置说明

• 网络：使用自定义网络sctgdesk-net隔离服务。
• hbbs服务：
  • 端口映射：21114（webconsole/API）、21115、21116（TCP/UDP）、21118
  • 命令：hbbs -r sctgdesk.example.com:21117（需将sctgdesk.example.com替换为实际服务器地址）
  • 数据卷：./data:/usr/local/share/sctgdesk（持久化存储服务器数据）
• hbbr服务：
  • 端口映射：21117、21119
  • 命令：hbbr
  • 数据卷：与hbbs共享同一数据卷，确保数据一致性

访问信息

Webconsole访问

• 地址：http://<server-ip>:21114/
• 登录信息：用户名admin，密码Hello,world!

API文档访问

• 内置API文档：http://<server-ip>:21114/api/doc/
• 非交互式API文档：https://sctg-development.github.io/sctgdesk-api-server/

代码仓库

项目代码可在 https://github.com/sctg-development/sctgdesk-server 获取。