Skip to main content

Introduction

This reference section documents the components, concepts, integrations, and technical conventions that make up Guardian Connector. It is intended as a place to look up how different parts of the platform work, how they relate to one another, and the terminology and structures used throughout the system.

Reference Sections​

📋 Guardian Connector Toolkit​

Reference documentation for the tools and services that make up the Guardian Connector platform.

What you'll find:

  • Documentation for GC Scripts Hub, GC Explorer, Apache Superset, FileBrowser, and other components of the Guardian Connector stack
  • Information on how Guardian Connector uses external services such as Mapbox and Auth0
  • Details on the broader range of data sources and applications that can be connected to Guardian Connector through GC Scripts Hub

Best for: Understanding the Guardian Connector platform, its individual components, and how they work together.

📚 Common Workflows​

Reference information for common tasks that involve Guardian Connector and related tools.

What you'll find:

  • How to use Guardian Connector data in QGIS or other GIS software
  • How to download or export data
  • Common ways of moving data between Guardian Connector and other applications
  • And more!

Best for: Looking up how common tasks are carried out across different parts of the Guardian Connector ecosystem.

🔗 Core Integrations​

Documentation for selected external applications that have established, closely supported workflows with Guardian Connector.

Guardian Connector can connect to many additional tools and data sources through GC Scripts Hub. The applications documented in this section are highlighted because they are used particularly closely within Guardian Connector workflows.

What you'll find:

  • Core applications such as KoboToolbox, CoMapeo, and Timelapse
  • Information on how data moves between these applications and Guardian Connector
  • Reference information on established workflows, data structures, and integration considerations

Best for: Understanding applications that are commonly used together with Guardian Connector as part of established data collection and management workflows.

🌐 Companion Applications​

Documentation for external applications that are useful alongside Guardian Connector but are not themselves part of the Guardian Connector platform or directly integrated into it.

What you'll find:

  • Tools such as QGIS for working with spatial data
  • Tools such as OpenRefine for cleaning and restructuring data Recommendations for applications that complement Guardian Connector workflows before, after, or outside the platform

Best for: Finding tools for specialized tasks such as data cleaning, analysis, mapping, and working with data exported from Guardian Connector.

🌐 Hosting Guardian Connector​

For System Administrators

This section is intended for system administrators who will be deploying and hosting Guardian Connector infrastructure.

Technical reference documentation for deploying, configuring, and maintaining Guardian Connector infrastructure.

What you'll find:

  • Guidance on how to deploy Guardian Connector to your own infrastructure
  • Configuration options and requirements
  • Maintenance and update procedures

Best for: System administrators responsible for deploying or maintaining Guardian Connector infrastructure.

📚 Onboarding Template for Community Organizations​

Onboarding template for community organizations that are new to Guardian Connector.

What you'll find:

  • Guidance on how to get started with Guardian Connector
  • Instructions on how to sign in and access each application

Best for: Community organizations that are new to Guardian Connector, and their technical support partners.

🔧 For Developers​

Technical information for developers contributing to Guardian Connector or building extensions and integrations.'

What you'll find:

  • Links to core repositories
  • Development environment setup
  • Deployment and hosting instructions
  • Contribution guidelines

Best for: Developers working on Guardian Connector itself or extending its functionality.

This reference documentation evolves with Guardian Connector development. For the most current information, always refer to the latest version of these docs.