Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 46 additions & 1 deletion docs/pages/connect-your-client/gui-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,29 @@ more information.)

![DynamoDB local connection in NoSQL Workbench](../../img/database-access/nosql-workbench-connection.png)

## PostgreSQL DBeaver
## SQL Server with Azure Data Studio

In Azure Data Studio create a connection using your proxy's endpoint. This is
`localhost,62652` in the example above. On a Windows machine, using an address in
the format `127.0.0.1,62652` could be required instead of `localhost`. (See
[Get connection information](./gui-clients.mdx#get-connection-information) for
more information.)

Create a connection with Microsoft SQL Server with these settings:

|Connection Detail|Value|
|---|---|
|Server|`host`,`port` of proxy endpoint|
|Authentication Type|SQL Login|
|Password|empty|
|Encrypt|`False`|

Example:
![Azure Data Studio connection options](../../img/database-access/azure-data-studio-connection.png)

Click **Connect** to connect.

## PostgreSQL DBeaver

To connect to your PostgreSQL instance, use the authenticated proxy address.
This is `127.0.0.1:62652` in the example above (see the “Authenticated Proxy”
Expand Down Expand Up @@ -248,6 +270,29 @@ certificate, key and root certificate from the configuration above:
Click "Save", and pgAdmin should immediately connect. If pgAdmin prompts you
for password, leave the password field empty and click OK.

## Microsoft SQL Server Management Studio

In Microsoft SQL Server Management Studio connect to a database engine using
your proxy's endpoint. This is `localhost,62652` in the example above. Using
the IP `127.0.0.1,62652` connection could be required on a Windows machine
instead of `localhost`. (See [Get connection information](./gui-clients.mdx#get-connection-information) for
more information.)

Create a connection with Microsoft SQL Server with these settings:

|Connection Detail|Value|
|---|---|
|Server type|Database Engine|
|Server name|`host`,`port` of proxy endpoint|
|Authentication|SQL Server Authentication|
|Password|empty|
|Encryption|do not enable|

Example:
![Microsoft SQL Server Management Studio connection options](../../img/database-access/msft-sql-server-management-studio-connection.png)

Click Connect to connect.

## Redis Insight

<Admonition type="note">
Expand Down
8 changes: 1 addition & 7 deletions docs/pages/database-access/guides/sql-server-ad-pkinit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -358,13 +358,7 @@ To retrieve credentials for a database and connect to it:
$ tsh db connect --db-user=teleport sqlserver
```

<Admonition type="note">
The `mssql-cli` command-line client should be available in `PATH` of the machine
you're running `tsh db connect` from.

`mssql-cli` is not required for SQL Server connections. Use `tsh proxy db --db-user=teleport --tunnel sqlserver`
to connect from other DB Clients such as Microsoft SQL Server Management Studio.
</Admonition>
(!docs/pages/includes/database-access/sql-server-connect-note.mdx!)

To log out of the database and remove credentials:

Expand Down
8 changes: 1 addition & 7 deletions docs/pages/database-access/guides/sql-server-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -346,13 +346,7 @@ To retrieve credentials for a database and connect to it:
$ tsh db connect --db-user=teleport sqlserver
```

<Admonition type="note">
The `mssql-cli` command-line client should be available in `PATH` of the machine
you're running `tsh db connect` from.

`mssql-cli` is not required for SQL Server connections. Use `tsh proxy db --db-user=teleport --tunnel sqlserver`
to connect from other DB Clients such as Microsoft SQL Server Management Studio.
</Admonition>
(!docs/pages/includes/database-access/sql-server-connect-note.mdx!)

To log out of the database and remove credentials:

Expand Down
14 changes: 14 additions & 0 deletions docs/pages/includes/database-access/sql-server-connect-note.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<Admonition type="note">
When you run the `tsh db connect` command above, `tsh` attempts to execute
the `mssql-cli` command-line client, which must be available in the user's
`PATH`. If you do not have `mssql-cli` available on your system, you can run the
following command to start a local proxy server that you can connect
to with your SQL Server client:

```code
$ tsh proxy db --db-user=teleport --tunnel sqlserver
```

Read the [Database Access GUI Clients](../../connect-your-client/gui-clients.mdx#sql-server-with-azure-data-studio)
guide for how to connect your DB GUI client to the local proxy.
</Admonition>