.. _deployment_guide:

Installation Guide
==================

This guide provides instructions on how to get the necessary files to deploy the Calyntro application. Calyntro is distributed as pre-built Docker images, so you do not need to build the software from source.

Prerequisites
-------------

Before starting, ensure you have the following installed on your system:

* **Docker** (version 20.10 or higher)
* **Docker Compose** (version 2.0 or higher)
* **Git** (to download the deployment scripts)

Getting the Deployment Files
----------------------------

To run Calyntro, you need the orchestration configuration and management scripts. The easiest way to get these is by cloning the Calyntro repository.

.. code-block:: bash

   git clone https://github.com/khReichel/Calyntro.git
   cd Calyntro

This repository contains:
* ``docker-compose.yml``: The configuration defining the backend, frontend, and gateway containers.
* ``manage.sh``: The main utility script used for starting, stopping, and updating the application.
* ``nginx.conf``: The routing configuration for the web gateway.
* ``config/``: A directory containing an example configuration file.

Next Steps
----------

Once you have downloaded the deployment files, you are ready to configure the application, pull the container images, and run your first repository analysis.

Please proceed to the :ref:`Setup & Update Guide <importer_guide>` for the step-by-step instructions on initializing and running Calyntro.

.. toctree::
   :maxdepth: 1
   :caption: Configuration Guides:

   config_guide
   manage_script