Skip to content

Commit 40b420a

Browse files
author
Qi Xiao
committed
Add quickstart in readme
1 parent 6d6eb12 commit 40b420a

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,31 @@ Support SHIR version: 5.0 or later
66

77
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)
88

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 |
934

1035
# Contributing
1136

0 commit comments

Comments
 (0)