Skip to content

Commit 50ae46b

Browse files
committed
Add documentation for Auth passthrough
1 parent 59a2928 commit 50ae46b

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

CONFIG.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,41 @@ Connecting to that database allows running commands like `SHOW POOLS`, `SHOW DAT
167167
### admin_password
168168
```
169169
path: general.admin_password
170-
default: "admin_pass"
170+
default: <UNSET>
171171
```
172172

173173
Password to access the virtual administrative database
174174

175+
### auth_query (experimental)
176+
```
177+
path: general.auth_query
178+
default: <UNSET>
179+
```
180+
181+
Query to be sent to servers to obtain the hash used for md5 authentication. The connection will be
182+
established using the database configured in the pool. This parameter is inherited by every pool
183+
and can be redefined in pool configuration.
184+
185+
### auth_query_user (experimental)
186+
```
187+
path: general.auth_query_user
188+
default: <UNSET>
189+
```
190+
191+
User to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
192+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
193+
This parameter is inherited by every pool and can be redefined in pool configuration.
194+
195+
### auth_query_password (experimental)
196+
```
197+
path: general.auth_query_password
198+
default: <UNSET>
199+
```
200+
201+
Password to be used for connecting to servers to obtain the hash used for md5 authentication by sending the query
202+
specified in `auth_query_user`. The connection will be established using the database configured in the pool.
203+
This parameter is inherited by every pool and can be redefined in pool configuration.
204+
175205
## `pools.<pool_name>` Section
176206

177207
### pool_mode
@@ -273,6 +303,30 @@ default: 3000
273303

274304
Connect timeout can be overwritten in the pool
275305

306+
### auth_query (experimental)
307+
```
308+
path: general.auth_query
309+
default: <UNSET>
310+
```
311+
312+
Auth query can be overwritten in the pool
313+
314+
### auth_query_user (experimental)
315+
```
316+
path: general.auth_query_user
317+
default: <UNSET>
318+
```
319+
320+
Auth query user can be overwritten in the pool
321+
322+
### auth_query_password (experimental)
323+
```
324+
path: general.auth_query_password
325+
default: <UNSET>
326+
```
327+
328+
Auth query password can be overwritten in the pool
329+
276330
## `pools.<pool_name>.users.<user_index>` Section
277331

278332
### username

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ PostgreSQL pooler (like PgBouncer) with sharding, load balancing and failover su
2222
| Statistics | :white_check_mark: | Statistics available in the admin database (`pgcat` and `pgbouncer`) with `SHOW STATS`, `SHOW POOLS` and others. |
2323
| Live configuration reloading | :white_check_mark: | Reload supported settings with a `SIGHUP` to the process, e.g. `kill -s SIGHUP $(pgrep pgcat)` or `RELOAD` query issued to the admin database. |
2424
| Client authentication | :white_check_mark: :wrench: | MD5 password authentication is supported, SCRAM is on the roadmap; one user is used to connect to Postgres with both SCRAM and MD5 supported. |
25+
| Auth passthrough | :white_check_mark: :wrench: | MD5 password authentication can be configured to use an `auth_query` so no cleartext passwords are needed in the config file. |
2526
| Admin database | :white_check_mark: | The admin database, similar to PgBouncer's, allows to query for statistics and reload the configuration. |
2627

2728
## Deployment

0 commit comments

Comments
 (0)