Setup-audit-runner.md

+# Prerequisites
+## Firefox
+### For 32-bit architecture
+Retrieve firefox [here](http://download.cdn.mozilla.net/pub/mozilla.org/firefox/releases/69.0/linux-i686/en-US/firefox-69.0.tar.bz2).
+Install it on your file system and make sure the binary is executable for the tomcat8 user.
+```sh
+cd /opt
+sudo wget http://download-origin.cdn.mozilla.net/pub/firefox/releases/69.0/linux-i686/en-US/firefox-69.0.tar.bz2
+sudo tar -xvf firefox-69.0.tar.bz2
+sudo mv firefox firefox-69.0
+sudo ln -s firefox-69.0 firefox
+```
+
+### For 64-bit architecture
+Retrieve firefox [here](http://download.cdn.mozilla.net/pub/mozilla.org/firefox/releases/69.0/linux-x86_64/en-US/firefox-69.0.tar.bz2).
+Install it on your file system and make sure the binary is executable for the tomcat8 user.
+```sh
+cd /opt
+sudo wget http://download-origin.cdn.mozilla.net/pub/firefox/releases/69.0/linux-x86_64/en-US/firefox-69.0.tar.bz2
+sudo tar -xvf firefox-69.0.tar.bz2
+sudo mv firefox firefox-69.0
+sudo ln -s firefox-69.0 firefox
+```
+
+# Geckodriver
+## For 32-bit architecture
+Retrieve geckodriver [here](https://github.com/mozilla/geckodriver/releases/download/v0.21.0/geckodriver-v0.21.0-linux32.tar.gz).
+Install it on your file system and make sure the binary is executable for the user that will perform the analysis (jenkins for instance)
+```sh
+cd /opt
+sudo wget https://github.com/mozilla/geckodriver/releases/download/v0.21.0/geckodriver-v0.21.0-linux32.tar.gz
+sudo tar -xvf geckodriver-v0.21.0-linux32.tar.gz
+```
+
+### For 64-bit architecture
+Retrieve geckodriver [here](https://github.com/mozilla/geckodriver/releases/download/v0.21.0/geckodriver-v0.21.0-linux64.tar.gz).
+Install it on your file system and make sure the binary is executable for the user that will perform the analysis (jenkins for instance)
+```sh
+cd /opt
+sudo wget https://github.com/mozilla/geckodriver/releases/download/v0.21.0/geckodriver-v0.21.0-linux64.tar.gz
+sudo tar -xvf geckodriver-v0.21.0-linux64.tar.gz
+```
+
+# Chrome
+### For 64-bit architecture
+Retrieve Chrome v.91 [here](https://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_91.0.4472.164-1_amd64.deb).
+Install it on your file system and make sure the binary is executable for the tomcat8 user.
+```sh
+cd /opt
+sudo wget --no-verbose https://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_91.0.4472.164-1_amd64.deb
+sudo dpkg-deb -x google-chrome-stable_91.0.4472.164-1_amd64.deb .
+sudo cp -r opt/google/ .
+sudo rm -r opt/ usr/ etc/
+```
+# Chromedriver
+## For 64-bit architecture
+Retrieve chromedriver v.91 [here](https://chromedriver.storage.googleapis.com/index.html?path=91.0.4472.101/).
+Install it on your file system and make sure the binary is executable for the user that will perform the analysis (jenkins for instance)
+```sh
+Unzip the .zip and put the chromedriver file in /opt (as geckodriver)
+```
+
+# Configuration
+Here you will find everything about the audit-runner module configuration file, you will find it in every package using audit-runner module of tanaguru.
+
+## Proxy configuration
+|Name|Description|Example|
+|----|-----------|-------|
+|auditrunner.proxy.exclusionUrls|Proxy exclusion url list|http://google.com|
+|auditrunner.proxy.username|Proxy username|username|
+|auditrunner.proxy.password|Proxy password|password|
+|auditrunner.proxy.port|Proxy port|8080|
+|auditrunner.proxy.host|Proxy host|192.168.1.1|
+
+## Webdriver and Crawler configuration
+|Name|Description|Example|
+|----|-----------|-------|
+|auditrunner.geckodriver|Geckodriver binary location|/opt/geckodriver|
+|auditrunner.firefox-binary|Firefox binary location|/opt/firefox/firefox|
+|auditrunner.chromedriver|Chromedriver binary location|/opt/chromedriver|
+|auditrunner.chrome-binary|Chrome binary location|/opt/google/chrome/chrome|
+|auditrunner.implicitlyWait|Wait time to find an element before timeout|10|
+|auditrunner.pageLoadTimeout|Wait time to load a page before timeout|10|
+|auditrunner.scriptTimeout|Wait time to execute a script before timeout|50|
+|auditrunner.crawler.outputDir|Output directory for the crawler's storage|/tmp/|
+|auditrunner.firefox.profile|Path to firefox profile|/tmp/firefoxProfile/profile|
+
+## Audit runner profile configuration
+Tanaguru can use multiple profile to change is behavior and environment :
+* async : queue multiple audit request and execute them in different thread (Standalone)
+* sync : execute the audit in the caller thread (CLI)
+* consumer : kafka use, listen for audit request and execute them synchronously
+* producer : kafka user, produce audit request for auudit-runner servers using consumer profile
+
+|Name|Description|Example|
+|----|-----------|-------|
+|auditrunner.profile|Audit runner profile name|async|
+
+## Audit configuration
+
+|Name|Profile|Description|Example|
+|----|-------|-----------|-------|
+|auditrunner.maxConcurrentAudit|async|Maximum number of audit running at the same time|5
+|auditrunner.scheduler.enabled|all|Activate or deactivate launch of schedule for this server (only 1 must be active on your cluster)|true
+
+## Kafka configuration
+|Name|Profile|Description|Example|
+|----|-------|-----------|-------|
+|auditrunner.kafka.bootstrap-servers|consumer, producer|Kafka server IP address and ports|localhost:9092
+|auditrunner.kafka.group|consumer, producer|Kafka group for audit runner|AUDIT_RUNNER
+|auditrunner.kafka.topic.auditrequest|consumer,producer|Kafka topic name for audit requests|AUDIT_REQUEST
\ No newline at end of file