DevOps Guide

The DevOps guide will help you through the deployment and setup process, so you will know how to deploy, configure, and maintain Corteza.

Structure overview

The structure overview section provides an outline of our repositories and how they connect.

System requirements

The numbers may differ for your needs, but you can still use them as a base.

System requirements help you determine the server configuration that best suits your needs.

Corteza demo in your local environment

See our example setup sections for a quick step-by-step on how to test Corteza on your laptop or workstation.

Refer to the docker compose section, if you need help with Docker.

Deploying Corteza for production

Potential data loss when using SQLite in memory.

We strongly recommend you use other DB engines (PostgreSQL or MySQL). If you are set on using SQLite, make sure to use persistent storage.

The used SQLite driver mattn/go-sqlite3 re-creates the entire database whenever a new connection is established and drops the whole database when the last connection is closed.

We use SQLite primarily for testing, so this isn’t an issue for us. We will work on a more robust solution in future releases.

See our example setup sections for a quick step-by-step on how to deploy to different environments. Use the local MySQL for any local development or demonstration. Use the PostgreSQL or MySQL setup for any live deployments (production or staging/testing).

Refer to the health check section to test your deploy.

Refer to the docker compose section, if you need help with Docker.

See the configuration sections (server and Corredor server) for available configuration options.

Post-deployment bits

Use the CLI tool to perform some base maintenance tasks.

Allow automation scripts to react to emails.