Skip to content

Getting Started

This guide explains how to navigate the AcuGIS Cloud platform and choose the documentation you need.

Platform overview

AcuGIS Cloud is composed of cooperating services:

  • Central is the platform entry point for discovery, identity, access control, and personal access tokens.
  • GeoVault manages and versions geospatial datasets.
  • QGIS Publisher publishes and operates QGIS projects.
  • GeoSync synchronizes QField Cloud project data with PostGIS.
  • Jasper Publisher publishes and integrates Jasper reports.
  • PostGIS Service provides spatial-database workflows used by other components.

Start with Central when you need platform-level identity or resource discovery. Go directly to a component when you are installing, configuring, or integrating a specific service.

Authentication

Central issues the shared session cookie used by browser workflows and personal access tokens used by supported automation workflows. Individual components apply their own service and resource authorization checks.

  1. Sign in through Central for an interactive session.
  2. Create a personal access token in Central when the target API supports PAT authentication.
  3. Send the documented cookie or bearer token with API requests.
  4. Check the component's authentication page for its exact support boundary.

Read the authentication guide before building an integration.

Finding APIs

Each documented component has an API page containing endpoint behavior, parameters, responses, and known constraints. Components with an existing OpenAPI specification also have an interactive API Reference (ReDoc) page:

Note

GeoSync does not currently include a standalone openapi.yaml file in this documentation repository.

Using the CLI

The AcuGIS CLI maps common platform and component workflows to terminal commands. Begin with the CLI guide, then use each component's CLI page for verified command coverage and explicit gaps.

acugis login --url https://cloud.example.com
acugis whoami
acugis catalog list

Always defer to the component documentation for currently supported command names and authentication behavior.

Reading API documentation

Use the two API views together:

The Markdown API pages explain behavior, authorization, workflows, caveats, and implementation boundaries.

The API Reference (ReDoc) pages provide searchable operation and schema details directly from each existing openapi.yaml.

Download the source openapi.yaml when generating a client or importing the contract into API tooling. The portal serves the original files unchanged.

Next steps

Choose a component from the Components navigation tab, then work through Overview, Installation, Configuration, Authentication, and Examples. Use Deployment and Troubleshooting when moving from development into production.