Hoppscotch Charts

Scalable Kubernetes Deployments for Hoppscotch

_{Built with ❤︎ by contributors}

Support

Features

❤️ Enterprise Ready: Built for large-scale deployments with security in mind.

⚡️ High Performance: Optimized for speed and resource efficiency.

🔒 Security First: Built-in security features and compliance controls.

🌐 Multi-Cloud: Deploy anywhere with our cloud-agnostic architecture.

🚀 Scalable: Automatically scales based on your workload.

🔄 High Availability: Built-in redundancy and failover capabilities.

Available Charts

Chart	Description
hoppscotch	Recommended. Unified chart (Community + Enterprise, AIO or distributed); used by the guides below
shc	Community edition chart, maintained for backward compatibility, superseded by hoppscotch
she	Enterprise edition chart, maintained for backward compatibility, superseded by hoppscotch

For deployment modes, configuration and the full parameters list, see the chart README . It is the authoritative install guide. The guides below are provider-specific quick starts.

Migrating an existing shc or she deployment? Follow the migration guide.

Installation Guides

Digital Ocean Installation

Prerequisites

• Access to a DOKS cluster (kubeconfig via doctl or the console)
• Cluster permissions to create the chart's resources (cluster-admin only if you also install an ingress controller)
• kubectl and Helm 3.x
• doctl (to fetch the kubeconfig)

Quick Install

# Configure access
export KUBECONFIG=path/to/k8s-config.yaml

# (Optional) Install NGINX Ingress
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.2/deploy/static/provider/do/deploy.yaml

# Add chart repository
helm repo add hoppscotch https://hoppscotch.github.io/helm-charts

# Deploy application (edition is selected in your values file)
helm install [RELEASE_NAME] hoppscotch/hoppscotch -f [path-to-values-file]

Configuration (deployment mode, database, ingress/TLS, etc.) is set in your values file. See the chart README for the full guide and all parameters.

• Load balancer / ingress: use NGINX ingress (aio.ingress.*) or a DigitalOcean LB via aio.service.type: LoadBalancer with service.beta.kubernetes.io/do-loadbalancer-* under aio.service.annotations. In distributed mode the same keys exist per component.

GCP Installation

Prerequisites

• Access to a GKE cluster (kubeconfig via gcloud)
• Cluster permissions to create the chart's resources (cluster-admin only if you also install an ingress controller)
• kubectl and Helm 3.x
• gcloud CLI (to fetch the kubeconfig)

Quick Install

# Configure cluster access
gcloud container clusters get-credentials cluster-name --zone zone --project project-id

# (Optional) Install NGINX Ingress
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.2/deploy/static/provider/cloud/deploy.yaml

# Add chart repository
helm repo add hoppscotch https://hoppscotch.github.io/helm-charts

# Deploy application (edition is selected in your values file)
helm install [RELEASE_NAME] hoppscotch/hoppscotch -f [path-to-values-file]

Configuration (deployment mode, database, ingress/TLS, etc.) is set in your values file. See the chart README for the full guide and all parameters.

• Load balancer / ingress: use the GKE ingress (aio.ingress.ingressClassName: gce + aio.ingress.annotations) or a Google Cloud LB via aio.service.type: LoadBalancer with networking.gke.io/* under aio.service.annotations. In distributed mode the same keys exist per component.

AWS EKS Installation

Prerequisites

• Access to an EKS cluster (kubeconfig via aws eks update-kubeconfig)
• Cluster permissions to create the chart's resources (cluster-admin only if you also install an ingress/ALB controller)
• kubectl and Helm 3.x
• AWS CLI (to fetch the kubeconfig)

Quick Install

# Configure cluster access
aws eks update-kubeconfig --name cluster-name --region region

# (Optional) Install NGINX Ingress
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.2/deploy/static/provider/aws/deploy.yaml

# Add chart repository
helm repo add hoppscotch https://hoppscotch.github.io/helm-charts

# Deploy application (edition is selected in your values file)
helm install [RELEASE_NAME] hoppscotch/hoppscotch -f [path-to-values-file]

Configuration (deployment mode, database, ingress/TLS, etc.) is set in your values file. See the chart README for the full guide and all parameters.

• Load balancer / ingress: use an ALB (aio.ingress.ingressClassName: alb + alb.ingress.kubernetes.io/*, AWS Load Balancer Controller required) or an NLB via aio.service.type: LoadBalancer with service.beta.kubernetes.io/aws-load-balancer-* under aio.service.annotations. In distributed mode the same keys exist per component.

Azure AKS Installation

Prerequisites

• Access to an AKS cluster (kubeconfig via az aks get-credentials)
• Cluster permissions to create the chart's resources (cluster-admin only if you also install an ingress controller)
• kubectl and Helm 3.x
• Azure CLI (to fetch the kubeconfig)

Quick Install

# Configure cluster access
az aks get-credentials --resource-group resource-group --name cluster-name

# (Optional) Install NGINX Ingress
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.2/deploy/static/provider/cloud/deploy.yaml

# Add chart repository
helm repo add hoppscotch https://hoppscotch.github.io/helm-charts

# Deploy application (edition is selected in your values file)
helm install [RELEASE_NAME] hoppscotch/hoppscotch -f [path-to-values-file]

Configuration (deployment mode, database, ingress/TLS, etc.) is set in your values file. See the chart README for the full guide and all parameters.

• Load balancer / ingress: use Application Gateway ingress (aio.ingress.ingressClassName: azure-application-gateway + appgw.ingress.kubernetes.io/*) or an Azure LB via aio.service.type: LoadBalancer with service.beta.kubernetes.io/azure-load-balancer-* under aio.service.annotations. In distributed mode the same keys exist per component.

OpenShift Installation

Prerequisites

• OpenShift 4.x cluster (works on the default restricted-v2 SCC; no cluster-admin required)
• oc CLI logged in to your cluster
• Helm 3.x installed

Quick Install

# Add chart repository
helm repo add hoppscotch https://hoppscotch.github.io/helm-charts

# Deploy on OpenShift (adapts securityContext for restricted-v2 and exposes a Route)
helm upgrade --install [RELEASE_NAME] hoppscotch/hoppscotch \
  --namespace hoppscotch --create-namespace \
  -f [path-to-values-file]

On OpenShift, enable global.compatibility.openshift.adaptSecurityContext and expose the app with a Route instead of an Ingress. See the chart's Deploying on OpenShift guide for the full walkthrough: restricted-v2 requirements, HOPP_ALTERNATE_PORT, and both aio and distributed modes.

About Helm Charts

Our application uses Helm for package management in Kubernetes. Helm Charts help you:

• 📦 Define, install, and upgrade Kubernetes applications
• 🔄 Share applications with others
• 🔧 Manage complex deployments with simple commands
• ⏪ Roll back to previous versions when needed

Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

Continuous Integration

We use GitHub Actions for continuous integration.

Authors

This project owes its existence to the collective efforts of all those who contribute — contribute now.

License

This project is licensed under the MIT License — see the LICENSE file for details.