Last updated

Technical Requirements

Catena is customer-hosted software and is not restricted to a specific cloud provider, hosting platform, or deployment strategy.

Catena can run locally, on bare metal, on virtual machines, in containers, on cloud infrastructure, or as a distributed production system. The exact requirements depend on whether you are building Catena, running Catena locally, or deploying Catena into a hosted environment.

For step-by-step setup instructions, see How to Run Catena.

Access Requirements

To build, run, or deploy Catena, you need access to the Catena source code.

Catena is distributed through Git. To gain access to the Catena source repository, contact Wolfjaw to obtain a license.

Most paths require:

RequirementPurpose
GitClone Catena source code
Catena source repository accessBuild, run, or deploy Catena
Command-line accessRun local, Docker, cloud, or deployment commands

Some deployment paths may also require access to the Catena infrastructure repository.

Requirements to Run Catena

Catena can be run directly from source or through Docker.

Running From Source

Running Catena from source requires:

RequirementPurpose
.NET 8 SDKBuild and run Catena locally
PowershellExecute catena run commands

For step-by-step instructions, see Running From Source.

Running With Docker

Running Catena with Docker requires:

RequirementPurpose
Docker-compatible runtimeRuns Catena containers
Docker ComposeStarts the documented local container stack
WSLRequired for the documented Windows Docker workflow

The default Docker Compose configuration may start additional local containers, including:

ContainerPurpose
catena-tools-coreCatena backend
kafkaOptional message transport support
init-kafkaKafka topic initialization
redisOptional ephemeral/session storage

For step-by-step instructions, see Running With Docker.

Documented Deployment Path Requirements

The following requirements apply to deployment paths documented in this guide. They are not the only ways to deploy Catena.

AWS EC2 Deployment Requirements

Deploying Catena to AWS on a single EC2 instance requires:

RequirementPurpose
AWS accountOwns the AWS resources used by the deployment
Scoped AWS IAM deployment identityUsed by Terraform/AWS CLI to provision resources
AWS CLIConfigures local AWS credentials and profile
TerraformProvisions AWS infrastructure
Catena source repository accessRequired to deploy Catena
Catena infrastructure repository accessRequired for the AWS Terraform configuration
Route53 domain or hosted zoneUsed for public DNS resolution
S3 bucketStores Terraform state
SSH key pairUsed for deployment and administrative access
Local command-line environmentRuns Terraform, AWS CLI, and Git deployment commands

The AWS EC2 deployment provisions infrastructure in the customer’s AWS account. The current single-node deployment may create resources such as IAM roles, VPC networking, subnets, an Internet Gateway, a security group, an Elastic IP, Route53 records, and an EC2 instance.

For step-by-step instructions, see Deploying to AWS.

Heroku Deployment Requirements

Deploying Catena to Heroku requires:

RequirementPurpose
Heroku accountOwns the Heroku application and add-ons
Heroku CLICreates and manages the Heroku app
GitPushes Catena to Heroku
Catena source repository accessRequired to deploy Catena
Heroku PostgreSQL add-onPersistent database storage
Heroku Redis add-onRedis/session storage
Heroku-compatible buildpackBuilds and runs Catena
Payment methodRequired by Heroku for the documented deployment path

For step-by-step instructions, see Deploying to Heroku.

Custom Infrastructure Requirements

Catena is not restricted to the these deployment paths.

When deploying Catena to custom infrastructure, customers are responsible for ensuring that the environment provides the compute, runtime, network access, persistence, configuration, secrets management, logging, monitoring, backup, and operational access required by their deployment.

Custom deployments may include bare metal servers, virtual machines, container platforms, Kubernetes, private cloud, public cloud, or customer-managed platform infrastructure.