owntracks-to-database

Motivations
License
Prerequisites
How to use

1. Motivations

Due to Owntracks recommending that users use their Recorder instead of o2s, and disliking the limitations of the Recorder vs some existing infrastructure available via a relational database, I made this tool.

2. License

The python3 flavor uses the EPL/EDL v1.0-licensed paho-mqtt and the BSD-licensed PyGreSQL. The combination should be distributable under the EPL 1.0 + EDL 1.0

The ruby flavor relies on the 2-clause BSD-licensed 'pg' gem and the MIT-licensed 'ruby-mqtt' gem; According to https://softwareengineering.stackexchange.com/questions/121998/mit-vs-bsd-vs-dual-license this means the ruby flavor is likely to be the same license as Ruby in general.

3. Prerequisites

General

Run the sql in owntracksDB.sql to generate the necessary schema and configure your usernames and passwords in a yaml configuration file that is specified via the --config flag. Example configuration:

mqtt:  
  host: localhost  
  port: 1883  
  ssl: :TLSv1  
  ca: /path/to/mqtt/ca.crt  
  ca_cert: /path/to/mqtt/ca.crt  
  username: mqttusername  
  password: mqttpassword  
database:  
  host: localhost  
  port: 5432  
  username: postgres  
  password: postgres  
  dbname: locationupdates  
metrics:  
  port: 8000

Alternatively, the script can be configured via environment variables. Specifying these will override any values found in a configuration file. These are the environment variables required:

OWNTRACKS2DB_MQTT_HOST
OWNTRACKS2DB_MQTT_PORT
OWNTRACKS2DB_MQTT_SSL
OWNTRACKS2DB_MQTT_CA
OWNTRACKS2DB_MQTT_USERNAME
OWNTRACKS2DB_MQTT_PASSWORD
OWNTRACKS2DB_DB_HOST
OWNTRACKS2DB_DB_PORT
OWNTRACKS2DB_DB_USERNAME
OWNTRACKS2DB_DB_PASSWORD
OWNTRACKS2DB_DB_NAME
OWNTRACKS2DB_METRICS_PORT

ruby

owntracks_to_db.rb runs under ruby 1.9.3 and up, with caveats in 1.9.3 as the pg gem is unable to serialize the json into the database so the 'rawdata' column will be empty. This shouldn't be an issue since that column can be generated from the other columns. These gems must be installed

logger
mqtt
pg

python

owntracks_to_db.py runs under python3 (tested with python 3.4 and 3.6). The following packages are required:

paho-mqtt
PyGreSQL
pyyaml
prometheus_client

The recommended way to install the python prerequisites is to pip install -r requirements.txt into a fresh virtualenv

4. How to use

While not recommended for production, a quick-and-dirty way to start the scripts is to just run them, if their environment is set up or you specify a configuration file:
nohup ruby owntracks_to_db.rb & will launch the ruby script in the background cleanly. The ruby version handles its own log rotation.

nohup python owntracks_to_db.py & will launch the python script in the background cleanly. The python version handles its own log rotation.

Otherwise, you can build the Docker image and run that with your own tooling.

vigevenoj/owntracks-to-db