# GeoLens Documentation

> Documentation for the GeoLens self-hosted GIS data catalog. Covers install, user guide, admin guide, and OGC/REST API reference. Single canonical home for all GeoLens user-facing documentation; supersedes legacy backend/docs/{install,admin}.md files.

## Guides

- [Documentation Home](https://docs.getgeolens.com/): Start here for installation, usage, administration, SDK, and API documentation.
- [Guides Hub](https://docs.getgeolens.com/guides/): Choose the right GeoLens guide for installation, catalog workflows, administration, or API integration.
- [Quickstart](https://docs.getgeolens.com/guides/quickstart/): Stand up GeoLens with Docker Compose and complete first-login flow.
- [User Guide](https://docs.getgeolens.com/guides/user/): Search, dataset detail, map builder, analysis, collections, imports, data location, and exports.
- [CLI & Manifests](https://docs.getgeolens.com/guides/cli/): Install the GeoLens CLI, authenticate, publish single files, and manage repeatable catalogs with geolens.yaml manifests.
- [Client SDKs](https://docs.getgeolens.com/guides/sdk/): Typed Python and TypeScript SDKs for the GeoLens API, auto-generated from the OpenAPI contract, plus when to reach for the CLI, an SDK, or the raw API.
- [Admin Guide](https://docs.getgeolens.com/guides/admin/): User management, OAuth/OIDC, settings, backups, monitoring, and managed-provider deployment.
- [API Reference](https://docs.getgeolens.com/guides/api/): OGC API (Common, Records, Features, STAC), REST endpoints with auth examples.
- [API Authentication](https://docs.getgeolens.com/guides/api/auth/): JWT, API key (header and query forms), and OAuth/OIDC examples for the GeoLens REST API.
- [API OGC Endpoints](https://docs.getgeolens.com/guides/api/ogc/): OGC API Common, Records, Features, STAC, and tile endpoints with QGIS and ogr2ogr examples.
- [Use GeoLens from QGIS](https://docs.getgeolens.com/guides/api/qgis/): OGC API Features connections, CQL2 filter push-down (spatial predicates need QGIS 3.44+), and vector tiles as a generic XYZ layer.
- [Install Guide](https://docs.getgeolens.com/guides/quickstart/install/): Production install reference: prerequisites, default services, optional profiles, troubleshooting.
- [Upgrade Guide](https://docs.getgeolens.com/guides/quickstart/upgrade/): Standard upgrade procedures, major version upgrades, pre-upgrade checklist, rollback, and version-specific notes.
- [Configuration Reference](https://docs.getgeolens.com/guides/quickstart/configuration/): Full .env reference for every GeoLens setting.
- [Self-host on managed cloud services](https://docs.getgeolens.com/guides/quickstart/cloud-deployment/): What GeoLens needs from a cloud host, the environment contract, and where the per-cloud steps live.
- [Deploy on Amazon EKS](https://docs.getgeolens.com/guides/quickstart/eks/): Run the community Helm chart on EKS with S3, RDS PostgreSQL, ingress and TLS.
- [User Guide → Search & Discovery](https://docs.getgeolens.com/guides/user/search/): Find datasets fast with filters, faceted search, semantic search, and saved searches.
- [User Guide → Dataset Detail](https://docs.getgeolens.com/guides/user/dataset-detail/): Overview / data / metadata / structure / sources / access tabs and exports.
- [User Guide → Map Builder](https://docs.getgeolens.com/guides/user/map-builder/): Create maps, manage layers and styles, AI chat, sharing.
- [User Guide → Analysis](https://docs.getgeolens.com/guides/user/analysis/): Buffer, centroid, clip, dissolve, spatial join, measure, select by location, and intersect vector layers, preview on the map, and save the result as a new dataset.
- [User Guide → Collections](https://docs.getgeolens.com/guides/user/collections/): Create, manage membership, and browse dataset collections.
- [User Guide → Importing Data](https://docs.getgeolens.com/guides/user/import/): Upload files, register in-place PostGIS tables, copy feature-service layers, and reference STAC assets.
- [User Guide → Where Your Data Lives](https://docs.getgeolens.com/guides/user/where-data-lives/): Managed copies, in-place PostGIS tables, Service snapshots, live STAC references, source state, and refresh behavior.
- [User Guide → Exports & Integrations](https://docs.getgeolens.com/guides/user/exports/): Export formats, OGC API access, STAC, QGIS / GDAL / pystac-client examples.
- [User Guide → Account Settings](https://docs.getgeolens.com/guides/user/settings/): Your role, file-storage and dataset usage meters, UI language, and self-service API keys on the /settings page.
- [User Guide → Taking your data with you](https://docs.getgeolens.com/guides/user/portability/): Postgres dumps, open export formats, live OGC API and STAC endpoints, object storage, and what does not migrate.
- [SDK → Python](https://docs.getgeolens.com/guides/sdk/python/): Install the GeoLens Python SDK, authenticate with a bearer token or API key, and make your first typed API call with GeolensClient.
- [SDK → TypeScript](https://docs.getgeolens.com/guides/sdk/typescript/): Install the GeoLens TypeScript SDK, authenticate with a bearer token or API key, and make your first typed API call with createGeolensClient.
- [SDK → MCP Server](https://docs.getgeolens.com/guides/sdk/mcp/): Point a coding agent (Claude Code, Cursor, Codex) at a GeoLens instance with the read-only geolens-mcp Model Context Protocol server to discover datasets, inspect schemas, and read features and maps.
- [Admin → User Management & RBAC](https://docs.getgeolens.com/guides/admin/users/): Roles, permissions, self-registration approval, and API key issuance.
- [Admin → OAuth/OIDC Setup](https://docs.getgeolens.com/guides/admin/oauth/): Google, Microsoft Entra ID, and generic OIDC providers.
- [Admin → Settings Reference](https://docs.getgeolens.com/guides/admin/settings/): General, Map, Auth, Storage, Network, AI, Permissions tabs.
- [Admin → Backups & Restore](https://docs.getgeolens.com/guides/admin/backups/): Schedule config, S3 off-site replication, retention, restore validation.
- [Admin → Infrastructure & Monitoring](https://docs.getgeolens.com/guides/admin/infrastructure/): Prometheus metrics, /api/health endpoint, /admin/overview UI.
- [Admin → Self-hosted Provider Notes](https://docs.getgeolens.com/guides/admin/cloud/): Admin-side orientation for self-hosting on managed cloud services.
- [Roadmap](https://docs.getgeolens.com/roadmap/): Where GeoLens is today and the themes we're exploring next. Directional, not a commitment.