### Jitsi Helm Installation Example

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/README.md

Provides a step-by-step guide to install Jitsi Meet using Helm, including adding the repository, creating a values.yaml file, and performing the installation.

```bash
# 1. Add Helm repository
helm repo add jitsi https://jitsi-contrib.github.io/jitsi-helm/
helm repo update

# 2. Create values.yaml (see 02_configuration_reference.md)
cat > values.yaml <<EOF
publicURL: https://meet.example.com

web:
  ingress:
    enabled: true
    hosts:
      - host: meet.example.com
        paths:
          - /
    tls:
      - secretName: meet-tls
        hosts:
          - meet.example.com

prosody:
  persistence:
    enabled: true
    size: 5G

jvb:
  publicIPs:
    - 203.0.113.5  # Your public IP

coturn:
  enabled: true
EOF

# 3. Install
helm install jitsi jitsi/jitsi-meet -f values.yaml -n jitsi --create-namespace
```

--------------------------------

### Install Jitsi Meet Helm Chart

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Quick start command to add the Jitsi Helm repository and install the Jitsi Meet chart with a public URL.

```bash
helm repo add jitsi https://jitsi-contrib.github.io/jitsi-helm/
helm install myjitsi jitsi/jitsi-meet --set publicURL=https://meet.mydomain.com
```

--------------------------------

### Scale Jitsi Components

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Configure replica counts for stateless components like web, coturn, and jibri to scale the installation. This allows for multi-instance setups.

```yaml
web:
  replicaCount: 3

coturn:
  replicaCount: 3

jibri:
  replicaCount: 3
```

--------------------------------

### Install Jitsi Meet Helm Chart

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/00_TABLE_OF_CONTENTS.md

Installs the Jitsi Meet chart using a custom values.yaml file. Ensure you have a values.yaml file configured for your deployment.

```bash
helm install jitsi jitsi/jitsi-meet -f values.yaml
```

--------------------------------

### TLS Certificate Setup with Cert-Manager

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Configure Jitsi Helm to automatically provision TLS certificates using cert-manager. Requires cert-manager installed and a ClusterIssuer named 'letsencrypt-prod'.

```yaml
web:
  ingress:
    enabled: true
    annotations:
      cert-manager.io/cluster-issuer: letsencrypt-prod
      cert-manager.io/issue-temporary-certificate: "true"
    hosts:
      - host: meet.example.com
        paths:
          - /
    tls:
      - secretName: meet-tls
        hosts:
          - meet.example.com

coturn:
  turns:
    enabled: true
    certificate:
      create: true
      issuerRef:
        name: letsencrypt-prod
        kind: ClusterIssuer
        group: cert-manager.io

```

--------------------------------

### Helm Template Looping Example

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Shows how to iterate over a list of items defined in Values using a range loop.

```yaml
{{- range $i, $item := .Values.items }}
  - {{- $item }}
{{- end }}
```

--------------------------------

### Configure hostPort with Auto-detected Node IP

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Example configuration for `hostPort` where JVB pods auto-detect their external IP from the node. Useful for installations using OCTO. `jvb.replicaCount` can be greater than 1.

```yaml
jvb:
  service:
    enabled: false

  useNodeIP: true

  useHostPort: true
  UDPPort: 10000
```

--------------------------------

### Get Public URL

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Constructs the public URL for the Jitsi Meet installation, prioritizing explicit configuration or deriving it from Gateway API or Ingress settings.

```go-template
{{ include "jitsi-meet.publicURL" . }}
```

--------------------------------

### Override Web Configuration Settings

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Customize web client behavior and interface by overriding configuration settings. This example sets 'startWithAudioMuted' and 'defaultLanguage' in config.js, and 'SHOW_CHROME_EXTENSION_BANNER' in interfaceConfig.js.

```yaml
web:
  custom:
    configs:
      _custom_config_js: |
        config.startWithAudioMuted = true;
        config.defaultLanguage = 'es';
      _custom_interface_config_js: |
        interfaceConfig.SHOW_CHROME_EXTENSION_BANNER = false;
```

--------------------------------

### Dry Run Jitsi Helm Installation

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/00_TABLE_OF_CONTENTS.md

Performs a dry run of the Jitsi Helm chart installation, simulating the deployment without actually creating resources. This is useful for validating configurations and debugging.

```bash
helm install jitsi jitsi/jitsi-meet --dry-run --debug -f values.yaml
```

