Skip to content

Commit

Permalink
update doc for v0.37.0
Browse files Browse the repository at this point in the history
  • Loading branch information
fatedier committed Jun 2, 2021
1 parent 069074b commit 6ad9db9
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
8 changes: 8 additions & 0 deletions content/zh/blog/releases/v0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: "v0"
---

#### v0.37.0

* [new] frpc 增加 verify 命令,检测配置文件是否有明显的错误, `frpc verify -c ./frpc.ini`
* [new] frpc 配置文件支持 includes 语法,支持拆分 proxy 配置到多个文件或目录。
* [new] Dashboard 支持 sudp 类型代理。
* [fix] Dashboard 用户名密码默认为空。
* [fix] 修复 `protocol = kcp``login_fail_exit` 无效的问题。

#### v0.36.2

* [improve] Dashboard 支持在增加 URL Path 前缀的反向代理后被正常访问。
Expand Down
35 changes: 35 additions & 0 deletions content/zh/docs/Features/common/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,41 @@ export FRP_SSH_REMOTE_PORT="6000"

frpc 会自动使用环境变量渲染配置文件模版,所有环境变量需要以 `.Envs` 为前缀。

### 配置校验

通过执行 `frpc verify -c ./frpc.ini``frps verify -c ./frps.ini` 可以对配置文件中的参数进行预先校验。

```
frpc: the configuration file ./frpc.ini syntax is ok
```

如果出现此结果,则说明新的配置文件没有错误,否则会输出具体的错误信息。

### 配置拆分

通过 `includes` 参数可以在主配置中包含其他配置文件,从而实现将代理配置拆分到多个文件中管理。

```ini
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
includes = ./confd/*.ini
```

```ini
# ./confd/test.ini
[ssh]
type = tcp
local_ip = 127.0.0.1
local_port = 22
remote_port = 6000
```

上述配置在 frpc.ini 中通过 includes 额外包含了 `./confd` 目录下所有的 ini 文件的代理配置内容,效果等价于将这两个文件合并成一个文件。

需要注意的是 includes 指定的文件中只能包含代理配置,common 段落的配置只能放在主配置文件中。

### 完整配置参数

由于 frp 目前支持的功能和配置项较多,未在文档中列出的功能参数可以在 [参考](/docs/reference) 中查看。

1 comment on commit 6ad9db9

@liyi830
Copy link

@liyi830 liyi830 commented on 6ad9db9 Jul 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OIDC 认证方式 配置说明能再详细点吗?最好有数据的例子可以参考。

Please sign in to comment.