cotugno/recorder
2
Fork 0
mirror of https://github.com/owntracks/recorder.git synced 2024-11-16 02:18:27 -07:00
Code Issues Packages Projects Releases Wiki Activity
c20d6a3158
recorder/doc/OPENCAGE.md
Jan-Piet Mens 8d36de816a Fully support OpenCage as a reverse geocoder 
closes #234
	addresses #202
	addresses #233
2018-05-04 09:34:02 +02:00

1.6 KiB
Raw Blame History

OpenCage

We now (since May 2018) recommend using OpenCage as reverse geo-coding provider: their pricing is attractive and they currently offer a free tier which allows up to 2,500 requests per day.

Use the OpenCage API in Recorder simply by setting the --geokey option to the string "opencage:" with your API key concatenated to it. (Without the substring opencage: the Recorder falls back to using Google in order to maintain backwards-compatibility.)

--geokey "opencage:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Be aware that the Recorder uses the following settings: no_record=1&limit=1. OpenCage documents the first as meaning it will not log the request, and that protects your privacy.

In order to use OpenCage with the Recorder using Lua, proceed as follows:

  1. Make sure you've built the Recorder with support for Lua
  2. Install the required Lua modules:
luarocks install lua-opencage-geocoder
  1. Obtain an OpenCage API key, and make careful note of that.
  2. Before launching the Recorder, export the API key to the Recorder's environment
export OPENCAGE_APIKEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  1. Add a Lua script for the Recorder, which looks like our example OpenCage Lua script
  2. Launch the Recorder using something along these lines:
ot-recorder --lua-script opencage.lua 'owntracks/#'
  1. Note that you'll currently still require a Google Maps browser API key for the actual maps.