Configuration Overview

The Carbon Engine is published as a Docker image and works with Docker Compose, Docker Swarm, Kubernetes, and all of the major cloud-based container environments.

You can deploy the Carbon Engine to your own infrastructure, enabling full use of its functionality without any data leaving your environments.

Without any storage configured, only the Carbon Engine stateless endpoints are available:

• Using the footprint endpoint, you can submit transactions and user responses to be processed in-memory, with the footprinted transactions and savings data returned.
• The datapack endpoints are also stateless, and will return static information about the current datapack.

When storage is configured, you can access the full API and specify additional custom fields to hold transaction metadata. Currently, storage can only be enabled when deployed to AWS. If you'd like to use a different storage platform, contact your Cogo representative with your requirements.

The following pages detail the configuration available for the Carbon Engine.

• Running locally
• Climate data access
• Storage with AWS
• Custom fields
• Security
• Event streaming with AWS
• Environment variables reference