Skip to main content
Previous sectionNext section

Installing InterSystems IRIS on UNIX®, Linux, and macOS

This chapter describes how to install InterSystems IRIS® data platform on a UNIX®, Linux, or macOS system. It assumes that you are familiar with UNIX®, Linux, and macOS directory structures, utilities, and commands.

Before Installing

Before beginning the installation, be sure you have read all the information that applies to your platform in the “Preparing to Install InterSystems IRIS” chapter of this guide. Additionally, review the following topics:

Uncompressing the Installation Kit

If your installation kit is in the form of a .tar file, for example iris-2019.3.0.710.0-lnxrhx64.tar.gz, uncompress the file into a temporary directory to avoid permissions issues, as shown in the following example.

# mkdir /tmp/iriskit 
# chmod og+rx /tmp/iriskit 
# gunzip -c /download/iris-2019.3.0.710.0-lnxrhx64.tar.gz | ( cd /tmp/iriskit ; tar xf - )
Copy code to clipboard

The installation files uncompress into a directory with the same name as the .tar file, for example /tmp/iriskit/iris-2019.3.0.710.0-lnxrhx64.

Important:

Do not uncompress the file into or run InterSystems IRIS installation from the /home directory, or any of its subdirectories. Additionally, the pathname of the temporary directory cannot contain spaces.

Note:

Because legacy tar commands may fail silently if they encounter long pathnames, InterSystems recommends that you use GNU tar to untar this file. To determine if your tar command is a GNU tar, run tar --version.

Determining Owners and Groups

The installation process prompts for the following user and group information:

  • Owner of the instance

  • Effective user for the InterSystems IRIS superserver and its jobs

  • Effective group for InterSystems IRIS processes

  • Group allowed to start and stop the instance

For more information about these categories, see the UNIX® User and Group Identifications section in the “Using InterSystems IRIS on UNIX®, Linux, and macOS” chapter of System Administration Guide.

Important:

The user you identify as the owner of the instance must have read and execute access to the installation kit during the installation process

In addition, during installation InterSystems IRIS must set user, group, and other permissions on files that it installs; therefore, do not modify the default umask value during installation.

The user account you identify as Owner of the instance and the group you identify as Group allowed to start and stop the instance must both exist before you begin installation. If an entry you provide at one of these prompts does not exist, the prompt is repeated, so verify that the user and group you intend to provide exist before you begin installation.

If your operating system contains the useradd and groupadd utilities, the system creates the account for the effective user for InterSystems IRIS superserver and the effective group for InterSystems IRIS processes, if the entries you provide do not exist. However, if these utilities are not present and an entry you provide does not exist, the prompt is repeated. If you are not sure that your system has these utilities, verify that the user and group you intend to provide exist before you begin installation.

Note:

If your operating system uses Network Information Services (NIS) or another form of network-based user/group database, the groupadd and useradd utilities may create a local user and/or group that could conflict with existing entries in the network database. To avoid this problem, it may be best to create the InterSystems IRIS effective group and effective user in your network database using the appropriate administration tools prior to beginning installation, rather than allowing the utilities to create them.

Tools used on UNIX® operating systems to display process ownership may or may not show effective versus real ownership. See the “UNIX® Users, Groups and Permissions” chapter of the System Administration Guide for details on how InterSystems IRIS assigns permissions.

InterSystems IRIS Installation

This section contains the procedure to install InterSystems IRIS on a UNIX® platform. There are two ways to run an attended IRIS installation, as explained in the following sections:

Standard InterSystems IRIS Installation Procedure

Standard InterSystems IRIS installation consists of a set of modular package scripts. The scripts conditionally prompt for information based on input to previous steps, your system environment, and whether or not you are upgrading an existing instance. The first stage of the installation stores all gathered information about the install in a parameter file. You then confirm the specifics of the installation before the actual install takes place. The final phase performs the operations that are contingent upon a successful install, such as instance startup.

The installation script, irisinstall, does the following:

  • Installs the InterSystems IRIS system manager databases.

  • Starts InterSystems IRIS in installation mode.

  • Installs InterSystems IRIS system manager globals and routines.

  • Shuts down InterSystems IRIS and restarts using the default configuration file (iris.cpf). Upgrade installations restart using their updated configuration files.

Note:

If the profile of the user executing irisinstall has a value set for the CDPATH variable, the installation fails.

