RustDesk API 安装与配置指南

RustDesk API 安装与配置指南

rustdesk-api Custom Rustdesk Api Server, include web admin ,web client, web client v2 preview and oidc login 项目地址: https://gitcode.com/gh_mirrors/rus/rustdesk-api

1. 项目基础介绍

RustDesk API 是一个开源项目，主要使用 Go 语言实现。该项目为 RustDesk 提供了一个自托管的 API 服务器，包含了 Web Admin 管理界面和 Web 客户端。RustDesk 是一款远程桌面软件，支持个人和企业级用户，提供了包括地址簿、群组、授权登录等功能。

2. 项目使用的关键技术和框架

• Go 语言：项目的主要开发语言，用于实现 API 服务器逻辑。
• Gin Web Framework：一个高性能的 HTTP Web 框架，用于处理 HTTP 请求。
• GORM：一个流行的 Go 语言 ORM 库，用于数据库操作。
• JWT：JSON Web Token 用于用户认证。
• OIDC：开放ID连接，用于支持如 GitHub、Google 等第三方登录。
• Swag：用于生成 API 文档的工具。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统满足以下要求：

• 操作系统：支持 Linux、macOS、Windows。
• Go 语言环境：Go 版本需在 1.16 或以上。
• 数据库：支持 SQLite 或 MySQL。
• 网络：确保您的系统可以访问互联网以下载必要的依赖。

安装步骤

步骤 1：克隆项目仓库

打开终端或命令提示符，运行以下命令克隆项目仓库：

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

步骤 2：安装依赖

在项目根目录下，运行以下命令安装项目依赖：

go mod tidy

步骤 3：编译项目

根据您的操作系统，选择相应的命令编译项目：

• Windows：

  build.bat
  

• Linux 或 macOS：

  ./build.sh
  

编译完成后，可执行文件会出现在 release 目录下。

步骤 4：配置数据库

根据您的选择，配置 SQLite 或 MySQL 数据库。

• SQLite：默认情况下，项目使用 SQLite 数据库，无需额外配置。

• MySQL：如果使用 MySQL，需要在 conf/config.yaml 文件中配置相关参数，或通过环境变量设置。

步骤 5：运行项目

编译完成后，运行可执行文件启动项目：

go run cmd/apimain.go

或者直接运行编译后的可执行文件。

步骤 6：访问 Web Admin

在浏览器中输入以下地址，使用默认的用户名（admin）和密码（安装时控制台显示）登录 Web Admin：

http://<您的服务器IP地址>:<端口>/_admin/

请及时更改默认密码以保证安全。

完成以上步骤后，您的 RustDesk API 服务器应该已经成功安装并运行。您可以开始进行进一步的配置和使用了。

rustdesk-api Custom Rustdesk Api Server, include web admin ,web client, web client v2 preview and oidc login 项目地址: https://gitcode.com/gh_mirrors/rus/rustdesk-api