Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.51 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.51 KB

CDS Engine

This is the core component of CDS.

This component is responsible and is the entry point to several µServices such as:

The API component is the core component and is mandatory in every setups.

To start CDS api, the mandatory dependencies are a PostgreSQL database, a Redis Server and a path to the directory containing other CDS binaries, for serious usages you may need other third parties Read more

Configuration

There are two ways to set up CDS:

  • with toml configuration
  • with environment variables.

Read more

Startup

A docker-compose file is provided for light deployment and dev environments, follow this guide.

For larger deployments you have to go deeper and read this advanced startup page.

Database management

CDS provides all needed tools scripts to perform Schema creation and auto-migration. Those tools are embedded inside the engine binary.

The migration files are available to download on Github Releases and the archive is named sql.tar.gz. You have to download it and untar (tar xvzf sql.tar.gz).

Read more