warp-tech/warpgate
1
1
Fork 0
mirror of https://github.com/warp-tech/warpgate.git synced 2025-09-08 15:44:25 +08:00
Code Issues Projects Releases Packages Wiki Activity

Updated Adding a PostgreSQL target (markdown)

Eugene 2025-03-06 09:41:28 +01:00
parent 9c1e2ae254
commit be112ad389
1 changed files with 2 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
Adding-a-PostgreSQL-target.md

@ -1,62 +1,2 @@
> This feature is available in v0.11+
This page explains the process of adding a new PostgreSQL target host to Warpgate and allowing users to connect to it.
# Authentication setup
Currently, Warpgate can connect to PostgreSQL servers with a username/password using `md5` and `password` (plaintext) auth mode.
As a PostgreSQL protocol server, Warpgate only allows secure (TLS) connections and uses `password` auth mode.
# Enabling PostgreSQL listener
Enable the PostgreSQL protocol in your config file (default: `/etc/warpgate.yaml`) if you didn't do so during the initial setup:
```diff
+ postgres:
+ enable: true
+ certificate: /var/lib/warpgate/tls.certificate.pem
+ key: /var/lib/warpgate/tls.key.pem
```
You can reuse the same certificate and key that are used for the HTTP listener.
# Connection setup
[Log into the Warpgate admin UI](https://github.com/warp-tech/warpgate/wiki/Accessing-the-admin-UI) and navigate to `Config` > `Targets` > `Add target` and give the new PostgreSQL target a name:
<img width="886" alt="Screenshot 2024-10-08 at 20 48 09" src="https://github.com/user-attachments/assets/acc4c851-c00d-4c4c-baa4-ab4bb4b2b4fb">
Fill out the configuration:
<img width="768" alt="Screenshot 2024-10-08 at 20 48 54" src="https://github.com/user-attachments/assets/eefd3ab4-ff54-4f3e-992c-5ba33332c4f5">
The target should show up on the Warpgate's homepage:
<img width="686" alt="Screenshot 2024-10-08 at 20 51 01" src="https://github.com/user-attachments/assets/33613765-9880-46ae-a3ed-b0c51ee1c9b8">
Users will be able to click the entry to obtain connection instructions:
<img width="711" alt="Screenshot 2024-10-08 at 20 51 16" src="https://github.com/user-attachments/assets/9f4204e8-ca1c-4fbe-87d4-9d52e1f0d499">
# Client setup
You can now use any PostgreSQL client applications to connect through Warpgate with the following settings:
* Host: the Warpgate host
* Port: the Warpgate PostgreSQL port (default: 55432)
* Username: `admin#<target-name>` or `admin:<target-name>`, in this example: `admin#db1`
* Password: your Warpgate admin password
* TLS: enabled
* Cleartext password authentication: allowed
If your client uses a database URL, use: `postgresql://<username>#<target>:<password>@<warpgate host>:<warpgate postgresql port>?sslmode=require`
While your PostgreSQL session is running, you'll be able to see its status in the Admin UI, including the query log:
<img width="500" alt="image" src="https://user-images.githubusercontent.com/161476/179948103-7d7f84f7-68a0-40c3-be1c-60892a7f0ace.png">
# Up next
* [[User authentication and roles]]
> [!NOTE]
> The docs have moved to https://warpgate.null.page/targets/postgres/