Incident Response Investigation System
Current Version v3.0.0-beta.1
Online Demonstration

Iris is a web collaborative platform aiming to help incident responders sharing technical details during investigations.

• Getting Started
  • Run IrisWeb
  • Configuration
• Versioning
• Showcase
• Documentation
  • Upgrades
  • API
• Help
• Considerations
• License

Starting with v3, IRIS ships as three coordinated repos:

• iris-web — this repo, the meta / umbrella. Owns the docker-compose stack, top-level docs, release orchestration.
• iris-backend — Python/Flask API and workers.
• iris-frontend — SvelteKit UI.

The backend and frontend are wired into iris-web as git submodules. docker compose up pulls pre-built images from ghcr.io/dfir-iris/iris-{backend,db,nginx,frontend} — no build step, no submodule init required for pull-only deployments.

⚠️ v3.0.0-beta.1 is a beta release. Not recommended for production use. For production, use the latest stable release, v2.4.29.

# Clone with submodules — only needed if you plan to build locally.
git clone --recursive https://github.com/dfir-iris/iris-web.git
cd iris-web

# Optional: pin to the last tagged version
git checkout v3.0.0-beta.1

# Copy and edit the environment template — set POSTGRES_PASSWORD,
# POSTGRES_ADMIN_PASSWORD, IRIS_SECRET_KEY, IRIS_SECURITY_PASSWORD_SALT,
# and IRIS_HOSTNAME at minimum.
cp .env.example .env

# Provide a TLS cert + key at certificates/web_certificates/iris_dev_cert.pem
# and iris_dev_key.pem (or set CERT_FILENAME/KEY_FILENAME in .env). For a
# quick self-signed pair:
openssl req -x509 -newkey rsa:2048 -sha256 -days 365 -nodes \
    -keyout certificates/web_certificates/iris_dev_key.pem \
    -out certificates/web_certificates/iris_dev_cert.pem \
    -subj "/CN=iris.local" \
    -addext "subjectAltName=DNS:localhost,IP:127.0.0.1"

# Pull images from ghcr.io and start
docker compose up -d

IRIS is now available at https://<IRIS_HOSTNAME> (default: https://localhost, port 443).

By default, an administrator account is created. The password is printed to stdout the very first time IRIS starts. WARNING :: post_init :: create_safe_admin :: >>> can be searched in the logs of the iris_app container to find it, or you can pre-set it via IRIS_ADM_PASSWORD in .env.

The stack runs six services:

• app: Flask API + web server (image: iris-backend)
• worker: Celery jobs handler (image: iris-backend)
• db: PostgreSQL (image: iris-db)
• rabbitmq: broker for Celery
• nginx: TLS termination + reverse proxy (image: iris-nginx)
• frontend: SvelteKit SSR (image: iris-frontend)

To build images from the submodules instead of pulling:

git submodule update --init --recursive
./scripts/dev-up.sh              # equivalent to `docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build`

There are three different options for configuring the settings and credentials: Azure Key Vault, Environment Variables and Configuration Files. This is also the order of priority, if a settings is not set it will fall back on the next option. For all available configuration options see configuration.

Starting with v3, contributor-facing docs live inside the submodules alongside the code they describe:

• iris-backend/CODESTYLE.md — Python and Flask conventions for the backend.
• iris-backend/CONFIGURATION.md — full backend env var reference (superset of the online docs).
• iris-backend/architecture.md — backend service architecture and data flow.
• iris-backend/deploy/ — Helm chart and EKS manifests. v2-era, and not usable for v3.0.0-beta.1: Docker Compose is the only supported deployment path for the beta. See docs/upgrade-to-3.0.0.md §5.
• docs/upgrade-to-3.0.0.md — v2.4.x → v3 upgrade procedure (docker-compose; §5 covers what Kubernetes operators should do instead).

Starting from version 2.0.0, Iris is following the Semantic Versioning 2.0 guidelines.
The code ready for production is always tagged with a version number. alpha and beta versions are not production-ready.

Do not use the master branch in production.

You can directly try Iris on our demo instance.
One can also head to tutorials, we've put some videos there.

A comprehensive documentation is available on docs.dfir-iris.org.

Please read the release notes when upgrading versions. Most of the time the migrations are handled automatically, but some changes might require some manual labor depending on the version.

The API reference is available in the documentation or documentation repository.

You can reach us on Discord or by mail if you have any question, issue or idea!
We are also on Twitter and Matrix.

Iris is still in its early stage. It can already be used in production, but please set backups of the database and DO NOT expose the interface on the Internet. We highly recommend using a private dedicated and secured network.

The contents of this repository is available under LGPL3 license.

Special thanks to Deutsche Telekom Security GmbH for sponsoring us!