--------------------------------

### Prosody Custom Initialization Script

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Add custom initialization scripts for Prosody. These scripts run before the main service starts and can be used for loading custom modules or hooks.

```yaml
prosody:
  custom:
    contInit:
      _10_config: |
        #!/bin/bash
        # Load custom Prosody modules or hooks
        echo "Setting up Prosody"
```

--------------------------------

### Configure LoadBalancer Service for JVB

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Example configuration to expose JVB using a LoadBalancer service. Ensure `jvb.replicaCount` remains 1. Public IPs can be added for direct connection fallback.

```yaml
jvb:
  service:
    type: LoadBalancer

  publicIPs:
    - 1.2.3.4
    # - 30.10.10.1
    # - 30.10.10.2
```

--------------------------------

### Basic Jigasi Setup for SIP Integration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Enables Jigasi to act as a SIP gateway, allowing users to dial in via SIP and bridge conference calls. Requires XMPP credentials and Prosody environment variables for SIP server configuration.

```yaml
jigasi:
  enabled: true
  
  xmpp:
    user: jigasi
    password: "jigasi-password"

prosody:
  extraEnvs:
    JIGASI_SIP_SERVER: sip.example.com
    JIGASI_SIP_PORT: "5060"
    JIGASI_SIP_TRANSPORT: udp
```

--------------------------------

### Extend Prosody with Custom Plugins

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Add custom Prosody plugins by mounting a ConfigMap containing the plugins into the Prosody container. This example shows how to load a 'measure_client_presence' plugin.

```yaml
prosody:
  extraVolumes:
    - name: custom-plugins
      configMap:
        name: prosody-custom-plugins

  extraVolumeMounts:
    - name: custom-plugins
      mountPath: /prosody-plugins-custom

  custom:
    contInit:
      _10_config: |
        module:load_plugins({'measure_client_presence'})
```

--------------------------------

### Web Custom Initialization Script

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Add custom initialization scripts for the web component. These scripts run before the main service starts and can be used to modify configurations like nginx.

```yaml
web:
  custom:
    contInit:
      _10_config: |
        #!/bin/bash
        echo "Custom web initialization"
        # Add custom nginx configuration
        cat >> /etc/nginx/nginx.conf <<EOF
        # Custom settings
        EOF
```

--------------------------------

### Configure NodePort Service for JVB

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Example configuration for exposing JVB using a NodePort service. Allows specifying UDP and NodePort, or using default random ports. `jvb.replicaCount` must be 1.

```yaml
jvb:
  service:
    type: NodePort

  #UDPPort: 32000
  #nodePort: 32000

  publicIPs:
    - 30.10.10.1
```

--------------------------------

### Mount Custom Nginx Configuration for Web

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Add custom Nginx configurations to the web component. This example mounts a custom.conf file to define a /health endpoint that returns 'OK'.

```yaml
web:
  extraFiles:
    - path: /etc/nginx/conf.d/custom.conf
      content: |
        location /health {
          return 200 "OK\n";
        }
      mode: "0644"
```

--------------------------------

### Get Chart Label

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Constructs the chart label by combining the chart name and version, replacing '+' with '_'.

```go-template
{{ include "jitsi-meet.chart" . }}
```

--------------------------------

### Restore Jitsi Meet Deployment from Backup

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Installs a Jitsi Meet release using previously saved Helm values and applies backed-up ConfigMaps and Secrets to a new namespace. This is part of the disaster recovery process.

```bash
helm install jitsi-restore jitsi/jitsi-meet \
  --namespace jitsi-new \
  -f jitsi-values-backup.yaml

# Restore secrets and configmaps if modified
kubectl apply -f jitsi-cm-secrets-backup.yaml
```

--------------------------------

### Mount Custom Configuration File for Jibri

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Mount arbitrary files into Jibri containers to provide custom configurations. This example mounts a JSON file for custom Jibri settings.

```yaml
jibri:
  extraFiles:
    - path: /etc/jibri/custom-config.json
      content: |{"custom": "configuration"}
```

--------------------------------

### Multi-Replica Jitsi Deployment Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configure multiple replicas for web, coturn, and jibri components for high availability. Prosody requires persistence for single replica setups. JVB can be scaled or use OCTO for multiple instances.

