Skip to content

Commit 88deb90

Browse files
datlechindatlechin
committed
docs: rewrite SSH profiles docs for accuracy and clarity
1 parent 098dfec commit 88deb90

3 files changed

Lines changed: 141 additions & 171 deletions

File tree

‎docs/features/ssh-profiles.mdx‎

Lines changed: 48 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,97 @@
11
---
22
title: SSH Profiles
3-
description: Create reusable SSH tunnel configurations that can be shared across multiple database connections
3+
description: Save SSH tunnel configurations as reusable profiles shared across connections
44
---
55

66
# SSH Profiles
77

8-
SSH profiles let you define an SSH tunnel configuration once and reuse it across multiple database connections. Instead of entering the same SSH host, port, username, and auth settings for every connection that tunnels through the same server, create a profile and select it from a dropdown.
8+
When you connect to MySQL, Redis, and PostgreSQL on the same remote server, you'd normally enter the same SSH host, port, and credentials three times. SSH profiles fix that: define the tunnel config once, then pick it from a dropdown on any connection.
99

10-
## Creating an SSH Profile
10+
## Creating a Profile
1111

1212
<Steps>
13-
<Step title="Open Connection Form">
14-
Open a new or existing connection and switch to the **SSH Tunnel** tab.
13+
<Step title="Open the SSH Tunnel tab">
14+
Open a new or existing connection and go to the **SSH Tunnel** tab.
1515
</Step>
16-
<Step title="Enable SSH Tunnel">
17-
Toggle the **SSH Tunnel** switch to ON.
16+
<Step title="Enable SSH">
17+
Turn on the **Enable SSH Tunnel** toggle.
1818
</Step>
19-
<Step title="Create New Profile">
20-
Click **Use SSH Profile** to switch from inline configuration to profile mode, then click **Create New Profile...** from the profile dropdown.
19+
<Step title="Click Create New Profile">
20+
In the **SSH Profile** section, click **Create New Profile...**. A sheet opens with all the SSH fields.
2121
</Step>
22-
<Step title="Fill in Profile Details">
23-
Enter a profile name and configure the SSH settings (host, port, username, authentication method). These are the same fields as inline SSH configuration.
24-
</Step>
25-
<Step title="Save">
26-
Click **Save** to store the profile. It is now available in the profile dropdown for all connections.
22+
<Step title="Configure and save">
23+
Give the profile a name (e.g. "prod-bastion"), fill in the SSH server details, and click **Create**.
2724
</Step>
2825
</Steps>
2926

30-
### Profile Fields
27+
### Profile fields
3128

