QGIS plugin

The Sarkoa QGIS plugin adds a dock to upload, list, view, download, and delete Sarkoa files without leaving QGIS.

Requirements: QGIS 3.28+.

Install

Install from ZIP

  1. Download the latest package: sarkoa-qgis-latest.zip
  2. In QGIS: Plugins → Manage and Install Plugins → Install from ZIP
  3. Select the downloaded ZIP and enable Sarkoa under Installed

If Plugin Manager shows This plugin is broken or Error reading metadata, uninstall the plugin and install again from the latest ZIP (link above or Downloads). The package metadata.txt must be a UTF-8 INI file that starts with [general].

Plugin Manager (coming soon)

When listed on plugins.qgis.org, open Plugins → Manage and Install Plugins → All, search for Sarkoa, and install.

Install links and CLI setup: Downloads.

Configure and use

  1. Open the Sarkoa dock from the toolbar or Plugins → Sarkoa.
  2. In Settings, paste your API token and save. Organization ID is usually unnecessary (keys are already tied to one org; see Authentication). The plugin connects to the Sarkoa app automatically.
  3. Click Refresh to load your file list. Use the filter box to narrow results.
  4. Upload a file from a layer already in the QGIS project, or browse the filesystem. Optionally enable Optimize locally before upload to create a map-ready file on your machine before uploading (needed for sources > 10 GB, which cannot be optimized remotely). Upload and delete need a key with write scope; the dock checks this before the file dialogs.
  5. Select an item and click View to add it as a layer, or drag the item onto the map canvas. Download (needs read scope) and Delete are also available.

You need an API key from the web app, see Authentication.

Optimize locally before upload

When enabled, the dock can convert a supported file to a map-ready format on your machine (PMTiles or COG), then upload that result. Use this for files larger than the 10 GB remote optimization limit, or when you want to inspect the optimized file before upload. Use the same Python environment QGIS uses, with any local optimize tooling documented for your install. See File optimization.

ArcGIS Pro

An ArcGIS Pro toolbox is in development and not yet publicly released. You can still add Sarkoa tile and file URLs as layers in ArcGIS Pro today.