Quick Start
Get a MISP instance running with Docker, sign in, and create your first event. This walkthrough builds MISP 3.0 locally using the official misp-docker early-access branch. If you already have access to an instance, skip to Sign in to MISP.
The screenshots show MISP 3.0.0 from the development branch 3.0_wip, using fictional data. The MISP 3.0 early-access instructions use the Docker branch misp-3.0_wip, which builds the application from 3.0_wip. No pre-built images are published for this early-access deployment; build them locally as shown below.
Start MISP with Docker
Prerequisites
You need Git, Docker Engine 25 or later, and the Docker Compose plugin 2.17 or later. Docker must be running, and your user must be able to run Docker commands. The build needs access to GitHub, GitHub Container Registry (ghcr.io), Docker Hub, and the package repositories used by the Dockerfiles. See the instance requirements for sizing guidance.
Check your Docker installation:
docker --version
docker compose versionPrepare the configuration
Clone the MISP 3.0 Docker branch and create its local configuration file:
git clone -b misp-3.0_wip https://github.com/MISP/misp-docker.git
cd misp-docker
cp template.env .envBefore starting MISP, open .env in your editor and review these settings:
| Setting | What to configure |
|---|---|
CORE_TAG |
Keep 3.0_wip, as supplied by this branch’s template.env, to build MISP 3.0. |
BASE_URL |
Keep http://localhost for access from the Docker host. For another hostname or port, use the exact URL you will open in your browser. |
ADMIN_EMAIL |
Set the initial administrator’s email address. If left empty, it defaults to admin@admin.test. |
ADMIN_PASSWORD |
Set a unique, strong administrator password. If left empty, it defaults to admin. |
ADMIN_ORG |
Set your organization’s name. |
Uncomment DISABLE_PRINTING_PLAINTEXT_CREDENTIALS and set it to true to keep the administrator password and API key out of initialization logs. Keep .env private: it contains credentials. The default Compose configuration publishes web ports 80 and 443 on the host; make sure they are available. For a different port, consult the NGINX_HTTP_PORT and NGINX_HTTPS_PORT settings in template.env and update BASE_URL to match.
This walkthrough is for getting started on a trusted test host. Before making the instance available to others, review the misp-docker production guidance for credentials, HTTPS, mail, and persistent storage.
Start the containers
From the misp-docker directory, build the application images locally, then start the services once the build succeeds:
docker compose build
docker compose up -d
docker compose psThe build downloads and installs the application and its dependencies, so it can take some time. The first startup then initializes the database and MISP configuration and can take several minutes. Follow its progress with:
docker compose logs --follow misp-corePress Ctrl+C to stop following the logs; the containers keep running. Once initialization finishes, open http://localhost on the Docker host, or the address you configured in BASE_URL. If the page is not available yet, check docker compose ps and the logs before trying again. The upstream troubleshooting guide covers common startup problems.
The application branch moves over time. For a later update, follow the early-access upgrade instructions and rebuild with docker compose build --no-cache to fetch current source, or set CORE_COMMIT in .env to the specific application revision you intend to build. Keep the Docker checkout, configuration, and database upgrade steps aligned with that revision.
To stop the instance without deleting its data:
docker compose stopRun docker compose up -d from the same directory to start it again.
Sign in to MISP
Use the ADMIN_EMAIL and ADMIN_PASSWORD you configured in .env. If you left both empty, the initial credentials are admin@admin.test / admin; change the default password immediately. For an existing instance, use the credentials supplied by your administrator.
Accept the terms of use and set a new password if prompted. See First run of the system for the account setup screens.
Using the initial administrator account, open Administration → Server Settings & Maintenance → Version & updates and confirm that the running server reports MISP 3.0 before continuing with the interface walkthrough.
First steps after login
- Secure your administrator account. Use a unique password that meets the password policy, and enable multi-factor authentication if your instance supports it. In Docker, keep
ADMIN_PASSWORDin.envconsistent with your intended administrator password: environment-driven settings are reapplied when the container starts. - Set up your organization and users. Check your organization’s name, designate site and organization administrators, and create separate accounts for contributors with the appropriate roles. Use an account with the permissions you need for daily analysis rather than sharing the initial administrator login. See user administration and organizations.
- Check that the instance is ready. As a site administrator, open Administration → Server Settings & Maintenance and review the diagnostics and background workers. Resolve reported configuration issues before importing data; see server settings and maintenance.
- Choose your tags and feeds. Enable a taxonomy, such as
tlp, so analysts can label information consistently. Then enable a feed relevant to your work. Start with caching for correlation; fetch events only when you want to import them into your instance. - Create a small test event. Follow Create an Event below, choose Your organisation only as the distribution, and add a harmless example indicator such as
example.org. Keep illustrative indicators out of detection exports by clearing for Intrusion Detection System (to_ids). Review the event’s tags and distribution before publishing or sharing it; see distribution guidance.
Password Policy
Use a password manager to generate and store a unique password. The instance’s configured policy determines the minimum length and required character types; follow the requirements shown when you change your password. See user management for profile settings and multi-factor authentication.
Reset an administrator password
For a Docker deployment, run the password reset command from your misp-docker directory. Replace the email address with the administrator’s login and NEW_PASSWORD with a strong password that meets the instance’s policy:
docker compose exec --user www-data misp-core /var/www/MISP/app/Console/cake User change_pw admin@admin.test 'NEW_PASSWORD'If ADMIN_PASSWORD is set in .env, update it too so a later container start does not restore the previous value. For a host installation, run the same Cake command directly as the web server user, using the path to your MISP installation.
Common actions at a glance
- Create an event to group the indicators and context for one investigation.
- Browse events to find existing intelligence and related reports.
- Export indicators in a format your analysis or detection tools can consume.
Create an Event
In the MISP 3.0 navigation, open Data points → Events and select Add Event. Enter a descriptive title in Event Info, such as Quick-start exercise: suspicious email investigation. Choose Your organisation only for this exercise, set the event date, and select the analysis and threat levels that match your information. Select Create Event Entry to save the event.
Distribution controls who can receive the event; a tag does not replace this setting. Keep the exercise private and unpublished while you add and review its contents.
Describe Event
The General tab brings together the event’s organization, distribution, context, reports, and indicator inventory. Use the other tabs to work with Attributes, Objects, Reports, and Correlation. The action panel provides shortcuts to edit the event, import data, or attach files.
For a simple first indicator, open Attributes, choose Add Attribute, and add example.org as a domain. Clear for Intrusion Detection System (to_ids) for illustrative data. Add a comment explaining what the value represents, then save it. Use objects when several attributes describe the same entity, such as a file or an email.
Free-Text Import Tool
From the event’s General tab, select Import and expand Freetext Import. Paste one indicator per line into IOCs. For this exercise, use these reserved documentation values:
example.net
198.51.100.25
contact@example.net
Select Run Freetext Import to review the detected attributes before saving them.
Check each value, category, type, and distribution in Review detected attributes. Use a row’s edit control to correct an ambiguous detection or its remove control to exclude a value. For these examples, turn off the IDS shield on each row so the indicators remain context rather than detection rules. Select Create attributes when the preview is correct.
Return to Attributes to review the saved values and comments. The example below contains the initial domain and URL plus the three imported indicators. The Correlation tab and Related Events panel help you investigate values that also appear in other events. A shared value is a lead to assess; it does not by itself prove that two reports describe the same activity.
Suggestions
Choose attribute types that describe what you observed: for example, domain, url, ip-src, ip-dst, or email-src. Use comments to explain the source and relevance of each value. Set to_ids only for indicators you intend detection tools to use, and review the event’s distribution and tags before sharing it. See best practices for tagging and data-modeling guidance.
Browsing Events
Open Data points → Events to see the events available to your account. Select Filters to narrow the list by criteria such as organization, tags, date, or publication state. Open an event by selecting its ID or title.
Export Events for Log Search
From an event, expand the action panel with Show all actions and select Download as. Choose the format required by your tool; MISP JSON is a useful starting point for exchanging the event with its metadata and attributes. The download dialog also offers XML, CSV, and detection-oriented formats, with options that vary by format.
Detection exports can require a published event and attributes marked for Intrusion Detection System (to_ids). The documentation indicators in this walkthrough deliberately have to_ids disabled, so they should not appear in detection-rule exports. See automation for export filters, supported formats, and API access.
Enable a Taxonomy
As a site administrator, open Data models → List Taxonomies, find the taxonomy you need, and enable it. Enable the tags you want analysts to use as well. For this walkthrough, enable the tlp taxonomy so tlp:clear is available in the event tag editor. See Taxonomies for the complete workflow.
Enable and fetch a feed
Open Sync → Feeds, choose a feed relevant to your work, and enable it. Cache a feed to correlate its indicators with your data without importing its events, or fetch it when you want to import those events into the instance. Start with one relevant feed and review the results before enabling more. See Managing feeds for configuration and import details.










