+---------------------------------+
| Warden Map Client 1.0           |
+---------------------------------+

Content

  A. Introduction
  B. Configuration
  C. Usage & Help

------------------------------------------------------------------------------
A. Introduction

  Warden Map Client is very simple client for drawing a map with events from
  database of the Warden server. It consists of a Python 2.7 backend and
  a javascript/jquery frontend.

  Backend uses Warden API for downloading of events. Events are processed and
  enhanced with a geodata via freegeoip.net API. Finally warden-map.json file
  with information for the frontend is created.

  Frontend uses datamaps project (http://datamaps.github.io/) for visualisation
  of events on a map. It is possible to check details of the event by moving
  cursor on a arc. It is also possible to zoom map via scrolling and/or clicking
  on the plus, minus and, home buttons.

------------------------------------------------------------------------------
B. Configuration

  1. Copy frontend folder into desired location.

  2. Copy html snippet into your web page, or use it as an iframe.
     NOTE: If necessary, change css/js paths in a html snippet.

  3. Copy backend folder into desired location.

  4. Setup backend call (warden-map.py) in a crontab.
     NOTE: Please make sure you will have stored warden-map.json file
           in the fronted folder.
     EXAMPLE: ./warden-map.py --events 100 \
                              --client cz.cesnet.warden.map \
                              --key certs/key.pem \
                              --cert certs/cert.pem \
                              --cacert certs/cacert.pem \
                              --secret SeCreT \
                              --output ../fronted/

  5. Enjoy your map.

------------------------------------------------------------------------------
C. Usage & Help

usage: warden-map.py [-h] [--output /path/] --events <number> --client
                     <org.ex.cl> --key /path/key.pem --cert /path/cert.pem
                     --cacert /path/cacert.pem --secret <SeCreT>

optional arguments:
  -h, --help                 show this help message and exit
  --output path/            path where warden-map.json should be saved

required arguments:
  --events <number>          count of events for a map
  --client <org.ex.cl>       client name
  --key path/key.pem        SSL key for a client
  --cert path/cert.pem      SSL cert for a client
  --cacert path/cacert.pem  SSL cacert for a client
  --secret <SeCreT>          secret key for a client


------------------------------------------------------------------------------
Copyright (C) 2016 Cesnet z.s.p.o