> ## Documentation Index
> Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nginx

> Deploy Nginx on Control Plane using the Template Catalog. Covers configuration, scaling, and reverse proxy setup with path-based routing rules for GVC workloads.

## Overview

Nginx is a high-performance web server and reverse proxy. This template deploys Nginx as a reverse proxy that routes incoming traffic to workloads in your GVC based on configurable path-based location rules.

### What Gets Created

* **Workload** — A serverless Nginx reverse proxy with configurable routing rules and autoscaling.
* **Secret** — An opaque secret containing the rendered Nginx configuration file, mounted into the container at startup.
* **Identity & Policy** — An identity bound to the workload with `reveal` access to the configuration secret.
* **Example Backend Workload** (optional) — A sample backend workload used to verify the proxy is working. Enabled when `enableExample: true`. Disable this before using in production.

<Note>
  This template does not create a GVC. You must deploy it into an existing GVC.
</Note>

## Installation

This template has no external prerequisites. To install, follow the instructions for your preferred method:

<CardGroup cols={2}>
  <Card title="UI" href="/template-catalog/install-manage/ui" icon="laptop">
    Browse, install, and manage templates visually
  </Card>

  <Card title="CLI" href="/template-catalog/install-manage/cli" icon="terminal">
    Manage templates from your terminal
  </Card>

  <Card title="Terraform" href="/template-catalog/install-manage/terraform" icon={<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><g fill-rule="evenodd"><path d="M77.941 44.5v36.836L46.324 62.918V26.082zm0 0" fill="#5c4ee5"/><path d="M81.41 81.336l31.633-18.418V26.082L81.41 44.5zm0 0" fill="#4040b2"/><path d="M11.242 42.36L42.86 60.776V23.941L11.242 5.523zm0 0M77.941 85.375L46.324 66.957v36.82l31.617 18.418zm0 0" fill="#5c4ee5"/></g></svg>}>
    Declare templates in your Terraform configurations
  </Card>

  <Card
    title="Pulumi"
    href="/template-catalog/install-manage/pulumi"
    icon={<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" id="Pulumi-Icon--Streamline-Svg-Logos" height="24" width="24">
    <desc>
        Pulumi Icon Streamline Icon: https://streamlinehq.com
    </desc>
    <path fill="#f26e7e" d="M4.683025 13.3318c0.869125 -0.5018 0.870575 -2.1264 0.003225 -3.62865s-2.27504 -2.313275 -3.1441725 -1.811475C0.672945 8.3935 0.6715 10.0181 1.53885 11.52035c0.86735 1.502275 2.27505 2.313275 3.144175 1.81145Zm0.0052 3.2167c0.86735 1.502275 0.865925 3.126875 -0.003225 3.628675 -0.86915 0.5018 -2.2768275 -0.309225 -3.144175 -1.81145 -0.8673525 -1.50225 -0.8659075 -3.126875 0.003225 -3.628675 0.8691325 -0.5018 2.276825 0.309225 3.144175 1.81145Zm5.922875 3.4243c0.86735 1.50225 0.8659 3.126775 -0.003225 3.62875 -0.869125 0.501775 -2.27685 -0.309325 -3.1442 -1.81155 -0.867325 -1.50225 -0.865875 -3.12685 0.00325 -3.628675 0.869125 -0.5018 2.276825 0.309225 3.144175 1.811475Zm-0.001925 -6.845275c0.86735 1.50225 0.8659 3.12685 -0.003225 3.628675 -0.869125 0.5018 -2.276825 -0.309225 -3.144175 -1.811475 -0.86735 -1.50225 -0.8659 -3.12685 0.003225 -3.62865 0.869125 -0.501825 2.276825 0.3092 3.144175 1.81145Z" stroke-width="0.25"></path>
    <path fill="#8a3391" d="M22.45775 11.524125c0.86725 -1.502225 0.865925 -3.12685 -0.003225 -3.62865 -0.869125 -0.501825 -2.276825 0.3092 -3.144175 1.811475 -0.86735 1.50225 -0.8659 3.126825 0.003225 3.62865 0.869125 0.501825 2.276825 -0.3092 3.144175 -1.811475Zm0.000175 3.2151c0.869075 0.5018 0.870625 2.1264 0.003225 3.62865 -0.86735 1.50225 -2.27505 2.313275 -3.144175 1.81145 -0.869125 -0.5018 -0.870575 -2.126425 -0.003225 -3.62865 0.86735 -1.50225 2.27505 -2.313275 3.144175 -1.81145ZM16.536225 18.157875c0.86915 0.501825 0.8706 2.126425 0.00325 3.628675 -0.86735 1.502125 -2.275075 2.313225 -3.1442 1.81145 -0.869125 -0.50175 -0.870575 -2.126425 -0.003225 -3.62865 0.867375 -1.502275 2.27505 -2.3133 3.144175 -1.811475Zm-0.003325 -6.843775c0.869125 0.5018 0.870575 2.126425 0.003225 3.628675s-2.27505 2.313275 -3.1442 1.811475c-0.869125 -0.501825 -0.870575 -2.126425 -0.003225 -3.628675 0.86735 -1.502275 2.27505 -2.313275 3.1442 -1.811475Z" stroke-width="0.25"></path>
    <path fill="#f7bf2a" d="M15.138225 2.06721c0 1.003615 -1.40625 1.817215 -3.14095 1.817215 -1.7347 0 -3.14095 -0.8136 -3.14095 -1.817215C8.856325 1.06359 10.262575 0.25 11.997275 0.25c1.7347 0 3.14095 0.81359 3.14095 1.81721ZM9.2166 5.482375c0 1.003625 -1.40625 1.8172 -3.14095 1.8172 -1.7347 0 -3.14095 -0.813575 -3.14095 -1.8172s1.40625 -1.817225 3.14095 -1.817225c1.7347 0 3.14095 0.8136 3.14095 1.817225Zm8.71005 1.8172c1.7347 0 3.14095 -0.813575 3.14095 -1.8172s-1.40625 -1.817225 -3.14095 -1.817225c-1.7347 0 -3.14095 0.8136 -3.14095 1.817225s1.40625 1.8172 3.14095 1.8172Zm-2.788425 1.605625c0 1.003625 -1.40625 1.8172 -3.14095 1.8172 -1.7347 0 -3.14095 -0.813575 -3.14095 -1.8172 0 -1.0036 1.40625 -1.8172 3.14095 -1.8172 1.7347 0 3.14095 0.8136 3.14095 1.8172Z" stroke-width="0.25"></path>
    </svg>}
  >
    Declare templates in your Pulumi programs
  </Card>
