diff --git a/README.md b/README.md index b063367..270dd88 100644 --- a/README.md +++ b/README.md @@ -8,59 +8,59 @@ A (nearly) production ready Dockered MISP This is based on some of the work from the DSCO docker build, nearly all of the details have been rewritten. -- Components are split out where possible, currently this is only the MISP modules -- Over writable configuration files -- Allows volumes for file store -- Cron job runs updates, pushes, and pulls - Logs go to docker logs -- Docker-Compose uses off the shelf images for Redis and MySQL -- Images directly from docker hub, no build required -- Slimmed down images by using build stages and slim parent image, removes unnecessary files from images +- Components are split out where possible, currently this is only the MISP modules +- Over writable configuration files +- Allows volumes for file store +- Cron job runs updates, pushes, and pulls - Logs go to docker logs +- Docker-Compose uses off the shelf images for Redis and MySQL +- Images directly from docker hub, no build required +- Slimmed down images by using build stages and slim parent image, removes unnecessary files from images -# Docker Tags +## Docker Tags [Docker hub](https://hub.docker.com/r/coolacid/docker-misp) builds the images automatically based on git tags. I try and tag using the following details -***v[MISP Version][Our build version]*** +***v\[MISP Version]\[Our build version]*** -- MISP version is the MISP tag we're building -- Our build version is the iteration for our changes with the same MISP version +- MISP version is the MISP tag we're building +- Our build version is the iteration for our changes with the same MISP version -# Getting Started +## Getting Started -## Development/Test +### Development/Test -- Grab the `docker-compose.yml` file and the `server-configs` directory -- [Optional] Copy the "default" configs removing "default" and edit the files in `server-configs` - - Note: A dry run without this step will try and make sane DEV configs -- `docker-compose up` -- Login to `https://localhost` - - User: `admin@admin.test` - - Password: `admin` -- Profit +- Grab the `docker-compose.yml` file and the `server-configs` directory +- \[Optional] Copy the "default" configs removing "default" and edit the files in `server-configs` + - Note: A dry run without this step will try and make sane DEV configs +- `docker-compose up` +- Login to `https://localhost` + - User: `admin@admin.test` + - Password: `admin` +- Profit -## Production -- Use docker-compose, or some other config management tool -- Directory volume mount SSL Certs /etc/apache2/ssl/ - - DH Parameters: dhparams.pem - - Certificate File: cert.pem - - Certificate Key File: key.pem - - Certificate Chain File: chain.pem -- Directory volume mount and create configs: /var/www/MISP/app/Config/ -- Additional directory volume mounts: - - /var/www/MISP/app/files - - /var/www/MISP/.gnupg - - /var/www/MISP/.smime +### Production +- Use docker-compose, or some other config management tool +- Directory volume mount SSL Certs /etc/apache2/ssl/ + - DH Parameters: dhparams.pem + - Certificate File: cert.pem + - Certificate Key File: key.pem + - Certificate Chain File: chain.pem +- Directory volume mount and create configs: /var/www/MISP/app/Config/ +- Additional directory volume mounts: + - /var/www/MISP/app/files + - /var/www/MISP/.gnupg + - /var/www/MISP/.smime -# Image file sizes +## Image file sizes -- Core server(Saved: 2.5GB) - - Original Image: 3.17GB - - First attempt: 2.24GB - - Remove chown: 1.56GB - - PreBuild python modules, and only pull submodules we need: 800MB - - PreBuild PHP modules: 664MB +- Core server(Saved: 2.5GB) + - Original Image: 3.17GB + - First attempt: 2.24GB + - Remove chown: 1.56GB + - PreBuild python modules, and only pull submodules we need: 800MB + - PreBuild PHP modules: 664MB -- Modules (Saved: 640MB) - - Original: 1.36GB - - Pre-build modules: 750MB +- Modules (Saved: 640MB) + - Original: 1.36GB + - Pre-build modules: 750MB