To perform the standard InterSystems IRIS server installation, follow the installation procedure.

  1. Log in as user ID root. The standard InterSystems IRIS installation must be run by a user with root privileges. It is acceptable to su (superuser) to root while logged in from another account.

    Note:

    If root is unavailable, you can perform a non-standard, limited InterSystems IRIS installation as a nonroot user. For details, read the Installing InterSystems IRIS as a Nonroot User section below before continuing the installation procedure.

  2. As a user with root privileges, start the installation procedure by running the irisinstall script, located at the top level of the installation files:

    # /<pathname>/irisinstall
    Copy code to clipboard

    where pathname is the location of the installation kit, typically the temporary directory to which you have extracted the kit, as described in the Uncompressing the Installation Kit section of this chapter.

  3. The installation script identifies your system type and validates it against the installation type on the distribution media. If your system supports more than one type, for example, 32-bit and 64-bit, or if the install script cannot identify your system type, it prompts you with additional questions. If your system type does not match that on the distribution media, the installation stops. Contact the InterSystems Worldwide Response Center (WRC) for help in obtaining the correct distribution.

  4. The script displays a list of any existing InterSystems IRIS instances on the host.

  5. At the Enter instance name: prompt, enter an instance name, using only alphanumeric characters, underscores, and dashes. If an instance with this name already exists, the program asks if you wish to upgrade it. If no such instance exists, it asks if you wish to create it and asks you to specify its installation directory. If the directory you specify does not exist, it asks if you want to create it. The default answer to each of these questions is Yes. Be sure to review the Installation Directory section in the “Preparing to Install InterSystems IRIS” chapter for more important information about choosing an installation directory.

    Note:

    If you select an existing instance that is of the same InterSystems IRIS version as the installation kit, the installation is considered an upgrade, and you can use the Custom selection, described in the following step, to modify the installed client components and certain settings.

    The InterSystems IRIS registry directory, /usr/local/etc/irissys, is always created along with the InterSystems IRIS installation directory.

  6. Next, select the installation type from the choices:

    Select installation type.
        1) Development - Install IRIS server and all language bindings
        2) Server only - Install IRIS server
        3) Custom - Choose components to install
    Setup type <1>? 
    
    Note:

    If the CSP Gateway is already installed on your system when you install the Web Gateway, the installer automatically upgrades the CSP Gateway to the Web Gateway. For details, see Preexisting CSP Gateway.

    Review the Setup Type section in the “Preparing to Install InterSystems IRIS” chapter of this book to decide which installation type is appropriate. The default for new instances is Development, which contains a complete installation of InterSystems IRIS; if you are upgrading an existing instance, the default is the option that was used to originally install the instance.

    Note:

    If you choose the Custom option, see the InterSystems IRIS Custom Installation section for additional installation steps.

  7. Next, indicate whether to install InterSystems IRIS with 8-bit or Unicode character support. On upgrade, you can convert from 8-bit to Unicode, but not the reverse.

  8. For new instances, you must next specify security settings. (Security settings cannot be changed when upgrading.)

    First, decide how restrictive you want the initial InterSystems security settings to be: choose from Minimal (1), Normal (2), and Locked Down (3). For a detailed explanation of these security settings, see the Initial InterSystems Security Settings section in the “Preparing to Install InterSystems IRIS” chapter of this book.

    Minimal is only available for InterSystems IRIS installations.. If you choose this, you can skip the next step; the installer sets the owner of the instance as root.

    Important:

    There are additional security settings that you can choose only through a custom install. See InterSystems IRIS Custom Installation for details.

  9. If you enter 2 or 3, the script asks for additional information:

    1. Instance owner — Enter the username of the account under which to run InterSystems IRIS processes. See Determining Owners and Groups for information about this account. Once InterSystems IRIS is installed, you cannot change the owner of the instance.

    2. Password for the instance owner — Enter the password for the username you entered at the previous prompt, and enter it again to confirm it. A privileged InterSystems IRIS user account is created for this user with the %All role.

      This password is used not only for the InterSystems IRIS privileged user account, but also for the _SYSTEM, Admin, and SuperUser predefined user accounts. For more details on these predefined users, see the Predefined User Accounts section of the “Users” chapter of the Security Administration Guide.

    3. Password for the CSPSystem predefined user.

    Note:

    The passwords must meet the criteria described in the Initial User Security Settings table. Passwords entered during this procedure cannot include space, tab, or backslash characters; the installer reject such passwords.

  10. At this point in the installation, you are asked which group should be allowed to start and stop InterSystems IRIS. Only one group can have these privileges, and it must be a valid group on the machine; see Determine Owners and Groups for more information. Enter the name or group ID number of an existing group; InterSystems IRIS verifies that the group exists before proceeding.

  11. Finally, for a new instance, or if the script does not detect an iris.key file in the mgr directory of an existing instance when upgrading, you are prompted for a license key file. If you specify a valid key, the license is automatically activated and the license key copied to the instance’s mgr directory during installation, and no further activation procedure is required. If you do not specify a license key, you can activate a license key following installation. See Activating a License Key in the “Managing InterSystems IRIS Licensing” chapter of the System Administration Guide for information about licenses, license keys and activation.

  12. Review your installation options and press enter to proceed with the installation. File copying does not begin until you answer Yes.

