Skip to content

Installation Guide

This guide will help you install and set up the OpenMISP in your environment.

Installation Methods

Using pip

The recommended way to install OpenMISP is using pip:

pip install git+https://github.com/ec-digit-csirc/openmisp.git@v0.0.1

From Source

To install from source:

git clone https://github.com/ec-digit-csirc/openmisp
cd openmisp
uv sync

Configuration

Environment Variables

OpenMISP can be configured using environment variables:

export MISP_URL="https://your-misp-instance.com"
export MISP_KEY="your-api-key"

Alternatively, you can create a .env file:

MISP_URL=https://your-misp-instance.com
MISP_KEY=your-api-key

Verifying Installation

You can verify your installation by running:

import os
from openmisp import MISP

# Initialize the MISP client
misp = MISP(
    url=os.getenv("MISP_URL"),
    key=os.getenv("MISP_KEY"),
    ssl=False,  # Set to True in production environments
)

# This should print your MISP instance version
version = misp.server.version()
print(f"MISP Version: {version}")

Next Steps