```yaml
web:
  replicaCount: 3
  resources:
    requests:
      cpu: 100m
      memory: 128Mi

prosody:
  # Single replica; persistence required
  persistence:
    enabled: true
    size: 5G

jvb:
  replicaCount: 1
  # Or use OCTO for multiple:
  # replicaCount: 3
  # useNodeIP: true
  # useHostPort: true

coturn:
  replicaCount: 3

jibri:
  replicaCount: 3
  singleUseMode: true

affinity:
  podAntiAffinity:
    preferredDuringSchedulingIgnoredDuringExecution:
      - weight: 100
        podAffinityTerm:
          labelSelector:
            matchExpressions:
              - key: app
                operator: In
                values:
                  - jitsi-meet
          topologyKey: kubernetes.io/hostname

```

--------------------------------

### Configure Multi-Region High Availability with OCTO

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Example Helm values for deploying Jitsi Meet across multiple regions to achieve high availability. This configuration enables OCTO for federation within each region.

```yaml
# Region 1
jvb:
  replicaCount: 3
  useNodeIP: true
  useHostPort: true
  publicIPs:
    - region1-ip

octo:
  enabled: true

# Region 2
jvb:
  replicaCount: 3
  useNodeIP: true
  useHostPort: true
  publicIPs:
    - region2-ip

octo:
  enabled: true
```

--------------------------------

### Jibri Custom Initialization Script

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Add custom initialization scripts for Jibri. These scripts run before the main service starts and are used for Jibri-specific initialization tasks.

```yaml
jibri:
  custom:
    contInit:
      _10_config: |
        #!/bin/bash
        # Jibri-specific initialization
        echo "Initializing Jibri"
```

--------------------------------

### Get XMPP Server FQDN

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Returns the fully qualified domain name for the Prosody XMPP service, including cluster domain if configured.

```go-template
{{ include "jitsi-meet.xmpp.server" . }}
```

--------------------------------

### Configure hostPort for JVB

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Example configuration to expose JVB using `hostPort`. This bypasses the Kubernetes service and directly uses the node's IP and specified UDP port. `jvb.replicaCount` can be greater than 1.

```yaml
jvb:
  service:
    enabled: false

  publicIPs:
    - 30.10.10.1

  useHostPort: true
  UDPPort: 10000
```

--------------------------------

### Get Full Resource Name

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Generates the full resource name by combining the release and chart names, truncated to 63 characters and removing trailing hyphens. Uses fullnameOverride if set.

```go-template
{{ include "jitsi-meet.fullname" . }}
```

--------------------------------

### Ingress Configuration for Jitsi Meet

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configures Jitsi Meet to use an Ingress controller for network exposure, including TLS termination. This is the recommended pattern for standard setups with a single JVB.

```yaml
web:
  ingress:
    enabled: true
    annotations:
      kubernetes.io/ingress.class: nginx
      cert-manager.io/cluster-issuer: letsencrypt-prod
    hosts:
      - host: meet.example.com
        paths:
          - /
    tls:
      - secretName: meet-tls
        hosts:
          - meet.example.com

publicURL: https://meet.example.com

jvb:
  publicIPs:
    - 203.0.113.5  # Your ingress/load balancer IP
```

--------------------------------

### Canary Deployment Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Configures a Jitsi Meet deployment for a canary release by specifying replica counts and version tags for pods. This setup is typically used in conjunction with traffic management tools like Istio.

```yaml
web:
  replicaCount: 3  # 3 pods
  podLabels:
    version: v1  # Tag with version

# Deploy canary pod
jitsi-canary:
  enabled: true
  image:
    tag: "v2.0.0-rc1"
  replicaCount: 1
  podLabels:
    version: v2-canary
```

--------------------------------

### hostPort with Port Range (OCTO) Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configures Jitsi Meet for multiple JVB instances using hostPort with a port range, intended for multi-region deployments with OCTO federation. Each JVB gets consecutive ports.

```yaml
jvb:
  replicaCount: 3
  service:
    enabled: false
  useNodeIP: true
  useHostPort: true
  UDPPort: 10000
  portRangeSize: 3

octo:
  enabled: true

publicURL: https://meet.example.com
```

--------------------------------

### External Jibri Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configures Jitsi to use a separate, externally managed Jibri installation for recording and streaming. This pattern is useful for multi-cluster setups or specialized Jibri hosts.

```yaml
jibri:
  enabled: true
  useExternalJibri: true
  
  recording: true
  livestreaming: true
  
  xmpp:
    user: jibri
    password: "external-jibri-password"
  
  recorder:
    user: recorder
    password: "recorder-password"
```