When the installation completes, you are directed to the appropriate URL for the Management Portal to manage your InterSystems IRIS system. See the “Using the Management Portal” chapter of the System Administration Guide for more information.

Continue to the Post-Installation Tasks section to complete the installation process.

InterSystems IRIS Custom Installation

If you choose a custom installation, you must answer additional questions throughout the procedure about installing several individual components. The defaults appear in brackets before the question mark (?); press Enter to accept the default.

  • Superserver and Web Server Ports — You can choose to let InterSystems IRIS assign the port numbers, or you can enter custom port numbers. Upgrade installs do not offer this choice; they keep the port numbers of the original instance. Review the Port Numbers section in the “Preparing to Install InterSystems IRIS” chapter of this book for more information.

  • Web Gateway and External Web Sever — You can configure the Web Gateway to use a supported external web server. Answer Yes and then answer additional web server configuration questions to configure the Web Gateway after the InterSystems IRIS installation completes.

  • Additional Security Options — If you chose Normal or Locked Down initial security, you have the option of configuring additional security settings (minimal installations use the default IDs):

    • Effective group for InterSystems IRIS — InterSystems IRIS internal effective group ID, which also has all privileges to all files and executables in the installation. For maximum security, no actual users should belong to this group. (Defaults to irisusr.)

    • Effective user for the InterSystems IRIS superserver — Effective user ID for processes started by the superserver and Job servers. Again, for maximum security, no actual users should have this user ID. (Defaults to irisusr.)

    See Determine Owners and Groups for additional information.

  • Client Components — You have the option of installing one client component. This client component may not be supported on all platforms.

    Client component selection
         [*]        1) IRIS shared library support (callin)
                    +) Select all
    
    Enter the number of each component you wish to install.
    Enter the number of an already selected component to deselect it.
    Multiple selections can be separated by spaces.
    Enter a blank line to continue.
    

    You can use the plus sign (+) to select all components.

    Note:

    UNIX® InterSystems IRIS kits always install client components.

See the following guides for more information on the specific client components in the selection list:

Installing as a Nonroot User

Although InterSystems IRIS is typically installed as root, it is possible for an instance to be installed and run by another user on a system on which root is not available. The operation in such an environment is identical to that of standard InterSystems IRIS instances, except:

  • The IRISSYS environment variable must be defined as an existing directory writable by the installing user, and must be present during installation and all instance operations.

  • The instance can be operated only by the installing user.

  • All InterSystems IRIS executables and processes run as the installing user.

  • All instance files, including the registry, are owned and can be read, written, and executed by the installing user only. There is no group access.

    For example, where a standard instance might have:

    -rws--x--- 5 root develop 43282 Aug 28 07:52 irismgr
    -r-x--s--x 1 <nonroot-user> irisusr 23058 Aug 28 07:52 irisuxsession
    Copy code to clipboard

    a nonroot instance would have:

    -rwx------ 5 <installing-user> develop 43282 Aug 28 07:52 irismgr
    -r-x------ 1 <installing-user> develop 23058 Aug 28 07:52 irisuxsession
    Copy code to clipboard

The registry is located in the directory specified by IRISSYS, and nonroot instances are found in that registry. (The iris executable is also in that directory.) Users who employ IRISSYS as a registry location for root-installed instances are unaffected. Note, however, that only nonroot instances may be in the nonroot registry. Any attempt to access a standard instance from a nonroot registry fails. Conversely, a nonroot instance may be defined in a root-registry, but an attempt to access the instance by any user other than the owner fails.

Note:

