diff --git a/docs/img/database-access/azure-data-studio-connection.png b/docs/img/database-access/azure-data-studio-connection.png new file mode 100644 index 0000000000000..df7e363f75630 Binary files /dev/null and b/docs/img/database-access/azure-data-studio-connection.png differ diff --git a/docs/img/database-access/msft-sql-server-management-studio-connection.png b/docs/img/database-access/msft-sql-server-management-studio-connection.png new file mode 100644 index 0000000000000..1606266edd9f9 Binary files /dev/null and b/docs/img/database-access/msft-sql-server-management-studio-connection.png differ diff --git a/docs/pages/connect-your-client/gui-clients.mdx b/docs/pages/connect-your-client/gui-clients.mdx index 3d3c3d790ee00..e51fd3bd63bb8 100644 --- a/docs/pages/connect-your-client/gui-clients.mdx +++ b/docs/pages/connect-your-client/gui-clients.mdx @@ -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” @@ -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 diff --git a/docs/pages/database-access/guides/sql-server-ad-pkinit.mdx b/docs/pages/database-access/guides/sql-server-ad-pkinit.mdx index 1125a358d6ea6..20c6144c394c1 100644 --- a/docs/pages/database-access/guides/sql-server-ad-pkinit.mdx +++ b/docs/pages/database-access/guides/sql-server-ad-pkinit.mdx @@ -358,13 +358,7 @@ To retrieve credentials for a database and connect to it: $ tsh db connect --db-user=teleport sqlserver ``` - - 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. - +(!docs/pages/includes/database-access/sql-server-connect-note.mdx!) To log out of the database and remove credentials: diff --git a/docs/pages/database-access/guides/sql-server-ad.mdx b/docs/pages/database-access/guides/sql-server-ad.mdx index de7b65e0e2546..a5ad49a622e5d 100644 --- a/docs/pages/database-access/guides/sql-server-ad.mdx +++ b/docs/pages/database-access/guides/sql-server-ad.mdx @@ -346,13 +346,7 @@ To retrieve credentials for a database and connect to it: $ tsh db connect --db-user=teleport sqlserver ``` - - 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. - +(!docs/pages/includes/database-access/sql-server-connect-note.mdx!) To log out of the database and remove credentials: diff --git a/docs/pages/includes/database-access/sql-server-connect-note.mdx b/docs/pages/includes/database-access/sql-server-connect-note.mdx new file mode 100644 index 0000000000000..531e4279ab2cb --- /dev/null +++ b/docs/pages/includes/database-access/sql-server-connect-note.mdx @@ -0,0 +1,14 @@ + +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. +