Skip to content

Commit 6d672ec

Browse files
mocsharpmocsharp
committed
update setup doc
1 parent 82ec2b7 commit 6d672ec

File tree

1 file changed

+84
-71
lines changed

1 file changed

+84
-71
lines changed

‎docs/setup/setup.md

Lines changed: 84 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ the repository and install it.
1919

2020
```bash
2121
# Download the CLI
22-
curl -LO https://url-to-cli
22+
curl -LO https://github.com/Project-MONAI/monai-deploy-informatics-gateway/releases/download/0.1.0/mig-cli-0.1.0-linux-x64.zip
23+
# Calculate the SHA256 checksum and verify the output with the checksum on the Releases page.
24+
sha256sum mig-cli-0.1.0-linux-x64.zip
2325
# Unzip the CLI
24-
unzip mig-cli-linux-0.1.0-x64.zip
25-
# Calculate the SHA256 checksum and compare with the one listed on the Releases page.
26-
sha256sum mig-cli
26+
unzip mig-cli-0.1.0-linux-x64.zip
2727
# Install it in bin
2828
sudo mv mig-cli /usr/local/bin
2929
```
@@ -32,11 +32,11 @@ sudo mv mig-cli /usr/local/bin
3232

3333
```powershell
3434
# Download the CLI
35-
curl -LO https://url-to-cli
35+
curl -LO https://github.com/Project-MONAI/monai-deploy-informatics-gateway/releases/download/0.1.0/mig-cli-0.1.0-win-x64.zip
36+
# Calculate the SHA256 checksum and verify the output with the checksum on the Releases page.
37+
Get-FileHash mig-cli-0.1.0-win-x64.zip
3638
# Unzip the CLI
37-
Expand-Archive -Path mig-cli-win-0.1.0-x64.zip
38-
# Calculate the SHA256 checksum and compare with the one listed on the Releases page.
39-
Get-FileHash mig-cli.exe
39+
Expand-Archive -Path mig-cli-0.1.0-win-x64.zip
4040
```
4141

4242
### Informatics Gateway Docker Image
@@ -56,8 +56,8 @@ docker pull ghcr.io/project-monai/monai-deploy-informatics-gateway:0.1.0
5656
Use the following command to initialize Informatics Gateway & default configuration:
5757

5858
```bash
59-
./mig-cli config init
60-
./mig-cli config endpoint http://localhost:5000
59+
mig-cli config init
60+
mig-cli config endpoint http://localhost:5000
6161
```
6262

6363

