Skip to main content
Version: Next

Deployment Guide

The deployment guide describes how to configure and run the deployment of the platform. This includes all stacks of the overall architecture.

Architecture overview

Deployment includes the initial setup of the platform for a specific purpose of use, e.g. a customer, as well as updating the platform with new versions or updated settings. To this end, the deployment guide provides detailed instructions for the automated deployment with Ansible. For this automated deployment, this docuemntation guides through the customization of the Ansible inventory file and other important configuration files. Start with cloning the CIVITAS/CORE Platform repository.

If you want to use the platform as is, the direct clone is sufficient. If you need adjustments, want to configure addons, etc. please make a fork of the platform before and clone this to control system.

Checkout the repository:

git clone https://gitlab.com/civitas-connect/civitas-core/civitas-core.git

Table of Contents

The rest of this guide is structured as follows. First, the deployment requirmeents are explained. Second, it guides you through the customization of the inventory file. Once the customization of that file is done, you can start the automated installation with ansible, which is explained afterwards. File-based customizations regarding specific components are explained afterwards. The last section of this guides explains some IT-Security aspects.

Download as PDF