frps-panel/README_zh.md

frps-multiuser

README | 中文文档

frps-multiuser 是 frp 的一个服务端插件，用于支持多用户鉴权。

frps-multiuser 会以一个单独的进程运行，并接收 frps 发送过来的 HTTP 请求。

 

更新说明

• 配置文件改为ini格式，便于增加注释
• 删除-l参数，其需要的配置由frps-multiuser.ini决定
• 指定配置文件的参数由-f改为-c，和frps一致
• 配置文件中，[users]节下如无用户信息，则直接由frps的token认证
• 配置文件中，[disabled]节下用户名对应的值如果为disable，则说明该账户被禁用，无法连接到服务器
• 增加了管理界面，并且会根据浏览器主题自动切换深色或浅色模式
• 新增动态添加、删除、禁用、启用用户
• 新增对用户的端口、域名、二级域名进行限制

用户被删除或禁用后，不会马上生效，需要等一段时间 用户端口、域名、二级域名限制仅在建立新连接(NewProxy)时生效

功能

• 通过配置文件配置所有支持的用户名和 Token，只允许匹配的 frpc 客户端登录。

下载

通过 Release 页面下载对应系统版本的二进制文件到本地。

要求

需要 frp 版本 >= v0.31.0

使用示例

1. 创建 frps-multiuser.ini 文件，内容为所有支持的用户名和 token。

[common]
;插件监听地址
plugin_addr = 127.0.0.1
;插件端口
plugin_port = 7200
;插件管理页面账号,可选
admin_user  = admin
;插件管理页面密码,与账号一起进行鉴权,可选
admin_pwd   = admin

[users]
;user1的meta_token为123
user1 = 123
;user2的meta_token为abc
user2 = abc

[ports]
;user1只能使用8080,9090到9010端口,其他端口则建立连接时返回失败(不影响客户端启动)
user1=8080,9090-9010

[domains]
;user1只能使用web01.yyy.zzz域名,配置了其他域名则建立连接时返回失败(不影响客户端启动)
user1=web01.user1.com

[subdomains]
;user1只能使用web01.xxx.yyy.zzz域名,配置了其他三级域名则建立连接时返回失败(不影响客户端启动)
user1=web01

[disabled]
;user2被禁用,frpc使用此账户与frps通信时,如果未启动则无法启动,如果已启动,则会一直打印错误日志
user2 = disable

每一个用户占一行，用户名和 token 之间以 `=` 号分隔。

2. 运行 frps-multiuser，指定监听地址以及 token 存储文件路径。

   ./frps-multiuser -c ./frps-multiuser.ini

3. 在 frps 的配置文件中注册插件，并启动。

# frps.ini
[common]
bind_port = 7000

[plugin.multiuser]
addr = 127.0.0.1:7200
path = /handler
ops = Login,NewWorkConn,NewUserConn,NewProxy,Ping

4. 在 frpc 中指定用户名，在 meta 中指定 token，用户名以及 meta_token 的内容需要和之前创建的 token 文件匹配。

   user1 的配置:

# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
user = user1
meta_token = 123

[ssh]
type = tcp
local_port = 22
remote_port = 8080

user2 的配置:（由于示例文件中user2被禁用，因此无法连接）

# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
user = user2
meta_token = abc

[ssh]
type = tcp
local_port = 22
remote_port = 6000

使用

如果使用中有问题或者有其他想法，在issues上提出来。 如果我能搞定的话，我尽量搞。

致谢

• frp
• fp-multiuser
• layui