--------------------------------

### Select Storage Class for Jitsi Components

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Choose the appropriate storage class for different Jitsi components based on performance needs. 'fast-ssd' is recommended for recordings, while 'standard' may suffice for configuration data.

```yaml
# High-performance SSD for recording
jibri:
  persistence:
    storageClassName: fast-ssd

# Standard storage for configuration
prosody:
  persistence:
    storageClassName: standard

# Network-attached storage for Etherpad
etherpad:
  # Configure postgres instead of sqlite for HA
  extraEnvs:
    DB_TYPE: postgres
```

--------------------------------

### Configure Coturn Init Container

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Set up an init container for Coturn using busybox to perform initialization tasks, such as waiting for DNS resolution.

```yaml
coturn:
  initContainers:
    busybox:
      image: busybox:1.36
      securityContext: {}
      command: ['sh', '-c']
      args:
        - |
          echo "Waiting for DNS..."
          until nslookup prometheus-operator.kube-system;
            sleep 1
          done
```

--------------------------------

### Generate Kubernetes Labels

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Outputs all recommended Kubernetes labels for resources, including chart, app, instance, version, and managed-by information. Indented by 4 spaces.

```go-template
{{ include "jitsi-meet.labels" . | nindent 4 }}
```

--------------------------------

### Configure Core Components

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/README.md

Sets replica counts for core Jitsi components like web, prosody, jvb, and jicofo. Persistence for Prosody is recommended for production.

```yaml
web:
  replicaCount: 1        # Stateless, scale as needed

prosody:
  persistence:
    enabled: true        # Recommended for production

jvb:
  replicaCount: 1        # 1 with service, 3+ with OCTO

jicofo:
  # Single replica (hardcoded)
```

--------------------------------

### Custom RBAC Role for Jitsi Meet

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Defines a custom Kubernetes Role for the Jitsi Meet service account, granting permissions to get, list, and watch pods, and get secrets and configmaps. This limits the service account's access to only necessary resources.

```yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: jitsi-meet
rules:
  - apiGroups: [""]
    resources: ["pods"]
    verbs: ["get", "list", "watch"]
  - apiGroups: [""]
    resources: ["configmaps", "secrets"]
    verbs: ["get"]
```

--------------------------------

### Get Etherpad Service Endpoint

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Retrieves the service endpoint for the Etherpad component.

```go-template
{{ include "jitsi-meet.etherpad.server" . }}
```

--------------------------------

### Generate Selector Labels

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Outputs minimal labels suitable for selector matching, including app name and instance. Indented by 6 spaces.

```go-template
{{ include "jitsi-meet.selectorLabels" . | nindent 6 }}
```

--------------------------------

### Get Excalidraw Service Endpoint

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Retrieves the service endpoint for the Excalidraw component.

```go-template
{{ include "jitsi-meet.excalidraw.server" . }}
```

--------------------------------

### Get Chart Name

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Retrieves the chart name, respecting the nameOverride value.

```go-template
{{ include "jitsi-meet.name" . }}
```

--------------------------------

### Get XMPP Domain

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Retrieves the XMPP domain name, prioritizing the xmpp.domain value or deriving it from the Kubernetes service DNS.

```go-template
{{ include "jitsi-meet.xmpp.domain" . }}
```

--------------------------------

### Enable Etherpad Integration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Enables Etherpad integration for shared document editing. Configure extra environment variables for Etherpad.

```yaml
etherpad:
  enabled: true
  
  extraEnvs:
    ADMIN_PASSWORD: "very-secure-password"
    DB_TYPE: postgres
    DB_HOST: postgres.example.com
    DB_USER: etherpad
    DB_PASS: "db-password"
    DB_NAME: etherpad
    DB_PORT: "5432"
```

--------------------------------

### Get Service Account Name

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Determines the service account name to be used, considering creation flags and explicit naming.

```go-template
{{ include "jitsi-meet.serviceAccountName" . }}
```

--------------------------------

### Get Common Resource Name

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Generates a common resource name for shared resources, typically in the format {fullname}-common.

```go-template
{{ include "jitsi-meet.common" . }}
```

--------------------------------

### Get Current Helm Values

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Retrieves the current configuration values for a Jitsi Helm release. This is a prerequisite for performing upgrades or rollbacks.

```bash
# Get current values
helm get values jitsi-release > current-values.yaml
```

--------------------------------

