Project to build a set of three docker images containing the components of MISP with self-configuration into a usable state from first start.
This GitHub repository is for maintaining the images, to use the images refer to the documentation site instead.
The images are build and tested using the latest docker engine, but should build on any Linux-based Docker Engine which supports multi-stage images.
quickstart.py is designed to create a test instance of MISP for validation of changes to the
builds, it should not be used in production environments.
It will:
- Create a "best guess"
.envfile if one does not exist, - Delete ALL existing persistent storage,
- Pull the three required external images,
- Build the three images in this project,
- Start MISP at https://{docker-hostname}/.
Quick Start requires:
- A Python >= 3.9 virtual environment, with the following modules installed:
- Dotenv (
python3 -m pip install python-dotenv), - Defused XML (
python3 -m pip install defusedxml), and - Requests (
python3 -m pip install requests).
- Dotenv (
For customisation options see the documentation site.
To simulate a High Availability setup with Quick Start add the --ha option, this will spawn two
misp-web frontend containers behind a HAProxy load balancing container.
Note: It is expected for the HA Proxy container to continually restart until a misp-web container generates the TLS keypair needed for a successful startup.
To test with SAML2/Shibboleth Single Sign On, ensure the appropriate options have been set in .env
(see the SAML2 Documentation), then
run Quick Start with the --shibb option.