Home

Getting Started

If you've set up RocketMap, then you've most likely set up a database. SQLite is not supported. You will need to use MySQL (MariaDB). This document assumes you can do this already. Also, if any network changes are needed (port forwards, firewalls, etc) it is assumed you know how to handle this.

Clone the project:
https://github.com/jagauthier/whserver.git

Install the requirements:
pip -r requirements.txt

The WH server can be run now, and the database will be created, if it does not exist. It you've pointed this to an existing database, and it's the same schema, your database will not be affected.

Note: If you're running a RocketMap schema older than this one, and connect this to that DB, this will attempt to update your database. This is not idiot proof. Quite simply, manage your software and add-on software appropriately.

As it is, running it now will not be useful. In order to send to the webhook, you must generate a key. This will serve as a deterrent for webhook poisoning.

When generating a token you must supply a human readable name (if you want to read it later). ./whserver -g <name>
Name could be: Mike, Dave, or, if you are doing this to aggregate your own data it could be a City. You'll see how this is useful later.

Tokens are stored in a database table and are never deleted buy the application.

An example:
./whserver.py -g Jason
Generating authorization token for Jason
Authorization token for Jason is: GGz90TO6YlUZcKehFH9MImKfI7U1LcME

Now, I can set my webhook to point to http://hostname|ip:port/GGz90TO6YlUZcKehFH9MImKfI7U1LcME

Fire up the webhook server, and RocketMap and data will begin to flow.

Please see "Command Line Parameters" for specific configuration options.