Skip to content

Commit

Permalink
Change default keyboard shortcuts (#41818)
Browse files Browse the repository at this point in the history 
* Change default keyboard shortcuts

* Add an entry to CHANGELOG.md

* Update shortcuts in text

* Remove spans

* Update changelog

* Replace angle brackets with > and &lt in `teleport-connect.mdx` to allow linter find the 'Configuration' heading

The angle brackets seem to be interpreted as HTML tags.

* Remove slash before the fragment
  • Loading branch information
@gzdunek
gzdunek authored May 24, 2024
1 parent ac9e4cd commit 9adb7a0
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 47 deletions.
11 changes: 10 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Opsgenie plugin users, role annotations must now contain
See [the Opsgenie plugin documentation](docs/pages/access-controls/access-request-plugins/opsgenie.mdx)
for setup instructions.

#### Teleport Assist chat has been remove.
#### Teleport Assist chat has been removed

Teleport Assist chat has been removed from Teleport 16. Assist is still available
in the SSH Web Terminal and Audit Monitoring.
Expand All @@ -34,6 +34,15 @@ more performant, `tbot ssh-proxy-command`. See the
[v16 upgrade guide](docs/pages/machine-id/reference/v16-upgrade-guide.mdx) for
more details.

#### Default keyboard shortcuts in Teleport Connect have been changed

On Windows and Linux, some of the default shortcuts conflicted with the default bash or nano shortcuts
(e.g. Ctrl + E, Ctrl + K).
On those platforms, the default shortcuts have been changed to a combination of Ctrl + Shift + *.
We also updated the shortcut to open a new terminal on macOS to Cmd + \`.
See [configuration](docs/pages/connect-your-client/teleport-connect.mdx#configuration)
for the current list of shortcuts.

## 15.0.0 (xx/xx/24)

### New features
Expand Down
62 changes: 31 additions & 31 deletions docs/pages/connect-your-client/teleport-connect.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ which cluster the current tab is bound to, and the **Share Feedback** button in
## Connecting to an SSH server

1. Open a tab with cluster resources by clicking on the plus symbol at the right end of the tab bar.
You can also press <span style="white-space: nowrap;">`Ctrl/Cmd + T`</span> to achieve the same result.
You can also press `Ctrl+Shift+T/Cmd+T` to achieve the same result.
1. Look for the SSH server you want to connect to and click the Connect button.
1. Select or enter the SSH user you wish to log in as and press `Enter`.

Expand All @@ -78,7 +78,7 @@ Alternatively, you can look for the server in the search bar and press `Enter` t
## Opening a local terminal

To open a terminal with a local shell session, either select "Open new terminal" from the additional
actions menu or press <span style="white-space: nowrap;">`Ctrl/Cmd + Shift + T`</span>.
actions menu or press `` Ctrl+Shift+`/Cmd+` ``.

Any tsh command executed within the tab targets the current cluster. Teleport Connect accomplishes
this by setting the environment variables `TELEPORT_PROXY` and `TELEPORT_CLUSTER` for the session.
Expand All @@ -92,7 +92,7 @@ reflected in both the tab title and the status bar.
## Connecting to a Kubernetes cluster

1. Open a tab with cluster resources by clicking on the plus symbol at the right end of the tab bar.
You can also press <span style="white-space: nowrap;">`Ctrl/Cmd + T`</span> to achieve the same result.
You can also press `Ctrl+Shift+T/Cmd+T` to achieve the same result.
1. Look for the cluster you wish to connect to and click the Connect button.

Alternatively, you can look for the cluster in the search bar and press `Enter`
Expand All @@ -113,7 +113,7 @@ Teleport Connect is closed.
## Connecting to a database

1. Open a tab with cluster resources by clicking on the plus symbol at the end of the tab bar. You
can also press <span style="white-space: nowrap;">`Ctrl/Cmd + T`</span> to achieve the same result.
can also press `Ctrl+Shift+T/Cmd+T` to achieve the same result.
1. Look for the database server you wish to connect to and click the Connect button.
1. Select or enter the database user you wish to use and press `Enter`.

Expand Down Expand Up @@ -148,7 +148,7 @@ can be used only through tsh in [a local terminal tab](#opening-a-local-terminal
### Launching an application in the browser

1. Open a tab with cluster resources by clicking on the plus symbol at the end of the tab bar. You
can also press <span style="white-space: nowrap;">`Ctrl/Cmd + T`</span> to achieve the same result.
can also press `Ctrl+Shift+T/Cmd+T` to achieve the same result.
1. Look for the application you wish to open and click the Launch button (web apps and AWS console)
or the Login button (SAML apps).

Expand All @@ -158,7 +158,7 @@ the browser.
### Creating an authenticated tunnel

1. Open a tab with cluster resources by clicking on the plus symbol at the end of the tab bar. You
can also press <span style="white-space: nowrap;">`Ctrl/Cmd + T`</span> to achieve the same result.
can also press `Ctrl+Shift+T/Cmd+T` to achieve the same result.
1. Look for the application you wish to connect to.
- For TCP applications, click the Connect button.
- For web applications, click the three dots next to the Launch button and select Set up
Expand All @@ -184,7 +184,7 @@ your first cluster, open the profile selector at the top right and click the *+A
button. You can switch between active profiles in multiple ways:

1. Click at the profile selector button at the top right.
1. Open the profile selector with a shortcut (<span style="white-space: nowrap;">`Ctrl/Cmd + I`</span>).
1. Open the profile selector with a shortcut (`Ctrl+Shift+I/Cmd+I`).
1. Select a connection from the connection list at the top to automatically switch to the right profile.

At the moment Teleport Connect supports only one user per cluster. To log in as a different user,
Expand Down Expand Up @@ -288,12 +288,12 @@ After the setup is done, open the Connect My Computer tab and from the three dot
tab choose "Open agent logs directory".

<Tabs>
<TabItem label="macOS">
The logs are stored at `~/Library/Application Support/Teleport Connect/agents/<cluster>/logs`.
</TabItem>
<TabItem label="Linux">
The logs are stored at `~/.config/Teleport Connect/agents/<cluster>/logs`.
</TabItem>
<TabItem label="macOS">
The logs are stored at <code>~/Library/Application Support/Teleport Connect/agents/&lt;cluster&gt;/logs</code>.
</TabItem>
<TabItem label="Linux">
The logs are stored at <code>~/.config/Teleport Connect/agents/&lt;cluster&gt;/logs</code>.
</TabItem>
</Tabs>

#### The Connect My Computer icon is not visible in the top bar
Expand Down Expand Up @@ -414,23 +414,23 @@ The file will open in your default editor.

Below is the list of the supported config properties.

| Property | Default | Description |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| `theme` | `system` | Color theme for the app. Available modes: `light`, `dark`, `system`. |
| `terminal.fontFamily` | `Menlo, Monaco, monospace` on macOS<br/>`Consolas, monospace` on Windows<br/>`'Droid Sans Mono', monospace` on Linux | Font family for the terminal. |
| `terminal.fontSize` | 15 | Font size for the terminal. |
| `usageReporting.enabled` | `false` | Enables collecting anonymous usage data (see [Telemetry](#telemetry)). |
| `keymap.tab1` - `keymap.tab9` | `Command+1` - `Command+9` on macOS <br/> `Ctrl+1` - `Ctrl+9` on Windows<br/>`Alt+1` - `Alt+9` on Linux | Shortcut to open tab 1–9. |
| `keymap.closeTab` | `Command+W` on macOS<br/>`Ctrl+W` on Windows/Linux | Shortcut to close a tab. |
| `keymap.newTab` | `Command+T` on macOS<br/>`Ctrl+T` on Windows/Linux | Shortcut to open a new tab. |
| `keymap.newTerminalTab` | `Shift+Command+T` on macOS<br/>`Ctrl+Shift+T` on Windows/Linux | Shortcut to open a new terminal tab. |
| `keymap.previousTab` | `Shift+Command+Tab` on macOS<br/>`Ctrl+Shift+Tab` on Windows/Linux | Shortcut to go to the previous tab. |
| `keymap.nextTab` | `Command+Tab` on macOS<br/>`Ctrl+Tab` on Windows/Linux | Shortcut to go to the next tab. |
| `keymap.openConnections` | `Command+P` on macOS<br/>`Ctrl+P` on Windows/Linux | Shortcut to open the connection list. |
| `keymap.openClusters` | `Command+E` on macOS<br/>`Ctrl+E` on Windows/Linux | Shortcut to open the cluster selector. |
| `keymap.openProfiles` | `Command+I` on macOS<br/>`Ctrl+I` on Windows/Linux | Shortcut to open the profile selector. |
| `keymap.openSearchBar` | `Command+K` on macOS<br/>`Ctrl+K` on Windows/Linux | Shortcut to open the search bar. |
| `headless.skipConfirm` | false | Skips the confirmation prompt for Headless WebAuthn approval and instead prompts for WebAuthn immediately. |
| Property | Default | Description |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| `theme` | `system` | Color theme for the app. Available modes: `light`, `dark`, `system`. |
| `terminal.fontFamily` | `Menlo, Monaco, monospace` on macOS<br/>`Consolas, monospace` on Windows<br/>`'Droid Sans Mono', monospace` on Linux | Font family for the terminal. |
| `terminal.fontSize` | 15 | Font size for the terminal. |
| `usageReporting.enabled` | `false` | Enables collecting anonymous usage data (see [Telemetry](#telemetry)). |
| `keymap.tab1` - `keymap.tab9` | `Command+1` - `Command+9` on macOS <br/> `Ctrl+1` - `Ctrl+9` on Windows<br/>`Alt+1` - `Alt+9` on Linux | Shortcut to open tab 1–9. |
| `keymap.closeTab` | `Command+W` on macOS<br/>`Ctrl+Shift+W` on Windows/Linux | Shortcut to close a tab. |
| `keymap.newTab` | `Command+T` on macOS<br/>`Ctrl+Shift+T` on Windows/Linux | Shortcut to open a new tab. |
| `keymap.newTerminalTab` | `` Shift+Command+` `` on macOS<br/>`` Ctrl+Shift+` `` on Windows/Linux | Shortcut to open a new terminal tab. |
| `keymap.previousTab` | `Shift+Command+Tab` on macOS<br/>`Ctrl+Shift+Tab` on Windows/Linux | Shortcut to go to the previous tab. |
| `keymap.nextTab` | `Command+Tab` on macOS<br/>`Ctrl+Tab` on Windows/Linux | Shortcut to go to the next tab. |
| `keymap.openConnections` | `Command+P` on macOS<br/>`Ctrl+Shift+P` on Windows/Linux | Shortcut to open the connection list. |
| `keymap.openClusters` | `Command+E` on macOS<br/>`Ctrl+Shift+E` on Windows/Linux | Shortcut to open the cluster selector. |
| `keymap.openProfiles` | `Command+I` on macOS<br/>`Ctrl+Shift+I` on Windows/Linux | Shortcut to open the profile selector. |
| `keymap.openSearchBar` | `Command+K` on macOS<br/>`Ctrl+Shift+K` on Windows/Linux | Shortcut to open the search bar. |
| `headless.skipConfirm` | false | Skips the confirmation prompt for Headless WebAuthn approval and instead prompts for WebAuthn immediately. |

<Admonition
type="note"
Expand All @@ -442,7 +442,7 @@ Below is the list of the supported config properties.

### Configuring keyboard shortcuts

A valid shortcut contains at least one modifier and a single key code, for example <span style="white-space: nowrap;">`Shift+Tab`</span>.
A valid shortcut contains at least one modifier and a single key code, for example `Shift+Tab`.
Function keys such as `F1` do not require a modifier.
Modifiers and a key code must be combined by the `+` character.

Expand Down
30 changes: 15 additions & 15 deletions web/packages/teleterm/src/services/config/appConfigSchema.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,15 @@ const getDefaultKeymap = (
tab7: 'Ctrl+7',
tab8: 'Ctrl+8',
tab9: 'Ctrl+9',
closeTab: 'Ctrl+W',
newTab: 'Ctrl+T',
newTerminalTab: 'Ctrl+Shift+T',
closeTab: 'Ctrl+Shift+W',
newTab: 'Ctrl+Shift+T',
newTerminalTab: 'Ctrl+Shift+`',
previousTab: 'Ctrl+Shift+Tab',
nextTab: 'Ctrl+Tab',
openSearchBar: 'Ctrl+K',
openConnections: 'Ctrl+P',
openClusters: 'Ctrl+E',
openProfiles: 'Ctrl+I',
openSearchBar: 'Ctrl+Shift+K',
openConnections: 'Ctrl+Shift+P',
openClusters: 'Ctrl+Shift+E',
openProfiles: 'Ctrl+Shift+I',
};
case 'linux':
return {
Expand All @@ -182,15 +182,15 @@ const getDefaultKeymap = (
tab7: 'Alt+7',
tab8: 'Alt+8',
tab9: 'Alt+9',
closeTab: 'Ctrl+W',
newTab: 'Ctrl+T',
newTerminalTab: 'Ctrl+Shift+T',
closeTab: 'Ctrl+Shift+W',
newTab: 'Ctrl+Shift+T',
newTerminalTab: 'Ctrl+Shift+`',
previousTab: 'Ctrl+Shift+Tab',
nextTab: 'Ctrl+Tab',
openSearchBar: 'Ctrl+K',
openConnections: 'Ctrl+P',
openClusters: 'Ctrl+E',
openProfiles: 'Ctrl+I',
openSearchBar: 'Ctrl+Shift+K',
openConnections: 'Ctrl+Shift+P',
openClusters: 'Ctrl+Shift+E',
openProfiles: 'Ctrl+Shift+I',
};
case 'darwin':
return {
Expand All @@ -205,7 +205,7 @@ const getDefaultKeymap = (
tab9: 'Command+9',
closeTab: 'Command+W',
newTab: 'Command+T',
newTerminalTab: 'Shift+Command+T',
newTerminalTab: 'Shift+Command+`',
previousTab: 'Control+Shift+Tab',
nextTab: 'Control+Tab',
openSearchBar: 'Command+K',
Expand Down

0 comments on commit 9adb7a0

Please sign in to comment.