Skip to main content

Deploy InterSystems IRIS Community Edition on Your Own System

Deploy InterSystems IRIS Community Edition on Your Own System

You can deploy a containerized instance of InterSystems IRIS Community Edition on your own public cloud, private cloud, or hardware system from the Community Edition image, using the following steps.

  1. Ensure that an OCI-compliant container runtime engine, such as Docker or Podman, is installed on your servers. (The specific instructions and procedures in this document are intended to be used with Docker on Linux.)

  2. Browse the InterSystems Container Registry (ICR) portalOpens in a new tab, as described in Using the InterSystems Container RegistryOpens in a new tab, to locate the Community Edition image you want (because they are publicly available, no InterSystems or Docker login is required to view or download them). You can download images from the iris-community (InterSystems IRIS Community Edition), iris-ml-community (InterSystems IRIS Community Edition with IntegratedML), irishealth-community (InterSystems IRIS for Health Community Edition), and irishealth-ml-community (InterSystems IRIS for Health Community Edition with IntegratedML) repositories. When you select a tag within a repository, the main panel displays one or two docker pull commands, which you can copy and paste onto your Linux command line to download the image. (Two docker pull commands are displayed when an image is available for both amd64 and arm64 architecture.) For example, if you selected the amd64 version of the latest image in the iris-community repository, your docker pull command would look like this:

    $ docker pull containers.intersystems.com/intersystems/iris-community:latest
    5c939e3a4d10: Pull complete
    c63719cdbe7a: Pull complete
    19a861ea6baf: Pull complete
    651c9d2d6c4f: Pull complete
    $ docker images
    REPOSITORY                  TAG      IMAGE ID     CREATED     SIZE
    intersystems/iris-community latest  15627fb5cb76 1 month ago 1.33GB
    
    
    Important:

    Do not copy the command in the example above, but rather copy the command for the image you want from the ICR portal.

    Note:

    The image tags shown in this document are examples only. Please go to the ICR portal, as noted above, to browse current repositories and tags.

    You can also download any of the Community Edition images described here from Docker Hub by removing containers.intersystems.com/ from the appropriate pull command or replacing it with hub.docker.com/.

  3. The following docker run command uses the containers.intersystems.com/intersystems/iris-community:latest image to create and starts an InterSystems IRIS Community Edition container called iris. If you have not already pulled (downloaded) the image, Docker does that first.

    $ docker run --name iris -d --publish 1972:1972 --publish 52773:52773 
        containers.intersystems.com/intersystems/iris-community:latest 
    
    Important:

    Remember to replace the image specification in the above command with that of the Community Edition image you have downloaded and want to use.

    The argument to each --publish option pairs a host port (which comes first) with a container port (which follows), allowing outside entities to interact with the container port by connecting to the host port. For example, to publish container port 2730 to host port 9730, you would use the option --publish 9730:2730. This example shows the instance’s superserver port (1972) and web server port (52773) published to the same ports on the host, so that you can interact with InterSystems IRIS from outside the container using theses known ports. If you publish to different host ports, be sure to note them for use in connecting to the instance.

    Important:

    The web server port is 52773 on Community Edition instances only. The port used to connect to the Management Portal on other instances depends on their manner of deployment, as discussed in InterSystems IRIS Connection Information in InterSystems IRIS Basics: Connecting an IDE.

  4. Execute the docker ps -a command to see the status of the container, which is called named according to the --name option in your docker run command, and confirm that it is running.

    Note:

    If the container fails to start, with an error message indicating that your system has too many cores for the Community Edition license, first remove the stopped container with the command docker rm iris, then restrictOpens in a new tab a new container to 20 cores, the Community Edition limit, by inserting the options--cpuset-cpus=0-19 --cpus=20 after the --name option in the above docker run command.

That’s it! You are the proud owner of an InterSystems IRIS Community Edition instance running in a container. The instance comes with a free built-in license that expires a year after the product version’s release date, as well as a production-enabledOpens in a new tab USER namespace (there are also some limitations).

Once the container is running, you can continue with the instructions in Explore Your InterSystems IRIS Instance.

Note:

The provided setup instructions are valid for most Docker environments; if you encounter any problems, see Using InterSystems IRIS ContainersOpens in a new tab and Additional Docker/InterSystems IRIS ConsiderationsOpens in a new tab in Running InterSystems Products in Containers. For information specific to Docker for Windows, see Using InterSystems IRIS Containers with Docker for WindowsOpens in a new tab on InterSystems Developer Community.

FeedbackOpens in a new tab