InterSystems recommends that the registry be placed in a directory that is local to the machine on which the instance is installed, not an NFS directory. Note that the standard location /usr/local/etc is such a directory.

Nonroot installation differs from standard installation in several ways:

  • There is no option to configure the Web Gateway to use an external web server.

  • The ISCAgent is installed in the directory specified by IRISSYS.

    Note:

    For information about starting the ISCAgent for a nonroot instance, see Starting the ISCAgent for Nonroot Instances on UNIX®/Linux and macOS Systems in the “Mirroring” chapter of the High Availability Guide.

    Use of a mirror Virtual IP, as described in Planning a Mirror Virtual IP (VIP) in the “Mirroring” chapter, is not possible with a nonroot instance.

  • The instance owner and the group allowed to start and stop InterSystems IRIS are not specified.

  • There is no configuration of advanced security.

Client-Only InterSystems IRIS Installation Procedure

The InterSystems IRIS distribution contains a separate script to install a client-only version of InterSystems IRIS. The installation process is fairly simple. You do not need to install as root. The files from this install have the user and group permissions of the installing user. To perform the InterSystems IRIS client installation:

  1. Start the installation procedure by running the irisinstall_client script, located at the top level of the installation files:

    # /<pathname>/irisinstall
    
    Copy code to clipboard

    where pathname is the location of the installation kit, typically the temporary directory to which you have extracted the kit, as described in the Uncompressing the Installation Kit section of this chapter.

  2. The installation script identifies your system type and validates it against the installation type on the distribution media. If your system supports more than one type, for example, 32-bit and 64-bit, or if the install script cannot identify your system type, it prompts you with additional questions. If your system type does not match that on the distribution media, the installation stops. Contact the InterSystems Worldwide Response Center (WRC) for help in obtaining the correct distribution.

  3. At the Enter a destination directory for client components prompt, specify the installation directory. If the directory you specify does not exist, it asks if you want to create it. The default answer is Yes. Be sure to review the Installation Directory section in the “Preparing to Install InterSystems IRIS” chapter for more important information about choosing an installation directory. Press Enter to continue with the installation.

    Note:

    The InterSystems IRIS registry directory, /usr/local/etc/irissys, is always created along with the InterSystems IRIS installation directory.

  4. Choose from the available client component options. Components that require the InterSystems IRIS server on the same machine do not appear in the list. For example:

    Client component selection
    
       [*]    1) ODBC client
       [*]    2) C++ binding
       [*]    3) C++ SDK
              +) Select all
    
    Enter the number of each component you wish to install.
    Enter the number of an already selected component to deselect it.
    Multiple selections can be separated by spaces.
    Enter a blank line to continue.
    

    You can use the plus sign (+) to select all components.

The list of client-only components does not include the shared library support or the light C++ binding because these components require a server installation.

You cannot use this script to update client components in server installations. Use the irisinstall script instead.

See the following guides in the InterSystems IRIS Language Bindings set for more information on the specific client components in the selection list:

Continue to the Post-Installation Tasks section to complete the installation process.

Unattended InterSystems IRIS Installation

You can perform unattended installation of InterSystems IRIS instances on your systems using the irisinstall_silent script. Whereas a standard install operation obtains the required specifications and selections in the form of user responses to prompts, an unattended operation gets this information from the configuration parameters and the packages specified on the irisinstall_silent command line. Each specified package represents an InterSystems IRIS component; the installation scripts for each component are contained in the packages directory below the directory containing the irisinstall_silent script.

The general format for the irisinstall_silent command line is to precede the command itself by setting environment variables to define the installation parameters, as follows:

sudo ISC_PACKAGE_INSTANCENAME="<instancename>"
 ISC_PACKAGE_INSTALLDIR="<installdir>"
 ISC_PACKAGE_PLATFORM="<platform>" ISC_PACKAGE_UNICODE="Y"|"N"
 ISC_PACKAGE_INITIAL_SECURITY="Minimal"|"Normal"|"Locked Down"
 ISC_PACKAGE_MGRUSER="<instanceowner>" ISC_PACKAGE_MGRGROUP="<group>"
 ISC_PACKAGE_USER_PASSWORD="<pwd>"  ISC_PACKAGE_CSPSYSTEM_PASSWORD="<pwd>"
 ISC_PACKAGE_IRISUSER="<user>" ISC_PACKAGE_IRISGROUP="<group>"
 ISC_PACKAGE_CLIENT_COMPONENTS="<component1> <component2> ..."
 ISC_PACKAGE_STARTIRIS="Y"|"N"
 ./irisinstall_silent [<pkg> ...]
