diff --git a/DEVELOP-GUIDE.md b/DEVELOP-GUIDE.md index 2c21cab..994ba90 100644 --- a/DEVELOP-GUIDE.md +++ b/DEVELOP-GUIDE.md @@ -30,31 +30,31 @@ docker-compose -f docker-compose-dev.yml up ### Volumes: -- **./my_fork_of_intelmq/:/my_fork_of_intelmq** -> this is the folder where your source code need to be, we decide to use fork from intelmq so you could inherit intelmq changes and upgrades to your bots code directly. +- **./my_bots:/my_bots** -> this is the folder where your bots source code need to be. ### Environment #Folder where you clone your repository - MY_FORK: "/mybots" + MY_FORK: "/my_bots" #Folder in your repo where bots are located MY_BOTS_FOLDER: "bots" ### Add your own bots -Just start coding or pull your bots repository in ./mybots by default in a subfolder bots, so you need for example mybots/bots/[collectors,parsers,experts,output,parsers] +Just start coding or pull your bots repository in ./my_bots by default in a subfolder bots, so you need for example my_bots/bots/[collectors,parsers,experts,output,parsers] + +You could take a look at the folder and files in https://github.com/certtools/intelmq/tree/develop/intelmq/bots ### How to install and look yours bots running After you change some bot or add something new just run command **install_reqs_and_deploy_bots.sh** in the running container ``` -docker-compose exec -f docker-compose-dev.yml intelmq sudo bash /opt/install_reqs_and_deploy_bots.sh +docker-compose exec -f docker-compose-dev.yml intelmq sudo bash /opt/install_reqs_and_deploy_bots.sh ``` When you do this: * Yours bots REQUERIMENTS.txt and the bots will be installed - - * Another thing, you could make your bots to be running when container startup, just setting ENABLE_BOTNET_AT_BOOT: "true" ## Dependencies problems @@ -79,4 +79,3 @@ This bot has 2 problems: If you don't need blueliv, just don't fix git+git with git+https. - diff --git a/docker-compose-dev.yml b/docker-compose-dev.yml index 4deffbf..01bd74a 100644 --- a/docker-compose-dev.yml +++ b/docker-compose-dev.yml @@ -24,7 +24,7 @@ services: - ./example_config/intelmq-api/config.json:/etc/intelmq/api-config.json - ./intelmq_logs:/opt/intelmq/var/log - ./intelmq_output:/opt/intelmq/var/lib/bots - - ./mybots:/my_fork_of_intelmq + - ./my_bots:/my_bots depends_on: - redis environment: @@ -37,7 +37,7 @@ services: INTELMQ_SOURCE_PIPELINE_HOST: redis INTELMQ_DESTINATION_PIPELINE_HOST: redis INTELMQ_REDIS_CACHE_HOST: redis - MY_FORK: "/my_fork_of_intelmq" + MY_FORK: "/my_bots" MY_BOTS_FOLDER: "bots" networks: - intelmq-internal