### Configure Custom Prosody Plugins

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Mount custom Lua modules for Prosody by defining extra volumes and volume mounts, then configuring Prosody to load these modules. The 'contInit' section allows for dynamic configuration updates.

```yaml
prosody:
  extraVolumes:
    - name: custom-prosody-plugins
      configMap:
        name: custom-prosody-plugins
  
  extraVolumeMounts:
    - name: custom-prosody-plugins
      mountPath: /prosody-plugins-custom
  
  custom:
    contInit:
      _10_config: |
        #!/bin/bash
        # Load custom modules
        cat >> /etc/prosody/prosody.cfg.lua <<EOF
        plugin_paths = {
          "/prosody-plugins-custom"
        }
        EOF
```

--------------------------------

### Configure SASL/PLAIN Authentication

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Enable simple username/password authentication using SASL/PLAIN and configure Prosody persistence to store user accounts.

```yaml
enableAuth: true

prosody:
  persistence:
    enabled: true
    size: 3G  # Store user accounts
  
  custom:
    defaults:
      _prosody_cfg_lua: |
        authentication = "internal_hashed"
```

--------------------------------

### External Jigasi Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configures Jitsi to use a separate, externally managed Jigasi installation. This pattern is suitable when Jigasi runs on different infrastructure.

```yaml
jigasi:
  enabled: true
  useExternalJigasi: true
  
  xmpp:
    user: jigasi
    password: "jigasi-password"
```

--------------------------------

### Package Jitsi Helm Chart

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/docs/manuals/releasing.md

Packages the Helm chart and signs it using a GPG key. Ensure your GPG key is configured and accessible.

```bash
gpg --list-keys --keyid-format LONG
```

```bash
gpg --keyserver hkps://keys.openpgp.org --recv-keys "$KEY_ID"
```

```bash
helm package . -d ./docs/ --sign --key "$KEY_EMAIL" --keyring ~/.gnupg/secring.gpg
```

--------------------------------

### Add Jitsi Helm Repository

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/docs/index.html

Add the Jitsi Helm chart repository to your Helm client configuration.

```bash
helm repo add jitsi https://jitsi-contrib.github.io/jitsi-helm/
```

--------------------------------

### Enable OCTO

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/docs/manuals/testing-octo.md

Enable the OCTO feature by setting 'octo.enabled' to true in the configuration.

```yaml
octo:
  enabled: true
```

--------------------------------

### Get NodePort for Jitsi Web Service

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/templates/NOTES.txt

This command retrieves the NodePort assigned to the Jitsi web service when the service type is NodePort. It's used to construct the access URL.

```bash
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "jitsi-meet.web.fullname" . }})
```

--------------------------------

### Configure Shared Memory for Recording Services

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Enable and configure shared memory (/dev/shm) for recording services. Allows specifying the size and whether to use the host's /dev/shm or an emptyDir.

```yaml
jibri:
  shm:
    enabled: true
    useHost: false  # Use emptyDir instead of host /dev/shm
    size: 2Gi  # Allocate 2GB for shared memory
```

--------------------------------

### Request Extended Resources (e.g., GPUs)

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Configure requests for specialized hardware, such as NVIDIA GPUs, for components like Jibri. Ensure the Kubernetes cluster has the necessary device plugins installed.

```yaml
jibri:
  resources:
    requests:
      nvidia.com/gpu: "1"
    limits:
      nvidia.com/gpu: "1"
```

--------------------------------

### Get Node IP for Jitsi Deployment

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/templates/NOTES.txt

This command retrieves the IP address of a Kubernetes node. It's used in conjunction with the NodePort to form the access URL when the service type is NodePort.

```bash
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
```

--------------------------------

### Enable TURNS and Configure Certificates

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/docs/manuals/turns.md

Activate standard TURN and TURNS, enabling TLS certificates to be created via cert-manager. This configuration also sets up ACME proxying to Traefik for certificate validation.

```yaml
coturn:
  enabled: true # enable standard TURN
  replicaCount: 3

  turns:
    enabled: true # activate TURNS
    certificate:

      # create TLS certificates using cert-manager
      create: true

      # use the given issuer to produce certificates
      issuerRef:
        name: letsencrypt-prod
        kind: ClusterIssuer
        group: cert-manager.io

      # enable proxying of ACME challenge requests back to the `traefik` service
      # in the `traefik` namespace
      acmeProxy:
        enabled: true
        target: traefik.traefik.svc.cluster.local

```

