Skip to main content

Quick Start

Prerequisites

  • Docker with swarm support for the local stack workflow
  • access to the repository and its mounted data paths
  • a valid API token if you plan to exercise protected routes

Fastest Local Path

From the repository root:

./reload_stack.sh

This is the deployment path currently used for the tuned local swarm profile.

Verify the Stack

Check these endpoints after the stack stabilizes:

curl http://127.0.0.1:8080/health
curl http://127.0.0.1:8080/config
curl http://127.0.0.1:8080/ui/
curl http://127.0.0.1:8080/ui-react/
curl http://127.0.0.1:8080/guide/
curl http://127.0.0.1:8080/guide/blog

Primary URLs

URLPurpose
http://127.0.0.1:8080/ui/legacy operator frontend
http://127.0.0.1:8080/ui-react/React operator frontend
http://127.0.0.1:8080/docsSwagger UI
http://127.0.0.1:8080/guide/Docusaurus documentation
http://127.0.0.1:8080/guide/blogproject blog and update log
http://127.0.0.1:8081/direct MapCache service
http://127.0.0.1:8084/terrain/Cesium terrain nginx endpoint

Log In

The repository ships with a demo user in development contexts.

curl -X POST http://127.0.0.1:8080/login \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'username=demo&password=changeme'

In many local tests the token itself is simply demo.

Smoke Test the Main Surfaces

curl -H 'Authorization: Bearer demo' 'http://127.0.0.1:8080/datasets?limit=5'
curl -H 'Authorization: Bearer demo' 'http://127.0.0.1:8080/jobs?limit=10'
curl 'http://127.0.0.1:8080/wms/<dataset_id>?SERVICE=WMS&REQUEST=GetCapabilities'

First Practical Workflow

  1. Open /ui-react/ (or /ui/ for the legacy interface).
  2. Review the current server config and job monitor.
  3. Upload a GeoTIFF or register one from an existing server path.
  4. Use the returned dataset row actions to inspect WMS, WCS, thumbnail, and terrain behavior.
  5. If you are working with HySpex data, move directly to the campaign pages in the User Guide.