Skip to content

Commit 4a6fccf

Browse files
committed
Refine deep linking documentation for clarity and update option order
1 parent e70c7c7 commit 4a6fccf

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

documentation/src/docs/documentation/help/howtos/use-deep-linking.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ title: Deep Linking
88
* Deep links are a way to open WebSSH within a browser. They are very useful to open a specific connection in WebSSH. However, they could also be used to do malicious things. Be careful when you click on a link you don't trust.
99
* In order to prevent malicious links, WebSSH will ask you to confirm the connection before opening it. You can disable this confirmation in WebSSH > Settings > "Deep Linking Strategy"
1010

11-
* Since version 21.4, WebSSH supports deep linking. This means that you can open a SSH connection directly from a link.
12-
* Since 21.6 you can also use deep linking feature to be able to launch a one time connection from the Search Bar (issue [#833](https://github.com/isontheline/pro.webssh.net/issues/833))
11+
* WebSSH supports deep linking, this means that you can open a SSH connection directly from a link.
12+
* You can also use this feature to be able to launch a one time connection from the Search Bar
1313

1414
## How to use it
1515
To use deep linking, you need to create a link with the following format:
@@ -25,11 +25,12 @@ You can also specify some options to customize the connection. Here is the list
2525

2626
| Option | Description | Example |
2727
| --- | --- | --- |
28-
| `save` | If set to `true`, the connection will be saved in the connection list | `ssh://username@host:port?save=true` |
29-
| `name` | The name of the connection | `ssh://username@host:port?name=My%20Connection` |
3028
| `group` | The group of the connection | `ssh://username@host:port?group=My%20Group` |
31-
| `tags` | The tags of the connection | `ssh://username@host:port?tags=tag1,tag2` |
3229
| `key`| The Private Key name you would like to use to establish the connection. This parameter is case insensitive. Your Private Keys' name should be unique in order to be used with this parameter. | `ssh://username@host?key=MYPKEY`|
30+
| `name` | The name of the connection | `ssh://username@host:port?name=My%20Connection` |
31+
| `save` | If set to `true`, the connection will be saved in the connection list | `ssh://username@host:port?save=true` |
32+
| `tags` | The tags of the connection | `ssh://username@host:port?tags=tag1,tag2` |
33+
| `theme` | The theme name to use | `ssh://username@host:port?theme=GitHub%20Dark` |
3334

3435
You can combine multiple options in the same link. Here is an example:
3536

0 commit comments

Comments
 (0)