How To (Docker)

Quick Start

Um das Docker Image zu starten muss docker-compose up ausgeführt werden.

Da die Credentials standardmäßig nicht gesetzt sind wird nach dem Start ein Index_Error geworfen, da essentielle Parameter fehlen. Daher muss sichergestellt werden, dass die nötigen Parameter übergeben werden die die OAuth Access Token für eine Twitter Application beinhalten.

Diese werden im docker-compose.yml gesetzt

Alternativ kann das Image auch über ein langes Docker-Kommando gestartet werden:

docker run --rm -it \
    -e CONSUMER_KEY="myFabolousConsumerKey" \
    -e CONSUMER_SECRET="myFabolouseConsumerSecret" \
    -e ACCESS_TOKEN="myFabolouseAccessToken" \
    -e ACCESS_TOKEN_SECRET="myFabolouseAccessTokenSecret" \
    -e DATABASE_REST_URL="http://myFaboulousRESTServer"\
    my_image_name

Verknüpfung mit notwendigen Modulen

Damit das Docker Image funktioniert muss dieser Container mit dem Container der Gruppe "Data Managemant" über Docker Links verknüpft werden.

Konfigurations-Parameter

Dieses Image wird durch folgende Environment-Variablen konfiguriert:

Parameter	Required	Default	Definition
CONSUMER_KEY	yes	''	Der Consumer Key der von Twitter bereitgestellt wird
CONSUMER_SECRET	yes	''	Das Consumer Secret das von Twitter bereitgestellt wird
ACCESS_TOKEN	yes	''	Der Access Token der von Twitter bereitgestellt wird
ACCESS_TOKEN_SECRET	yes	''	Das Token Secret der von Twitter bereitgestellt wird
TWEET_THRESHOLD	no	20	Die Anzahl der Tweets die intern gebuffert und dann gebündelt an die Persistenz weiter gegeben werden
DATABASE_REST_URL	yes	''	Die Host URL an der die REST-Schnittstelle der Datenbank gehostet und angesprochen wird. (z.B https://myDomain.com)
UPPER_RIGHT_LONGITUDE	no	'11.451602200000025'	Längengrad der oberen rechten Ecke des Quadrats in dem die Tweets liegen sollen
UPPER_RIGHT_LATITUDE	no	'53.8979416'	Breitengrad der oberen rechten Ecke des Quadrats in dem die Tweets liegen sollen
LOWER_LEFT_LONGITUDE	no	'9.391045899999995'	Längengrad der unteren linken Ecke des Quadrats in dem die Tweets liegen sollen
LOWER_LEFT_LATITUDE	no	'53.11264'	Breitengrad der unteren linken Ecke des Quadrats in dem die Tweets liegen sollen
DEBUGGING	no	'false'	Stellt den Debug Modus ein, im Debug Modus werden die erhaltenen Tweets auf der Konsole ausgegeben
DRY_RUN	no	'false'	Stellt den Dry Run Modus ein, im Dry Run Modus werden die Tweets nicht an die Persistenz gesendet
DB_ACCESS_TOKEN	yes	'superSecret'	Authentifizierungstoken zur Kommunikation mit der DB von AG4