Environment variables in docker-compose.yaml file

[nicolasduminil]

The documentation instructs to initialize the environment variables KARAVAN_GIT_REPOSITORY, KARAVAN_GIT_USERNAME and KARAVAN_GIT_PASSWORDin the docker-compose.yaml file but it doesn't mention what this variables should contain as values.

If I have to take a guess, which isn't the right way to proceed when installing stuff, I would say that they should contain a GitHub repository name, user and password but, in the same time, why would someone need to provide these information just to run a Docker image ?

Some explanation would be welcome.

Many thanks in advance.

[mgubaidullin]

Based on the Karavan Architecture , a Git repository is a mandatory core component of the platform.

To answer your question: you need to provide these credentials because the Git repository acts as the single source of truth for all your projects. Even when just running the Karavan Docker image, the application requires a place to store and retrieve all essential project files, including:

• Integration YAML files
• application.properties
• Container configurations
• Deployment resources and templates

What values to use:

• KARAVAN_GIT_REPOSITORY: The URL of the Git repository you want to use to store your integration projects.
• KARAVAN_GIT_USERNAME: Your Git username.
• KARAVAN_GIT_PASSWORD: Your Git password or Personal Access Token (PAT) with read/write permissions for that repository.