| Option | Description | Default |
|---|---|---|
| -i instance,
--instance instance |
Sets the name of the InterSystems IRIS instance to start or stop. (The instance in a container distributed by InterSystems is always named IRIS.) | IRIS |
| -d true|false,
--down true|false |
Stops InterSystems IRIS (using iris stop) on container shutdown | true |
| -u true|false,
--up true|false |
Starts InterSystems IRIS (using iris start) on container startup | true |
| -s true|false,
--nostu true|false |
Starts InterSystems IRIS in single-user access mode | false |
| -k key_file,
--key key_file |
Copies the specified InterSystems IRIS license key (see License Keys for InterSystems IRIS Containers) to the mgr/ subdirectory of the install directory. | none |
| -l log_file,
--log log_file |
Specifies a log file to redirect to standard output for monitoring using the docker logs command. | none |
| -b command,
--before command |
Sets the executable to run (such as a shell script) before starting InterSystems IRIS | none |
| -a command,
--after command |
Sets the executable to run after starting InterSystems IRIS | none |
| -e command,
--exit command |
Sets the executable to run after stopping InterSystems IRIS | none |
|
-c command --create command |
Execute a custom shell command before any other arguments are processed |
none |
|
-t command --terminate command |
Execute a custom shell command after any other arguments are processed |
none |
| -p password_file,
--password-file password_file |
Change the default password for the predefined InterSystems IRIS accounts to the string contained in the file, and then delete the file.
Important:
This option, which is described in Authentication and Passwords, is useful in scripts and other automation; when using it, bear in mind the risks of committing the password to a file for any significant length of time. Even when the default password has been changed, the first manual login to each predefined account after the container starts includes a mandatory default password change. |
none |
| --ISCAgent true|false |
Starts the ISCAgent on the default ISCAgent port, 2188, on container startup. If false, the ISCAgent does not start, and the --ISCAgentPort option is ignored. |
true |
| --ISCAgentPort NNNN |
Specifies the port to start the ISCAgent on. Can be used together with --ISCAgent true. |
2188 |
| --check-caps false | Disables automatic Linux capability check before InterSystems IRIS is started. | true |
| --version | Prints the iris-main version | N/A |
| -h,
--help |
Displays usage information and exits | N/A |
