{"id":45380675,"url":"https://github.com/lantongxue/rustdesk-api-server-pro","last_synced_at":"2026-02-21T16:44:48.521Z","repository":{"id":244980503,"uuid":"816368686","full_name":"lantongxue/rustdesk-api-server-pro","owner":"lantongxue","description":"🚀This is an open source Api server based on the open source RustDesk client, the implementation of the client all Api interfaces, and provides a Web-UI for the management of data.","archived":false,"fork":false,"pushed_at":"2025-12-03T07:44:37.000Z","size":6904,"stargazers_count":222,"open_issues_count":4,"forks_count":48,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-12-05T00:57:43.377Z","etag":null,"topics":["rustdesk","rustdesk-api-server"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lantongxue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-17T15:48:39.000Z","updated_at":"2025-12-03T07:44:40.000Z","dependencies_parsed_at":"2024-11-18T04:31:24.627Z","dependency_job_id":"0e9d850a-593c-4709-8871-f7232e6edd24","html_url":"https://github.com/lantongxue/rustdesk-api-server-pro","commit_stats":null,"previous_names":["lantongxue/rustdesk-api-server-pro"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lantongxue/rustdesk-api-server-pro","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lantongxue%2Frustdesk-api-server-pro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lantongxue%2Frustdesk-api-server-pro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lantongxue%2Frustdesk-api-server-pro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lantongxue%2Frustdesk-api-server-pro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lantongxue","download_url":"https://codeload.github.com/lantongxue/rustdesk-api-server-pro/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lantongxue%2Frustdesk-api-server-pro/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29686832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T15:51:39.154Z","status":"ssl_error","status_checked_at":"2026-02-21T15:49:03.425Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rustdesk","rustdesk-api-server"],"created_at":"2026-02-21T16:44:48.095Z","updated_at":"2026-02-21T16:44:48.509Z","avatar_url":"https://github.com/lantongxue.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## This project will be rewrite\nSee https://github.com/lantongxue/rustdesk-api-server-pro/issues/30\n\nRustdesk Api Server Pro\n============\n\n[English](https://github.com/rustdesk/rustdesk) | [简体中文](https://github.com/lantongxue/rustdesk-api-server-pro/blob/master/README_CN.md)\n\nThis is an open source Api server based on the open source [RustDesk](https://github.com/rustdesk/rustdesk) client, the implementation of the client all Api interfaces, and provides a Web-UI for the management of data.\n\n![Dashboard](./img/1.jpeg \"Dashboard\")\n\n\u003e We strive to achieve functionality with the simplest possible code and structure!\n\n## Special Sponsor\n\nCDN acceleration and security protection for his project are sponsored by Tencent EdgeOne.\n\n\u003ca href=\"https://edgeone.ai/?from=github\" target=\"_blank\"\u003eBest Asian CDN, Edge, and Secure Solutions - Tencent EdgeOne\u003c/a\u003e\n\n\u003ca href=\"https://edgeone.ai/?from=github\" target=\"_blank\"\u003e![edgeone](https://edgeone.ai/media/34fe3a45-492d-4ea4-ae5d-ea1087ca7b4b.png)\u003c/a\u003e\n\n## Features\n\n- Synchronized RuskDesk version (Currently adapted client: 1.2.7)\n- Pure Go implementation of all interfaces\n- Visual management interface\n  - Internationalization support\n  - Statistics panel\n  - User Management\n  - 2FA \u0026 Email Verify Code\n  - Session Management\n  - Log Audit\n- Lightweight \u0026 Cross Platform\n  - Minimal sqlite\n  - Support for major operating systems and architectures\n\n## Deploying with Docker(recommend)\n\n1. pull image\n ```shell\n docker pull ghcr.io/lantongxue/rustdesk-api-server-pro:latest\n ```\n\n2. create config\n```shell\ncat \u003e /your/path/server.yaml \u003c\u003cEOF\nsignKey: \"sercrethatmaycontainch@r$32chars\" # this is the token signing key. change this before start server\ndebugMode: true # debug mode\ndb:\n  driver: \"sqlite\"\n  dsn: \"./server.db\"\n  timeZone: \"Asia/Shanghai\" # setting the time zone fixes the database creation time problem\n  showSql: false\n  # driver: \"mysql\"\n  # dsn: \"root:123@tcp(localhost:3306)/test?charset=utf8mb4\"\nhttpConfig:\n  printRequestLog: true\n  staticdir: \"/app/dist\"\n  port: \":12345\" # api server port\n\nsmtpConfig:\n  host: \"127.0.0.1\"\n  port: 1025\n  username: \"test\"\n  password: \"test\"\n  encryption: \"none\" # none ssl/tls starttls\n  from: \"test@localhost.com\"\n\njobsConfig:\n  deviceCheckJob:\n  duration: 30\nEOF\n\n```\n\n3. run image\n```shell\ndocker run \\\n  --name rustdesk-api-server-pro \\\n  -d \\\n  -e ADMIN_USER=admin \\ #Administrator account (optional)\n  -e ADMIN_PASS=yourpassword \\ #Administrator password (optional)\n  -e TZ=Asia/Shanghai \\ #must match the 'timeZone' setting in server.yaml\n  -p 8080:8080 \\\n  -v /your/path:/app/data \\\n  ghcr.io/lantongxue/rustdesk-api-server-pro:latest\n```\n\n4. add your admin account(This step can be ignored if an environment variable is set to initialize the administrator account password, but I still recommend that you create the administrator account this way instead of initializing it with an environment variable)\n   \n```shell\ndocker exec rustdesk-api-server-pro rustdesk-api-server-pro user add admin yourpassword --admin\n```\n\n\u003e The container image listens on port `8080` by default.\n\n\u003e Default configuration file path `/app/data/server.yaml`, you can specify your own configuration file with `-v`.\n\n### Docker compose\n\n```yaml\nservices:\n  rustdesk-api-server-pro:\n    container_name: rustdesk-api-server-pro\n    image: ghcr.io/lantongxue/rustdesk-api-server-pro:latest\n    environment:\n      - \"ADMIN_USER=youruser\"\n      - \"ADMIN_PASS=yourpassword\"\n      - \"TZ=Asia/Shanghai\"\n    volumes:\n      - ./server.yaml:/app/data/server.yaml\n    network_mode: host\n    restart: unless-stopped\n```\n\n### Environment variables\n\n| Variables  | Default Values | Description                                                    |\n|:----------:|:--------------:|:--------------------------------------------------------------:|\n| ADMIN_USER | -              | Default administrator account                                  |\n| ADMIN_PASS | -              | Default administrator password                                 |\n| TZ         | -              | Container OS timezone; must match the app setting in YAML file |\n\n## Build from source\n\n### Required\n\n- Golang \u003e= 1.21.4\n- NodeJs ~= latest(recommend LTS)version\n- pnpm ~= latest\n\n### Build\n\n1. Get source code\n\n```shell\ngit clone https://github.com/lantongxue/rustdesk-api-server-pro.git\n```\n\n2. Build the api-server\n\n```shell\ncd backend \u0026\u0026 go build\n```\n\n3. Build the frontend\n   \n```shell\ncd soybean-admin \u0026\u0026 pnpm i \u0026\u0026 pnpm build\n```\n\n### Run\n\n#### api-server\n\nAssuming the compiled binary file is called `rustdesk-api-server-pro.exe`.\n\n1. Synchronize the database table structure\n   \n```shell\nrustdesk-api-server-pro.exe sync\n```\n\n2. Add your first user\n   \n```shell\nrustdesk-api-server-pro.exe user add admin yourpassword --admin\n```\n\n\u003e --admin is optional, when enabled the added user is an administrator user, otherwise it is a regular user\n\n3. Start the server\n   \n```shell\nrustdesk-api-server-pro.exe start\n```\n\n\u003e Listening on port `8080` by default\n\n#### Web Management Interface\n\nFor this step you need a web server software (e.g. nginx, apache, etc.), by copying the packaged product to the web root directory.\n\nTypically, the packaged product is in the `soybean-admin/dist` directory.\n\nReverse Proxy Configuration, you need to configure reverse proxy in `nginx` or other WEB servers, through the reverse proxy server can access the interface address correctly.\n\nHere's my backend reverse proxy configuration for you to refer to:\n\n```nginx\n#PROXY-START /api for rustdesk client\nlocation ^~ /api\n{\n    proxy_pass http://127.0.0.1:8080;\n    proxy_set_header Host 127.0.0.1;\n    proxy_set_header X-Real-IP $remote_addr;\n    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n    proxy_set_header REMOTE-HOST $remote_addr;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection $connection_upgrade;\n    proxy_http_version 1.1;\n    # proxy_hide_header Upgrade;\n\n    add_header X-Cache $upstream_cache_status;\n}\n#PROXY-END/\n\n#PROXY-START /admin for web-ui\nlocation ^~ /admin\n{\n    proxy_pass http://127.0.0.1:8080/admin;\n    proxy_set_header Host 127.0.0.1;\n    proxy_set_header X-Real-IP $remote_addr;\n    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n    proxy_set_header REMOTE-HOST $remote_addr;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection $connection_upgrade;\n    proxy_http_version 1.1;\n    # proxy_hide_header Upgrade;\n\n    add_header X-Cache $upstream_cache_status;\n}\n#PROXY-END/\n```\n\n## CLI help\n\n```shell\nUsage:\n  rustdesk-api-server-pro [command]\n\nAvailable Commands:\n  completion  Generate the autocompletion script for the specified shell\n  help        Help about any command\n  rustdesk    About rustdesk-server command\n  start       Start the api-server\n  sync        The api-server database synchronization\n  user        User management\n\nFlags:\n  -h, --help   help for rustdesk-api-server-pro\n\nUse \"rustdesk-api-server-pro [command] --help\" for more information about a command.\n```\n\n## Follow-up plan\n\nWe will continue to follow up the RustDesk client and implement the corresponding interfaces, which will be a long-term plan.\n\n## Sponsorship\n\nIf you found this project helpful, why not buy the developers a cup of coffee :)\n\n![Sponsorship](./soybean-admin/src/assets/imgs/sponsorships.png \"Sponsorship\")\n\n**Thank you for your sponsorship**\n\n## License\n\n\u003e You can view the full license [here](https://github.com/lantongxue/rustdesk-api-server-pro/blob/master/LICENSE)\n\nThis project is under the terms of the **MIT** license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flantongxue%2Frustdesk-api-server-pro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flantongxue%2Frustdesk-api-server-pro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flantongxue%2Frustdesk-api-server-pro/lists"}