https://github.com/mroth/nanogeoip

:dragon: tiny and blazing fast experimental geoip microservice
https://github.com/mroth/nanogeoip

api geoip geolocation microservice

Last synced: 2 months ago
JSON representation

:dragon: tiny and blazing fast experimental geoip microservice

• Host: GitHub
• URL: https://github.com/mroth/nanogeoip
• Owner: mroth
• Created: 2018-12-14T20:38:48.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-30T22:48:30.000Z (about 6 years ago)
• Last Synced: 2024-11-02T03:32:56.034Z (2 months ago)
• Topics: api, geoip, geolocation, microservice
• Language: Rust
• Homepage:
• Size: 106 KB
• Stars: 8
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-blazingly-fast - nanogeoip - :dragon: tiny and blazing fast experimental geoip microservice (Rust)

README

        
# nanogeoip :dragon:

[![Build Status](https://travis-ci.com/mroth/nanogeoip.svg?branch=master)](https://travis-ci.com/mroth/nanogeoip)

A tiny and blazing fast HTTP based microservice for extremely minimal geoip

location lookups.

This is a work-in-progress experimental Rust port of [tinygeoip] (by the same

author). It is additionally built on top of rapidly evolving unstable crates and

language features, so should not be used in production just quite yet.

[tinygeoip]: https://github.com/mroth/tinygeoip

## API

Identical to [tinygeoip], so for now, go there for documentation.

## Performance

TODO

## Installing and running the server

Compile with standard Rust toolchain or download a binary for your platform from

the [Releases] page.

```

nanogeoip 0.1.0

A tiny (and blazing fast!) geoip lookup microservice

USAGE:

    nanogeoip [OPTIONS] [db]

FLAGS:

    -h, --help       Prints help information

    -V, --version    Prints version information

OPTIONS:

    -a           Address to listen for connections on [default: 0.0.0.0]

    -o         'Access-Control-Allow-Origin' header [default: *]

    -p           Port to listen for connections on [default: 9000]

ARGS:

        MaxMind database file [default: data/GeoLite2-City.mmdb]

```

[releases]: https://github.com/mroth/tinygeoip/releases

## Rust library

For more information, see the [Rust Docs]. (Note: these are only built online

for tagged and pushed releases on crates.io, so you'll have to build locally if

you need them right now.)

[rust docs]: https://docs.rs/nanogeoip

## Stability

:construction: The current API is considered _unstable_. This is just being

released and I'd like some feedback to make any potential changes before tagging

a `v1.0` which will maintain API stability.

In other words, comments and feedback wanted!

## License

This is still in progress and is not yet considered released software yet.

Please contact me if you have a need for a license ASAP.

## Code of Conduct

Please note that this project is released with a [Contributor Code of

Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to

abide by its terms.