Skip to content
Back to search

geolens

Self-hosted geospatial data catalog with semantic search (pgvector), OGC/STAC APIs, and map builder. Built on FastAPI, PostGIS, React, and MapLibre.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/geolens-io/geolens with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/geolens-io/geolens'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/geolens-io--geolens/badge.svg)](/listings/geolens-io--geolens)

HTML

<a href="/listings/geolens-io--geolens"><img src="/api/listings/geolens-io--geolens/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

These steps run a script from the network that findsafeskills does not scan.

**Prerequisites:** Docker Engine 24+ and Docker Compose v2. The bundled stack ships PostgreSQL 18. If you point GeoLens at an externally managed database, it must be **PostgreSQL 15+** (for `NULLS NOT DISTINCT` unique indexes) with **pgvector 0.5+** (for HNSW semantic-search indexes), plus PostGIS, pg_trgm, and unaccent. The API and worker run in containers (Python 3.14 bundled, no host Python needed). The optional CLI runs on your host and requires Python 3.11+; the Python SDK and seed scripts require Python 3.10+.

Clone the repo and run the installer from the checkout. You can read the script before running it; from a clone it builds the images locally:

git clone https://github.com/geolens-io/geolens.git
cd geolens
bash scripts/install.sh

The one-line form runs the same script and pulls the prebuilt, version-pinned images instead of building them:

curl -fsSL https://getgeolens.com/install.sh | sh

Either way, `scripts/install.sh` copies `.env.example` to `.env`, generates a JWT signing secret, sets up admin credentials, and runs `docker compose up -d`. The admin **username** defaults to `admin`; the admin **password** is auto-generated as a strong random value (written to `.env`, never printed to your terminal) unless you supply your own. For unattended installs, set `GEOLENS_ADMIN_USERNAME` and `GEOLENS_ADMIN_PASSWORD` in the environment before running and the prompts are skipped. Re-running the script is idempotent: existing values in `.env` are preserved.

