mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-02-08 05:56:45 +00:00
a02e360bfd
Added a tip suggesting the use of Maxmind's Docker container to automate GeoIP database updates, with a link to a relevant community guide.
66 lines
2.2 KiB
Plaintext
66 lines
2.2 KiB
Plaintext
---
|
|
title: "Enable Geo-blocking"
|
|
description: "Configuration requirements to enable geoblocking in Pangolin"
|
|
---
|
|
|
|
To enable geoblocking in Pangolin Community you must download and place the Maxmind geoip database into the `config/` directory and update the config file. This can be done for free.
|
|
|
|
<Tip>
|
|
Remember to keep the GeoIP database updated regularly, as IP-to-country mappings can change over time. You can just repeat the download and extraction steps periodically to ensure your database is current.
|
|
</Tip>
|
|
|
|
<Tip>
|
|
It is possible to automate this process with a Docker container from Maxmind themself.
|
|
Have a look at this [Community guide](/self-host/community-guides/geolite2automation) on how to implement this!
|
|
</Tip>
|
|
|
|
You can use the installer to download and place the database for you, just grab the latest installer:
|
|
|
|
```bash
|
|
curl -fsSL https://pangolin.net/get-installer.sh | bash
|
|
```
|
|
Then run the installer again:
|
|
|
|
```bash
|
|
./installer
|
|
```
|
|
|
|
### Manual Installation Steps
|
|
|
|
<Steps>
|
|
<Step title="Download and extract the GeoIP database">
|
|
Download and extract the GeoLite2 Country database using the following commands:
|
|
|
|
```bash
|
|
# Download the GeoLite2 Country database
|
|
curl -L -o GeoLite2-Country.tar.gz https://github.com/GitSquared/node-geolite2-redist/raw/refs/heads/master/redist/GeoLite2-Country.tar.gz
|
|
|
|
# Extract the database
|
|
tar -xzf GeoLite2-Country.tar.gz
|
|
|
|
# Move the .mmdb file to the config directory
|
|
mv GeoLite2-Country_*/GeoLite2-Country.mmdb config/
|
|
|
|
# Clean up the downloaded files
|
|
rm -rf GeoLite2-Country.tar.gz GeoLite2-Country_*
|
|
```
|
|
</Step>
|
|
<Step title="Update the Pangolin config file">
|
|
Update your Pangolin configuration to point to the new GeoIP database file. Edit your `config/config.yml` file to include the following entry:
|
|
|
|
```yaml
|
|
server:
|
|
maxmind_db_path: "./config/GeoLite2-Country.mmdb"
|
|
```
|
|
</Step>
|
|
<Step title="Restart Pangolin">
|
|
Restart your Pangolin instance to apply the changes:
|
|
|
|
```bash
|
|
docker compose restart pangolin
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
Alternativly you can create an account at [Maxmind](https://www.maxmind.com/en/geolite2/signup) to get a license key and download the database directly from them.
|