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
status MONAI Deploy Informatics Gateway service status
38
+
```
39
+
40
+
## Help & Logging
41
+
42
+
The verbose switch `-v` and the help switch `-h` are available for all commands.
43
+
44
+
For example:
45
+
46
+
```bash
47
+
> mig-cli aet add -h
48
+
49
+
add
50
+
Add a new SCP Application Entity
51
+
52
+
Usage:
53
+
mig-cli [options] aet add
54
+
55
+
Options:
56
+
-n, --name <name> Name of the SCP Application Entity
57
+
-a, --aetitle <aetitle> (REQUIRED) AE Title of the SCP
58
+
-g, --grouping <grouping> DICOM tag used to group instances [default: 0020,000D]
59
+
-t, --timeout <timeout> Timeout, in seconds, to waitfor instances [default: 5]
60
+
-w, --workflows <workflows> A space separated list of workflow names or IDs to be associated with the SCP AE Title [default: ]
61
+
-i, --ignored-sops <ignored-sops> A space separated list of SOP Class UIDs to be ignoredS [default: ]
62
+
-v, --verbose Show verbose output [default: False]
63
+
-?, -h, --help Show help and usage information
64
+
```
65
+
66
+
67
+
## Controlling Informatics Gateway
68
+
69
+
Use the following commands to start, stop or restart the Informatics Gateway:
70
+
71
+
```bash
72
+
mig-cli start
73
+
mig-cli stop
74
+
mig-cli restart
75
+
```
76
+
77
+
## System Health
78
+
79
+
`mig-cli status` displays status of all running services inside the Informatics Gateway & number of active associations.
80
+
81
+
```bash
82
+
> mig-cli status
83
+
84
+
info: Number of active DIMSE connections: 8
85
+
info: Service Status:
86
+
info: space Reclaimer Service: Running
87
+
info: dicom SCP Service: Running
88
+
info: dicoMweb Export Service: Running
89
+
info: dicom Export Service: Running
90
+
info: data Retrieval Service: Running
91
+
info: payload Notification Service: Running
92
+
```
93
+
94
+
## Configure AE Titles
95
+
96
+
The CLI provides three commands to configure the listening AE Titles, sources and destinations. Each command allows you to add (`add`), delete (`rm`) and list (`list`) configured AE Titles. Use the `-h` switch for additional options.
97
+
98
+
### Listening AE Titles
99
+
100
+
```bash
101
+
> mig-cli aet
102
+
103
+
Description:
104
+
Configure SCP Application Entities
105
+
106
+
Usage:
107
+
mig-cli aet [command] [options]
108
+
109
+
Options:
110
+
-?, -h, --help Show help and usage information
111
+
-v, --verbose Show verbose output [default: False]
112
+
113
+
Commands:
114
+
add Add a new SCP Application Entity
115
+
del, rm Remove a SCP Application Entity
116
+
list, ls List all SCP Application Entities
117
+
```
118
+
119
+
### Source AE Titles
120
+
121
+
```bash
122
+
> mig-cli src
123
+
124
+
Description:
125
+
Configure DICOM sources
126
+
127
+
Usage:
128
+
mig-cli src [command] [options]
129
+
130
+
Options:
131
+
-?, -h, --help Show help and usage information
132
+
-v, --verbose Show verbose output [default: False]
133
+
134
+
Commands:
135
+
add Add a new DICOM source
136
+
del, rm Remove a DICOM source
137
+
list, ls List all DICOM sources
138
+
139
+
```
140
+
141
+
### Destination/Export AE Titles
142
+
143
+
```bash
144
+
> mig-cli dst
145
+
146
+
Description:
147
+
Configure DICOM destinations
148
+
149
+
Usage:
150
+
mig-cli dst [command] [options]
151
+
152
+
Options:
153
+
-?, -h, --help Show help and usage information
154
+
-v, --verbose Show verbose output [default: False]
| dicom | DICOM DIMSE service configuration options |[DicomConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DicomConfiguration)|
36
-
| dicomWeb | DICOMweb service configuration options |[DicomWebConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DicomWebConfiguration)|
37
-
| export | Export service configuration options |[DataExportConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DataExportConfiguration)|
38
-
| fhir | FHIR service configuration options |[FhirConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.FhirConfiguration)|
39
-
| storage | Storage configuration options, including storage service and disk usage monitoring |[StorageConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.StorageConfiguration)|
| dicom | DICOM DIMSE service configuration options |[DicomConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DicomConfiguration)|
36
+
| dicomWeb | DICOMweb service configuration options |[DicomWebConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DicomWebConfiguration)|
37
+
| export | Export service configuration options |[DataExportConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.DataExportConfiguration)|
38
+
| fhir | FHIR service configuration options |[FhirConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.FhirConfiguration)|
39
+
| storage | Storage configuration options, including storage service and disk usage monitoring |[StorageConfiguration](xref:Monai.Deploy.InformaticsGateway.Configuration.StorageConfiguration)|
@@ -62,12 +62,12 @@ Use the following commands to initialize the Informatics Gateway and default con
62
62
63
63
```bash
64
64
mig-cli config init
65
-
mig-cli config endpoint http://localhost:5000
65
+
mig-cli config endpoint http://localhost:5000#skip if running locally
66
66
```
67
67
68
68
```powershell
69
69
mig-cli.exe config init
70
-
mig-cli.exe config endpoint http://localhost:5000
70
+
mig-cli.exe config endpoint http://localhost:5000 #skip if running locally
71
71
```
72
72
73
73
The first command extracts the default `appsettings.json` file into the home directory:
@@ -83,6 +83,7 @@ The second command passes the endpoint for the Informatics Gateway RESTful API t
83
83
84
84
> [!Note]
85
85
> To see available commands, simply execute `mig-cli` or `mig-cli.exe`.
86
+
> Refer to [CLI](./cli.md) for complete reference.
86
87
87
88
## Storage Consideration & Configuration
88
89
@@ -106,6 +107,7 @@ To change the temporary storage location, locate the `./InformaticsGateway/stora
106
107
> size of a single study multiplied by the number of configured AE Titles.
107
108
108
109
### Shared Storage
110
+
109
111
Informatics Gateway includes MinIO as the default storage service provider. To integrate with another storage service provider, please refer to the [Data Storage](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/blob/main/guidelines/srs.md#data-storage) section of the SRS.
110
112
111
113
Download and install MinIO by following the [quickstart guide](https://docs.min.io/docs/minio-quickstart-guide.html). Once MinIO is installed and configured, modify the storage configuration to enable communication between the Informatics Gateway and MinIO.
@@ -121,11 +123,15 @@ Locate the storage section of the configuration in `appsettings.json`:
121
123
"dicom": { ... },
122
124
"storage": {
123
125
"storageServiceCredentials": {
124
-
"endpoint": "192.168.1.1:9000", # IP & port to MinIO instance
126
+
"endpoint": "localhost:9000", # IP & port to MinIO instance
125
127
"accessKey": "admin", # Access key or username
126
-
"accessToken": "password"# Access token or password
128
+
"accessToken": "password", # Access token or password
129
+
"securedConnection": false, # Indicates if connection should be secured using HTTPS
130
+
"region": "local", # Region
131
+
"executableLocation": "/bin/mc", # Path to minio client
132
+
"serviceName": "MinIO"# Name of the service
127
133
},
128
-
"storageService": "Monai.Deploy.InformaticsGateway.Storage.MinIoStorageService, Monai.Deploy.InformaticsGateway.Storage.MinIo", # Fully qualified type name of the storage service
134
+
"storageService": "Monai.Deploy.Storage.MinIO.MinIoStorageService, Monai.Deploy.Storage.MinIO", # Fully qualified type name of the storage service
129
135
"securedConnection": false, # Indicates if a secured connection is required to access MinIO
130
136
"storageServiceBucketName": "igbucket"# The name of the bucket where data is uploaded to
131
137
},
@@ -134,6 +140,20 @@ Locate the storage section of the configuration in `appsettings.json`:
134
140
}
135
141
```
136
142
143
+
#### Install the Stoage Plug-in
144
+
145
+
The default plug-in configured as shown above is __MinIO__.
146
+
147
+
To install the default MinIO plug-in, download the plug-in `Monai.Deploy.Storage.MinIO.zip` from [MONAI Deploy Storage](https://github.com/Project-MONAI/monai-deploy-storage/releases)
148
+
and unzip the files to the `plug-ins` directory in your home directory:
149
+
150
+
* Linux: `~/.mig/plug-ins`
151
+
* Windows: `C:\Users\[username]\.mig\plug-ins`
152
+
153
+
> [!Note]
154
+
> If a plug-in other than MinIO is used, please do update `storageService` in the appsettings.json file.
155
+
156
+
137
157
### Message broker
138
158
139
159
The nformatics Gateway communicates with other MONAI Deploy components through a message broker. The default messaging service
The default plug-in configured as shown above is __RabbitMQ__.
199
+
200
+
To install the default RabbitMQ plug-in, download the plug-in `Monai.Deploy.Messaging.RabbitMQ.zip` from [MONAI Deploy Messaging](https://github.com/Project-MONAI/monai-deploy-messaging/releases)
201
+
and unzip the files to the `plug-ins` directory in your home directory:
202
+
203
+
* Linux: `~/.mig/plug-ins`
204
+
* Windows: `C:\Users\[username]\.mig\plug-ins`
205
+
206
+
> [!Note]
207
+
> If a plug-in other than Rabbit is used, please do update `publisherServiceAssemblyName` & `subscriberServiceAssemblyName` in the appsettings.json file.
208
+
209
+
174
210
## Start/Stop Informatics Gateway
175
211
176
-
To start or stop the Informatics Gateway, update the value of `DockerImagePrefix` in `appsettings.json` with the repository name of the Docker image:
212
+
To start or stop the Informatics Gateway, update the value of `DockerImagePrefix` in `appsettings.json` with the repository name of the Docker image (default value shown below):
0 commit comments