geolite

making openstreetmap data usable by anyone: from .osm.pbf to the first query answer.

open source geocode

getting started

with cargo

$ cargo install geolite
$ geolite --version
$ geolite build brazil # needs +/- 45gb while building then +/- 3gb when finished
$ geolite http-server # open http://localhost:8080

with docker

# command line
$ docker run pjpimentel/geolite:latest --version
# pre-built countries geocodes
$ docker run -p 8080:8080 pjpimentel/geolite:prebuilt-brazil
# open http://localhost:8080

docs

1. source code modules
   1. database
   2. osm-pbf-file
   3. admin-level
   4. admin-level-hierarchy
   5. extract
   6. optimize
   7. query
   8. cli
   9. http
2. docker images
   1. base image
   2. pre-built images
3. cookbook
   1. execute all necessary steps
   2. extract each data from a pbf file
   3. index extracted data
   4. optimize data
   5. query
   6. explore
   7. merge separately-built databases
   8. run the end-to-end suite

docker images

base image

$ docker run pjpimentel/geolite:latest --version
$ docker run -t -v ./geolite-data:/.geolite pjpimentel/geolite:latest build brazil

pre-built images

size matters: once a country's data grows too large for a docker image, its pre-built image stops being updated and may be dropped.

docker run -p 8080:8080 pjpimentel/geolite:prebuilt-brazil
docker run -p 8080:8080 pjpimentel/geolite:prebuilt-brazil-YYYYMMDDHHMM
# open http://localhost:8080

available country list

cookbook

execute all necessary steps

$ geolite build brazil
# or with docker
$ docker run --rm -t -v ./geolite-data:/.geolite pjpimentel/geolite:latest build brazil
$ docker run --rm -p 8080:8080 -v ./geolite-data:/.geolite pjpimentel/geolite:latest http-server

extract each data from a pbf file

$ geolite osm-pbf-file download brazil
$ geolite extract osm-pbf-blob-chunks brazil
$ geolite extract osm-pbf-header brazil
$ geolite extract osm-pbf-data brazil
$ geolite --preset brazil extract osm-admin-levels
$ geolite --preset brazil extract osm-house-numbers

index extracted data

$ geolite index admin-levels-hierarchy
$ geolite --preset brazil index user-friendly-name
$ geolite index coordinates

optimize data

$ geolite optimize delete-intermediary-data
$ geolite optimize sqlite-file

query

$ geolite query "-23.970949,-46.318730"
$ geolite query "rua castro alves, embare, santos, sao paulo"

explore

$ geolite http-server

merge separately-built databases

# machine 1
$ geolite --sqlite-path sudeste.sqlite3 build sudeste
# machine 2
$ geolite --sqlite-path nordeste.sqlite3 build nordeste

# merge all builds into a new combined database (created fresh)
$ geolite --preset brazil merge brazil.sqlite3 sudeste.sqlite3 nordeste.sqlite3 ...

# or with docker 
$ docker run --rm -t -v ./geolite-data:/.geolite pjpimentel/geolite:latest --sqlite-path /.geolite/sudeste.sqlite3 build sudeste
$ docker run --rm -t -v ./geolite-data:/.geolite pjpimentel/geolite:latest --sqlite-path /.geolite/nordeste.sqlite3 build nordeste
$ docker run --rm -t -v ./geolite-data:/.geolite pjpimentel/geolite:latest --preset brazil merge /.geolite/brazil.sqlite3 /.geolite/sudeste.sqlite3 /.geolite/nordeste.sqlite3
$ docker run --rm -p 8080:8080 -v ./geolite-data:/.geolite pjpimentel/geolite:latest --sqlite-path /.geolite/brazil.sqlite3 http-server

run the end-to-end suite

$ cargo test --release --test '*' -- --ignored --nocapture

question and answers

a) why geolite?

"geo" comes from "geocode" and "lite" comes from "sqlite", no special meaning.

b) where does the data come from?

the data comes from any .osm.pbf file (openstreetmap's protobuffer format). this project uses geofabrik as the initial source, which extracts its data from openstreetmap.

c) which license applies?

the source code is under agplv3 and its dependencies keep their own (all permissive: mit, apache-2.0, bsd, zlib, isc). databases built from openstreetmap data — including the ones shipped in the prebuilt-* images — are derivative databases under the odbl, filtered and restructured for geocoding: © openstreetmap contributors.

d) why build another geocoder?

two reasons, in this order: to practice rust on a problem large enough to be interesting, and because the alternatives i tried were a bit too complex for a quick run.

license: GNU AGPLv3

this is a work in progress and, for now, new patch versions have no backward-compatibility guarantees