Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circa10a/caddy-geofence
A caddy module for IP geofencing your caddy web server using ipbase.com
https://github.com/circa10a/caddy-geofence
caddy caddy-module caddy-plugin caddyserver geofence golang hacktoberfest redis webserver
Last synced: 21 days ago
JSON representation
A caddy module for IP geofencing your caddy web server using ipbase.com
- Host: GitHub
- URL: https://github.com/circa10a/caddy-geofence
- Owner: circa10a
- License: mit
- Created: 2021-11-15T03:29:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-13T18:55:12.000Z (6 months ago)
- Last Synced: 2024-12-15T03:40:56.239Z (26 days ago)
- Topics: caddy, caddy-module, caddy-plugin, caddyserver, geofence, golang, hacktoberfest, redis, webserver
- Language: Go
- Homepage:
- Size: 361 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# caddy-geofence
A caddy module for IP geofencing your caddy web server using https://ipbase.com/
[](https://goreportcard.com/report/github.com/circa10a/caddy-geofence)
- [caddy-geofence](#caddy-geofence)
- [Usage](#usage)
- [Build with caddy](#build-with-caddy)
- [Docker](#docker)
- [Caddyfile example](#caddyfile-example)
- [Development](#development)
- [Run](#run)
- [Build](#build)
## Usage
1. For an IP that is not within the geofence, `403` will be returned on the matching route.
2. An API token from [ipbase.com](https://ipbase.com/) is **required** to run this module.
## Caching
This module by default will use a configurable in-memory cache, should you need an external/persistent cache, the module supports [redis](https://redis.io/). See the caddyfile exmaple below for how to enable.
> Free tier includes 150 requests per month
### Build with caddy
```shell
# build module with caddy
xcaddy build --with github.com/circa10a/caddy-geofence
```
### Docker
```shell
docker run --net host -v /your/Caddyfile:/etc/caddy/Caddyfile -e IPBASE_API_TOKEN -p 80:80 -p 443:443 circa10a/caddy-geofence
```
## Caddyfile example
```
{
debug
order geofence before respond
}
:80
route /* {
geofence {
# cache_ttl is the duration to store ip addresses and if they are within proximity or not to increase performance
# Cache for 7 days, valid time units are "ms", "s", "m", "h"
# Not specifying a TTL sets no expiration on cached items and will live until restart
cache_ttl 168h
# ipbase.com API token, this example reads from an environment variable
ipbase_api_token {$IPBASE_API_TOKEN}
# radius is the distance of the geofence in kilometers
# If not supplied, will default to 0.0 kilometers
# 1.0 => 1.0 kilometers
radius 1.0
# allow_private_ip_addresses is a boolean for whether or not to allow private ip ranges
# such as 192.X, 172.X, 10.X, [::1] (localhost)
# false by default
# Some cellular networks doing NATing with 172.X addresses, in which case, you may not want to allow
allow_private_ip_addresses true
# allowlist is a list of IP addresses that will not be checked for proximity and will be allowed to access the server
allowlist 206.189.205.251 206.189.205.252
# status_code is the HTTP response code that is returned if IP address is not within proximity. Default is 403
status_code 403
# redis_enabled disables the in-memory cache and will connect to a remote redis instance
# default is false
redis_enabled true
# the : of the remote redis instance
# default is localhost:6379
redis_addr redis:6379
# redis_username is the username to connect to a secured redis instance
# default is ""
redis_username user
# redis_password is the password to connect to a secured redis instance
# default is ""
redis_password password
# redis_db is the id of the redis db to connect to to store cache ip addresses
# default is 0
redis_db 0
}
}
log {
output stdout
}
```
## Development
Requires [xcaddy](https://caddyserver.com/docs/build#xcaddy) to be installed
### Run
```shell
export IPBASE_API_TOKEN=
make run
```
### Build
```shell
make build
```
### Run redis enabled stack
```shell
export IPBASE_API_TOKEN=
make redis
```