Getting Started Overview
Welcome to the Terragnos Core documentation set. This page curates the fastest path for experienced developers to understand what the platform offers, spin up an environment, and know where to dive deeper. Treat it as your navigation hub: every phase below links to the next document you should read or the task you should perform.
Who this guide targets
- Solution engineers and platform owners evaluating whether Terragnos Core satisfies spatial/object management needs.
- Backend/API developers who will integrate Terragnos Core via REST/GraphQL APIs and SDKs.
- Operations/SRE partners responsible for running self-hosted installations.
If you need business-level positioning or roadmap context, skip to the Roadmap section later. The focus here is on getting hands-on quickly.
Onboarding phases
| Phase | Goal | Key actions | References |
|---|---|---|---|
| 1. Orientation | Understand the moving pieces (objects, workflows, automation, spatial layers). | Skim the core concepts, note how tenants and roles scope data. | Core Concepts |
| 2. Environment setup | Bring up a working stack either locally or via containers. | Pick between the quickstart Compose stack or the self-hosted setup. | Quickstart, Self-Hosted Setup |
| 3. First interactions | Call health endpoints, authenticate, list object types, and create sample data. | Use the SDK or direct REST requests to explore /v1/object-types, /v1/objects, /v1/workflows. | API Overview, SDK Overview |
| 4. Explore modules | Dive into domain-specific guides (schemas, workflows, automation, layers). | Follow the guide index that matches your project. | Product Guides onward |
| 5. Operational readiness | Learn how to observe, secure, license, and upgrade the platform. | Configure metrics/logging, set RBAC policies, install a license. | Operations, Security & Access |
Platform snapshot
Terragnos Core packages:
- A NestJS API (
/v1/...) that exposes REST and GraphQL interfaces, RBAC-enforced admin endpoints, and health checks. - A background worker that processes the outbox, workflow transitions, automation pipelines, and scheduled tasks.
- A PostGIS-backed persistence layer with temporal history, spatial indexing, and tenant isolation baked in.
- Official SDKs (TypeScript, Python, .NET) generated from the OpenAPI snapshot to help you script or automate operations.
All of the above are delivered as container images (terragnos-core-api, terragnos-core-worker, terragnos-core-db plus helpers). The quickest way to experience the stack is through Docker Compose (see the Quickstart). For a more detailed self-hosted setup, follow the Self-Hosted Setup guide.
Picking your path
- Proof-of-concept or evaluation → start with the quickstart environment; use sample data, focus on workflows and automation guides, defer Kubernetes/production considerations until later.
- Integration development → after you are comfortable with the architecture, use the REST/GraphQL APIs and SDKs to integrate Terragnos Core into your applications.
- Operations & reliability → prioritize the deployment and operations sections (Compose, Kubernetes, configuration, observability) so you can map the platform to your infrastructure standards.
Next steps
- Read Core Concepts to internalize the vocabulary that shows up across the docs, API, and SDKs.
- Decide whether to follow the Quickstart or Self-Hosted Setup path and bring up a running environment.
- Once you have the stack online, continue with the Product Guides that match your immediate goals (model schemas, author workflows, configure automation, build spatial exports).
- When preparing for a real deployment, visit the Deployment and Operations sections to cover production-grade requirements.
Keep this page bookmarked: it will be updated with links to tutorial videos, sandbox tenants, and ready-made blueprints as those assets become available.