https://github.com/alisinabh/atlas
A simple performant GeoIP server written in Rust using MaxMind DBs with auto database update
https://github.com/alisinabh/atlas
geoip geoip-api geoip-lookup geoip2 geolocation maxmind maxmind-geoip
Last synced: about 1 month ago
JSON representation
A simple performant GeoIP server written in Rust using MaxMind DBs with auto database update
- Host: GitHub
- URL: https://github.com/alisinabh/atlas
- Owner: alisinabh
- License: apache-2.0
- Created: 2024-04-20T01:27:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T19:27:37.000Z (about 1 month ago)
- Last Synced: 2025-03-16T06:24:03.408Z (about 1 month ago)
- Topics: geoip, geoip-api, geoip-lookup, geoip2, geolocation, maxmind, maxmind-geoip
- Language: Rust
- Homepage:
- Size: 521 KB
- Stars: 51
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Atlas
[](https://github.com/alisinabh/atlas-rs)
Atlas is a geoip HTTP service built in Rust, designed to simplify IP GeoLocation by automatically
managing MaxMind databases. It ensures that users have up-to-date IP data without the hassle of
manual downloads and updates. This tool is perfect for services who need reliable and fast
IP GeoLocation lookup in their applications using a very simple HTTP API.
Learn more about Atlas in [**my blog post here**](https://hackernoon.com/ip-geo-location-local-database-vs-remote-apifinding-the-middle-ground-with-atlas).
## Features
- Automatic Database Updates: Automatically downloads and updates MaxMind's GeoIP databases.
- Dead-simple HTTP API: Atlas has a very simple HTTP API that users can use and query IP Data.
- Efficient and Low Memory Footprint: Built with Rust for safety and performance also to minimize memory footprint during database updates and normal operations.
- Configurable: Allows users to select which edition of the MaxMind databases they want to use (e.g., GeoLite2, GeoIP2, Enterprise, ISP).
## Running Atlas
To run Atlas, you can choose one of the methods below.
### Using Docker (Recommended)
We automatically build docker images of Atlas and push them to [docker hub](https://hub.docker.com/r/alisinabh/atlas).
You can easily run our docker image which automatically downloads the latest MaxMind DB like this.
```
docker run -it --rm \
-e "MAXMIND_ACCOUNT_ID={account id here}" \
-e "MAXMIND_LICENSE_KEY={license_key_here}" \
-p 8080:8080 \
alisinabh/atlas
```
Same image can be used for deploying Atlas to Kubernetes or other orchestration platforms. By default, the databases will be saved at
`/opt/atlas/db` directory. It is recommended to mount this path to a persistant storage medium to avoid downloading a new DB on every restart.
For more configuration variables, visit [Configuration](#configuration) section.
### Compiling from source
Firstly, make sure you have rustc and cargo installed. Then after cloning the repository you can
simply run the following command to build a release binary to use in your service.
```
cargo build --release
```
You can find the release binaries at `target/release/atlas`. Then you can run atlas by running
`./target/release/atlas` in your terminal. Make sure that the `DB_PATH` directory already exists
otherwise atlas crashes on startup.
## API Documentation
Atlas generates OpenApi 3.0 specifications for its APIs. We host our main branch docs at https://atlas-rs.fly.dev/swagger-ui/.
You can also enable the `/swagger-ui` endpoint locally or in your deployments by setting `SWAGGER_UI_ENABLED` to `true`.
## Configuration
Atlas uses OS environment variables for configuration. Here are the list of environment variables
that atlas looks into.
- `MAXMIND_ACCOUNT_ID`: Your Maxmind Account ID used to download the database. **Required** (Get GeoLite2 databses for free at https://dev.maxmind.com/geoip/geolite2-free-geolocation-data)
- `MAXMIND_LICENSE_KEY`: Your Maxmind license key used to download the database. **Required** (Generate a License Key from maxmind portal)
- `MAXMIND_DB_VARIANT`: (Also called Edition ID) The database edition to used. Default is `GeoLite2-City`.
- `MAXMIND_DB_DOWNLOAD_URL`: Database download URL (only change if your download URL differs). Default is `https://download.maxmind.com/geoip/databases/{VARIANT}/download?suffix=tar.gz`. `{VARIANT}` literal will be replaced by `MAXMIND_DB_VARIANT` value.
- `DB_PATH`: Default path to save databases in. Default is `/opt/atlas/db`.
- `DB_UPDATE_INTERVAL_SECONDS`: How often to check for updates in seconds. Default is a day (86400s).
- `HOST`: Host to serve Atlas API on. Default is `0.0.0.0`.
- `PORT`: Port number to serve Atlas API on. Default is `8080`.
- `SWAGGER_UI_ENABLED`: If set to `true` swagger UI will be served on `http://{HOST}:{PORT}/swagger-ui` endpoint. Default is `false`.
## Contribution
Contributions to Atlas are very welcome! Before undertaking any substantial work, please consider
opening an issue to discuss ideas and planned approaches so we can ensure we keep progress moving
in the same direction. Always remember to be respectful of others.
## License
[Apache License 2.0](/LICENSE)