install instructions

README.md

@@ -2,4 +2,20 @@
 
 ## Setup
 
-To run the application the `OPENCODE_TOKEN` environment variable must be set. 
+1. Build all docker images in the `tools` folder. Make sure the container name matches the name expected in the
\ No newline at end of file
+   corresponding launch script in `resources/scripts` (usually matches the folder name of the tool).
+2. Start the database docker service in `tools/db`.
+3. Set the necessary environment variables (the following shows examples):
+
+```
+OPENCODE_GITLAB_TOKEN=XXX
+GIT_PROJECT_PATH=/tmp/opencode
+
+DB_URL=jdbc:postgresql://localhost:5432/dataprovider
+DB_USER=sa
+DB_PW=password
+```
+
+Make sure that the db settings match the values in the database dockerfile!
+If you are using IntelliJ for development it is easiest to create a `.env` file in the `resources` folder.
+This file is automatically loaded by the IDE.
\ No newline at end of file

src/main/resources/scripts/odc.sh

 #!/bin/sh
 
-DC_VERSION="latest"
 DC_DIRECTORY=${1}/odc
 DC_PROJECT="dependency-check scan: ${2}"
-DATA_DIRECTORY="/tmp/opencode/data"
-CACHE_DIRECTORY="/tmp/opencode/data/cache"
+DATA_DIRECTORY="/tmp/opencode/data" # TODO: make this configurable !
+CACHE_DIRECTORY="/tmp/opencode/data/cache" # TODO: make this configurable !
 
 if [ ! -d "$DATA_DIRECTORY" ]; then
     echo "Initially creating persistent directory: $DATA_DIRECTORY"
@@ -15,8 +14,6 @@ if [ ! -d "$CACHE_DIRECTORY" ]; then
     mkdir -p "$CACHE_DIRECTORY"
 fi
 
-# Make sure we are using the latest version
-#docker pull owasp/dependency-check:$DC_VERSION
 
 docker run --rm \
     --volume "${2}":/src:z \

tools/detekt/Readme.md

-## Example Usage:
-
-docker run -v /tmp/data-provider:/code detekt --input /code/src --report sarif:/code/reports/detekt.sarif
\ No newline at end of file