Skip to content

Commit cdc4254

Browse files
committed
Improve README information about username and password
1 parent 7cc4f2f commit cdc4254

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,19 @@ We recommend you define server connections in the `intersystems.servers` object
4343
"host": "127.0.0.1",
4444
"port": 52773
4545
},
46-
"description": "My local IRIS",
47-
"username": "me"
46+
"description": "My local IRIS",
47+
"username": "me"
4848
}
4949
}
5050
```
51-
Setting the `username` property is optional. If omitted it will be prompted for when connecting.
5251

53-
By defining connections in your User Settings they become available for use by any workspace you open in VSCode.
52+
By defining connections in your User Settings they become available for use by any workspace you open in VSCode. Alternatively, define them in workspace-specific settings.
53+
54+
Setting the `username` property is optional. If omitted it will be prompted for when connecting, then cached for the session..
55+
56+
Setting a plaintext value for the `password` property is not recommended. Instead, run the `InterSystems Server Manager: Store Password in Keychain` command from Command Palette.
57+
58+
If no password has been set or stored it will be prompted for when connecting, then cached for the session.
5459

5560
### Client-side Editing
5661

@@ -66,7 +71,9 @@ We recommend that `objectscript.conn` uses its `server` property to point to an
6671
}
6772
```
6873

69-
The mandatory `ns` property defines which server namespace you will work with. If `username` is set here it overrides that setting from the `intersystems.servers` entry.
74+
The mandatory `ns` property defines which server namespace you will work with.
75+
76+
When the `server` property is set, any `username` or `password` properties of `objectscript.conn` are ignored. Instead these values come from the `intersystems.servers` entry.
7077

7178
### Server-side Editing
7279

0 commit comments

Comments
 (0)