diff --git a/README.md b/README.md
index a3ceac8..7667c94 100644
--- a/README.md
+++ b/README.md
@@ -1,207 +1,116 @@
# rustdesk-api-server
-## 请使用客户端最新版本1.2.3
+## based on https://github.com/kingmo888/rustdesk-api-server
-[The English explanation is available by clicking here.](https://github.com/kingmo888/rustdesk-api-server/blob/master/README_EN.md)
+![Main Page](images/user_devices.png)
+![Connection Log](images/connection_log.png)
+![File Transfer Log](images/file_log.png)
+![Client Downloads](images/clients.png)
-
- 一个 python 实现的 Rustdesk API 接口,支持 WebUI 管理
-
-
-
-
-
-
-
-
+## Features
-![主页面](images/front_main.png)
+- Supports self-registration and login on the front-end webpage.
+- Supports displaying device information on the front end, divided into administrator and user versions.
+- Supports custom aliases (remarks).
+- Supports backend management.
+- Supports colored tags.
+- Supports device online statistics.
+- Supports saving device passwords.
+- Automatically manages tokens and keeps them alive using the heartbeat interface.
+- Supports sharing devices with other users.
+- Supports web control terminal (currently only supports non-SSL mode, see below for usage issues)
-## 功能特点
-
-- 支持前台网页自主注册和登录。
- - 注册页与登录页:
- ![Front Registration](images/front_reg.png)
- ![Front Login](images/front_login.png)
-
-- 支持前台展示设备信息,分为管理员版、用户版。
-- 支持自定义别名(备注)。
-- 支持后台管理。
-- 支持彩色标签。
-![Rust Books](images/rust_books.png)
-
-- 支持设备在线统计。
-- 支持设备密码保存。
-- 利用心跳接口自动管理token并保活。
-- 支持分享设备给其他用户。
-![Rust Share](images/share.png)
-- 支持web控制端(目前仅支持非SSL模式,见下面使用问题说明)
-![Rust Share](images/webui.png)
-
-后台主页:
-![Admin Main](images/admin_main.png)
-
-## 安装
-
-### 方法1:开箱即用
-
-仅支持Windows,请前往 release 下载,无需安装环境,直接运行`启动.bat`即可。 截图:
-
-![window直接运行版](/images/windows_run.png)
-
-
-### 方法2:代码运行
+## Installation
```bash
-# 将代码克隆到本地
-git clone https://github.com/kingmo888/rustdesk-api-server.git
-# 进入目录
+# Clone the code locally
+git clone https://github.com/bryangerlach/rustdesk-api-server.git
+# Enter the directory
cd rustdesk-api-server
-# 安装依赖
+# Install dependencies
pip install -r requirements.txt
-# 确保依赖安装正确后,执行:
-# 端口号请自行修改,建议保留21114为Rustdesk API默认端口
+python manage.py migrate
+# After ensuring dependencies are installed correctly, execute:
+# Please modify the port number yourself, it is recommended to keep 21114 as the default port for Rustdesk API
python manage.py runserver 0.0.0.0:21114
```
-此时即可使用 `http://本机IP:端口` 的形式来访问。
-
-**注意**:如果 CentOS 配置时,Django4 会因为系统的 sqlite3 版本过低而出问题,请修改依赖库中的文件。路径:`xxxx/Lib/site-packages/django/db/backends/sqlite3/base.py` (根据情况自行查找包所在地址),修改内容:
-```python
-# from sqlite3 import dbapi2 as Database #(注释掉这行)
-from pysqlite3 import dbapi2 as Database # 启用pysqlite3
-```
-
-### 方法3:Docker 运行
+## Updating
-#### Docker方法1:自行构建
```bash
-git clone https://github.com/kingmo888/rustdesk-api-server.git
-cd rustdesk-api-server
-docker compose --compatibility up --build -d
+#this assumes you have cloned the repo into /opt/rustdesk/rustdesk-api-server and have a service named rustdeskapi set up
+systemctl stop rustdeskapi
+cd /opt/rustdesk/rustdesk-api-server
+git pull
+pip install -r requirements.txt
+python manage.py migrate
+systemctl start rustdeskapi
```
-感谢热心网友 @ferocknew 提供。
-#### Docker方法2:预构建运行
+**Client Downlaods**: You will need to generate your own client downloads with your server and key hard coded into the program. The easiest way to do this is using github actions https://rustdesk.com/docs/en/dev/build/all/
-docker run 命令:
+Now you can access it using `http://localhostIP:Port`.
-```bash
-docker run -d \
- --name rustdesk-api-server \
- -p 21114:21114 \
- -e CSRF_TRUSTED_ORIGINS=http://yourdomain.com:21114 \ #防跨域信任来源,可选
- -e ID_SERVER=yourdomain.com \ #Web控制端使用的ID服务器
- -v /yourpath/db:/rustdesk-api-server/db \ #修改/yourpath/db为你宿主机数据库挂载目录
- -v /etc/timezone:/etc/timezone:ro \
- -v /etc/localtime:/etc/localtime:ro \
- --network bridge \
- --restart unless-stopped \
- ghcr.io/kingmo888/rustdesk-api-server:latest
-```
-
-docker-compose 方式:
-
-```yaml
-version: "3.8"
-services:
- rustdesk-api-server:
- container_name: rustdesk-api-server
- image: ghcr.io/kingmo888/rustdesk-api-server:latest
- environment:
- - CSRF_TRUSTED_ORIGINS=http://yourdomain.com:21114 #防跨域信任来源,可选
- - ID_SERVER=yourdomain.com #Web控制端使用的ID服务器
- volumes:
- - /yourpath/db:/rustdesk-api-server/db #修改/yourpath/db为你宿主机数据库挂载目录
- - /etc/timezone:/etc/timezone:ro
- - /etc/localtime:/etc/localtime:ro
- network_mode: bridge
- ports:
- - "21114:21114"
- restart: unless-stopped
+**Note**: When configuring on CentOS, Django4 may have problems due to the low version of sqlite3 in the system. Please modify the file in the dependency library. Path: `xxxx/Lib/site-packages/django/db/backends/sqlite3/base.py` (Find the package address according to the situation), modify the content:
+```python
+# from sqlite3 import dbapi2 as Database #(comment out this line)
+from pysqlite3 import dbapi2 as Database # enable pysqlite3
```
-## 环境变量
+## Environment Variables
-| 变量名 | 参考值 | 备注 |
+| Variable Name | Reference Value | Note |
| ---- | ------- | ----------- |
-| `HOST` | 默认 `0.0.0.0` | 绑定服务的IP |
-| `TZ` | 默认 `Asia/Shanghai`,可选 | 时区 |
-| `SECRET_KEY` | 可选,自定义一串随机字符 | 程序加密秘钥 |
-| `CSRF_TRUSTED_ORIGINS` | 可选,默认关闭验证;
如需开启填写你的访问地址 `http://yourdomain.com:21114`
**如需关闭验证请删除此变量,而不是留空** | 防跨域信任来源 |
-| `ID_SERVER` | 可选,默认为和API服务器同主机。
可自定义如 `yourdomain.com` | Web控制端使用的ID服务器 |
-| `DEBUG` | 可选,默认 `False` | 调试模式 |
-| `ALLOW_REGISTRATION` | 可选,默认 `True` | 是否允许新用户注册 |
-| 数据库配置 | -- 开始 -- | 若不使用MYSQL则以下皆无需配置 |
-| `DATABASE_TYPE` | 可选,默认 `SQLITE3` | 数据库类型(SQLITE/MYSQL) |
-| `MYSQL_DBNAME` | 可选,默认 `-` | MYSQL数据库名 |
-| `MYSQL_HOST` | 可选,默认 `127.0.0.1` | MYSQL数据库的服务器IP |
-| `MYSQL_USER` | 可选,默认 `-` | MYSQL数据库的用户名 |
-| `MYSQL_PASSWORD` | 可选,默认 `-` | MYSQL数据库的密码 |
-| `MYSQL_PORT` | 可选,默认 `3306` | MYSQL数据库端口 |
-| 数据库配置 | -- 结束 -- | 查看【[sqlite3迁移mysql教程](/tutorial/sqlite2mysql.md)】 |
-| `LANGUAGE_CODE` | 可选,默认 `zh-hans` | 语言,支持中文(`zh-hans`)、英语(`en`) |
-
-## 使用问题
-
-- 管理员设置
-
- 当数据库中不存在账户时,第一个注册的账户直接获取超级管理员权限,之后注册账户为普通账户。
-
-- 设备信息
+| `HOST` | Default `0.0.0.0` | IP binding of the service |
+| `TZ` | Default `Asia/Shanghai`, optional | Timezone |
+| `SECRET_KEY` | Optional, custom a random string | Program encryption key |
+| `CSRF_TRUSTED_ORIGINS` | Optional, verification off by default;
If you need to enable it, fill in your access address `http://yourdomain.com:21114`
**To disable verification, please delete this variable instead of leaving it blank** | Cross-origin trusted source |
+| `ID_SERVER` | Optional, default is the same host as the API server.
Customizable like `yourdomain.com` | ID server used by the web control terminal |
+| `DEBUG` | Optional, default `False` | Debug mode |
+| `ALLOW_REGISTRATION` | Optional, default `True` | Whether to allow new user registration |
+| Database Configuration | -- Start -- | If not using MYSQL, the following are unnecessary |
+| `DATABASE_TYPE` | Optional, default `SQLITE3` | Database type (SQLITE/MYSQL) |
+| `MYSQL_DBNAME` | Optional, default `-` | MYSQL database name |
+| `MYSQL_HOST` | Optional, default `127.0.0.1` | MYSQL database server IP |
+| `MYSQL_USER` | Optional, default `-` | MYSQL database username |
+| `MYSQL_PASSWORD` | Optional, default `-` | MYSQL database password |
+| `MYSQL_PORT` | Optional, default `3306` | MYSQL database port |
+| Database Configuration | -- End -- | See [sqlite3 migration to mysql tutorial](/tutorial/sqlite2mysql.md) |
- 经测试,客户端会在非绿色版模式下,安装为服务的模式中,定时发送设备信息到api接口,所以如果想要设备信息,需要安装rustdesk客户端并启动服务。
+## Usage Issues
-- 连接速度慢
+- Administrator Settings
- 新版本Key模式链接速度慢,可以在服务端启动服务时,不要带参数的-k,此时,客户端也不能配置key。
+ When there are no accounts in the database, the first registered account directly obtains super administrator privileges,
-- Web控制端配置
+ and subsequently registered accounts are ordinary accounts.
- - 设置ID_SERVER环境变量,或修改rustdesk_server_api/settings.py文件中ID_SERVER配置项,将ID服务器/中继服务器IP或域名填上。
+- Device Information
-- Web控制端一直转圈
+ Tested, the client will send device information to the API interface regularly in the mode of installation as a service under non-green mode, so if you want device information, you need to install the Rustdesk client and start the service.
- - 检查ID服务器填写是否正确
+- Slow Connection Speed
- - Web控制端目前仅支持非SSL模式,若webui为https访问,请将s去掉,否则ws连不上一直转圈。如:https://domain.com/webui,改为http://domain.com/webui
+ The new version Key mode connection speed is slow. You can start the service on the server without the -k parameter. At this time, the client cannot configure the key either.
-- 后台操作登录或登出时:CSRF验证失败. 请求被中断.
+- Web Control Terminal Configuration
- 这种操作大概率是docker配置+nginx反代+SSL的组合,要注意修改CSRF_TRUSTED_ORIGINS,如果是ssl那就是https开头,否则就是http。
+ - Set the ID_SERVER environment variable or modify the ID_SERVER configuration item in the rustdesk_server_api/settings.py file and fill in the IP or domain name of the ID server/relay server.
-## 开发计划
+- Web Control Terminal Keeps Spinning
-- [x] 分享设备给其他已注册用户(v1.3+)
+ - Check if the ID server filling is correct.
- > 说明:类似网盘url分享,url激活后可以获得某个或某组或某个标签下的设备
- > 备注:其实web api作为中间件,可做的不多,更多功能还是需要修改客户端来实现,就不太值当了。
+ - The web control terminal currently only supports non-SSL mode. If the webui is accessed via https, remove the 's', otherwise ws cannot connect and keeps spinning. For example: https://domain.com/webui, change to http://domain.com/webui
-- [x] 集成Web客户端形式(v1.4+)
+- CSRF verification failed when logging in or logging out of backend operations. Request interrupted.
- > 将大神的web客户端集成进来,已集成。 [来源](https://www.52pojie.cn/thread-1708319-1-1.html)
-
-- [x] 对过期(不在线)设备的过滤,用以区分在线&离线设备(1.4.7)
+ This operation is highly likely to be a combination of docker configuration + nginx reverse proxy + SSL. Pay attention to modifying CSRF_TRUSTED_ORIGINS. If it is SSL, it starts with https, otherwise it is http.
- > 通过配置方式,对过期超过指定时间的设备清理或过滤。
+## Other Related Tools
-- [x] 首屏拆分为用户列表页与管理员列表页并增加分页(1.4.6)。
-
-- [x] 支持信息导出到为xlsx文件(1.4.6)。
-
- > 支持管理员在【所有设备】页面导出所有设备信息。
-
-- [x] 通过配置项设定是否允许新用户注册(1.4.7)。
-
-- [x] 支持mysql及sqlite3迁移mysql(1.4.8)。
-
-## 其他相关工具
-
-- [可以修改客户端ID的CMD脚本](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
+- [CMD script for modifying client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
- [rustdesk](https://github.com/rustdesk/rustdesk)
- [rustdesk-server](https://github.com/rustdesk/rustdesk-server)
-
-## Stargazers over time
-[![Stargazers over time](https://starchart.cc/kingmo888/rustdesk-api-server.svg?variant=adaptive)](https://starchart.cc/kingmo888/rustdesk-api-server)
diff --git a/images/clients.png b/images/clients.png
new file mode 100644
index 0000000..68caa64
Binary files /dev/null and b/images/clients.png differ
diff --git a/images/connection_log.png b/images/connection_log.png
new file mode 100644
index 0000000..46c6847
Binary files /dev/null and b/images/connection_log.png differ
diff --git a/images/file_log.png b/images/file_log.png
new file mode 100644
index 0000000..6ceafa8
Binary files /dev/null and b/images/file_log.png differ
diff --git a/images/user_devices.png b/images/user_devices.png
new file mode 100644
index 0000000..b7d2e81
Binary files /dev/null and b/images/user_devices.png differ