Qyra
DocsAPI
Self-host

Self-Host Qyra

Deploy Qyra on Kubernetes with the official Helm chart, from minimum config to production

Qyra is MIT licensed and open source. You can self-host Qyra on your own infrastructure.

This guide is designed for DevOps Engineers that are familiar with Docker, Kubernetes, and are comfortable configuring environment variables, SMTP credentials, and database connections. If you're unsure whether to self-host please read our guide on Qyra Cloud vs. Self-Hosted.

Prerequisites for self-hosting

  • Access to a kubernetes cluster and kubectl installed
  • Helm
  • Docker

Self-host Qyra on Kubernetes

The following steps will create a Qyra instance and a postgres database to store your metadata (note: this is separate to your data warehouse with your analytics data).

We recommend using kubernetes + helm but you can alternatively follow these guides for a minimum deployment without kubernetes:

To deploy Qyra on your Kubernetes cluster you can use our community maintained Helm chart: https://github.com/quanvio/helm-charts. This will get you started with the simplest configuration possible. At the end of this guide you can find a list of configuration options to customise your Qyra instance and make it production ready.

1. Add the Qyra Helm repository

helm repo add qyra https://qyraflow.com/helm-charts

2. Create a namespace for Qyra

kubectl create namespace qyra

3. Create a minimum configuration for Qyra

At minimum you should configure:

  • secrets.QYRA_SECRET - this variable is used by Qyra to encrypt data at rest in the database. You must keep this secret. If this is lost, you will not be able to access your data in Qyra.
  • configMap.S3_REGION, configMap.S3_BUCKET, configMap.S3_ENDPOINT, secrets.S3_ACCESS_KEY and secrets.S3_SECRET_KEY - These variables are for configuring external object storage with S3. For detailed information, refer to the external object storage documentation.
  • service.type - by default the Qyra UI and API is exposed on a ClusterIP service. This means that it is only accessible from within the Kubernetes cluster. If you want to access Qyra from outside the cluster, you can change this to LoadBalancer or NodePort. See the Kubernetes documentation for more information.
  • configMap.SITE_URL - if you know the URL that Qyra will be accessible at, you can set this variable. This will ensure that all links in Qyra are correct. If you don't know the URL yet, you can leave this blank and update it later.

When setting up and configuring your Qyra instance, you'll likely need to configure many additional environment variables. The Helm chart supports three ways to set environment variables:

  • configMap - for non-sensitive configuration values
  • secrets - for sensitive values like passwords and API keys
  • extraEnv - for additional environment variables not covered by the chart's built-in options

For a complete list of available environment variables, see the environment variables documentation. For detailed Helm chart configuration options, refer to the Qyra Helm charts repository.

Example values.yaml file containing our configuration:

# values.yaml
secrets:
  QYRA_SECRET: notverysecret
  S3_ACCESS_KEY: secret # not required if using IAM role
  S3_SECRET_KEY: secret # not required if using IAM role
  # QYRA_LICENSE_KEY: your-enterprise-license-key # Optional: for Enterprise Edition features

configMap:
  SITE_URL: https://qyra.mycompany.com
  S3_REGION: us
  S3_BUCKET: qyra
  S3_ENDPOINT: https://storage.provider.com

# Additional environment variables not covered by configMap or secrets
extraEnv:
  - name: CUSTOM_ENV_VAR
    value: "custom-value"
  - name: ANOTHER_CONFIG
    value: "another-value"

service:
  type: NodePort

Enterprise License Key (Optional)

If you have a Qyra Enterprise license, you can enable enterprise features by adding your license key to the configuration:

secrets:
  QYRA_LICENSE_KEY: your-enterprise-license-key-here

To obtain an Enterprise License Key, contact our team. For more details, see our enterprise features documentation.

4. Install Qyra with helm

Create a new helm release called qyra using the quanvio/qyra helm chart. In this example we're also using the namespace -n qyra. Finally we apply our minimum configuration from above using -f values.yaml.

helm install qyra quanvio/qyra -n qyra -f values.yaml

4 (alternative). Install Qyra with kubectl

If you prefer not to manage your deployment with helm, you can generate the kubernetes manifests and apply them using kubectl.

helm template qyra quanvio/qyra -n qyra -f values.yaml > qyra.yaml
kubectl apply -f qyra.yaml

Visit your SITE_URL to access Qyra!

Configure Qyra for production

Now you have a working Qyra instance, you can customise it to your needs. The following docs cover the most common configuration options, including those we recommend before going to production:

Required configuration

Recommended for production usage

Optional configuration

Environment variables

Complete reference of the environment variables that configure a Qyra deployment

Self-host Qyra using docker compose

Run a minimal Qyra instance on your own machine with Docker Compose

On this page

Prerequisites for self-hostingSelf-host Qyra on Kubernetes1. Add the Qyra Helm repository2. Create a namespace for Qyra3. Create a minimum configuration for QyraEnterprise License Key (Optional)4. Install Qyra with helm4 (alternative). Install Qyra with kubectlConfigure Qyra for production