README.md

Hi, welcome to the introductory workshop of detectem.

Setup the environment

1. Install Docker CE
2. Install docker-compose
3. Create a directory i.e. det-playground and enter it.
4. Get the two files from this repository:
   • wget https://raw.githubusercontent.com/alertot/detectem-workshop/master/docker-compose.yml
   • wget https://raw.githubusercontent.com/alertot/detectem-workshop/master/Dockerfile
5. Clone detectem: git clone https://github.com/alertot/detectem.git
6. Execute docker-compose up -d to set up the environment.

Alternative method

If the previous method fails because of network latency, try this:

1. We will provide some urls where you're going to download python.tar.gz and splash.tar.gz
2. Decompress them: gzip -d python.tar.gz and gzip -d splash.tar.gz.
3. Load them in your docker environment using:
   • docker load -i python.tar
   • docker load -i splash.tar

Execute detectem

docker-compose run --rm detectem https://domain.tld

Execute detectem tests

docker-compose run --rm tests

Development

Any change made in detectem directory will be immediately available through the docker container. If you want to contribute to the project, you should follow the normal fork and pull request flow:

1. Create your plugin and test file in local detectem directory.
2. Run both docker containers to ensure that the plugin and test works.
3. Fork detectem on Github.
4. Add your fork repository as a remote in local detectem directory.
5. Push your contribution to your fork repository.
6. Create a pull request using Github interface.