Browse Source

ReadMe aktualisiert

Helge Jung 9 years ago
parent
commit
e71c76cf3b
1 changed files with 8 additions and 5 deletions
  1. 8 5
      Readme.md

+ 8 - 5
Readme.md

@@ -19,22 +19,24 @@ Zusätzlich besteht die Möglichkeit der Datenabfrage über eine HTTP-JSON-Schni
 ## Installation
 
 ```
-sudo apt-get install python-daemon python-requests
+sudo apt-get install python-daemon python-redis python-requests
 sudo ln -s "`pwd`/contrib/init-script.sh" /etc/init.d/ffstatus
 echo "DAEMON_DIR=`pwd`" | sudo tee -a /etc/default/ffstatus
 sudo update-rc.d ffstatus defaults
 sudo update-rc.d ffstatus enable
 ```
 
-## Nutzung
+## Aufruf
 
+Ohne Paramter startet die BATCAVE mit einem lokalen Storage (storage.dat im aktuellen Verzeichnis).
+**Empfohlen wird jedoch die Verwendung von Redis als Storage-Backend.** Hierzu ist dem Parameter `-S` mindestens der String "redis:" anzugeben. Optional folgen können - jeweils mit Doppelpunkt getrennt - der Redis-Hostname, -Port und -Kennwort; z.B. `-S redis:localhost:6379:geheim`.
 ```
 usage: batcave.py [-h] [--logfile LOGFILE] [--interval INTERVAL] [-v] [-d]
                   [-n] [-A ALFRED_JSON] [-B BATADV_VIS] [-G GRAPHITE_HOST]
                   [--graphite-port GRAPHITE_PORT] [--dashing-url DASHING_URL]
                   [--dashing-token DASHING_TOKEN]
                   [--api-bind-host API_BIND_HOST]
-                  [--api-bind-port API_BIND_PORT] [-S STORAGE_DIR]
+                  [--api-bind-port API_BIND_PORT] [-S STORAGE]
 
 Batman/Alfred Transmission Collection, Aggregation & Value Engine
 
@@ -61,6 +63,7 @@ optional arguments:
                         API-Server Hostname
   --api-bind-port API_BIND_PORT
                         API-Server Port
-  -S STORAGE_DIR, --storage-dir STORAGE_DIR
-                        Path where to store data
+  -S STORAGE, --storage STORAGE
+                        Path where to store data or
+                        "redis:[<host>[:<port>[:<password>]]]"
 ```