RustDesk API 服务器项目教程

RustDesk API 服务器项目教程

项目地址:https://gitcode.com/gh_mirrors/rust/rustdesk-api-server

1. 项目的目录结构及介绍

rustdesk-api-server/
├── config.py
├── mysql_async.py
├── mytools.py
├── requirements.txt
├── server_v1.py
├── server_v2.py
├── README.md
└── LICENSE

目录结构说明

• config.py: 配置文件，包含数据库连接参数和其他运行时配置。
• mysql_async.py: MySQL 数据库连接库，用于异步数据库操作。
• mytools.py: 工具库，包含一些常用的工具函数。
• requirements.txt: Python 依赖库文件，列出了项目所需的 Python 库。
• server_v1.py: 1.1.9 版本的 API 接口实现。
• server_v2.py: 1.2.0 版本的 API 接口实现。
• README.md: 项目说明文档。
• LICENSE: 项目许可证文件，采用 AGPL-3.0 许可证。

2. 项目的启动文件介绍

server_v1.py

这是 1.1.9 版本的 API 接口实现文件。启动该文件可以运行 1.1.9 版本的 API 服务器。

python server_v1.py

server_v2.py

这是 1.2.0 版本的 API 接口实现文件。启动该文件可以运行 1.2.0 版本的 API 服务器。

python server_v2.py

3. 项目的配置文件介绍

config.py

配置文件 config.py 包含了项目的运行时配置参数，主要包括数据库连接参数和运行时配置。

# 数据模式 mysql|sqlite
db_model = "mysql"

# MySQL 配置
MYSQL_HOST = "127.0.0.1"
MYSQL_PORT = 3306
MYSQL_USER = "root"
MYSQL_PASSWORD = "password"

# SQLite 配置
# 期待 PR

# 允许跨域的域名
CORS_ORIGINS = "http://127.0.0.1:8080 http://127.0.0.1"

# 新建用户和重置密码时候的授权码
AUTH_KEY = "123456"

# 运行配置
IP = "0.0.0.0"
PORT = 21114
DEBUG = False

配置参数说明

• db_model: 数据库模式，支持 mysql 和 sqlite。
• MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_PASSWORD: MySQL 数据库连接参数。
• CORS_ORIGINS: 允许跨域的域名列表。
• AUTH_KEY: 新建用户和重置密码时的授权码。
• IP, PORT: 服务器监听的 IP 地址和端口。
• DEBUG: 是否开启调试模式。

通过修改 config.py 文件中的参数，可以自定义项目的运行环境和数据库连接配置。

rustdesk-api-server rustdesk api 服务器后端 支持1.1.9 和 1.2.0 版本 rustdesk-api-server self host version. support 1.1.9 and 1.2.0 项目地址: https://gitcode.com/gh_mirrors/rust/rustdesk-api-server