diff --git a/doc/user/layouts/shortcodes/cloud-connection-details.html b/doc/user/layouts/shortcodes/cloud-connection-details.html index 0913a7588bc78..5dbb2668e4bef 100644 --- a/doc/user/layouts/shortcodes/cloud-connection-details.html +++ b/doc/user/layouts/shortcodes/cloud-connection-details.html @@ -1,4 +1,16 @@ -1. Click the deployment card, then **download** and **unzip** the certificate package. +1. Click on a deployment to see the individual deployment view. + +1. If you are connecting through Tailscale VPN, go to the Integrations card, then the Tailscale tab. Click **Enable**, then enter the Tailscale auth key in the Tailscale Authentication dialog and click **Save**. The deployment will automatically restart. + + Tailscale integration must enabled separately for each deployment. + + For help generating an auth key, please see the [Tailscale documentation](https://tailscale.com/kb/1085/auth-keys/). Make sure you create a **one-off key**. + +1. In the Connect card, go to the psql tab and click **Download certificates**. + +1. Unzip the certificate package. + + The certificate package is named `.zip` and contains the TLS certificates and keys you need to connect. 1. To connect to the deployment, you can use any [Materialize-compatible CLI](/connect/cli), like `psql` or `mzcli`. If you have `psql` installed on your machine, proceed to the next step. @@ -6,6 +18,8 @@ 1. Open a terminal window on your machine, copy the `psql` command from the connection dialog and run it from the directory that contains the certificates. + If you're connecting through Tailscale, replace the hostname in the copied command with the address of your Materialize connection in Tailscale. + On connection success, you should see an **open prompt** waiting for your next commands: ```nofmt