@@ -77,61 +77,8 @@ For a complete reference of the `appsettings.jon`, please refer to [Configuratio
7777

7878
The second command tells `mig-cli` where the endpoint is for the Informatics Gateway RESTful API.
7979

80-
## Start/Stop Informatics Gateway
81-
82-
To start or stop Informatics Gateway, use one of the following commands:
83-
84-
```bash
85-
./mig-cli start
86-
./mig-cli stop
87-
```
88-
89-
9080
> [!Note]
91-
> To see available commands simply execute `./mig-cli` or `mig-cli.exe`.
92-
93-
## Enable Incoming Associations
94-
95-
The next step is to configure Informatics Gateway enable receiving of DICOM instances from external DICOM devices.
96-
97-
1. Configure a listening AE Title to receive instances:
98-
99-
```bash
100-
./mig-cli aet add -a BrainAET -grouping 0020,000E, -t 30
101-
```
102-
103-
The command creates a new listening AE Title with AE Title `BrainAET`. The listening AE Title
104-
will be grouping instances by the Series Instance UID (0020,000E) with a timeout value of 30 seconds.
105-
106-
> [!Note]
107-
> `-grouping` is optional with default of 0020,000D.
108-
> `-t` is optional with default of 5 seconds.
109-
> For complete reference, please refer to the [Config API](../api/rest/config.md).
110-
111-
2. Enable receiving DICOM instances from an external DICOM devices:
112-
113-
```bash
114-
./mig-cli src add -n PACS-LA -a PACSLA001 --h 20.10.30.55 -p 104
115-
```
116-
117-
This command above tells Informatics Gateway to accept instances from AE Title `PACSLA001` at IP `20.10.30.55` and port `104`.
118-
119-
120-
> [!Note]
121-
> By default, Informatics Gateway blocks all unknown sources.
122-
> To allow all unknown sources, set `dicom>scp>rejectUnknownSources` to `false` in `appsettings.json`.
123-
124-
## Export Processed Results
125-
126-
If exporting via DIMSE is required, add a DICOM destination:
127-
128-
```bash
129-
./mig-cli dst add -a WORKSTATION1 -h 100.200.10.20 -p 104
130-
```
131-
132-
The command adds a DICOM export destination with AE Title `WORKSTATION1` at IP `100.200.10.20` and port `104`.
133-
134-
81+
> To see available commands simply execute `mig-cli` or `mig-cli.exe`.
13582
13683
## Storage Consideration & Configuration
13784

@@ -144,8 +91,8 @@ The temporary storage location, by default, is set to `/payloads` in the `appset
14491
To change the temporary storage location, please locate `./InformaticsGateway/storage/temporary` property in the `appsettings.json` file.
14592

14693
> [!Note]
147-
> Calculate the required temporary storage based on the number of studies and the size of each study.
148-
> Please also consider the AE Title timeout if the AE Title needs to wait a long time before assembling & uploading
94+
> Calculate the required temporary storage based on the number of studies and the size of each study.
95+
> Please also consider the AE Title timeout if the AE Title needs to wait a long time before assembling & uploading
14996
> the payload for final storage.
15097
15198

@@ -171,10 +118,10 @@ Locate the storage section of the configuration in `appsettings.json`:
171118
"storage": {
172119
"storageServiceCredentials": {
173120
"endpoint": "192.168.1.1:9000", # IP & port to MinIO instance
174-
"accessKey": "admin", # Access key or username
175-
"accessToken": "password" # Access token or password
121+
"accessKey": "admin", # Access key or username
122+
"accessToken": "password" # Access token or password
176123
},
177-
"storageService": "Monai.Deploy.InformaticsGateway.Storage.MinIoStorageService, Monai.Deploy.InformaticsGateway.Storage.MinIo", # Fully qualified type name of the storage service
124+
"storageService": "Monai.Deploy.InformaticsGateway.Storage.MinIoStorageService, Monai.Deploy.InformaticsGateway.Storage.MinIo", # Fully qualified type name of the storage service
178125
"securedConnection": false, # Indicates if a secured connection is required to access MinIO
179126
"storageServiceBucketName": "igbucket" # The name of the bucket where data is uploaded to
180127
},
@@ -186,11 +133,11 @@ Locate the storage section of the configuration in `appsettings.json`:
186133
### Message broker
187134

188135
Informatics Gateway communicates with other MONAI Deploy components through a message broker. The default messaging service
189-
included is provided by [RabbitMQ](https://www.rabbitmq.com/). To integrate with another storage service provider, please refer
136+
included is provided by [RabbitMQ](https://www.rabbitmq.com/). To integrate with another storage service provider, please refer
190137
to the [Data Storage](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/blob/main/guidelines/srs.md#message-broker) section of the SRS.
191138

192139
To use the default messaging service, please download and install RabbitMQ by following the
193-
[Get Started](https://www.rabbitmq.com/#getstarted) page.
140+
[Get Started](https://www.rabbitmq.com/#getstarted) page.
194141

195142
Before launching Informatics Gateway, update `appsettings.json` to configure the publisher and subscriber settings.
196143
IG publishes all messages to an *exchange* under the specified *virtual host*. Therefore, please confirm the values before starting
@@ -219,3 +166,69 @@ Informatics Gateway.
219166
}
220167
}
221168
```
169+
170+
## Start/Stop Informatics Gateway
171+
172+
To start or stop Informatics Gateway, update the value of `DockerImagePrefix` in `appsettings.json` with the repository name of the Docker image:
173+
174+
```json
175+
{
176+
...,
177+
"Cli": {
178+
"DockerImagePrefix": "ghcr.io/project-monai/monai-deploy-informatics-gateway"
179+
}
180+
}
181+
```
182+
183+
184+
Lastly, use one of the following commands start or stop Informatics Gateway:
185+
186+
```bash
187+
mig-cli start
188+
mig-cli stop
189+
```
190+
191+
192+
## Enable Incoming Associations
193+
194+
The next step is to configure Informatics Gateway enable receiving of DICOM instances from external DICOM devices.
195+
196+
1. Configure a listening AE Title to receive instances:
197+
198+
```bash
199+
mig-cli aet add -a BrainAET -grouping 0020,000E, -t 30
200+
```
201+
202+
The command creates a new listening AE Title with AE Title `BrainAET`. The listening AE Title
203+
will be grouping instances by the Series Instance UID (0020,000E) with a timeout value of 30 seconds.
204+
205+
> [!Note]
206+
> `-grouping` is optional with default of 0020,000D.
207+
> `-t` is optional with default of 5 seconds.
208+
> For complete reference, please refer to the [Config API](../api/rest/config.md).
209+
210+
2. Enable receiving DICOM instances from an external DICOM devices:
211+
212+
```bash
213+
mig-cli src add -n PACS-LA -a PACSLA001 --h 20.10.30.55
214+
```
215+
216+
This command above tells Informatics Gateway to accept instances from AE Title `PACSLA001` at IP `20.10.30.55` and port `104`.
217+
218+
> [!Note]
219+
> By default, Informatics Gateway blocks all unknown sources.
220+
> To allow all unknown sources, set `dicom>scp>rejectUnknownSources` to `false` in `appsettings.json`.
221+
222+
> [!WARNING]
223+
> Informatics Gateway validates both the source IP address and AE Title when `rejectUnknownSources` is set to `true`.
224+
> When running Informatics Gateway in a container and data is coming from the localhost, the IP address may not be the host's IP address. In such a case, open the log file and locate the association that failed; the log should indicate the correct IP address under `Remote host`.
225+
226+
## Export Processed Results
227+
228+
If exporting via DIMSE is required, add a DICOM destination:
229+
230+
```bash
231+
mig-cli dst add -a WORKSTATION1 -h 100.200.10.20 -p 104
232+
```
233+
234+
The command adds a DICOM export destination with AE Title `WORKSTATION1` at IP `100.200.10.20` and port `104`.

0 commit comments

Comments
 (0)