You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-5Lines changed: 30 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,15 @@
1
1
# InterSystems® Server Manager
2
-
This is a VS Code helper extension that contributes settings which define connections to [InterSystems](https://www.intersystems.com/) servers.
2
+
3
+
This is a VS Code helper extension that helps configure connections to [InterSystems](https://www.intersystems.com/) servers in VS Code extensions such as the [ObjectScript Extension for VS Code](https://github.com/intersystems-community/vscode-objectscript).
4
+
5
+
It also enables the secure storage of passwords using the underlying operating system's native keystore.
6
+
7
+
## Configuring connections
8
+
9
+
Add server definitions to [user or workspace settings](https://code.visualstudio.com/docs/getstarted/settings) by editing JSON files.
3
10
4
11
For example:
12
+
5
13
```json
6
14
"intersystems.servers": {
7
15
"dev": {
@@ -26,13 +34,30 @@ For example:
26
34
}
27
35
```
28
36
29
-
This extension helps users add server definitions to their [user or workspace settings](https://code.visualstudio.com/docs/getstarted/settings) by editing JSON files.
37
+
## Storing passwords securely
38
+
39
+
This extension adds the command `InterSystems Server Manager: Store Password in Keychain` to the Command Palette, which offers a quickpick of defined servers, then prompts for a password to store. This facility should be used instead of the plaintext `password` property of a server's definition, which has been deprecated.
40
+
41
+
**Usage:**
42
+
43
+
1. Bring up the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) by typing Ctrl+Shift+P (Cmd+Shift+P on Mac) or F1.
44
+
2. Start typing "Server Manager" to locate the `InterSystems Server Manager: Store Password in Keychain` command.
45
+
3. Pick a server.
46
+
4. Enter your password.
47
+
48
+
You will no longer need to supply a password when connecting to the server you selected.
49
+
50
+
## Removing a stored password
51
+
52
+
The command `InterSystems Server Manager: Clear Password from Keychain` removes a stored password.
30
53
31
-
It adds the command `InterSystems Server Manager: Store Password in Keychain` to the Command Palette, which offers a quickpick of defined servers, then prompts for a password to store. This facility should be used instead of the plaintext `password` property of a server's definition, which has been deprecated.
54
+
**Usage:**
32
55
33
-
A command `InterSystems Server Manager: Clear Password from Keychain` removes a stored password.
56
+
1. Bring up the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) by typing Ctrl+Shift+P (Cmd+Shift+P on Mac) or F1.
57
+
2. Start typing "Server Manager" to locate the `InterSystems Server Manager: Clear Password from Keychain` command.
58
+
3. Pick a server.
34
59
35
-
## Use By Other Extensions
60
+
## For Developers: Use By Other Extensions
36
61
37
62
An extension XYZ needing to connect to InterSystems servers can define this extension as a dependency in its `package.json`
0 commit comments