Skip to content

Free, open-source Google Maps scraper for lead generation (Python, no API key, no Docker). Exports name, phone, email, website, rating and Instagram/Facebook/LinkedIn/TikTok/YouTube/X links to CSV. 100 places with emails in 44 s; --grid beats Google's 120 cap. MX email check, ad-pixel detection. Skill for Claude Code, Codex and Cursor.

feat(ui): web UI links to this kit and its sponsors

Mahan Jafari870ce6d37908
diff --git a/README.md b/README.md
index 707769c..c7ed2e5 100644
--- a/README.md
+++ b/README.md
@@ -292,6 +292,7 @@ If this kit saved you an afternoon of copy-pasting, a star helps the next person
```
google-maps-scraper-kit/
├── docker-compose.yml local engine on 127.0.0.1:8080
+├── ui-branding.conf nginx proxy: web UI links to this kit and its sponsors
├── .env.example config template
├── scripts/
│ ├── scrape.py Python CLI: single, batch, geocoding, socials, CSV
diff --git a/SETUP.md b/SETUP.md
index 4b15b16..fd7817d 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -194,7 +194,8 @@ curl -X DELETE http://localhost:8080/api/v1/jobs/<job-id>
### No Compose? Run the same container with `docker run`
-`docker-compose.yml` is thin. This command is the exact equivalent, including the localhost binding:
+This command runs the engine alone, with the localhost binding. It skips the `ui` proxy from
+`docker-compose.yml`, so the web UI shows upstream's GitHub and sponsor links; the API is the same:
```bash
docker run -d --name gmaps-scraper --restart unless-stopped \
diff --git a/docker-compose.yml b/docker-compose.yml
index 2c8b39b..7cbcc83 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -17,12 +17,23 @@ services:
container_name: gmaps-scraper
restart: unless-stopped
command: ["-web", "-data-folder", "/gmapsdata"]
+ # No published port: the engine is reached only through the ui service below.
+ volumes:
+ - gmaps_data:/gmapsdata # job results; they persist until you delete the job or the volume
+ - gmaps_cache:/opt # Playwright browser cache, so restarts skip the download
+
+ # Serves the engine's UI and API with the kit's own GitHub and sponsor links (ui-branding.conf).
+ ui:
+ image: nginx:1.27-alpine
+ container_name: gmaps-scraper-ui
+ restart: unless-stopped
+ depends_on:
+ - google-maps-scraper
ports:
# Host port comes from SCRAPER_PORT in .env (default 8080). The container side stays 8080.
- "127.0.0.1:${SCRAPER_PORT:-8080}:8080" # localhost only, see the warning above
volumes:
- - gmaps_data:/gmapsdata # job results; they persist until you delete the job or the volume
- - gmaps_cache:/opt # Playwright browser cache, so restarts skip the download
+ - ./ui-branding.conf:/etc/nginx/conf.d/default.conf:ro
volumes:
gmaps_data:
diff --git a/ui-branding.conf b/ui-branding.conf
new file mode 100644
index 0000000..9d85956
--- /dev/null
+++ b/ui-branding.conf
@@ -0,0 +1,24 @@
+# Fronts the engine's web UI so its "Star on GitHub" button and sponsor box point at this kit
+# instead of upstream. The engine embeds its HTML in the binary, so the links are rewritten in
+# flight. sub_filter only touches text/html: API JSON and CSV downloads pass through unchanged.
+server {
+ listen 8080;
+
+ # Docker's DNS, re-resolved so a recreated engine container is still found.
+ resolver 127.0.0.11 valid=10s;
+ set $engine http://google-maps-scraper:8080;
+
+ location / {
+ proxy_pass $engine;
+ proxy_set_header Host $http_host;
+ proxy_set_header Accept-Encoding ""; # sub_filter cannot rewrite a gzipped body
+
+ sub_filter_once off;
+ sub_filter 'github.com/gosom/google-maps-scraper' 'github.com/Mahanaicoach/google-maps-scraper-kit';
+ sub_filter 'github.com/sponsors/gosom' 'github.com/sponsors/Mahanaicoach';
+ sub_filter 'Sponsor on GitHub' 'Become a sponsor';
+ # Same sponsors, order and links as the README's "Sponsored by" section.
+ sub_filter '<p class="sponsor-text">Support the ongoing maintenance and development of this project by becoming a sponsor. Your contribution helps ensure the tool\'s continued improvement and reliability.</p>'
+ '<p class="sponsor-text">Sponsored by <a href="https://www.swiftproxy.net/?ref=googlemapsscraperkit" target="_blank" rel="sponsored noopener"><strong>Swiftproxy</strong></a>, residential proxies for Google Maps scraping (10% off with code <strong>PROXY90</strong>), and <a href="https://serpapi.com/maps-scraper-kit-github" target="_blank" rel="sponsored noopener"><strong>SerpApi</strong></a>, the Google Maps API in JSON and Markdown.</p>';
+ }
+}