</CardGroup>

## Configuration

The default `values.yaml` for this template:

```yaml theme={null}
proxyWorkload:
  image: nginx:latest
  port: 80
  capacityAI: false
  timeoutSeconds: 5

resources:
  cpu: 100m
  memory: 128Mi

autoscaling:
  minScale: 1
  maxScale: 1
  maxConcurrency: 1000

enableExample: true # set to false when routing to your own workloads

locations: [] # add your own proxy targets here
  # - path: /
  #   workload: my-workload
  #   port: 8080
  #   regexModifier: ""
```

### Proxy Workload

* `proxyWorkload.image` — Nginx container image.
* `proxyWorkload.port` — Port Nginx listens on (default: `80`).
* `proxyWorkload.capacityAI` — Enable CapacityAI autoscaling on the proxy workload.
* `proxyWorkload.timeoutSeconds` — Proxy connection timeout in seconds.

### Resources

* `resources.cpu` / `resources.memory` — CPU and memory allocated to each Nginx replica.

### Autoscaling

* `autoscaling.minScale` / `autoscaling.maxScale` — Minimum and maximum replica count.
* `autoscaling.maxConcurrency` — Maximum number of concurrent connections per replica.

### Routing

* `locations` — Array of path-based routing rules. Each entry forwards matching requests to an internal workload:

| Field           | Description                                       |
| --------------- | ------------------------------------------------- |
| `path`          | URL path prefix to match (e.g. `/`, `/api`)       |
| `workload`      | Name of the target workload in the same GVC       |
| `port`          | Port on the target workload to forward traffic to |
| `regexModifier` | Optional regex modifier for path matching         |

Example:

```yaml theme={null}
locations:
  - path: /
    workload: my-app
    port: 8080
  - path: /api
    workload: my-api
    port: 3000
```

### Built-in Endpoints

The following endpoints are always active regardless of your `locations` configuration:

| Endpoint  | Behavior                                                                             |
| --------- | ------------------------------------------------------------------------------------ |
| `/health` | Returns `ok` — used for liveness and readiness probes                                |
| `/fail`   | Returns `500` — any 5XX errors from upstream workloads are returned as this response |

### Example Backend

* `enableExample` — When `true`, deploys a sample helloworld backend workload and routes all traffic to it. Set to `false` when configuring your own `locations`.

### Accessing the Proxy

Once deployed, the Nginx proxy is available at:

```text theme={null}
https://RELEASE_NAME-GVC_NAME.cpln.app
```

## External References

<CardGroup cols={2}>
  <Card title="Nginx Documentation" icon="book" href="https://nginx.org/en/docs/">
    Official Nginx documentation
  </Card>

  <Card title="Nginx Template" icon="github" href="https://github.com/controlplane-com/templates/tree/main/nginx">
    View the source files, default values, and chart definition
  </Card>
</CardGroup>