Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include the data download and generate scripts … #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

include the data download and generate scripts … #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ Once all the data has been loaded into memory, queries are around 1.5 ms slower

-->

## Manually Updating The Geo Data
Every release of this package will have the most updated data, but if you want to update without installing a new version, this is how:
```shell
MAXMIND_LICENSE_KEY=<your key> python downloadDatabases.py
python processGeoIpCsv.py

```
(automate this with a cronjob or whatnot, in production)

## Benchmarks
Benchmarks were taken on my workstation and should be straightforward to reproduce with the scripts provided in this repo. HDD benchmarks were taken in an old laptop. Specs of both machines are the following:

Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
"build/index.js",
"build/index.d.ts",
"build/utils.js",
"build/params.js"
"build/params.js",
"downloadDatabases.py",
"processGeoIpCsv.py"
],
"main": "build/index.js",
"types": "build/index.d.ts",
Expand Down