Skip to content

Commit 48bd7f7

Browse files
authored
Merge pull request #21 from intersystems-community/readme-update
adding more detail
2 parents 2d93024 + bc3629d commit 48bd7f7

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
# 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.
310

411
For example:
12+
513
```json
614
"intersystems.servers": {
715
"dev": {
@@ -26,13 +34,30 @@ For example:
2634
}
2735
```
2836

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.
3053

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:**
3255

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.
3459

35-
## Use By Other Extensions
60+
## For Developers: Use By Other Extensions
3661

3762
An extension XYZ needing to connect to InterSystems servers can define this extension as a dependency in its `package.json`
3863

0 commit comments

Comments
 (0)