Deployment and Integration Overview

SerenityGPT offers flexible installation options tailored to your environment and preferences. The platform can be deployed on-premises or in your cloud, with two approaches available:

• SerenityGPT-assisted installation: Our team can handle the entire setup and configuration for you on a provided server or VM (via secure remote access). This means SerenityGPT will install and configure the system for you, minimizing the effort on your side.
• Self-service deployment: You may also choose to install SerenityGPT yourself using our comprehensive documentation and scripts. This gives your IT administrators full control to deploy the containerized services within your own infrastructure, following our step-by-step guides.

We also offer a fully hosted service:. For a completely hands-off solution, SerenityGPT can host and manage the system for you in our cloud environment. In this subscription model, we maintain all infrastructure and updates, allowing you to simply use the service without worrying about server maintenance.

No matter which deployment model you choose, SerenityGPT is built as a fully containerized application. All components run in Docker containers, which simplifies installation, scaling, and updates. This containerized architecture ensures a consistent environment and makes ongoing maintenance straightforward .

Configuration of the system is centralized in a single YAML configuration file. This unified config approach means administrators can manage the entire setup from one place, making it easy to adjust parameters or integrate new data sources without digging through multiple files or interfaces.

Finally, SerenityGPT supports white‑label integration for partners and enterprises looking to embed its capabilities into their own products. The platform’s search and Q&A interface can be embedded into your existing software or website under your branding, allowing a seamless user experience. This whitelabelling option is ideal for integrators who want to incorporate SerenityGPT’s functionality into their product offerings or internal portals.

SerenityGPT offers flexible installation options tailored to your environment and preferences. The platform can be deployed on‑premises or in your cloud, with three approaches available:

1. SerenityGPT‑assisted installation – Our team handles the entire setup and configuration for you (via secure remote access), minimising effort on your side.
2. Self‑service deployment – You install SerenityGPT yourself using our documentation and scripts, giving your IT administrators full control to deploy the containerised services within your own infrastructure.
3. Fully hosted service – SerenityGPT hosts and manages the system for you in our cloud. In this subscription model we maintain all infrastructure and updates so you can simply use the service.

No matter which deployment model you choose, SerenityGPT is built as a fully containerised application. All components run in Docker containers, simplifying installation, scaling and updates. This consistent runtime environment makes ongoing maintenance straightforward.

Configuration of the system is centralised in a single config.yaml file. Administrators can manage the entire setup from one place, making it easy to adjust parameters or integrate new data sources without digging through multiple files or interfaces.

Finally, SerenityGPT supports white‑label integration for partners and enterprises looking to embed its capabilities into their own products. The platform’s search and Q\&A interface can be embedded into existing software or websites under your branding, ensuring a seamless user experience.

Self‑Service Installation Guide

Serenity analyses your data sources and applies prompt tuning, then sends you a ready‑to‑use config.yaml, a private Docker Compose bundle, and registry credentials. From there the installation is a straightforward three‑step process: transfer, configure, launch.

1. Prerequisites

• Linux server (Ubuntu 22.04 LTS or compatible) with ≥ 4 vCPU, 16 GB RAM, 50 GB disk
• Docker ≥ 24.x and Docker Compose plugin (docker compose) installed
• Outbound HTTPS access to infra.serenitygpt.com (a docker registry and telemetry monitoring collector server)

• Files provided by Serenity:

• config.yaml – pre‑configured, you only fill in credentials

• docker-compose.yml – references the correct image tags
• Docker registry username/password supplied by Serenity

2. Transfer the Bundle to Your Server

scp config.yaml docker-compose.yml user@your‑server:/opt/serenitygpt/

3. Authenticate to the Private Registry

export SERENITY_REGISTRY=registry.serenitygpt.com
docker login $SERENITY_REGISTRY -u <username> -p <password>

4. Configure Credentials

Open config.yaml and replace placeholders under credentials field (details will be provided)

Tip: Keep secrets out of Git. Reference them via environment variables in the YAML (e.g. ${JIRA_TOKEN}).

5. Launch the Stack

cd /opt/serenitygpt
docker compose pull      # downloads images (~3 GB)
docker compose up -d     # starts services in background

Initial indexing begins automatically; follow progress with:

docker compose logs -f worker_crawler

6. Verify & Smoke‑Test

• Browse to https://<your‑server‑fqdn>/ – the SerenityGPT login page should load.
• Run docker compose ps – all containers should show healthy status.
• Check Grafana at /grafana for metrics dashboards.

7. Routine Operations

8. Next Steps

• Integrate additional data sources by duplicating a datasource: block in config.yaml.
• Contact Serenity support (support@serenitygpt.com) for enterprise licence keys, scaling advice, or troubleshooting.