This project will be rewrite
See #30
Rustdesk Api Server Pro
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.
We strive to achieve functionality with the simplest possible code and structure!
Special Sponsor
CDN acceleration and security protection for his project are sponsored by Tencent EdgeOne.
Best Asian CDN, Edge, and Secure Solutions - Tencent EdgeOne
Features
- Synchronized RuskDesk version (Currently adapted client: 1.2.7)
- Pure Go implementation of all interfaces
- Visual management interface
- Internationalization support
- Statistics panel
- User Management
- 2FA & Email Verify Code
- Session Management
- Log Audit
- Lightweight & Cross Platform
- Minimal sqlite
- Support for major operating systems and architectures
Deploying with Docker(recommend)
- pull image
- create config
signKey: "sercrethatmaycontainch@r$32chars" # this is the token signing key. change this before start server
debugMode: true # debug mode
db:
driver: "sqlite"
dsn: "./server.db"
timeZone: "Asia/Shanghai" # setting the time zone fixes the database creation time problem
showSql: false
# driver: "mysql"
# dsn: "root:123@tcp(localhost:3306)/test?charset=utf8mb4"
httpConfig:
printRequestLog: true
staticdir: "/app/dist"
port: ":12345" # api server port
smtpConfig:
host: "127.0.0.1"
port: 1025
username: "test"
password: "test"
encryption: "none" # none ssl/tls starttls
from: "test@localhost.com"
jobsConfig:
deviceCheckJob:
duration: 30
EOF
- run image
--name rustdesk-api-server-pro \
-d \
-e ADMIN_USER=admin \ #Administrator account (optional)
-e ADMIN_PASS=yourpassword \ #Administrator password (optional)
-e TZ=Asia/Shanghai \ #must match the 'timeZone' setting in server.yaml
-p 8080:8080 \
-v /your/path:/app/data \
ghcr.io/lantongxue/rustdesk-api-server-pro:latest
- 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)
The container image listens on port
8080by default.
Default configuration file path
/app/data/server.yaml, you can specify your own configuration file with-v.
Docker compose
rustdesk-api-server-pro:
container_name: rustdesk-api-server-pro
image: ghcr.io/lantongxue/rustdesk-api-server-pro:latest
environment:
- "ADMIN_USER=youruser"
- "ADMIN_PASS=yourpassword"
- "TZ=Asia/Shanghai"
volumes:
- ./server.yaml:/app/data/server.yaml
network_mode: host
restart: unless-stopped
Environment variables
| Variables | Default Values | Description |
|---|---|---|
| ADMIN_USER | - | Default administrator account |
| ADMIN_PASS | - | Default administrator password |
| TZ | - | Container OS timezone; must match the app setting in YAML file |
Build from source
Required
- Golang >= 1.21.4
- NodeJs ~= latest(recommend LTS)version
- pnpm ~= latest
Build
- Get source code
- Build the api-server
- Build the frontend
Run
api-server
Assuming the compiled binary file is called rustdesk-api-server-pro.exe.
- Synchronize the database table structure
- Add your first user
--admin is optional, when enabled the added user is an administrator user, otherwise it is a regular user
- Start the server
Listening on port
8080by default
Web Management Interface
For this step you need a web server software (e.g. nginx, apache, etc.), by copying the packaged product to the web root directory.
Typically, the packaged product is in the soybean-admin/dist directory.
Reverse 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.
Here's my backend reverse proxy configuration for you to refer to:
location ^~ /api
{
proxy_pass http://127.0.0.1:8080;
proxy_set_header Host 127.0.0.1;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header REMOTE-HOST $remote_addr;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_http_version 1.1;
# proxy_hide_header Upgrade;
add_header X-Cache $upstream_cache_status;
}
#PROXY-END/
#PROXY-START /admin for web-ui
location ^~ /admin
{
proxy_pass http://127.0.0.1:8080/admin;
proxy_set_header Host 127.0.0.1;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header REMOTE-HOST $remote_addr;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_http_version 1.1;
# proxy_hide_header Upgrade;
add_header X-Cache $upstream_cache_status;
}
#PROXY-END/
CLI help
rustdesk-api-server-pro [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
rustdesk About rustdesk-server command
start Start the api-server
sync The api-server database synchronization
user User management
Flags:
-h, --help help for rustdesk-api-server-pro
Use "rustdesk-api-server-pro [command] --help" for more information about a command.
Follow-up plan
We will continue to follow up the RustDesk client and implement the corresponding interfaces, which will be a long-term plan.
Sponsorship
If you found this project helpful, why not buy the developers a cup of coffee :)
Thank you for your sponsorship
License
You can view the full license here
This project is under the terms of the MIT license.