Skip to content

Commit

Permalink
fix: use "" to represent empty string (#18562)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt authored Aug 13, 2024
1 parent b23af50 commit 1cef35f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions tiproxy/tiproxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ Configuration for SQL port.

#### `proxy-protocol`

+ Default value: ``
+ Default value: `""`
+ Support hot-reload: yes, but only for new connections
+ Possible values: ``, `v2`
+ Enable the [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) on the port. By enabling the PROXY protocol, TiProxy can pass the real client IP address to TiDB. `v2` indicates using the PROXY protocol version 2, and `` indicates disabling the PROXY protocol. If the PROXY protocol is enabled on TiProxy, you need to also enable the [PROXY protocol](/tidb-configuration-file.md#proxy-protocol) on the TiDB server.
+ Possible values: `""`, `"v2"`
+ Enable the [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) on the port. By enabling the PROXY protocol, TiProxy can pass the real client IP address to TiDB. `"v2"` indicates using the PROXY protocol version 2, and `""` indicates disabling the PROXY protocol. If the PROXY protocol is enabled on TiProxy, you need to also enable the [PROXY protocol](/tidb-configuration-file.md#proxy-protocol) on the TiDB server.

### api

Expand All @@ -102,10 +102,10 @@ Configurations for HTTP gateway.

#### `proxy-protocol`

+ Default value: ``
+ Default value: `""`
+ Support hot-reload: no
+ Possible values: ``, `v2`
+ Enable the [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) on the port. `v2` indicates using the PROXY protocol version 2, and `` indicates disabling the PROXY protocol.
+ Possible values: `""`, `"v2"`
+ Enable the [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) on the port. `"v2"` indicates using the PROXY protocol version 2, and `""` indicates disabling the PROXY protocol.

### balance

Expand Down Expand Up @@ -146,7 +146,7 @@ Configurations for the load balancing policy of TiProxy.

#### `filename`

+ Default value: ``
+ Default value: `""`
+ Support hot-reload: yes
+ Log file path. Non empty value will enable logging to file. When TiProxy is deployed with TiUP, the filename is set automatically.

Expand Down

0 comments on commit 1cef35f

Please sign in to comment.