You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

Corteza

Corteza is an open source, self-hosted cloud-based Digital Work Platform. Main features include a Low-Code Platform, CRM, Service Solution, Enterprise Messaging, and End-to-End Business Automation.

Corteza is built upon modern technologies, using Golang and Vue.js. The platform is secure with a powerful RBAC access control facility, that allows you to configure your permissions just the way you want to!

Corteza aims to be indisputably trustworthy in its motivations and its approach to design, development and maintenance of the platform. Organisations should feel that their chosen digital work platform is always under their control, always protected and continuously developed in their best interests.

Questions? Check out our homepage or get in touch with us.

Install Corteza on your server, laptop or workstation with Docker

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.

Take a look at the DevOps guide!

The guide walks you through server and Corredor server configuration.

You can find an example for a local MySQL and production deployments for PostgreSQL and MySQL.

We also have some miscellanies, such as relaying inbound emails, health check, and data backups.

Learning Corteza

Take a look at the end-user guide!

It covers all Corteza applications, their features, and how to use them. We’ve designed the end-user guide to be easily understandable by non-techy people, so you don’t need to be a field expert.

System administration

Take a look at the administrator guide!

The guide covers the security system, the administration panel, and the application administration (Low Code and Messaging)

The guide also covers Corteza Federation — a brand new feature which lets you connect different Corteza instances to securely share data.

Create with Corteza

Take a look at the integrator guide!

The guide walks you through the integration process; from the security system, Low Code configuration, and extension development.

We also offer some copy-pastable samples, instructions for deploying, debugging and testing (yes, there is a working setup with unit tests and coverage reporting).

Core developers

Take a look at the developer guide!

The guide gives a fairly abstract overview of the Corteza. The documentation compliments the source code.

We cover things from writing documentation, to build pipelines, and core system features.

If you have any questions or are stuck, don’t hesitate to get in touch with us on the community Corteza instance!

Samples and examples

Learning from examples is completely valid, but we recommend that you firstly study the guides that are relevant to you. Assuming what something does can be dangerous.

We have examples for working with the System API, Compose API, and automation script development.

We also have some extension development samples in the integrator guide.

To top it off, some examples for local and production Corteza deployment.

Do you need help? Get in touch with us on the community Corteza instance!

API reference

Each Corteza instance has its own API reference built-in so that the reference is always there and always valid. Navigate to the /docs/ API sub-page; for example https://api.your-corteza-instance.tld/docs.

Alternatively, you can use our community instance https://api.latest.cortezaproject.org/docs/

Our community instance is always on the latest stable version so the reference may not be compatible.

Upgrading Corteza

When upgrading, you should always firstly go over the changelog and the upgrade guide.

Versions may not be backwards compatible and may need some additional work to get setup.

To upgrade from 2020.9, you can use this changelog and this upgrade guide.

You can find all of the changelogs here, and all of the upgrade guides here.