# Deployment And Troubleshooting

Use Wrangler for repeatable deployment of the worker, service modules, and bindings configuration. This guide covers the `wrangler.toml` fields relevant to the gateway, the `wrangler deploy` command, and post-deploy verification steps. Start here if you are deploying the gateway for the first time.

**Last reviewed:** 2026-03-06

## When to use this

Use the deployment and troubleshooting guides when you are deploying the gateway to Cloudflare, setting up CI/CD, running tests, or diagnosing production issues. These guides cover the operational side of the gateway lifecycle from local development to production debugging.

## Key concepts

* The gateway deploys as a standard Cloudflare Worker using `wrangler deploy`. The `wrangler.toml` file defines the worker name, entrypoint, compatibility settings, and binding declarations.
* GitHub Actions can automate deployments, running config validation, tests, and docs checks before publishing the worker. The workflow uses the same `wrangler deploy` command.
* The gateway repo includes Vitest unit tests and optional E2E tests using `unstable_dev`. Run unit tests with `npm test` and E2E tests with the `RUN_LOCAL_WORKER_E2E=true` flag.
* When debugging upstream failures, isolate whether the issue is in routing (wrong path matched), auth (token rejected), or the upstream itself (backend error). Check `wrangler tail` logs for the gateway's perspective.

## Repo-grounded example

```toml
name = "serverless-api-gateway"
main = "src/index.js"
compatibility_date = "2025-01-01"
compatibility_flags = ["nodejs_compat"]
find_additional_modules = true
rules = [{ type = "ESModule", globs = ["services/*.js"] }]
```

This snippet shows a `wrangler.toml` with the worker name, entrypoint, compatibility date, and module rules. The `compatibility_flags` array includes `nodejs_compat` for Node.js API support, and `rules` tells Wrangler to bundle JavaScript files from the `services/` directory as ES modules.

## Troubleshooting

* If `wrangler deploy` fails with "missing binding", check your `wrangler.toml` for typos in binding names and verify that all referenced KV namespaces, service bindings, and secrets exist in your Cloudflare account.
* If GitHub Actions deploys succeed but the worker returns 500, check whether environment variables and secrets are set in the Cloudflare dashboard -- they are not deployed by Wrangler and must be configured separately.
* If E2E tests fail with "unstable\_dev not found", make sure you are running a Wrangler version that supports `unstable_dev` and that `RUN_LOCAL_WORKER_E2E=true` is set in your environment.
* If routes work locally but not in production, compare the config source: local dev uses the file system, while production may use KV or `SAG_API_CONFIG_JSON`. Confirm the production config matches your local config.

## Related docs

* [wrangler](/deployment/wrangler.md)
* [github actions](/deployment/github-actions.md)
* [gateway troubleshooting matrix](/troubleshooting/wrangler-deploy-guide/gateway-troubleshooting-matrix.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.serverlessapigateway.com/troubleshooting/wrangler-deploy-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.