Skip to content

Commit 811c614

Browse files
authored
tiproxy: info about API access restrictions (pingcap#21865) (pingcap#21918)
1 parent f39b384 commit 811c614

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

tiproxy/tiproxy-api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,9 @@ The output is as follows:
126126
```bash
127127
curl http://127.0.0.1:3080/metrics/
128128
```
129+
130+
## Access control
131+
132+
You can restrict access to the TiProxy API by enabling TLS through [`server-http-tls`](/tiproxy/tiproxy-configuration.md#server-http-tls) and configuring the `cert-allowed-cn` option in the `server-http-tls` subsection under the [security](/tiproxy/tiproxy-configuration.md#security) section. TiProxy then uses the common name (CN) in the client certificate to [verify component caller's identity](/enable-tls-between-components.md#verify-component-callers-identity).
133+
134+
If TLS is not enabled, you can control access using firewall rules instead.

0 commit comments

Comments
 (0)