--------------------------------

### NodePort Service Configuration for Jitsi Meet

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Configures Jitsi Meet to use NodePort services, useful for on-premises setups with an external load balancer. The JVB replicaCount must be 1.

```yaml
web:
  service:
    type: NodePort
    nodePort: 30443

jvb:
  service:
    type: NodePort
    nodePort: 30000
  publicIPs:
    - <NODE_PUBLIC_IP>

publicURL: https://meet.example.com
```

--------------------------------

### Accessing Helm Values via Dot Notation

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/03_helm_templates.md

Demonstrates how to access component-specific and global configuration values using dot notation.

```yaml
{{ .Values.{{component}}.{{property}} }}
{{ .Values.global.{{property}} }}
```

--------------------------------

### Tune Prosody Readiness Probe

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Configure readiness probe settings for Prosody to manage traffic routing based on its health.

```yaml
prosody:
  readinessProbe:
    httpGet:
      path: /http-bind
      port: 5280
    initialDelaySeconds: 30
    periodSeconds: 5
    timeoutSeconds: 3
    failureThreshold: 3
    successThreshold: 1
```

--------------------------------

### Enable Excalidraw Integration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Enables Excalidraw integration for a virtual whiteboard. Specify the image tag for Excalidraw.

```yaml
excalidraw:
  enabled: true
  
  image:
    tag: "2026.3.0"
```

--------------------------------

### Blue-Green Deployment with Helm

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Deploys a new version of Jitsi Meet in parallel to the existing one using a different release name. This allows for testing the new version before switching traffic and decommissioning the old one.

```bash
# Deploy new version with different name
helm install jitsi-release-v2 jitsi/jitsi-meet \
  -f current-values.yaml \
  --set nameOverride=jitsi-v2

# Test new version
# Update ingress/loadbalancer to point to new version
# Delete old version: helm uninstall jitsi-release
```

--------------------------------

### Jitsi Helm Chart Directory Structure

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/01_chart_overview.md

Illustrates the standard directory layout for the Jitsi Meet Helm chart, outlining the purpose of key files and directories.

```yaml
jitsi-helm/
├── Chart.yaml                 # Chart metadata
├── values.yaml               # Default configuration values
├── templates/                # Kubernetes resource templates
│   ├── _helpers.tpl         # Global helper functions
│   ├── configmap.yaml       # Global configuration
│   ├── serviceaccount.yaml  # Service account definition
│   ├── web/                 # Web component templates
│   ├── prosody/             # Prosody component templates
│   ├── jicofo/              # Jicofo component templates
│   ├── jvb/                 # JVB component templates
│   ├── jibri/               # Jibri component templates
│   ├── jigasi/              # Jigasi component templates
│   ├── transcriber/         # Transcriber component templates
│   ├── coturn/              # Coturn component templates
│   ├── etherpad/            # Etherpad component templates
│   ├── excalidraw/          # Excalidraw component templates
│   └── tests/               # Test manifests
├── docs/                     # Documentation
└── files/                    # Static files (Grafana dashboards, etc.)
```

--------------------------------

### Create Istio VirtualService

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Define an Istio VirtualService to route traffic for a specific host to the Jitsi Meet web service.

```yaml
apiVersion: networking.istio.io/v1beta1
kind: VirtualService
metadata:
  name: jitsi-web
spec:
  hosts:
    - meet.example.com
  http:
    - match:
        - uri:
            prefix: /
      route:
        - destination:
            host: jitsi-meet-web
            port:
              number: 80
      timeout: 30s
      retries:
        attempts: 3
        perTryTimeout: 10s
```

--------------------------------

### Port-forward Jitsi Web Service (ClusterIP)

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/templates/NOTES.txt

This command sets up a port-forwarding connection to a Jitsi web service when its type is ClusterIP. This allows access to the application via localhost.

```bash
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "jitsi-meet.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=web" -o jsonpath="{.items[0].metadata.name}")
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
```

--------------------------------

### Recording and Streaming Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Enables Jibri for both local recording and livestreaming, such as to YouTube. Requires YouTube API credentials to be configured via environment variables.

```yaml
jibri:
  enabled: true
  recording: true
  livestreaming: true
  
  replicaCount: 3
  
  persistence:
    enabled: true
    size: 20Gi
  
  singleUseMode: false
```

--------------------------------