3229
| Field | Description |
3330
|-------|-------------|
34-
| **Profile Name** | A label to identify this profile (e.g., "Production Bastion", "Staging Jump") |
35-
| **SSH Host** | SSH server hostname or IP |
36-
| **SSH Port** | SSH server port (default `22`) |
37-
| **SSH User** | SSH username |
38-
| **Auth Method** | Password, Private Key, or SSH Agent |
39-
| **Jump Hosts** | Optional multi-hop configuration |
40-
41-
Authentication fields (password, key file, passphrase, agent socket) depend on the selected auth method. These work identically to [inline SSH tunnel settings](/databases/ssh-tunneling#authentication-methods).
31+
| **Name** | Label for this profile — shows in the dropdown |
32+
| **SSH Host** | Hostname or IP of the SSH server |
33+
| **SSH Port** | Default `22` |
34+
| **Username** | SSH login user |
35+
| **Auth Method** | Password, Private Key, SSH Agent, or Keyboard-Interactive |
36+
| **Jump Hosts** | Optional multi-hop bastion chain |
37+
| **TOTP** | Optional two-factor (auto-generate or prompt) |
4238

43-
## Using SSH Profiles
39+
Auth-specific fields (password, key file, passphrase, agent socket) match the [inline SSH tunnel settings](/databases/ssh-tunneling#authentication-methods).
4440

45-
1. Open a connection's **SSH Tunnel** tab and enable SSH
46-
2. Click **Use SSH Profile** to switch to profile mode
47-
3. Select a profile from the dropdown
48-
4. The SSH settings display as a read-only summary showing the profile's host, port, user, and auth method
41+
## Selecting a Profile
4942

50-
The connection stores a reference to the profile, not a copy of the settings. If you update the profile later, all connections using it pick up the changes automatically.
43+
1. Go to a connection's **SSH Tunnel** tab and enable SSH
44+
2. Open the **Profile** picker and select a profile
45+
3. The connection shows a read-only summary of the profile's settings
5146

52-
To switch back to per-connection SSH settings, click **Use Inline Config**. This detaches the connection from the profile and lets you edit SSH fields directly.
47+
The connection stores a reference to the profile — not a copy. Updating the profile later affects every connection that uses it.
5348

54-
## Editing and Deleting Profiles
49+
To go back to per-connection SSH settings, switch the picker back to **Inline Configuration**.
5550

56-
### Editing
51+
## Editing a Profile
5752

58-
1. Open any connection that uses the profile (or create a new one and select the profile)
59-
2. Click the **Edit** button next to the profile dropdown
60-
3. Modify the settings and click **Save**
53+
1. Select the profile in any connection's SSH tab
54+
2. Click **Edit Profile...**
55+
3. Change what you need and click **Save**
6156

62-
Changes apply to all connections that reference this profile.
57+
All connections referencing the profile get the updated config on next connect.
6358

64-
### Deleting
59+
## Deleting a Profile
6560

66-
1. Open the profile editor
61+
1. Open the profile editor via **Edit Profile...**
6762
2. Click **Delete Profile**
68-
3. A confirmation dialog shows how many connections currently use this profile
69-
4. Confirm to delete. Affected connections revert to inline SSH configuration with the profile's settings copied in, so no connection loses its SSH config.
63+
3. A confirmation dialog shows how many connections use this profile
64+
4. Confirm deletion
65+
66+
After deletion, affected connections show a "profile no longer exists" warning in the SSH tab. SSH tunneling is disabled for those connections until you select a different profile or switch to inline configuration.
7067

71-
## Save Current Config as Profile
68+
## Saving Inline Config as a Profile
7269

73-
If you already have a connection with inline SSH settings and want to reuse that configuration:
70+
If you already configured SSH inline on a connection and want to reuse it:
7471

75-
1. Open the connection's **SSH Tunnel** tab
72+
1. Go to the connection's **SSH Tunnel** tab (with inline config active)
7673
2. Click **Save Current as Profile...**
77-
3. Enter a profile name
78-
4. The current SSH settings are saved as a new profile, and the connection switches to using that profile
74+
3. Name the profile and click **Create**
7975

80-
This is useful when you realize multiple connections share the same SSH tunnel and you want to consolidate them.
76+
The connection switches to using the new profile. Your SSH password, key passphrase, and TOTP secret carry over.
8177

8278
## iCloud Sync
8379

84-
SSH profiles sync across your Macs when iCloud Sync is enabled with the **Connections** category turned on. Profiles are synced alongside your connections.
80+
SSH profiles sync across Macs when iCloud Sync is enabled with the **SSH Profiles** toggle on in **Settings > Sync**.
8581

8682
<Note>
87-
SSH passwords and key passphrases are **not** synced with the profile by default. These credentials are stored in the local macOS Keychain. Enable **Password sync** in **Settings** > **Sync** to sync credentials via iCloud Keychain (end-to-end encrypted by Apple).
83+
SSH passwords and key passphrases stay in the local macOS Keychain by default. Turn on **Password sync** in **Settings > Sync** to sync credentials via iCloud Keychain.
8884
</Note>
8985

90-
See [iCloud Sync](/features/icloud-sync) for full sync configuration details.
86+
See [iCloud Sync](/features/icloud-sync) for setup details.
9187

92-
## Related pages
88+
## Related
9389

9490
<CardGroup cols={2}>
9591
<Card title="SSH Tunneling" icon="lock" href="/databases/ssh-tunneling">
96-
Full SSH tunnel setup and troubleshooting
92+
SSH tunnel setup and troubleshooting
9793
</Card>
9894
<Card title="iCloud Sync" icon="cloud" href="/features/icloud-sync">
99-
Sync settings across Macs
100-
</Card>
101-
<Card title="Connection Management" icon="plug" href="/databases/overview">
102-
Managing all your connections
103-
</Card>
104-
<Card title="Keyboard Shortcuts" icon="keyboard" href="/features/keyboard-shortcuts">
105-
Speed up your workflow
95+
Sync across Macs
10696
</Card>
10797
</CardGroup>

‎docs/vi/features/ssh-profiles.mdx‎

Lines changed: 47 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,97 @@
11
---
22
title: SSH Profiles
3-
description: Tạo cấu hình SSH tunnel tái sử dụng để chia sẻ giữa nhiều kết nối database
3+
description: Lưu cấu hình SSH tunnel thành profile tái sử dụng cho nhiều kết nối
44
---
55

66
# SSH Profiles
77

8-
SSH profiles cho phép bạn định nghĩa cấu hình SSH tunnel một lần và tái sử dụng cho nhiều kết nối database. Thay vì nhập cùng SSH host, port, username và cài đặt xác thực cho mỗi kết nối đi qua cùng server, tạo một profile và chọn từ dropdown.
8+
Khi bạn kết nối MySQL, Redis và PostgreSQL trên cùng server, bạn phải nhập cùng SSH host, port và credentials ba lần. SSH profiles giải quyết vấn đề này: cấu hình tunnel một lần, rồi chọn từ dropdown trên bất kỳ kết nối nào.
99

10-
## Tạo SSH Profile
10+
## Tạo Profile
1111

1212
<Steps>
13-
<Step title="Mở Form Kết nối">
14-
Mở kết nối mới hoặc sẵn có và chuyển sang tab **SSH Tunnel**.
13+
<Step title="Mở tab SSH Tunnel">
14+
Mở kết nối mới hoặc có sẵn, chuyển sang tab **SSH Tunnel**.
1515
</Step>
16-
<Step title="Bật SSH Tunnel">
17-
Bật công tắc **SSH Tunnel**.
16+
<Step title="Bật SSH">
17+
Bật toggle **Enable SSH Tunnel**.
1818
</Step>
19-
<Step title="Tạo Profile Mới">
20-
Nhấp **Use SSH Profile** để chuyển từ cấu hình inline sang chế độ profile, sau đó chọn **Create New Profile...** từ dropdown profile.
19+
<Step title="Nhấn Create New Profile">
20+
Trong phần **SSH Profile**, nhấn **Create New Profile...**. Một sheet mở ra với đầy đủ các trường SSH.
2121
</Step>
22-
<Step title="Điền Thông tin Profile">
23-
Nhập tên profile và cấu hình SSH (host, port, username, phương thức xác thực). Các trường giống cấu hình SSH inline.
24-
</Step>
25-
<Step title="Lưu">
26-
Nhấp **Save** để lưu profile. Profile giờ có sẵn trong dropdown cho tất cả kết nối.
22+
<Step title="Cấu hình và lưu">
23+
Đặt tên profile (ví dụ "prod-bastion"), điền thông tin SSH server, rồi nhấn **Create**.
2724
</Step>
2825
</Steps>
2926

30-
### Các Trường Profile
27+
### Các trường profile
3128

3229
| Trường | Mô tả |
3330
|-------|-------------|
34-
| **Profile Name** | Tên để nhận dạng profile (ví dụ: "Production Bastion", "Staging Jump") |
31+
| **Name** | Tên hiển thị trong dropdown |
3532
| **SSH Host** | Hostname hoặc IP của SSH server |
36-
| **SSH Port** | Cổng SSH server (mặc định `22`) |
37-
| **SSH User** | Tên người dùng SSH |
38-
| **Auth Method** | Password, Private Key, hoặc SSH Agent |
39-
| **Jump Hosts** | Cấu hình multi-hop tùy chọn |
40-
41-
Các trường xác thực (password, key file, passphrase, agent socket) phụ thuộc vào phương thức xác thực đã chọn. Hoạt động giống [cài đặt SSH tunnel inline](/vi/databases/ssh-tunneling#phương-thức-xác-thực).
33+
| **SSH Port** | Mặc định `22` |
34+
| **Username** | Tên đăng nhập SSH |
35+
| **Auth Method** | Password, Private Key, SSH Agent, hoặc Keyboard-Interactive |
36+
| **Jump Hosts** | Chuỗi bastion multi-hop (tùy chọn) |
37+
| **TOTP** | Xác thực hai yếu tố (tùy chọn) |
4238

43-
## Sử dụng SSH Profiles
39+
Các trường xác thực (password, key file, passphrase, agent socket) giống với [cài đặt SSH tunnel inline](/vi/databases/ssh-tunneling#phương-thức-xác-thực).
4440

45-
1. Mở tab **SSH Tunnel** của kết nối và bật SSH
46-
2. Nhấp **Use SSH Profile** để chuyển sang chế độ profile
47-
3. Chọn profile từ dropdown
48-
4. Cài đặt SSH hiển thị dạng tóm tắt chỉ đọc gồm host, port, user và phương thức xác thực
41+
## Chọn Profile
4942

50-
Kết nối lưu tham chiếu đến profile, không phải bản sao cài đặt. Nếu bạn cập nhật profile sau, tất cả kết nối dùng profile đó tự động nhận thay đổi.
43+
1. Vào tab **SSH Tunnel** của kết nối và bật SSH
44+
2. Mở picker **Profile** và chọn một profile
45+
3. Kết nối hiển thị tóm tắt chỉ đọc cài đặt của profile
5146

52-
Để chuyển về cài đặt SSH riêng cho từng kết nối, nhấp **Use Inline Config**. Thao tác này tách kết nối khỏi profile và cho phép chỉnh sửa trực tiếp các trường SSH.
47+
Kết nối lưu tham chiếu đến profile, không phải bản sao. Cập nhật profile sẽ ảnh hưởng đến mọi kết nối dùng nó.
5348

54-
## Sửa và Xóa Profile
49+
Để quay lại cài đặt SSH riêng cho từng kết nối, chuyển picker về **Inline Configuration**.
5550

56-
### Sửa
51+
## Sửa Profile
5752

58-
1. Mở kết nối đang dùng profile (hoặc tạo mới và chọn profile)
59-
2. Nhấp nút **Edit** bên cạnh dropdown profile
60-
3. Sửa cài đặt và nhấp **Save**
53+
1. Chọn profile trong tab SSH của bất kỳ kết nối nào
54+
2. Nhấn **Edit Profile...**
55+
3. Thay đổi và nhấn **Save**
6156

62-
Thay đổi áp dụng cho tất cả kết nối tham chiếu đến profile này.
57+
Tất cả kết nối tham chiếu profile sẽ nhận cấu hình mới khi kết nối lại.
6358

64-
### Xóa
59+
## Xóa Profile
6560

66-
1. Mở trình sửa profile
67-
2. Nhấp **Delete Profile**
61+
1. Mở trình sửa profile qua **Edit Profile...**
62+
2. Nhấn **Delete Profile**
6863
3. Hộp thoại xác nhận hiển thị số kết nối đang dùng profile
69-
4. Xác nhận xóa. Các kết nối bị ảnh hưởng chuyển về cấu hình SSH inline với cài đặt của profile được sao chép vào, không kết nối nào mất cấu hình SSH.
64+
4. Xác nhận xóa
65+
66+
Sau khi xóa, các kết nối bị ảnh hưởng hiển thị cảnh báo "profile không còn tồn tại" trong tab SSH. SSH tunneling bị vô hiệu hóa cho những kết nối đó cho đến khi bạn chọn profile khác hoặc chuyển sang cấu hình inline.
7067

71-
## Lưu Cấu hình Hiện tại thành Profile
68+
## Lưu cấu hình inline thành Profile
7269

73-
Nếu bạn đã có kết nối với cài đặt SSH inline và muốn tái sử dụng cấu hình đó:
70+
Nếu bạn đã cấu hình SSH inline trên một kết nối và muốn tái sử dụng:
7471

75-
1. Mở tab **SSH Tunnel** của kết nối
76-
2. Nhấp **Save Current as Profile...**
77-
3. Nhập tên profile
78-
4. Cài đặt SSH hiện tại được lưu thành profile mới, và kết nối chuyển sang dùng profile đó
72+
1. Vào tab **SSH Tunnel** của kết nối (đang dùng cấu hình inline)
73+
2. Nhấn **Save Current as Profile...**
74+
3. Đặt tên profile và nhấn **Create**
7975

80-
Hữu ích khi bạn nhận ra nhiều kết nối dùng chung SSH tunnel và muốn hợp nhất.
76+
Kết nối chuyển sang dùng profile mới. Mật khẩu SSH, key passphrase và TOTP secret được chuyển theo.
8177

8278
## Đồng bộ iCloud
8379

84-
SSH profiles đồng bộ giữa các Mac khi bật iCloud Sync với danh mục **Connections**. Profile được đồng bộ cùng với kết nối.
80+
SSH profiles đồng bộ giữa các Mac khi bật iCloud Sync với toggle **SSH Profiles** trong **Settings > Sync**.
8581

8682
<Note>
87-
Mật khẩu SSH và passphrase key **không** đồng bộ cùng profile theo mặc định. Thông tin xác thực lưu trong macOS Keychain local. Bật **Password sync** trong **Settings** > **Sync** để đồng bộ qua iCloud Keychain (mã hóa đầu cuối bởi Apple).
83+
Mật khẩu SSH và key passphrase mặc định lưu trong macOS Keychain local. Bật **Password sync** trong **Settings > Sync** để đồng bộ qua iCloud Keychain.
8884
</Note>
8985

90-
Xem [Đồng bộ iCloud](/vi/features/icloud-sync) để biết chi tiết cấu hình đồng bộ.
86+
Xem [Đồng bộ iCloud](/vi/features/icloud-sync) để biết chi tiết.
9187

92-
## Trang liên quan
88+
## Liên quan
9389

9490
<CardGroup cols={2}>
9591
<Card title="SSH Tunneling" icon="lock" href="/vi/databases/ssh-tunneling">
9692
Thiết lập và khắc phục sự cố SSH tunnel
9793
</Card>
9894
<Card title="Đồng bộ iCloud" icon="cloud" href="/vi/features/icloud-sync">
99-
Đồng bộ cài đặt giữa các Mac
100-
</Card>
101-
<Card title="Quản lý Kết nối" icon="plug" href="/vi/databases/overview">
102-
Quản lý tất cả kết nối
103-
</Card>
104-
<Card title="Phím tắt" icon="keyboard" href="/vi/features/keyboard-shortcuts">
105-
Tăng tốc quy trình làm việc
95+
Đồng bộ giữa các Mac
10696
</Card>
10797
</CardGroup>

0 commit comments

Comments
 (0)