t e l i z e
_______________________
\ /_
\ \ ___ // /
__ \ ____ \ __ / \ /\ / ____
/ _/ //___/ __/_ // //___
\_ ____ / __ __ ____ ____ / ///
/ _, / _ / / //, / _
\\ /_ //_/\ /_ /
<0(--- _/ -h7- _/ \ . __/ ---- _/ --(0>
\ .\ /. .
\ .\ // /
_\ //___/
Y
Description
Telize is a REST API built in C with Kore allowing to get a visitor IP
address and to query location information from any IP address. It outputs
JSON-encoded IP geolocation data, and supports both JSON and JSONP.
Geolocation operations are performed using libmaxminddb which caches the
database in RAM. Therefore, Telize has very minimal overhead and should
be blazing fast.
Requirements
Dependencies
Telize requires Kore 3.2.0+ and libmaxminddb.
GeoIP2 databases
Telize requires the free GeoLite2 databases from MaxMind.
The GeoLite2 City and GeoLite2 ASN databases files should be placed
in /var/db/GeoIP.
Building
Using the kodev tool:
kodev build
Configuration
Running
Using the kodev tool:
kodev run
Access and Error logs
The default Telize configuration does not have logging enabled, it must be
configured manually.
If your Telize instance produces lots of logs, Logswan might be of
interest.
Telize and proxies
CORS Support (Cross-origin resource sharing)
Telize has CORS enabled by default with the following policy:
Access-Control-Allow-Origin: *
Usage
For complete API documentation and usage examples, please check the
project site.
Get IP address in Plain text format
- Example: http://127.0.0.1/ip
Get IP address in JSON format
- Example (JSON): http://127.0.0.1/jsonip
- Example (JSONP): http://127.0.0.1/jsonip?callback=getip
Get IP address location in JSON format
Calling the API endpoint without any parameter will return the visitor
IP address:
- Example (JSON): http://127.0.0.1/location
- Example (JSONP): http://127.0.0.1/location?callback=getgeoip
Appending an IP address as parameter will return location information for
the given address:
- Example (JSON): http://127.0.0.1/location/46.19.37.108
- Example (JSONP): http://127.0.0.1/location/46.19.37.108?callback=getgeoip
License
Telize is released under the BSD 2-Clause license. See LICENSE file
for details.
Author
Telize is developed by Frederic Cambus.
- Site: https://www.cambus.net
Resources
Project homepage: https://www.telize.com
Latest tarball release: https://www.statdns.com/telize/telize-2.0.0.tar.gz