Главная Обзор Помощь
Вход
master
/
rustdesk-api-lejianwen
зеркало из https://github.com/lejianwen/rustdesk-api.git
Следить 1
В избранное 0
Ответвить 0
Файлы Обсуждения 0 Вики
Дерево: b9109b4d0e
Ветки Метки
rustdesk-api...
/
README_EN.md

README_EN.md 15 KB
История Исходник

RustDesk API

This project implements the RustDesk API using Go, and includes both a web UI and web client. RustDesk is a remote desktop software that provides self-hosted solutions.

Features

  • PC API
    • Personal API
    • Login
    • Address Book
    • Groups
    • Authorized login, supports GitHub and Google login, supports web admin authorized login
    • i18n
  • Web Admin
    • User Management
    • Device Management
    • Address Book Management
    • Tag Management
    • Group Management
    • OAuth Management
    • Quick access to web client
    • i18n
  • Web Client
    • Automatically obtain API server
    • Automatically obtain ID server and KEY
    • Automatically obtain address book

Prerequisites

Rustdesk

  1. The PC client version used is 1.3.0, and versions 1.2.6+ have been tested to work.
  2. The server must specify a key, and not use the auto-generated key, otherwise there may be connection failures or timeouts.
   hbbs -r <relay-server-ip[:port]> -k <key>
   hbbr -k <key>

Example:

   hbbs -r <relay-server-ip[:port]> -k abc1234567
   hbbr -k abc1234567

Overview

API Service: Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the rustdesk.personal file or the RUSTDESK_API_RUSTDESK_PERSONAL environment variable.

Login

  • Added GitHub and Google login, which can be used after configuration in the admin panel. See the OAuth configuration section for details.
  • Added authorization login for the web admin panel.

pc_login

Address Book

pc_ab

Groups: Groups are divided into shared groups and regular groups. In shared groups, everyone can see the peers of all group members, while in regular groups, only administrators can see all members' peers.

pc_gr

Web Admin

The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and displaying data.Frontend code is available at rustdesk-api-web

Admin panel URL: http://<your server[:port]>/_admin/. The default username and password for the initial installation are admin admin, please change the password immediately.

  1. Admin interface: web_admin
  2. Regular user interface: web_user You can change your password from the top right corner: web_resetpwd
  3. Groups can be customized for easy management. Currently, two types are supported: shared group and regular group. web_admin_gr
  4. You can open the web client directly for convenience: web_webclient
  5. OAuth support: Currently, GitHub and Google is supported. You need to create an OAuth App and configure it in the admin panel. web_admin_oauth
    • Create a GitHub OAuth App at Settings -> Developer settings -> OAuth Apps -> New OAuth App here.
    • Set the Authorization callback URL to http://<your server[:port]>/api/oauth/callback, e.g., http://127.0.0.1:21114/api/oauth/callback.

Web Client:

  1. If you're already logged into the admin panel, the web client will log in automatically.
  2. If you're not logged in, simply click the login button at the top right corner, and the API server will be pre-configured. webclient_conf
  3. After logging in, the ID server and key will be automatically synced.
  4. The address book will also be automatically saved to the web client for convenient use.

Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.

  1. Admin panel docs: <your server[:port]>/admin/swagger/index.html
  2. PC client docs: <your server[:port]>/swagger/index.html api_swag

Installation and Setup

Configuration

  • Modify the configuration in conf/config.yaml.
  • If gorm.type is set to sqlite, MySQL-related configurations are not required.
  • Language support: en and zh-CN are supported. The default is zh-CN.
lang: "en"
gin:
  api-addr: "0.0.0.0:21114"
  mode: "release"
  resources-path: 'resources'
  trust-proxy: ""
gorm:
  type: "sqlite"
  max-idle-conns: 10
  max-open-conns: 100
mysql:
  username: "root"
  password: "111111"
  addr: "192.168.1.66:3308"
  dbname: "rustdesk"
rustdesk:
  id-server: "192.168.1.66:21116"
  relay-server: "192.168.1.66:21117"
  api-server: "http://192.168.1.66:21114"
  key: "123456789"
  personal: 1
  • Environment variables, with the prefix RUSTDESK_API_RUSTDESK_PERSONAL, will override the settings in the configuration file if present.
Variable Name Description Example
TZ timezone Asia/Shanghai
RUSTDESK_API_LANG Language en,zh-CN
----- GIN Configuration ----- --------------------------------------- ------------------------------
RUSTDESK_API_GIN_TRUST_PROXY Trusted proxy IPs, separated by commas. 192.168.1.2,192.168.1.3
----- GORM Configuration ----- --------------------------------------- ------------------------------
RUSTDESK_API_GORM_TYPE Database type (sqlite or mysql). Default is sqlite. sqlite
RUSTDESK_API_GORM_MAX_IDLE_CONNS Maximum idle connections 10
RUSTDESK_API_GORM_MAX_OPEN_CONNS Maximum open connections 100
RUSTDESK_API_RUSTDESK_PERSONAL Open Personal Api 1:Enable,0:Disable 1
----- MYSQL Configuration ----- --------------------------------------- ------------------------------
RUSTDESK_API_MYSQL_USERNAME MySQL username root
RUSTDESK_API_MYSQL_PASSWORD MySQL password 111111
RUSTDESK_API_MYSQL_ADDR MySQL address 192.168.1.66:3306
RUSTDESK_API_MYSQL_DBNAME MySQL database name rustdesk
----- RUSTDESK Configuration ----- --------------------------------------- ------------------------------
RUSTDESK_API_RUSTDESK_ID_SERVER Rustdesk ID server address 192.168.1.66:21116
RUSTDESK_API_RUSTDESK_RELAY_SERVER Rustdesk relay server address 192.168.1.66:21117
RUSTDESK_API_RUSTDESK_API_SERVER Rustdesk API server address http://192.168.1.66:21114
RUSTDESK_API_RUSTDESK_KEY Rustdesk key 123456789

