Home

Getting Started

If you've set up RocketMap, then you've most likely set up a database. SQLite is not supported by this application. 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. If 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.

If you are sharing a database with RocketMap searchers, then I would recommend updating RocketMap first, and letting it get started. Then, if there is an update for this software to match those changes, use that as well.

So, now we're ready to go. But it's not useful yet. In order to send to the webhook, you must generate authorization tokens.

Please continue reading Token Management.