diff --git a/docs.json b/docs.json index 2875015..41a213a 100644 --- a/docs.json +++ b/docs.json @@ -172,6 +172,7 @@ "group": "Community Guides", "pages": [ "self-host/community-guides/overview", + "self-host/community-guides/remove-geoblock-plugin", "self-host/community-guides/crowdsec", "self-host/community-guides/metrics", "self-host/community-guides/homeassistant", diff --git a/manage/geoblocking.mdx b/manage/geoblocking.mdx index f060097..7f85339 100644 --- a/manage/geoblocking.mdx +++ b/manage/geoblocking.mdx @@ -88,4 +88,3 @@ Priority 4: Deny - Country: ALL ``` This configuration allows access only from the US, Canada, and UK while blocking all other countries. - diff --git a/self-host/community-guides/geoblock.mdx b/self-host/community-guides/geoblock.mdx index e4f222c..9ac5bb4 100644 --- a/self-host/community-guides/geoblock.mdx +++ b/self-host/community-guides/geoblock.mdx @@ -6,6 +6,10 @@ title: "GeoBlock" This is a community guide and is not officially supported. If you have any issues, please reach out to the [author](https://github.com/Lokowitz). + +Legacy guide. Pangolin now supports native geoblocking. If you previously installed this plugin, follow [Remove GeoBlock Plugin](/self-host/community-guides/remove-geoblock-plugin) before enabling native geoblocking. + + GeoBlock is a Traefik middleware that uses IP-based geolocation to allow or block traffic from specific countries. It helps enhance security and access control by restricting unwanted or potentially harmful connections based on geographic regions. ## Installation diff --git a/self-host/community-guides/overview.mdx b/self-host/community-guides/overview.mdx index 9403e17..5b06363 100644 --- a/self-host/community-guides/overview.mdx +++ b/self-host/community-guides/overview.mdx @@ -28,6 +28,10 @@ For additional information, consult the following resources: The GeoBlock plugin for Traefik is a middleware that restricts access based on the client’s geographic location. It runs within a Traefik container and uses IP-based geolocation to allow or block traffic from specific countries. This is useful for security, compliance, or access control in Traefik-managed services. + +Pangolin now supports native geoblocking. The GeoBlock plugin is considered legacy in Pangolin setups. If you previously installed it, follow [Remove GeoBlock Plugin](/self-host/community-guides/remove-geoblock-plugin) before enabling native geoblocking. + + For more details, please refer to the following resources: - [Github Repository](https://github.com/PascalMinder/geoblock) @@ -69,4 +73,3 @@ The Traefik Logs Dashboard is a real-time dashboard for analyzing Traefik logs w For more details, please refer to the following resources: - [Github Repository](https://github.com/hhftechnology/traefik-log-dashboard) - diff --git a/self-host/community-guides/remove-geoblock-plugin.mdx b/self-host/community-guides/remove-geoblock-plugin.mdx new file mode 100644 index 0000000..ca29b0e --- /dev/null +++ b/self-host/community-guides/remove-geoblock-plugin.mdx @@ -0,0 +1,66 @@ +--- +title: "Remove GeoBlock Plugin" +--- + + +This is a community guide and is not officially supported. If you have any issues, please reach out to the community on [Discord](https://pangolin.net/discord) or [Github discussions](https://github.com/orgs/fosrl/discussions). + + +Pangolin now supports native geoblocking. If you previously installed the Traefik GeoBlock plugin, remove it before enabling native geoblocking to avoid duplicate blocking or startup errors. + + +After cleanup, follow [Enable Geo-blocking](/self-host/advanced/enable-geoblocking) to configure native geoblocking in Pangolin. + + +## Remove the GeoBlock plugin + + + + Remove any references to `geoblock@file` from your Traefik entry points, routers, or labels. + + Example removal in `/config/traefik/traefik_config.yml`: + + ```yaml + entryPoints: + websecure: + http: + middlewares: + # Remove this line + - geoblock@file + ``` + + + Delete the GeoBlock plugin block from `/config/traefik/traefik_config.yml`: + + ```yaml + experimental: + plugins: + geoblock: + moduleName: github.com/PascalMinder/geoblock + version: v0.3.2 + ``` + + + Delete the GeoBlock middleware section from `/config/traefik/dynamic_config.yml`: + + ```yaml + http: + middlewares: + geoblock: + plugin: + geoblock: + ... + ``` + + + Restart Traefik to apply the changes: + + ```bash + docker restart traefik + ``` + + + +## Next steps + +Follow [Enable Geo-blocking](/self-host/advanced/enable-geoblocking) to configure native geoblocking in Pangolin.