Wait about 60 seconds for services to start, then open [http://localhost:8080](http://localhost:8080). Log in with your admin username and the generated password (retrieve it with `grep '^GEOLENS_ADMIN_PASSWORD=' geolens/.env` — the one-line installer clones into `geolens/` under the directory you ran it from; inside a source checkout it's just `.env`).

Verify all services are healthy:

docker compose ps

First-run notes: the one-line install **pulls** prebuilt images and is up in about a minute (only the small PostGIS + pgvector database layer builds locally). Cloning and running `bash scripts/install.sh` instead **builds** every image from source: 5-10 minutes on the first run (GDAL + Postgres extensions + the frontend bundle); subsequent starts settle in ~60 seconds either way. If ports 5434/8001/8080 are already taken, change `DB_PORT`, `API_PORT`, or `FRONTEND_PORT` in `.env`. For port conflicts, stuck startups, out-of-memory, and migration warnings, see the [Troubleshooting guide](https://docs.getgeolens.com/guides/quickstart/install/#troubleshooting).

For production deployment, see the [Install Guide](https://docs.getgeolens.com/guides/quickstart/install/). A Kubernetes Helm chart lives in the separate [`geolens-deployments`](https://github.com/geolens-io/geolens-deployments) repo.

Verify the installer

Each [GitHub Release](https://github.com/geolens-io/geolens/releases) attaches a `SHA256SUMS` file generated by CI alongside `install.sh`. To confirm a downloaded installer was not tampered with before running it, download both assets from the same release and place them in the same directory, then run:

# Linux / Windows WSL
sha256sum -c SHA256SUMS

# macOS
shasum -a 256 -c SHA256SUMS

A passing check prints `install.sh: OK`.

Upgrading

To upgrade a prebuilt install, run `./scripts/upgrade.sh` from your install directory. It backs up the database, pulls the new images, runs migrations behind a health gate, and prints a rollback recipe if anything fails. See [`UPGRADING.md`](UPGRADING.md) for the prebuilt and source-build flows plus rollback, or the online [Upgrade Guide](https://docs.getgeolens.com/guides/quickstart/upgrade/).

Add your first dataset

The repo ships a small `city-parks.geojson`. Upload and publish it in one command with the **GeoLens CLI**:

pip install geolens-cli                              # installs the `geolens` command

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 395 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <picture>
  3. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-emblem-dark.svg">
  4. <img src=".github/assets/geolens-emblem.svg" alt="GeoLens logo: a magnifying glass over a globe with crosshair ticks" width="96">
  5. </picture>
  6. </p>
  7. <h1 align="center">GeoLens</h1>
  8. <p align="center">
  9. <b>A self-hosted spatial data catalog and map builder that keeps track of where every dataset came from.</b>
  10. </p>
  11. <p align="center">
  12. <a href="https://demo.getgeolens.com"><b>Live demo</b></a> ·
  13. <a href="#install">Install</a> ·
  14. <a href="https://docs.getgeolens.com">Documentation</a> ·
  15. <a href="#use-the-data-from-anywhere">Connect QGIS or code</a> ·
  16. <a href="https://github.com/geolens-io/geolens/discussions">Discussions</a>
  17. </p>
  18. <div align="center">
  19. [English](README.md) · [Español](README.es.md) · [Français](README.fr.md) · [Deutsch](README.de.md) · [简体中文](README.zh.md)
  20. [![Latest release](https://img.shields.io/github/v/release/geolens-io/geolens?style=flat-square&label=release)](https://github.com/geolens-io/geolens/releases/latest)
  21. [![CI status](https://img.shields.io/github/actions/workflow/status/geolens-io/geolens/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/geolens-io/geolens/actions/workflows/ci.yml)
  22. [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-2563eb?style=flat-square)](LICENSE)
  23. [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/geolens-io/geolens/badge)](https://securityscorecards.dev/viewer/?uri=github.com/geolens-io/geolens)
  24. [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/15857/badge)](https://www.bestpractices.dev/projects/15857)
  25. </div>
  26. <p align="center">
  27. <a href="https://demo.getgeolens.com/maps">
  28. <picture>
  29. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-manhattan-3d-hero-dark.jpg">
  30. <img src=".github/assets/geolens-manhattan-3d-hero.jpg" alt="The GeoLens map builder showing Manhattan's buildings extruded to their surveyed roof heights and colored by construction era, with the subway network, the layer list and a legend" width="100%">
  31. </picture>
  32. </a>
  33. <br>
  34. <sub>Manhattan's buildings at their surveyed roof heights, colored by construction era, with the subway network. <a href="https://demo.getgeolens.com/maps">Browse the demo's maps</a>.</sub>
  35. </p>
  36. GeoLens is for teams whose spatial data is spread across file shares, PostGIS databases, web
  37. services and STAC catalogs. It puts that data in one searchable catalog, records where each
  38. dataset came from and checks whether the source is still current. Teams build and share maps in
  39. the browser, and QGIS, scripts and AI agents read the same data through OGC API and STAC. It runs
  40. on your own servers with Docker Compose, sends no telemetry and is licensed under Apache 2.0.
  41. The [demo](https://demo.getgeolens.com) needs no install or account; sign in with Google, GitHub
  42. or Microsoft to use the map builder. Demo data may be wiped at any time.
  43. ## A closer look
  44. <table>
  45. <tr>
  46. <td width="50%" valign="top">
  47. <picture>
  48. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-catalog-search-dark.png">
  49. <img src=".github/assets/geolens-catalog-search.png" alt="GeoLens catalog search for 'where storms hit the coast', signed out, listing hurricane and coastal datasets with type, source and freshness badges beside the dataset filters" width="100%">
  50. </picture>
  51. <br><sub>Search by meaning: "where storms hit the coast" finds hurricane tracks and coastal exposure layers.</sub>
  52. </td>
  53. <td width="50%" valign="top">
  54. <picture>
  55. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-dataset-page-dark.png">
  56. <img src=".github/assets/geolens-dataset-page.png" alt="The dataset page for Atlantic Hurricane Tracks: storm tracks on a map preview, badges for vector, uploaded, source fresh, published and public, and the feature count, geometry, CRS, version and column count" width="100%">
  57. </picture>
  58. <br><sub>Each dataset has a page with its metadata and source, plus a map preview when it has an extent.</sub>
  59. </td>
  60. </tr>
  61. <tr>
  62. <td width="50%" valign="top">
  63. <picture>
  64. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-import-preview-dark.png">
  65. <img src=".github/assets/geolens-import-preview.png" alt="The Import Data page's Service URL tab previewing the USGS Significant Earthquakes ArcGIS layer: CRS, geometry type, feature count, layer name and sample rows" width="100%">
  66. </picture>
  67. <br><sub>Before you import a service layer, GeoLens previews its columns and first rows.</sub>
  68. </td>
  69. <td width="50%" valign="top">
  70. <picture>
  71. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-version-history-dark.png">
  72. <img src=".github/assets/geolens-version-history.png" alt="Version history of the Significant Volcanic Eruptions dataset: three GeoJSON versions with dates, file names and feature counts, the current one marked, and a Restore button on the previous version" width="100%">
  73. </picture>
  74. <br><sub>Each replacement is recorded in the history, and you can restore the previous version.</sub>
  75. </td>
  76. </tr>
  77. <tr>
  78. <td width="50%" valign="top">
  79. <picture>
  80. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-builder-style-dark.png">
  81. <img src=".github/assets/geolens-builder-style.png" alt="The map builder with the Restless Earth map on a globe: an earthquake heatmap along the Pacific plate boundaries, the grouped layer list and the heatmap style panel with its color ramps" width="100%">
  82. </picture>
  83. <br><sub>Layers render as points, symbols, heatmaps or clusters, and the ramp list can be limited to colorblind-safe ones.</sub>
  84. </td>
  85. <td width="50%" valign="top">
  86. <picture>
  87. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-matterhorn-terrain-dark.jpg">
  88. <img src=".github/assets/geolens-matterhorn-terrain.jpg" alt="The GeoLens map builder rendering the Matterhorn as 3D terrain from swissALTI3D lidar, with labeled peaks, climbing routes, the layer list and a legend" width="100%">
  89. </picture>
  90. <br><sub>3D terrain from your own elevation data, here the Matterhorn from swissALTI3D lidar.</sub>
  91. </td>
  92. </tr>
  93. <tr>
  94. <td width="50%" valign="top">
  95. <picture>
  96. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-stac-imagery-dark.jpg">
  97. <img src=".github/assets/geolens-stac-imagery.jpg" alt="The map builder showing four dated Sentinel-2 true-color scenes over New York City and northern New Jersey, referenced from the Earth Search STAC catalog, with the layer list and legend" width="100%">
  98. </picture>
  99. <br><sub>Sentinel-2 scenes referenced from a STAC catalog. The imagery stays where it is and is tiled on request.</sub>
  100. </td>
  101. <td width="50%" valign="top">
  102. <picture>
  103. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-share-embed-dark.png">
  104. <img src=".github/assets/geolens-share-embed.png" alt="The Share dialog for a map: visibility set to Public, with Only you and All team members as the other options, a share link and an iframe embed code" width="100%">
  105. </picture>
  106. <br><sub>Keep a map to yourself, open it to your team, or make it public with a link and embed code.</sub>
  107. </td>
  108. </tr>
  109. <tr>
  110. <td width="50%" valign="top">
  111. <picture>
  112. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-admin-overview-dark.png">
  113. <img src=".github/assets/geolens-admin-overview.png" alt="The admin Overview page: All Systems Operational, with database, storage, cache and tile cache status, total datasets, recent additions and storage used, beside the admin menu" width="100%">
  114. </picture>
  115. <br><sub>The admin overview shows service health next to dataset and storage totals.</sub>
  116. </td>
  117. <td width="50%" valign="top">
  118. <picture>
  119. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-admin-permissions-dark.png">
  120. <img src=".github/assets/geolens-admin-permissions.png" alt="The admin Permissions page: capabilities such as Upload Datasets, Export Data, Edit Metadata and Manage Users, with a checkbox for each of the viewer, editor and admin roles" width="100%">
  121. </picture>
  122. <br><sub>Viewer, editor and admin roles, with each capability switched on or off per role.</sub>
  123. </td>
  124. </tr>
  125. </table>
  126. ## How it fits together
  127. ```mermaid
  128. flowchart LR
  129. subgraph IN ["Bring data in"]
  130. F["Files<br/>GeoPackage · Shapefile · GeoParquet<br/>GeoTIFF · COPC · 3D Tiles"]
  131. DB["Existing PostGIS tables"]
  132. SVC["Services<br/>ArcGIS · WFS · OGC API Features"]
  133. ST["Remote STAC assets"]
  134. end
  135. subgraph GL ["GeoLens"]
  136. CAT["Catalog<br/>search · metadata · provenance"]
  137. MB["Map builder<br/>styles · 3D · analysis · stories · dashboards · sharing"]
  138. STD["Open APIs<br/>OGC API · STAC · DCAT · tiles"]
  139. end
  140. subgraph OUT ["Use it anywhere"]
  141. WEB["Browsers and embeds"]
  142. GIS["QGIS · ArcGIS · CesiumJS"]
  143. CODE["curl · Python · TypeScript · DuckDB"]
  144. AG["AI agents via MCP"]
  145. end
  146. F & DB & SVC & ST --> CAT
  147. CAT --> MB --> WEB
  148. CAT --> STD --> GIS & CODE & AG
  149. ```
  150. ## One catalog for scattered data
  151. - Upload Shapefile, GeoPackage, GeoJSON, GeoParquet, FlatGeobuf, KML/KMZ, zipped File
  152. Geodatabase, CSV, Excel or GeoTIFF (converted to Cloud-Optimized GeoTIFF). 3D Tiles and COPC
  153. point clouds are hosted for CesiumJS, QGIS and Potree.
  154. - Serve tables already in GeoLens's PostGIS database in place, import WFS, ArcGIS and OGC API
  155. Features layers and refresh them on demand, or reference remote STAC assets without copying
  156. them.
  157. - Draw new datasets in the browser.
  158. - Find data with fuzzy search, or by meaning once an embedding provider is configured. Filter by
  159. type, place and time, group datasets into collections, edit metadata and restore a dataset's
  160. previous version after a replacement.
  161. ## Know where every dataset came from
  162. <p align="center">
  163. <picture>
  164. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-provenance-dark.png">
  165. <img src=".github/assets/geolens-provenance.png" alt="The Source tab of the USGS Earthquakes dataset: imported from the USGS ArcGIS service into an owned copy, with last refreshed and last checked times, the feature count, and Healthy, Fresh and No drift badges" width="100%">
  166. </picture>
  167. <br>
  168. <sub>A dataset imported from the USGS earthquake service.</sub>
  169. </p>
  170. Each dataset records where it came from: an uploaded file, a database table, a service, a STAC
  171. item or a drawing in the browser. Imported datasets also record when they were last refreshed, and
  172. with an update cadence GeoLens marks them fresh, due or overdue. For services and
  173. STAC sources, GeoLens also checks that the source still answers, and for services it flags upstream
  174. schema changes before they reach your maps. If a service disappears, the imported copy keeps working.
  175. ## Build and share maps
  176. - Point, symbol, heatmap, cluster, line, arrow, fill, 3D extrusion, raster and hillshade layers,
  177. with data-driven styles, labels, icons, patterns, filters and popups. Terrain comes from your own
  178. elevation models.
  179. - Buffer, centroid, clip, dissolve, spatial join, select by location, measure and intersect. Most
  180. operations preview on the map, and each result is saved as a new dataset, from the builder or
  181. the CLI.
  182. - Story maps walk readers through a map scene by scene, with Markdown text, images, buttons and
  183. separators. Dashboards put indicators, charts, filters and Markdown notes beside a map. A Map
  184. data panel shows the rows behind each layer, as a table or a list.
  185. - Public maps and published stories show their title and image when pasted into Slack, Teams or
  186. social posts, and maps embed in other sites with private tokens.
  187. - The interface is in English, Spanish, French, German and Simplified Chinese.
  188. ## Use the data from anywhere
  189. Vector datasets are OGC API Features collections, the catalog is OGC API Records and STAC, and
  190. every layer has a tile URL. You can try this against the demo without an account (the second
  191. command needs `jq`):
  192. ```sh
  193. # Search the catalog (OGC API Records)
  194. curl "https://demo.getgeolens.com/api/collections/datasets/items?q=volcanic%20eruptions"
  195. # Read the top match with a CQL2 filter (OGC API Features): eruptions of VEI 6 or larger
  196. ID=$(curl -s "https://demo.getgeolens.com/api/collections/datasets/items?q=volcanic%20eruptions&limit=1" | jq -r '.features[0].id')
  197. curl -G "https://demo.getgeolens.com/api/collections/$ID/items" \
  198. --data-urlencode "filter=vei >= 6" -d limit=3
  199. ```
  200. QGIS adds the same API as an OGC API Features connection, as the
  201. [QGIS guide](https://docs.getgeolens.com/guides/api/qgis/) shows. The
  202. [GeoLens plugin for QGIS](https://github.com/geolens-io/qgis-geolens-plugin) adds catalog search,
  203. private datasets and edits that sync back to GeoLens.
  204. <p align="center">
  205. <img src=".github/assets/geolens-qgis.png" alt="QGIS 4 with the GeoLens demo added as an OGC API Features connection: the Browser panel lists the demo's collections, and recent earthquakes, significant volcanic eruptions, plate boundaries and countries from the demo are loaded as layers on a world map" width="100%">
  206. <br>
  207. <sub>QGIS reading the demo over OGC API Features, without a plugin.</sub>
  208. </p>
  209. | Standard | Where | Use it with |
  210. |---|---|---|
  211. | OGC API Features, with CQL2 filtering and queryables | `/api/collections/{id}/items` | QGIS, ArcGIS, GDAL/OGR and other OGC API clients |
  212. | OGC API Records | `/api/collections/datasets/items` | Catalog search from other portals and tools |
  213. | STAC API 1.0 | `/api/stac/` | STAC clients such as pystac-client and STAC Browser |
  214. | DCAT 3, DCAT-US 3.0 and GeoDCAT-AP as JSON-LD | `/api/datasets/dcat/`, `/api/datasets/dcat-us/3.0/`, `/api/datasets/geodcat-ap/` | Harvesting into national and EU open-data portals |
  215. | Vector tiles and COG raster tiles | a tile URL on every layer | MapLibre, OpenLayers, Leaflet |
  216. | 3D Tiles and COPC | each 3D dataset's page | CesiumJS, QGIS, Potree |
  217. Data exports as GeoJSON, Shapefile, GeoPackage, CSV, FlatGeobuf, GeoParquet, PMTiles or
  218. Cloud-Optimized GeoTIFF.
  219. The `geolens` CLI publishes files and applies catalog manifests, Python and TypeScript SDKs cover
  220. the API, and an MCP server lets AI agents search the catalog and, with a `map_author` API key,
  221. create and style maps. The [API reference](https://docs.getgeolens.com/guides/api/) and
  222. [SDK guides](https://docs.getgeolens.com/guides/sdk/) document them, and the
  223. [examples gallery](https://geolens-io.github.io/geolens-examples/) has runnable code for
  224. MapLibre, Leaflet, OpenLayers, the ArcGIS Maps SDK, QGIS and DuckDB.
  225. ## Optional AI
  226. <p align="center">
  227. <picture>
  228. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/geolens-ask-ai-dark.png">
  229. <img src=".github/assets/geolens-ask-ai.png" alt="The Ask AI panel on the Major Hurricane Tracks dataset answering 'How many of these hurricanes made landfall?' with 119 of 202, a two-row count table, a note on how it read the landfall column, and an Open in builder button" width="100%">
  230. </picture>
  231. <br>
  232. <sub>"How many of these hurricanes made landfall?" returns the count, a table and the assumption the answer rests on.</sub>
  233. </p>
  234. GeoLens can answer questions about a dataset, edit maps from plain-language requests, draft
  235. metadata and search in natural language. It works with any OpenAI-compatible endpoint, including
  236. a local server such as Ollama, and with Claude through Anthropic, Microsoft Foundry, Amazon Bedrock
  237. or Google Vertex AI. AI stays off until an administrator configures a provider, and every workflow
  238. works without it.
  239. ## Install
  240. You need Git, curl and Docker with the Compose plugin. The
  241. [Install Guide](https://docs.getgeolens.com/guides/quickstart/install/) lists the versions, memory
  242. and ports it expects.
  243. ```sh
  244. curl -fsSL https://getgeolens.com/install.sh | sh # clone, generate secrets, start the stack
  245. cd geolens
  246. grep '^GEOLENS_ADMIN_PASSWORD=' .env # the generated admin password
  247. ```
  248. Open http://localhost:8080 and sign in as `admin` with that password. Each
  249. [release](https://github.com/geolens-io/geolens/releases) includes a `SHA256SUMS` file for checking
  250. `install.sh` before you run it. To build from source instead, clone the repository and run
  251. `bash scripts/install.sh`; the first build takes 5-10 minutes.
  252. For production, read the
  253. [cloud deployment guide](https://docs.getgeolens.com/guides/quickstart/cloud-deployment/), which
  254. also lists what an external database needs. Docker Compose is the supported path, and
  255. [geolens-deployments](https://github.com/geolens-io/geolens-deployments) has a community-maintained
  256. Helm chart and Terraform recipes for AWS ECS Fargate and Azure Container Apps.
  257. The bundled database is backed up daily, and the
  258. [backup guide](https://docs.getgeolens.com/guides/admin/backups/) covers off-site copies and
  259. restores. [UPGRADING.md](UPGRADING.md) covers upgrades and rollback, [RUNBOOK.md](RUNBOOK.md)
  260. covers operations, and the
  261. [Configuration Reference](https://docs.getgeolens.com/guides/quickstart/configuration/) lists every
  262. setting.
  263. ## Your first dataset
  264. With the [CLI](https://docs.getgeolens.com/guides/cli/) installed, publish the sample file from the
  265. install directory:
  266. ```sh
  267. geolens login http://localhost:8080/api # your admin username and password
  268. geolens publish examples/manifests/first-catalog/city-parks.geojson --name "City Parks"
  269. ```
  270. `geolens publish` prints the new dataset's URL. To manage a whole catalog, describe the sources in
  271. a `geolens.yaml` manifest and run `geolens apply`; [`examples/manifests/`](examples/manifests/) has
  272. templates.
  273. To load the demo's maps and datasets, export `GEOLENS_ADMIN_PASSWORD` from `.env` and run
  274. `python scripts/seed-showcase.py --username admin`. The script needs Python 3.10+ and `httpx` and
  275. downloads public data from about a dozen sources; [scripts/README.md](scripts/README.md) has the
  276. sizes and options.
  277. ## Privacy and access
  278. - GeoLens sends no telemetry. Apart from the default basemap tiles and the remote services or
  279. STAC sources your users register, it makes outbound calls only for features an administrator
  280. turns on. [EGRESS.md](EGRESS.md) lists them and explains how to run air-gapped.
  281. - Your data stays readable without GeoLens. Vector datasets are ordinary PostGIS tables in a
  282. `data` schema, rasters are Cloud-Optimized GeoTIFFs in your own storage (local disk, S3/MinIO or
  283. Azure Blob), and the catalog exports through OGC API, STAC and DCAT.
  284. - Sign-in uses local accounts or OAuth 2.0/OIDC (Google, Microsoft, GitHub or a generic provider),
  285. with roles, per-dataset permissions, per-user API keys and an audit log. Self-registration is
  286. off by default.
  287. - Features released in this repository stay free.
  288. [EDITIONS.md](EDITIONS.md) describes the optional paid support and add-ons.
  289. ## Known limitations
  290. - The supported install, Docker Compose, runs on one host. For high availability, run several
  291. replicas of the API, worker, frontend and Titiler against a managed PostgreSQL with automatic
  292. failover, shared object storage and one Valkey or Redis cache. With Azure Blob or local storage,
  293. API and worker replicas also need a shared staging volume, since only S3 keeps uploads in the
  294. bucket. Local storage keeps every file on that volume, so Titiler replicas mount it too.
  295. [geolens-deployments](https://github.com/geolens-io/geolens-deployments) has a
  296. community-maintained Helm chart, Terraform recipes for AWS and Azure, and guides for AWS, Azure,
  297. Google Cloud and DigitalOcean. GeoLens itself doesn't cluster the database or read from replicas.
  298. - One organization per deployment.
  299. - Terrain rendering assumes elevation in meters; other vertical units render exaggerated.
  300. - GeoLens's own REST API can change between minor releases (the standards endpoints follow their
  301. specifications). The [CHANGELOG](CHANGELOG.md) lists contract changes. When a change breaks
  302. callers, the old form keeps working for the later of the next minor release and 90 days, and
  303. the CHANGELOG records its removal date. That covers REST routes and fields, the map and
  304. dashboard JSON clients write, and CLI commands and flags; the SDKs follow the API, and MCP
  305. tool names and arguments aren't covered.
  306. ## Contributing
  307. Bug reports, fixes, translations and docs are welcome. [CONTRIBUTING](.github/CONTRIBUTING.md)
  308. covers setup and tests, and [ARCHITECTURE](.github/ARCHITECTURE.md) maps the code.
  309. The [QGIS plugin](https://github.com/geolens-io/qgis-geolens-plugin),
  310. [examples](https://github.com/geolens-io/geolens-examples) and
  311. [deployments](https://github.com/geolens-io/geolens-deployments) repositories take issues and pull
  312. requests too. Ask questions in
  313. [GitHub Discussions](https://github.com/geolens-io/geolens/discussions), report bugs in
  314. [Issues](https://github.com/geolens-io/geolens/issues), and report security problems privately as
  315. described in [SECURITY.md](.github/SECURITY.md). The [roadmap](https://docs.getgeolens.com/roadmap/)
  316. shows what's planned.
  317. ## Built on
  318. GeoLens is built on these open source projects. Thanks to everyone who maintains them.
  319. - [PostgreSQL](https://www.postgresql.org/) and [PostGIS](https://postgis.net/) hold the catalog and every vector dataset, and
  320. [pgvector](https://github.com/pgvector/pgvector) stores the embeddings behind search by meaning.
  321. - [GDAL](https://gdal.org/) reads the files and services GeoLens imports and writes the formats it exports,
  322. and [PROJ](https://proj.org/) handles coordinate transformations.
  323. - [TiTiler](https://developmentseed.org/titiler/) serves raster tiles from Cloud Optimized GeoTIFFs.
  324. - [FastAPI](https://fastapi.tiangolo.com/) serves the API, and [Procrastinate](https://procrastinate.readthedocs.io/) runs background
  325. jobs with PostgreSQL as the queue.
  326. - [MapLibre GL JS](https://maplibre.org/) draws the maps, [deck.gl](https://deck.gl/) and
  327. [loaders.gl](https://loaders.gl/) render 3D Tiles and point clouds, and [Terra Draw](https://terradraw.io/)
  328. handles drawing and editing.
  329. - The web app is written in [React](https://react.dev/).
  330. These names belong to their owners, and listing them doesn't mean they endorse GeoLens; see
  331. [TRADEMARKS.md](TRADEMARKS.md#other-projects-names).
  332. ## License
  333. GeoLens is licensed under the [Apache License 2.0](LICENSE). The GeoLens name, logo and brand
  334. assets are not covered by this license; see [TRADEMARKS.md](TRADEMARKS.md). Sample-data
  335. attribution is in [THIRD_PARTY_DATA.md](THIRD_PARTY_DATA.md). The web app serves the license notices for the
  336. code it bundles at `/third-party-licenses.txt`, and the backend image's copyleft notices are in
  337. [backend/licenses](backend/licenses/).
  338. Project policies: [editions](EDITIONS.md) · [support](SUPPORT.md) · [governance](GOVERNANCE.md) · [maintainers](MAINTAINERS.md) · [security](.github/SECURITY.md) · [release process](RELEASE.md) · [egress &amp; air-gap](EGRESS.md)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.