Skip to content

docs(hoppscotch): sync template standards updates #353

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
mberlofa wants to merge 2 commits into
base: main
Choose a base branch
from
+47 −23
Open

docs(hoppscotch): sync template standards updates #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a29446
docs(hoppscotch): sync template standards updates
mberlofa Jul 3, 2026
99dcbdb
docs(hoppscotch): document templated extra manifests
mberlofa Jul 5, 2026
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
21 changes: 21 additions & 0 deletions src/data/playground-configs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10554,6 +10554,27 @@ export const chartConfigs: Record<string, ChartConfig> = {
},
],
},
{
name: 'Network Policy',
collapsible: true,
gateField: 'networkPolicy.enabled',
fields: [
{
label: 'Extra Egress CIDR',
key: 'networkPolicy.extraEgress[0].to[0].ipBlock.cidr',
type: 'text',
default: '10.0.0.0/8',
description: 'Additional destination allowed after DNS and database baseline rules',
},
{
label: 'Extra Egress Port',
key: 'networkPolicy.extraEgress[0].ports[0].port',
type: 'number',
default: '443',
description: 'Additional TCP egress port',
},
],
},
],
};

Expand Down
48 changes: 25 additions & 23 deletions src/pages/docs/charts/hoppscotch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Callout from '../../../components/Callout.astro';

# Hoppscotch

Hoppscotch is an open-source API development platform supporting REST, GraphQL, and WebSocket APIs. The HelmForge chart deploys the Community Edition All-in-One image (`2026.4.1`) with subpath-based routing, automatic Prisma migrations, optional OAuth providers, SMTP, ExternalSecrets Operator support, and a bundled HelmForge PostgreSQL subchart.
Hoppscotch is an open-source API development platform supporting REST, GraphQL, and WebSocket APIs. The HelmForge chart deploys the Community Edition All-in-One image (`2026.5.0`) with subpath-based routing, automatic Prisma migrations, optional OAuth providers, SMTP, ExternalSecrets Operator support, and a bundled HelmForge PostgreSQL subchart.

## Key Features

Expand Down Expand Up @@ -388,28 +388,30 @@ helm test hoppscotch -n hoppscotch

## Parameters

| Parameter | Description | Default |
| -------------------------------- | ---------------------------------------------- | ---------- |
| `mode` | Chart mode: `dev` or `production` | `dev` |
| `namespaceOverride` | Override namespace for chart-managed resources | `""` |
| `image.tag` | Hoppscotch image tag | `2026.4.1` |
| `replicaCount` | Number of replicas | `1` |
| `ingress.enabled` | Enable Ingress | `false` |
| `ingress.host` | Hostname (auto-derives all VITE\_\* URLs) | `""` |
| `postgresql.enabled` | Enable PostgreSQL subchart | `true` |
| `database.external.enabled` | Use external PostgreSQL | `false` |
| `encryption.key` | 32-char encryption key (auto-generated) | `""` |
| `encryption.existingSecret` | Existing secret with encryption key | `""` |
| `auth.providers` | Comma-separated enabled auth providers | `EMAIL` |
| `auth.github.enabled` | Enable GitHub OAuth | `false` |
| `auth.google.enabled` | Enable Google OAuth | `false` |
| `auth.microsoft.enabled` | Enable Microsoft OAuth | `false` |
| `mailer.enabled` | Enable SMTP | `false` |
| `gatewayAPI.enabled` | Enable HTTPRoute | `false` |
| `externalSecrets.enabled` | Enable ExternalSecret | `false` |
| `networkPolicy.enabled` | Enable NetworkPolicy | `false` |
| `podDisruptionBudget.enabled` | Enable PDB | `false` |
| `metrics.serviceMonitor.enabled` | Enable ServiceMonitor | `false` |
| Parameter | Description | Default |
| -------------------------------- | -------------------------------------------------------- | ---------- |
| `mode` | Chart mode: `dev` or `production` | `dev` |
| `namespaceOverride` | Override namespace for chart-managed resources | `""` |
| `image.tag` | Hoppscotch image tag | `2026.5.0` |
| `replicaCount` | Number of replicas | `1` |
| `ingress.enabled` | Enable Ingress | `false` |
| `ingress.host` | Hostname (auto-derives all VITE\_\* URLs) | `""` |
| `postgresql.enabled` | Enable PostgreSQL subchart | `true` |
| `database.external.enabled` | Use external PostgreSQL | `false` |
| `encryption.key` | 32-char encryption key (auto-generated) | `""` |
| `encryption.existingSecret` | Existing secret with encryption key | `""` |
| `auth.providers` | Comma-separated enabled auth providers | `EMAIL` |
| `auth.github.enabled` | Enable GitHub OAuth | `false` |
| `auth.google.enabled` | Enable Google OAuth | `false` |
| `auth.microsoft.enabled` | Enable Microsoft OAuth | `false` |
| `mailer.enabled` | Enable SMTP | `false` |
| `gatewayAPI.enabled` | Enable HTTPRoute | `false` |
| `externalSecrets.enabled` | Enable ExternalSecret | `false` |
| `networkPolicy.enabled` | Enable NetworkPolicy | `false` |
| `networkPolicy.extraEgress` | Additional egress rules after DNS and database | `[]` |
| `podDisruptionBudget.enabled` | Enable PDB | `false` |
| `extraManifests` | Additional Kubernetes manifests rendered with Helm `tpl` | `[]` |
| `metrics.serviceMonitor.enabled` | Enable ServiceMonitor | `false` |

## Links

Expand Down
1 change: 1 addition & 0 deletions src/pages/playground.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ const siteSyncPlaygroundConfigs: Record<string, string> = {
'adguard-home': 'src/data/playground-configs.ts',
booklore: 'src/data/playground-configs.ts',
changedetection: 'src/data/playground-configs.ts',
hoppscotch: 'src/data/playground-configs.ts',
medikeep: 'src/data/playground-configs.ts',
memcached: 'src/data/playground-configs.ts',
notediscovery: 'src/data/playground-configs.ts',
Expand Down