Skip to content

Prerequisites

Before installing iris-haystack, make sure your environment meets the following requirements.

Python

Python 3.10 or higher is required.

python --version
# Python 3.10.x | 3.11.x | 3.12.x | 3.13.x | 3.14.x
Why 3.10+?

The project uses X | Y union type syntax (PEP 604) and match statements which require Python 3.10. The pyproject.toml enforces requires-python = ">=3.10".

Docker

IRIS Community Edition is distributed as a Docker image. You need Docker Desktop or Docker Engine installed.

Download Docker Desktop.

sudo apt-get update
sudo apt-get install -y docker.io
sudo systemctl enable --now docker
sudo usermod -aG docker $USER   # allow running without sudo (re-login required)

Verify the installation:

docker --version
# Docker version 27.x.x, build ...

IRIS Connection Details

Once IRIS is running with this repository's Docker Setup, use:

Parameter Default value
Host localhost
Port (DB-API / superserver) 1972
Namespace USER
Username demo
Password demo

Development credentials only

The demo/demo account has broad permissions and is intended only for this isolated local example. Use a dedicated, securely managed account in any other environment.

Environment Variables

iris-haystack uses Haystack Secret objects to read credentials from the environment. Set these before running any code:

export IRIS_CONNECTION_STRING="localhost:1972/USER"
export IRIS_USERNAME="demo"
export IRIS_PASSWORD="demo"

Or create a .env file at the root of your project:

.env
IRIS_CONNECTION_STRING=localhost:1972/USER
IRIS_USERNAME=demo
IRIS_PASSWORD=demo

Never commit .env to git

Add .env to your .gitignore. Credentials committed to git are a security risk.

echo ".env" >> .gitignore

Optional: hatch (for contributors)

If you plan to contribute to the project or run the full test suite, you will also need hatch:

pip install hatch

See the Development Setup guide for full details.