Copy code to clipboard
Note:

If you are attempting to install InterSystems IRIS without root permissions, refer to the Installing as a Nonroot User section for additional details.

This section discusses the following topics:

Unattended Installation Parameters

The following table describes the parameters used with the irisinstall_silent script in unattended installation.

Unattended Installation Parameters
Parameter Description
ISC_CPF_MERGE_FILE=<location>"
Specifies the location of the CPF merge file when performing a CPF merge.
For more information, see the Creating and Using a CPF Merge File topic in Configuration Parameter File Reference.
ISC_PACKAGE_INSTANCENAME="<instancename>"
(Required)
Specifies the name of the instance to be installed or upgraded: if the instance does not exist, this is a new installation; if it does exist, this is an upgrade. For example:
ISC_PACKAGE_INSTANCENAME="MyIris"
Note:
If this a new install, the ISC_PACKAGE_INSTALLDIR parameter is required.
ISC_PACKAGE_INSTALLDIR="<installdir>"
(Required for new instances)
Specifies the installation directory for the new instance to be installed; for example:
ISC_PACKAGE_INSTALLDIR="/opt/MyIris"
If the specified directory does not exist, the installation attempts to create it. This parameter is ignored if you are upgrading an installation.
Note:
Review the Installation Directory section of this book for information about choosing an installation directory.
ISC_PACKAGE_PLATFORM="<platform>"
(Optional)
Specifies a platform when installing InterSystems IRIS on a system that supports multiple platforms on the same hardware.
Important:
Currently, the only ISC-supported platform that supports this feature is IBM AIX®; valid values are ppc (32–bit system) and ppc64 (64–bit system). For example:
ISC_PACKAGE_PLATFORM="ppc"
Note:
By default, the platform is auto-detected. If the parameter is omitted and no supported platform is detected, unattended installation terminates with an error.
ISC_PACKAGE_UNICODE="Y"|"N"
(Optional)
Specifies whether or not this is a UNICODE installation; valid values are Y or N. See Character Width Settings for more information.
ISC_PACKAGE_INITIAL_SECURITY="Minimal"|"Normal"|"LockedDown"
(Optional)
Specifies the initial security setting for the installation; valid values are: "Minimal", "Normal", or "LockedDown".
Note:
"Minimal" is only available for InterSystems IRIS installations.
If it is set to "Normal" or "LockedDown", ISC_PACKAGE_USER_PASSWORD is required.
ISC_PACKAGE_MGRUSER="<user>"
(Optional)
Specifies the login name of the owner of the installation. For example:
ISC_PACKAGE_MGRUSER="jcsmith"
Note:
By default, this is set to the username of the user who is installing the instance.
If the security level is "Minimal", this parameter is ignored, and ISC_PACKAGE_MGRUSER is set to "root".
ISC_PACKAGE_MGRGROUP="<group>"
(Optional)
Specifies the group that is allowed to start and stop the instance. For example:
ISC_PACKAGE_INITIAL_MGRGROUP="irisusr"
Note:
By default, this is set to the group of the user who is installing the instance.
ISC_PACKAGE_USER_PASSWORD="<password>"
(Required for installation of secure instances.)
Specifies the required password for an instance with Normal or Locked Down security.
Note:
If the security level is "Minimal", this parameter is ignored.
If the security level is "Normal" or "LockedDown" and this parameter is not specified, the installation fails and an error is thrown.
ISC_PACKAGE_CSPSYSTEM_PASSWORD="<password>" Specifies the password for the CSPSystem user.
Note:
If the security level is "Minimal", this parameter is ignored.
If the security level is "Normal" or "LockedDown" and this parameter is not specified, the value of ISC_PACKAGE_USER_PASSWORD is used.
ISC_PACKAGE_IRISUSER="<user>"
(Optional)
Specifies the effective user for the InterSystems IRIS Superserver.
Note:
By default, this is set to irisusr.
If the security level is "Minimal", this parameter is ignored and set to the default.
ISC_PACKAGE_IRISGROUP="<group>"
(Optional)
Specifies the effective user for InterSystems IRIS processes.
Note:
By default, this is set to irisusr.
If the security level is "Minimal", this parameter is ignored and set to the default.
ISC_PACKAGE_CLIENT_COMPONENTS="<component1> <component2> ..."
(Optional)
Specifies the client bindings to be installed from the client_components package (see Unattended Installation Packages).
Note:
By default, all client bindings are installed. Specified components (bindings) must be space-delimited. Available components are listed in package/client_components/manifest.isc. Installation validates the specified components and removes those that do not exist or are not supported on a particular system.
ISC_PACKAGE_WEB_CONFIGURE="Y"|"N"
(Optional)
Specifies whether or not to configure the Web Gateway for an external web server.
Note:
By default, this is set to N (do not configured the gateway for an external web server).
ISC_PACKAGE_WEB_SERVERTYPE="Apache"|"SunOne"|"None"
(Optional)
Type of existing web server for the Web Gateway to use. For example: ISC_PACKAGE_WEB_SERVERTYPE="Apache"
Note:
By default, this is set to None.
ISC_PACKAGE_WEB_APACHE_VERSION=2.2|2.4
(Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache")
Version of Apache web server.
Note:
By default, the version is autodetected.
ISC_PACKAGE_WEB_APACHE_USER="<username>"
(Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache")
Username for Apache web server.
Note:
By default, the username is autodetected.
ISC_PACKAGE_WEB_APACHE_CONF="<path_to_httpd.conf>"
(Optional, with ISC_PACKAGE_WEB_SERVERTYPE="Apache")
Location of the Apache Web server configuration file, for example: /etc/httpd/conf/httpd.conf
Note:
By default, installation attempts to autodetect file in one of several stardard locations. Installation exits with error if ISC_PACKAGE_WEB_SERVERTYPE="Apache" and httpd.conf location is undetermined.
ISC_PACKAGE_WEB_SUNONE_DIR="<sunone_installation_dir>"
(Optional, with ISC_PACKAGE_WEB_SERVERTYPE="SunOne")
Installation directory of the SunOne web server, for example:
/usr/netscape/server4/httpd-production
Note:
By default, the installation directory is autodetected.
ISC_PACKAGE_WEB_SUNONE_NUMBER="<number>"
(Optional, with ISC_PACKAGE_WEB_SERVERTYPE="SunOne")
SunOne web server number to configure if multiple servers are installed.
Note:
By default, value is 1.
ISC_PACKAGE_WEB_GATEWAY_DIR="<web_gateway_directory>"
(Optional, for new Web Gateway installations only)
Directory to contain the Web Gateway files.
Note:
By default, the directory is /opt/webgateway_.
ISC_PACKAGE_STARTIRIS="Y"|"N"
(Optional)
Specifies whether or not to start the installed InterSystems IRIS instance following installation.
Note:
By default, this is set to Y, to start the instance.
ISC_INSTALLER_MANIFEST="<location>" When installing with an installation manifest, specifies the location of the exported manifest class.
Note:
See Using the Manifest in the appendix “Creating and Using an Installation Manifest” for more information.
ISC_INSTALLER_PARAMETERS="<var>=<value>,<var>=<value> ..." When installing with an installation manifest, specifies variable name/value pairs.
ISC_INSTALLER_LOGFILE="<filename>" When installing with an installation manifest, specifies the log file name.
ISC_INSTALLER_LOGLEVEL="<level>" When installing with an installation manifest, specifies the log level, from -1 (“none”) to 3 (“verbose”).
ISC_PACKAGE_SUPERSERVER_PORT="<port_number>"
(Optional)
Specifies the Superserver port to be used by the instance being installed.
Note:
By default, this port is set to 1972 (if available). Otherwise, the port is set to 51773 or the first available subsequent number.
ISC_PACKAGE_USER_DATABASE=Y|N Specifies whether or not to install the optional users database. By default, this is set to Y.
ISC_PACKAGE_WEBSERVER_PORT="<port_number>"
(Optional)
Specifies the Webserver port to be used by the instance being installed.
Note:
By default, this port is auto-determined, beginning with 52773 and increasing by 1 for each installed instance of InterSystems IRIS.

Unattended Installation Packages

The installation scripts for each component are contained in the packages directory below the directory containing the irisinstall_silent script. Each package is in its own directory, and each package directory contains a manifest.isc file defining prerequisite packages for the package in that directory.

The standard_install package is the starting point for a server install in which all packages are installed. To define a custom package, you can use the manifest.isc file for the standard_install package as a template, as follows:

  1. Copy the standard_install directory to a new directory.

    For example, copy it to a directory named custom_install; initially, the manifest.isc file in the new directory is similar to the following:

    #This is the target for a standard (non-client-only) install
    package: standard_install
    prerequisite: install_mode
    prerequisite: database_server
    prerequisite: databases
    prerequisite: gadget
    prerequisite: fop
    prerequisite: renderserver
    prerequisite: printserver
    prerequisite: excelexporter
    prerequisite: callin_components
    prerequisite: client_components
    prerequisite: addenda
    prerequisite: install_confirmation
    prerequisite: copyright
    
  2. In the new directory, modify the manifest.isc file as follows:

    • Set the package key to the value of the directory name (required).

    • Add and/or remove prerequisites for your custom installation.

    For example, in the following manifest.isc file, the value of the package key has been changed to match the directory name (custom_install).

    #This is the target for a custom (non-client-only) install
    package: custom_install
    prerequisite: install_mode
    prerequisite: database_server
    prerequisite: gadget
    prerequisite: fop
    prerequisite: renderserver
    prerequisite: printserver
    prerequisite: excelexporter
    prerequisite: callin_components
    prerequisite: client_components
    prerequisite: addenda
    prerequisite: install_confirmation
    prerequisite: copyright
    

Then you can specify the new custom package when performing unattended installations; for example: sudo ISC_PACKAGE_INSTANCENAME="MyIris" ./irisinstall_silent custom_install.

Note:

See the Adding UNIX® Installation Packages to an InterSystems IRIS Distribution appendix for information about creating your own UNIX® installation packages and adding them to an InterSystems IRIS distribution.

Unattended Installation Examples

The following examples illustrate how you can use the irisinstall_silent script for unattended installation of InterSystems IRIS on UNIX® platforms.

Example 1

In this example, all packages are installed with minimal security:

sudo ISC_PACKAGE_INSTANCENAME="MyIris" ISC_PACKAGE_INSTALLDIR="/opt/MyIris1" ./irisinstall_silent
Copy code to clipboard

If the MyIris instance already exists, it is upgraded; otherwise, it is installed in the /opt/MyIris1 directory.

Example 2

In this example, the installation is aborted and an error is thrown if the instance named MyIris does not already exist:

sudo ISC_PACKAGE_INSTANCENAME="MyIris" ./irisinstall_silent
Copy code to clipboard
Example 3

In this example, only the database_server and odbc packages and the odbc client binding are installed with minimal security:

sudo ISC_PACKAGE_INSTANCENAME="MyIris" ISC_PACKAGE_INSTALLDIR="/opt/MyIris2"
ISC_PACKAGE_CLIENT_COMPONENTS="odbc" ./irisinstall_silent database_server odbc
Copy code to clipboard

Post-Installation Tasks

Once you have completed running the installation procedure, perform the following tasks:

Starting InterSystems IRIS

For most installations, InterSystems IRIS starts automatically when the install completes. If you need to start InterSystems IRIS, first log into your operating system, then start InterSystems IRIS using the iris command:

iris start <instname>
Copy code to clipboard

Where instname is the instance name that you chose during the installation. On Red Hat Linux, the start command is:

service <instname> start
Copy code to clipboard

Use the iris command to start and stop InterSystems IRIS. It is described in greater detail in the Controlling InterSystems IRIS Instances section of the System Administration Guide.

Note:

If the permissions on all elements of the path to the mgr subdirectory do not provide read access to the irisusr group (at a minimum), the instance fails to fully start and the following message is recorded in messages.log: Element of path manager_subdirectory could not be read (errno 2).

Once InterSystems IRIS is started, initiate an InterSystems IRIS session using the iris terminal command, as described in Connecting to an InterSystems IRIS Instance in the “Using Multiple Instances of InterSystems IRIS” chapter of the System Administration Guide:

iris terminal <instname> [parameters]
Copy code to clipboard

Where instname is the instance name that you chose during the installation.

For more information, see the “Using InterSystems IRIS on UNIX®, Linux, and macOS” chapter of the System Administration Guide.

Installing a Development Environment

InterSystems IRIS installs a private Apache Web server so you can access the Management Portal, but does not include a development environment on UNIX®; therefore, you must choose between installing Atelier, which is based on Eclipse, or Studio, which must be run on a Windows client. For more information about Atelier, see Install the Atelier Development Environment in the “Preparing to Install InterSystems IRIS” chapter of this guide.

To install a Windows client, follow the instructions in the Installing Client Components Only section of the “Installing InterSystems IRIS on Microsoft Windows” chapter in this book. Once the Windows client is installed, perform the following tasks to connect Studio to your instance:

  1. Open the InterSystems IRIS launcher on the Windows client.

  2. Point to Preferred Server and click Add/Edit to add a remote server connection to the InterSystems IRIS instance just installed. Make sure you specify the appropriate port numbers for this connection.

  3. Point to Remote System Access, point to Studio, and then click the appropriate connection name you entered in the previous step.

Special Considerations

This section describes the following topics:

Multiple InterSystems IRIS Instances

You can install and simultaneously run multiple instances on a single machine. Install InterSystems IRIS as for a single installation, giving each instance a unique name, a unique installation directory, and a unique port number.

For more information, reference the Configuring Multiple InterSystems IRIS Instances section of the “Using Multiple Instances of InterSystems IRIS” chapter in System Administration Guide.

Uninstalling InterSystems IRIS

To safely uninstall InterSystems IRIS, follow this procedure:

  1. Find the name of the InterSystems IRIS instance you wish to delete using the iris list command to list all the instances on your machine:

    iris list
    Copy code to clipboard
  2. Verify the instance is stopped. If it is not, stop it with the iris stop command:

    iris stop <instname>
    Copy code to clipboard

    Where instname is the instance name that you chose during the installation. If it hangs, force it down using iris force:

    iris force <instname>
    Copy code to clipboard
  3. Remove the instance using the iris delete command:

    iris delete <instname>
    Copy code to clipboard
  4. Remove the installation directory using the following operating system command:

    rm -r <directory>
    Copy code to clipboard
    Important:

    Be aware that this removes files you may wish to keep. For example: the license key (iris.key), the configuration file (iris.cpf), and the user database file (iris.dat).

The uninstall procedure removes all files installed and created during normal InterSystems IRIS processing, including journal and temporary database files.

Important:

The SUSE Linux Enterprise Server 9 platform uses asynchronous scriptlets, so the uninstall process cannot guarantee that InterSystems IRIS stops before it removes files.

Using an Installation Manifest

You can define an installation manifest that describes a specific InterSystems IRIS configuration and use it with either of the irisinstall or irisinstall_silent commands. For more information on installation manifests, see the appendix “Creating and Using an Installation Manifest” in this book.

Adding Unix® Installation Packages

You can add a new UNIX® installation package to an existing InterSystems IRIS distribution. For more information, see the appendix “Adding Unix® Installation Packages to an InterSystems IRIS Distribution” in this book.

Adjustments for Large Number of Concurrent Processes on macOS

Make the following adjustments if you are running a system that requires a large number of processes or telnet logins:

  1. Remote connections — The number of pty (pseudo terminal) connections is limited to 128 system-wide. If your applications count on telnet or other pty-using connections for users to access, keep this in mind.

  2. Number of processes — If the pty limit is not a problem, but you need to run a larger number of processes, there are limits to that as well.

    • System-wide process limits — The kern.maxproc, kern.maxprocperuid parameters are set to 532 and 100 by default. You can change them using the following commands:

      administrator$ sudo sysctl -w kern.maxproc=2500
      kern.maxproc: 2065 -> 2500
      administrator$ sudo sysctl -w kern.maxprocperuid=2500
      kern.maxprocperuid: 2000 -> 2500
      
      administrator$ sysctl -a | grep maxproc
      kern.maxproc = 2500
      kern.maxprocperuid = 2500
      
      Copy code to clipboard

      Note, however, that 2500 is the absolute unchangeable upper limit.

macOS Web Servers

For macOS, the Web Server Pages technology is supported on the Apache and Nginx web servers. For current information, see the “Supported Technologies” chapter of the online InterSystems IRIS Data Platform Supported Platforms document for this release.

Note:

Starting with macOS 10.14, the Web Gateway is incompatible with the pre-installed Apache web server. Therefore, InterSystems recommends one of these alternatives:

  • Build your own version of Apache from source. For instructions, see the Apache Software Foundation site.

  • Install Apache using Homebrew, an open-source package manager for macOS.

For deployments of http-based applications, including CSP and SOAP over http or https, you should not use the private web server for any application other than the Management Portal; instead, you must install and deploy one of the supported web servers (for information, see “Supported Web Servers” in the online InterSystems IRIS Data Platform Supported Platforms document for this release).