Skip to content

Commit 9e8e2ad

Browse files
committed
polish configuration doc page
1 parent 443039a commit 9e8e2ad

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/Configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The settings that define an InterSystems IRIS server and the connection to the s
1010

1111
## Configuring a Server
1212

13-
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) from the menu. Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. For example, the following screen shot shows Workspace selected:
13+
First, configure one or more servers. Open the settings editor by selecting **File > Preferences > Settings** (**Code > Preferences > Settings** on macOS) from the menu. Select the **User** or **Workspace** settings level by selecting it at the top of the settings window. For example, the following screen shot shows Workspace selected:
1414

1515
![Workspace selected.](../assets/images/ClickWorkspace.png "workspace selected")
1616

@@ -24,7 +24,7 @@ And this screen shot shows Server Manager area of the edit pane:
2424

2525
You need to edit the server configuration in the settings.json file, so your only option is to click *Edit in settings.json*.
2626

27-
To configure a server, enter code something like this:
27+
To configure a server, enter something like this:
2828

2929
```json
3030
"intersystems.servers": {
@@ -41,36 +41,36 @@ To configure a server, enter code something like this:
4141

4242
The components of this server definition are:
4343

44-
- **test** - an arbitrary name to identify this server
44+
- **test** - an arbitrary name to identify this server.
4545
- **webServer** - The collection of properties that define the web server.
4646
- **scheme** - The protocol used for connections.
47-
- **host** - the host for this server
48-
- **port** - the WebServer port number for this server
47+
- **host** - the host for this server.
48+
- **port** - the WebServer port number for this server.
4949
- **username** - the username to use in logging in to this server.
5050
- **password** - password for the specified username. Entering the password in this file is acceptable only in limited situations with very low need for security.
5151

52-
If you do not add a password to the server definition, anyone using the server needs to supply the password. Or, you can store the password securely in the system Keychain. The InterSystems Server Manager adds the following commands for managing stored passwords to the Command Palette:
52+
If you do not add a password to the server definition, anyone using the server needs to supply the password. Or, you can store the password securely in the system keychain. The InterSystems Server Manager extension adds to the Command Palette the following commands for managing stored passwords:
5353

54-
- **InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server
55-
- **InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password
54+
- **InterSystems Server Manager: Store Password in Keychain** - select a server and enter a password.
55+
- **InterSystems Server Manager: Clear Password from Keychain** - remove password for selected server.
5656

5757
## Configuring a Server Connection
5858

59-
Select InterSystems ObjectScript from the settings editor extensions list. You need to edit the server configuration in the settings.json file, so your click *Edit in settings.json* under the heading **Objectscript: conn**.
59+
Select InterSystems ObjectScript from the settings editor's Extensions list. You need to edit the server configuration in the settings.json file, so your click *Edit in settings.json* under the heading **Objectscript: conn**.
6060

6161
You should enter code something like this:
6262

6363
```json
6464
"objectscript.conn": {
65+
"server": "test",
6566
"ns": "USER",
66-
"server": "tst",
6767
"active": true,
6868
},
6969
```
7070
The components of this server definition are:
7171

72-
- **ns** - namespace to use on the server
73-
- **server** - server name as specified in the server configuration
72+
- **server** - server name as specified in the server configuration.
73+
- **ns** - namespace to use on the server.
7474
- **active** - specifies whether the connection is active.
7575

7676
## Configuring Export from Server
@@ -100,6 +100,6 @@ The components of this export definition are:
100100
- **generated** - Export generated source code files.
101101
- **filter** -
102102
- **category** - Specifies a category of source code to export: CLS = classes; RTN = routines; CSP = csp files; OTH = other. The default is *, export everything.
103-
- ****noStorage** - Strip the storage XML on export. This is useful for multiple systems.
103+
- **noStorage** - Strip the storage XML on export. This is useful for multiple systems.
104104
- **dontExportIfNoChanges** - Don't update the local file if the content is identical to what is on the server.
105105
- **maxConcurrentConnections** - The maximum number of export connections. (0 = Unlimited)

0 commit comments

Comments
 (0)