From 88aeb36053fb75360e091001dd041d2e3feac502 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=A8=E9=BB=84=E6=9E=97?= Date: Mon, 11 Sep 2023 12:41:12 +0800 Subject: [PATCH] update README --- README.md | 38 +++++++++++++++++++------------------- README_zh.md | 38 +++++++++++++++++++------------------- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 697d07c..ded3148 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,29 @@ [README](README.md) | [中文文档](README_zh.md) -frp server plugin to support multiple users for [frp](https://github.com/fatedier/frp). +frp server plugin to show server info and support multiple users for [frp](https://github.com/fatedier/frp). frps-panel will run as one single process and accept HTTP requests from frps. +![支持英文](screenshots/i18n.png) +![服务器信息](screenshots/server%20info.png) ![用户列表](screenshots/user%20list.png) ![新增列表](screenshots/new%20user.png) -![支持英文](screenshots/i18n.png) +![代理列表](screenshots/proxy%20list.png) +![代理流量统计](screenshots/proxy%20traffic%20statistics.png) ![自动深色模式](screenshots/dark%20mode.png) -## Update Notes +### Features -+ **the default tokens file is frps-panel.ini now,ini file support comment** -+ **remove `-l`,it configure in `frps-panel.ini` now** -+ **change `-f` to `-c`,the same as `frps`** -+ **if \[users\] section is empty,the authentication will only be handle by frps** -+ **if user under \[disabled\] section ,and the value is `disable`, it means that user is be disabled, and can not connect to server** -+ **add a manage ui, and change color mode base on browser** -+ **you can dynamic `add`,`remove`,`disable` or `enable` user now** -+ **you can limit `ports`,`domains` and `subdomains` for each user now** ++ **Show frp server info** ++ **Support multiple user authentication by tokens saved in file.** ++ **Dynamic `add`,`remove`,`disable` or `enable` user now** ++ **Limit `ports`,`domains` and `subdomains` for each user now** ***when a user is dynamic been `remove` or `disable`,it will take some time to be effective*** ***the limit of `ports`、`domains`、`subdomains` only effective at `NewProxy`*** -### Features - -* Support multiple user authentication by tokens saved in file. -* Support dynamic `add`,`remove`,`disable` or `enable` user -* Limit `ports`,`domains` and `subdomains` for each user - ### Download Download frps-panel binary file from [Release](../../releases). @@ -55,6 +48,13 @@ admin_user = admin ;the password of manage ui,optional admin_pwd = admin +; frp server's dashboard config info, it's required and should be the same as frp server +; otherwaise, this plugin cannot get server info +dashboard_addr = 127.0.0.1 +dashboard_port = 7500 +dashboard_user = admin +dashboard_pwd = admin + [users] ;user user1 with meta_token 123 user1 = 123 @@ -146,9 +146,9 @@ Wants = network.target [Service] Type = simple # config of frps-panel.ini,you should change the file path -Environment=FRPS_MULTIUSER_OPTS="-c /root/frps-panel/frps-panel.ini" +Environment=FRPS_PANEL_OPTS="-c /root/frps-panel/frps-panel.ini" # command of run frps-panel,you should change the file path -ExecStart = /root/frps-panel/frps-panel $FRPS_MULTIUSER_OPTS +ExecStart = /root/frps-panel/frps-panel $FRPS_PANEL_OPTS [Install] WantedBy = multi-user.target diff --git a/README_zh.md b/README_zh.md index b7053af..0fc1db1 100644 --- a/README_zh.md +++ b/README_zh.md @@ -2,36 +2,30 @@ [README](README.md) | [中文文档](README_zh.md) -frps-panel 是 [frp](https://github.com/fatedier/frp) 的一个服务端插件，用于支持多用户鉴权。 +frps-panel 是 [frp](https://github.com/fatedier/frp) 的一个服务端插件，用于查看服务器信息以及支持多用户鉴权。 frps-panel 会以一个单独的进程运行，并接收 frps 发送过来的 HTTP 请求。 +![支持英文](screenshots/i18n.png) +![服务器信息](screenshots/server%20info.png) ![用户列表](screenshots/user%20list.png) ![新增列表](screenshots/new%20user.png) -![支持英文](screenshots/i18n.png) +![代理列表](screenshots/proxy%20list.png) +![代理流量统计](screenshots/proxy%20traffic%20statistics.png) ![自动深色模式](screenshots/dark%20mode.png) -## 更新说明 -+ **配置文件改为ini格式，便于增加注释** -+ **删除-l参数，其需要的配置由`frps-panel.ini`决定** -+ **指定配置文件的参数由`-f`改为`-c`，和`frps`一致** -+ **配置文件中，\[users\]节下如无用户信息，则直接由frps的token认证** -+ **配置文件中，\[disabled\]节下用户名对应的值如果为`disable`，则说明该账户被禁用，无法连接到服务器** -+ **增加了管理界面，并且会根据浏览器主题自动切换深色或浅色模式** -+ **新增动态`添加`、`删除`、`禁用`、`启用`用户** -+ **新增对用户的`端口`、`域名`、`二级域名`进行限制** +### 功能 + ++ **支持展示服务器信息** ++ **支持多用户鉴权** ++ **动态`添加`、`删除`、`禁用`、`启用`用户** ++ **对用户的`端口`、`域名`、`二级域名`进行限制** ***用户被`删除`或`禁用`后，不会马上生效，需要等一段时间*** ***用户`端口`、`域名`、`二级域名`限制仅在建立新连接(`NewProxy`)时生效*** -### 功能 - -* 通过配置文件配置所有支持的用户名和 Token，只允许匹配的 frpc 客户端登录。 -* 动态`添加`、`删除`、`禁用`、`启用`用户 -* 对每个用户进行`端口`、`域名`、`二级域名`限制 - ### 下载 通过 [Release](../../releases) 页面下载对应系统版本的二进制文件到本地。 @@ -55,6 +49,12 @@ admin_user = admin ;插件管理页面密码,与账号一起进行鉴权,可选 admin_pwd = admin +; frp服务器的看板页面信息，必须配置，且与frp服务器一致，否则无法获取服务器信息 +dashboard_addr = 127.0.0.1 +dashboard_port = 7500 +dashboard_user = admin +dashboard_pwd = admin + [users] ;user1的meta_token为123 user1 = 123 @@ -146,9 +146,9 @@ Wants = network.target [Service] Type = simple # 启动frps-panel的配置文件路径，需修改为您的frps-panel.ini的路径 -Environment=FRPS_MULTIUSER_OPTS="-c /root/frps-panel/frps-panel.ini" +Environment=FRPS_PANEL_OPTS="-c /root/frps-panel/frps-panel.ini" # 启动frps-panel的命令，需修改为您的frps-panel的安装路径 -ExecStart = /root/frps-panel/frps-panel $FRPS_MULTIUSER_OPTS +ExecStart = /root/frps-panel/frps-panel $FRPS_PANEL_OPTS [Install] WantedBy = multi-user.target