Skip to content

Commit bb02897

Browse files
author
Jani Giannoudis
committed
updated README.md
1 parent 07911dc commit bb02897

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,20 @@ The following command files are located in the installation start folder and mus
5454
## Data Storage
5555
All configuration data is stored in the operating system's environment variables:
5656

57-
| Variable | Description | Required | Used by |
58-
|:--|:--|:--:|:--|
59-
| `PayrollDatabaseConnection` | The database connection string | yes | Backend |
60-
| `PayrollApiConnection` | The Backend connection string | yes | Web App, Console |
61-
| `PayrollWebAppConnection` | The Web Application connection string | no | Admin App <sup>1)</sup> |
62-
| `PayrollApiKey` | The payroll API key | no | Backend |
57+
| Variable | Description | Required | Read by | Set by |
58+
|:--|:--|:--:|:--|:--|
59+
| `PayrollApiKey` | The backend API access key | no | Backend | Backend |
60+
| `PayrollDatabaseConnection` | The database connection string <sup>1)</sup> | yes | Backend | Backend |
61+
| `PayrollApiConnection` | The backend connection string <sup>2)</sup> | yes | Backend | Web App, Console |
62+
| `PayrollWebAppConnection` | The Web App connection string <sup>3)</sup> | no | Web App | Admin App <sup>4)</sup> |
6363

64-
<sup>1)</sup> Used to start the web application server within the admin application.<br/>
64+
<sup>1)</sup> Example: `Server=localhost; Database=PayrollEngine; Integrated Security=true; TrustServerCertificate=true; Timeout=30;`.<br />
65+
<sup>2)</sup> Example: `BaseUrl=https://localhost; Port=44354; Timeout=02:46:40; ApiKey=MyApiKey;`.<br/>
66+
<sup>3)</sup> Example: `BaseUrl=https://localhost; Port=7179;`.<br/>
67+
<sup>4)</sup> Used to start the web application server within the admin application.<br/>
68+
69+
The `PayrollApiKey` parameter forces a key when accessing the Backend API. This value must be set to restrict access to the API server. Once the API key has been defined, it must be included in the client connection string.
6570

66-
The `PayrollApiKey` parameter forces a key when accessing the Backend API. This value must be set to restrict access to the API server. Once the API key is defined, only applications that know this key will be able to use the API.
6771

6872
## Application Configuration
6973
The application configuration file `appsetings.json` contains the following settings:

0 commit comments

Comments
 (0)