From a8d249f7aae245e53bb8123381bcde0e677ec28a Mon Sep 17 00:00:00 2001 From: Sebastian Waldbauer Date: Tue, 3 Nov 2020 23:29:37 +0100 Subject: [PATCH] Changed readme Signed-off-by: Sebastian Waldbauer --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f963a73..98b39a7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ # intelmq-docker + +**ATTENTION** This docker image is not docker compliant. **THIS** is just for beta usage & information gathering. +Do not run this software in production, it might break. + +If you do have any questions / feedback / questions, please open an issue :) + ## Fastest way to run & deploy 1. `cd ~` @@ -7,5 +13,27 @@ 0. `git clone https://github.com/waldbauer-certat/intelmq-docker.git` 0. `cd intelmq-docker` 0. `sudo docker pull certat/intelmq-full:1.0` -0. `sudo chown -R $USER:$USER example_config` -0. `sudo docker-compose up` \ No newline at end of file +0. `chown -R $USER:$USER example_config` +0. `sudo docker-compose up` + +If you want to build/deploy/test this container run +1. `chmod +x build.sh` +0. `chmod +x test.sh` +0. `chmod +x publish.sh` + +**!ATTENTATION!** Only [CERT.AT](https://cert.at/) employee's/maintainer can publish on `cerat/` repository. Change this in `publish.sh` + +## How to develop new features & build containers? +1. `cd ~` +0. `git clone https://github.com/certtools/intelmq.git` +0. `git clone https://github.com/certtools/intelmq-manager` + +Now you can start making changes to source code. If you're finished and ready to test within your docker enviroment +1. `cd ~/intelmq-docker` +0. `sudo ./build.sh` + +Now your docker image should be built successfully. Check for errors :) + +Now lets run tests to ensure our image is ready. + +1. `sudo ./test.sh` \ No newline at end of file