Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lrstanley/geoip

:globe_with_meridians: Geolocation API service -- Run it yourself! | alternative to freegeoip.net
https://github.com/lrstanley/geoip

api cli docker geoip go golang maxmind-geoip

Last synced: 18 days ago
JSON representation

:globe_with_meridians: Geolocation API service -- Run it yourself! | alternative to freegeoip.net

Host: GitHub
URL: https://github.com/lrstanley/geoip
Owner: lrstanley
License: mit
Created: 2015-03-08T08:38:42.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-09-23T16:26:49.000Z (about 2 months ago)
Last Synced: 2024-10-16T03:44:18.194Z (29 days ago)
Topics: api, cli, docker, geoip, go, golang, maxmind-geoip
Language: TypeScript
Homepage: https://geoip.pw
Size: 20.2 MB
Stars: 114
Watchers: 7
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
![logo](https://liam.sh/-/gh/svg/lrstanley/geoip?icon=fluent-emoji-flat%3Aglobe-showing-americas&icon.height=80&layout=left&bgcolor=rgba%282%2C+12%2C+18%2C+1%29)



  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





  

    

  

  

    

  

  

    

  

  

    

    

  

  

    

  

  



## :link: Table of Contents

  - [Installation](#computer-installation)

    - [Container Images (ghcr)](#whale-container-images-ghcr)

    - [Build From Source](#toolbox-build-from-source)

  - [Usage](#gear-usage)

    - [Example](#example)

  - [Support & Assistance](#raising_hand_man-support--assistance)

  - [Contributing](#handshake-contributing)

  - [License](#balance_scale-license)

## :computer: Installation

Check out the [releases](https://github.com/lrstanley/geoip/releases)

page for prebuilt versions.

### :whale: Container Images (ghcr)

```console

$ docker run -it --rm -p 8080:80 --env-file .env -v $PWD/:/data ghcr.io/lrstanley/geoip:latest

$ curl -I http://localhost:8080

HTTP/1.1 200 OK

Content-Type: text/html

Date: Thu, 06 Aug 2020 00:55:21 GMT

```

### :toolbox: Build From Source

Dependencies (to build from source only):

- [Go](https://golang.org/doc/install) (latest)

- [NodeJS](https://nodejs.org/en/download/) (v17)

Setup:

```console

git clone 

cd geoip

make

./geoip --help

```

## :gear: Usage

Take a look at the [CLI usage options here](./USAGE.md).

### Example

```console

geoip --http.bind-addr "localhost:8080" --http.limit 15000 --dns.resolver 8.8.8.8 --dns.resolver 8.8.4.4

```

## :raising_hand_man: Support & Assistance

* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for

     guidelines on ensuring everyone has the best experience interacting with

     the community.

* :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on

     guidelines for tips on how to ask the right questions.

* :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/geoip/issues/new/choose).

## :handshake: Contributing

* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines

     on ensuring everyone has the best experience interacting with the

    community.

* :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting

     issues/a guide on submitting pull requests and helping out.

* :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/geoip/security/policy).

## :balance_scale: License

```

MIT License

Copyright (c) 2015 Liam Stanley 

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

```

_Also located [here](LICENSE)_