From ce7cf7ce0d8d086ed797dd3e0a9b59a88025a661 Mon Sep 17 00:00:00 2001 From: Jason Kendall Date: Tue, 28 Jan 2020 17:42:10 -0500 Subject: [PATCH] Update readme --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8e9ba2f..ee7a99e 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,34 @@ 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 +- Overwritable 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 + + Getting Started: - Copy the "default" configs removing "default" and edit the files in `server-configs` - Note: A dry run without this step will try and make a sane DEV build for docker-compose -- [Don't] run `generate.sh` in `./ssl` to generate some fake certs +- Run `generate.sh` in `./ssl` to generate some fake certs - `docker-compose up --build` - Login with - User: admin@admin.test - Password: admin -Server image notes: -- Server file sizes +Server image file sizes: +- Core server - 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 -- Server Saved: 2.5GB +- Saved: 2.5GB -- Modules file sizes: +- Modules: - Original: 1.36GB - Pre-build modules: 750MB -- Modules Saved: 640MB - +- Saved: 640MB