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
+25Lines changed: 25 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,31 @@ Support SHIR version: 5.0 or later
6
6
7
7
For more information about Azure Data Factory, see [https://docs.microsoft.com/en-us/azure/data-factory/concepts-integration-runtime](https://docs.microsoft.com/en-us/azure/data-factory/concepts-integration-runtime)
8
8
9
+
# QuickStart
10
+
1. Prepare [Windows for containers](https://learn.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=dockerce)
11
+
2. Build the Windows container image in the project folder
12
+
```bash
13
+
> docker build . -t <image-name>
14
+
```
15
+
3. Run the container with specific arguments by passing environment variables
16
+
```bash
17
+
> docker run -d -e AUTH_KEY=<ir-authentication-key> \
18
+
[-e NODE_NAME=<ir-node-name>] \
19
+
[-e ENABLE_HA={true|false}] \
20
+
[-e HA_PORT=<port>] \
21
+
[-e ENABLE_AE={true|false}] \
22
+
[-e AE_TIME=<expiration-time-in-seconds>] \
23
+
<image-name>
24
+
```
25
+
### __Arguments list__
26
+
|Name|Description|Default
27
+
|---|---|---|
28
+
| `AUTH_KEY` | Required, the authentication key for the self-hosted integration runtime. | None
29
+
|`NODE_NAME`| Optional, the specified name of the node. | hostname |
30
+
|`ENABLE_HA`| Optional, the flag to enable high availability. | false |
31
+
|`HA_PORT`| Optional, the port for high availability. | 8060 |
32
+
|`ENABLE_AE`| Optional, the flag to enable offline nodes auto-expiration.<br/> Only works when `ENABLE_HA=true`. | false |
33
+
|`AE_TIME`| Optional, the expiration time for offline nodes in seconds. <br/>Should be no less than 600. | 600 |
0 commit comments