Skip to content

chore: added configuration description #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sr-remsha wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: added configuration description #346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions docs/tutorials/2.devops/1.configuration/0.configuration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,48 @@ This instruction assumes that you are installing and configuring applications us

## General method of configuration

AI DIAL helm chart contains various applications, and, to configure them, it is necessary to make corresponding changes to different sections of the **values** file.
DIAL helm chart contains various applications, and, to configure them, it is necessary to make corresponding changes to different sections of the **values** file.

To add environment variables to AI DIAL application, you can use either `env` or `secrets` section in specific components, e.g `core.env`, `openai.secrets`
To add environment variables to a DIAL application, you can use either `env` or `secrets` section in specific components, e.g `core.env`, `openai.secrets`

> Refer to the [helm chart repository](https://github.com/epam/ai-dial-helm/tree/main/charts/dial/examples) to view selected configuration examples.

### Enabling Support for Private Certificate Authority or Self-Signed Certificate

Java-based and NodeJS-based DIAL components require different configurations to support private CA or self-signed certificates.

#### NodeJS-based components

For DIAL frontend components such as [DIAL Chat](https://github.com/epam/ai-dial-chat/blob/development/apps/chat/README.md) or [DIAL Admin frontend](https://github.com/epam/ai-dial-admin-frontend), set the `NODE_TLS_REJECT_UNAUTHORIZED` environment variable to allow connections to servers with self-signed or private CA certificates:

```bash
NODE_TLS_REJECT_UNAUTHORIZED: 0
```
> **Warning**: Setting `NODE_TLS_REJECT_UNAUTHORIZED=0` disables certificate validation for all outgoing HTTPS requests. Use this setting only in trusted environments, such as development or testing, as it introduces security risks in production.

#### Java-based components

This configuration applies to Java-based components such as [DIAL Core](https://github.com/epam/ai-dial-core), [DIAL Admin backend](https://github.com/epam/ai-dial-admin-backend), or any component using the `eclipse-temurin` Docker image as a base. This image includes a script to enable the use of self-signed or private CA certificates.

To enable support for self-signed or private CA certificates:

* Set the `USE_SYSTEM_CA_CERTS` environment variable to `true`.
* Mount your private certificate(s) into the `/certificates` directory inside the container.

Example Docker Compose configuration for DIAL Admin backend:
Copy link
Copy Markdown
Contributor

@alexey-ban alexey-ban Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the general section of the document, it's about Helm, so why is there an example for Docker Compose here?


```bash
admin-backend:
image: ghcr.io/epam/ai-dial-admin-backend:latest
environment:
[redacted]
USE_SYSTEM_CA_CERTS: true
volumes:
/opt/ssl/YOUR_NON_PUBLIC_CERTIFICATE.crt:/certificates/YOUR_NON_PUBLIC_CERTIFICATE.crt
```

> **Note**: Replace `YOUR_NON_PUBLIC_CERTIFICATE.crt` with the actual filename of your certificate. Ensure that the certificate file(s) you mount are in PEM (Privacy Enhanced Mail) format (`.crt`). Multiple certificates can be mounted if needed.

## Core Parameters

> Refer to the [AI DIAL Core](https://github.com/epam/ai-dial-core) to view a complete documentation.
Expand Down