Installation Steps

Running via Docker

  1. Run directly with Docker. Configuration can be modified by mounting the config file /app/conf/config.yaml, or by using environment variables to override settings.
docker run -d --name rustdesk-api -p 21114:21114 \
-v /data/rustdesk/api:/app/data \
-e RUSTDESK_API_LANG=en \
-e RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 \
-e RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 \
-e RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 \
-e RUSTDESK_API_RUSTDESK_KEY=123456789 \
lejianwen/rustdesk-api

  1. Using docker-compose

    • Simple example:
   services:
      rustdesk-api:
       container_name: rustdesk-api
       environment:
         - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
         - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
         - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
         - RUSTDESK_API_RUSTDESK_KEY=123456789
       ports:
         - 21114:21114
       image: lejianwen/rustdesk-api
       volumes:
         - /data/rustdesk/api:/app/data # Mount the database for easy backup
       networks:
         - rustdesk-net
       restart: unless-stopped

- Example with RustDesk's official Docker Compose file, adding your `rustdesk-api` service:

   networks:
     rustdesk-net:
       external: false
   services:
     hbbs:
       container_name: hbbs
       ports:
         - 21115:21115
         - 21116:21116 # 自定义 hbbs 映射端口
         - 21116:21116/udp # 自定义 hbbs 映射端口
         - 21118:21118 # web client 需要
       image: rustdesk/rustdesk-server
       command: hbbs -r <relay-server-ip[:port]> -k 123456789 # 填入个人域名或 IP + hbbr 暴露端口
       volumes:
         - /data/rustdesk/hbbs:/root # 自定义挂载目录
       networks:
         - rustdesk-net
       depends_on:
         - hbbr
       restart: unless-stopped
       deploy:
         resources:
           limits:
             memory: 64M
     hbbr:
       container_name: hbbr
       ports:
         - 21117:21117 # 自定义 hbbr 映射端口
       image: rustdesk/rustdesk-server
       command: hbbr -k 123456789
       #command: hbbr
       volumes:
         - /data/rustdesk/hbbr:/root # 自定义挂载目录
       networks:
         - rustdesk-net
       restart: unless-stopped
       deploy:
         resources:
           limits:
             memory: 64M
     rustdesk-api:
       container_name: rustdesk-api
       environment:
         - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
         - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
         - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
         - RUSTDESK_API_RUSTDESK_KEY=123456789
       ports:
         - 21114:21114
       image: lejianwen/rustdesk-api
       volumes:
         - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份
       networks:
         - rustdesk-net
       restart: unless-stopped
   

- If you are using an S6 image, you need to modify the startup script `/etc/s6-overlay/s6-rc.d/hbbr/run`
  and `/etc/s6-overlay/s6-rc.d/hbbr/run`

    1. create `hbbr/run`

        ```bash
        #!/command/with-contenv sh
        cd /data
        PARAMS=
        [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
        /usr/bin/hbbr $PARAMS
        ```

    2. create `hbbs/run`
        ```bash
        #!/command/with-contenv sh
        sleep 2
        cd /data
        PARAMS=
        [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
        /usr/bin/hbbs -r $RELAY $PARAMS
        ```
    3. edit `docker-compose.yml`
        ```
        networks:
          rustdesk-net:
            external: false
        services:
          rustdesk-server:
            container_name: rustdesk-server
            ports:
              - 21115:21115
              - 21116:21116
              - 21116:21116/udp
              - 21117:21117
              - 21118:21118
              - 21119:21119
            image: rustdesk/rustdesk-server-s6:latest
            environment:
              - RELAY=192.168.1.66:21117
              - ENCRYPTED_ONLY=1
              - KEY=abc123456789
            volumes:
              - ./data:/data
              - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run
              - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run
            restart: unless-stopped
          rustdesk-api:
            container_name: rustdesk-api
            ports:
              - 21114:21114
            image: lejianwen/rustdesk-api
            environment:
              - TZ=Asia/Shanghai
              - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
              - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
              - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
              - RUSTDESK_API_RUSTDESK_KEY=abc123456789
            volumes:
              - /data/rustdesk/api:/app/data #将数据库挂载
            networks:
              - rustdesk-net
            restart: unless-stopped
        ```

Running from Release

Download the release from release.

Source Installation

  1. Clone the repository:

    git clone https://github.com/lejianwen/rustdesk-api.git
cd rustdesk-api

  2. Install dependencies:

    go mod tidy
# Install Swag if you need to generate documentation; otherwise, you can skip this step
go install github.com/swaggo/swag/cmd/swag@latest

  3. Build the admin front-end (the front-end code is in rustdesk-api-web):

    cd resources
mkdir -p admin
git clone https://github.com/lejianwen/rustdesk-api-web
cd rustdesk-api-web
npm install
npm run build
cp -ar dist/* ../admin/

  4. Run:

    # Run directly
go run cmd/apimain.go
# Or generate and run the API using generate_api.go
go generate generate_api.go

  5. To compile, change to the project root directory. For Windows, run build.bat, and for Linux, run build.sh. After compiling, the corresponding executables will be generated in the release directory. Run the compiled executables directly.

  6. Open your browser and visit http://<your server[:port]>/_admin/, with default credentials admin admin. Please change the password promptly.

Miscellaneous