Files
nym/explorer-api
Jędrzej Stuczyński 879ce3f2d5 Feature/field renaming (#1654)
* Replaced serde renames to aliases

Ideally I would have removed all serde macros, but then it would have broken existing QA deployments - perhaps we should do it later

* Renamed 'node_id' in Delegation to 'mix_id'

* Further renamings of 'node_id' to 'mix_id' in various places
2022-09-23 15:01:39 +01:00
..
2022-09-23 15:01:39 +01:00
2021-08-04 12:38:35 +01:00

Network Explorer API

An API that provides data for the Network Explorer.

Features:

  • geolocates mixnodes using https://app.ipbase.com/
  • calculates how many nodes are in each country
  • proxies mixnode API requests to add HTTPS

Running

Supply the environment variable GEOIP_DATABASE_PATH with a path that points to a GeoIP2 database file in binary format.

Run as a service and reverse proxy with nginx to add https with Lets Encrypt.

Setup nginx to inject the request IP to the header X-Real-IP.

Use https://github.com/maxmind/geoipupdate to automatically provide and update the GeoIP2 database file.

TODO / Known Issues

TODO

  • record the number of mixnodes on a given date and write to a file for later retrieval
  • dependency injection
  • tests