### Jibri Configuration File Overrides

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Override default configuration files for Jibri. Customize Jibri settings, stats service, and X.org video dummy configuration.

```yaml
jibri:
  custom:
    defaults:
      _jibri_conf: |
        {
          "jibri": {
            "stats": {
              "enable-stats-service": false
            }
          }
        }
      _xorg_video_dummy_conf: |
        # Custom X.org video dummy config
```

--------------------------------

### Configure LDAP Authentication via Prosody

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Enable and configure LDAP/Active Directory authentication by specifying connection details and user base for Prosody.

```yaml
enableAuth: true

prosody:
  custom:
    defaults:
      _prosody_cfg_lua: |
        authentication = "ldap"
        ldap = {
          hostname = "ldap.example.com",
          bind_dn = "cn=admin,dc=example,dc=com",
          bind_password = "password",
          user_base = "ou=users,dc=example,dc=com",
          user_filter = "(&(uid=$user)(objectClass=inetOrgPerson))"
        }
```

--------------------------------

### Add Custom Prosody Plugins

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/README.md

Integrates custom Prosody plugins by mounting additional ConfigMaps. This allows extending Jitsi Meet with custom features not included by default.

```yaml
prosody:
  extraVolumes:
    - name: prosody-modules
      configMap:
        name: prosody-modules

  extraVolumeMounts:
    - name: prosody-modules
      subPath: mod_measure_client_presence.lua
      mountPath: /prosody-plugins-custom/mod_measure_client_presence.lua
```

--------------------------------

### Mount Extra Files to Web Pod

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/07_advanced_configuration.md

Use the 'web.extraFiles' directive to mount custom configuration files or scripts into the web pod. Specify the path, mode, and content for each file.

```yaml
web:
  extraFiles:
    - path: /etc/nginx/conf.d/custom-locations.conf
      mode: "0644"
      content: |
        location /custom-health {
          return 200 "OK\n";
        }
    
    - path: /custom-config.json
      mode: "0644"
      content: |
        {
          "custom": "configuration"
        }
```

--------------------------------

### Configure Jibri Recording Storage

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Set up persistent storage for Jibri recordings. This allows recordings to survive pod restarts. Ensure to use `ReadWriteOnce` storage or `ReadWriteMany` if scaling Jibri.

```yaml
jibri:
  persistence:
    enabled: true
    size: 100G
    storageClassName: fast-ssd
    
    # Or use existing PVC:
    # existingClaim: jibri-recordings-pvc
```

--------------------------------

### Guest Access Only Configuration

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/04_deployment_patterns.md

Enables guest access without any authentication. This is the default setting.

```yaml
enableAuth: false
enableGuests: true
```

--------------------------------

### Set Component Log Levels

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Configure the verbosity of logs for various Jitsi components by setting environment variables in the Helm chart. Use 'debug', 'info', 'warn', or 'error' as appropriate.

```yaml
web:
  extraEnvs:
    # Nginx typically doesn't expose log level via env

prosody:
  extraEnvs:
    PROSODY_LOG_LEVEL: debug  # debug, info, warn, error

jvb:
  extraEnvs:
    JVB_LOG_LEVEL: debug

jicofo:
  extraEnvs:
    JICOFO_LOG_LEVEL: debug

jibri:
  extraEnvs:
    JIBRI_LOG_LEVEL: debug
```

--------------------------------

### Configure OAuth / OpenID Connect Adapter

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/08_integration_and_extensions.md

Forward OAuth requests to an external provider by deploying an OIDC adapter container and configuring Nginx proxy.

```yaml
web:
  extraContainers:
    - name: oidc-adapter
      image: ghcr.io/jitsi-contrib/jitsi-oidc-adapter:latest
      ports:
        - name: http
          containerPort: 9000
      env:
        - name: OIDC_ISSUER
          value: "https://auth.example.com"
        - name: OIDC_CLIENT_ID
          valueFrom:
            secretKeyRef:
              name: oidc-credentials
              key: client-id
  
  custom:
    defaults:
      _nginx_conf: |
        location /oidc/ {
          proxy_pass http://localhost:9000;
        }
```

--------------------------------

### Retrieve Current Jitsi Helm Values

Source: https://github.com/jitsi-contrib/jitsi-helm/blob/main/_autodocs/00_TABLE_OF_CONTENTS.md

Fetches the current configuration values for a deployed Jitsi Helm release and saves them to a local file.

```bash
helm get values jitsi > current-values.yaml
```