From 8ab792902a3b8626dfd04fdc4fc8d892fe5a6528 Mon Sep 17 00:00:00 2001 From: Roy Anger Date: Wed, 18 Dec 2024 01:44:25 -0500 Subject: [PATCH] refactor: Renamed doc based on review feedback --- ...y-to-a-web-server.mdx => deploying-behind-a-proxy.mdx} | 8 +++++--- docs/manifest.json | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) rename docs/deployments/{deploy-to-a-web-server.mdx => deploying-behind-a-proxy.mdx} (73%) diff --git a/docs/deployments/deploy-to-a-web-server.mdx b/docs/deployments/deploying-behind-a-proxy.mdx similarity index 73% rename from docs/deployments/deploy-to-a-web-server.mdx rename to docs/deployments/deploying-behind-a-proxy.mdx index 974674148d..cb9859e06d 100644 --- a/docs/deployments/deploy-to-a-web-server.mdx +++ b/docs/deployments/deploying-behind-a-proxy.mdx @@ -1,9 +1,9 @@ --- -title: Deploying a Clerk app to a web server or with Docker -description: Learn how to deploy a Clerk app to a web server using servers like nginx or Caddy, or using Docker +title: Deploying a Clerk app behind a proxy +description: Learn how to deploy a Clerk app to a web server using proxies and reverse proxies like nginx or Caddy, or using Docker --- -When deploying a Clerk app to a web server or container, you may need to proxy two headers for Clerk to work correctly. The two headers that you must forward are: +When deploying a Clerk app beind a proxy, you may need to proxy two headers for Clerk to work correctly. The two headers that you must forward are: - `X-Forwarded-Host` - `X-Forwarded-Proto` @@ -36,6 +36,8 @@ export default clerkMiddleware( ## Non-exhaustive list +The following is a non-exhaustive list that includes some of the hosts and servers that will require this proxying of headers. + - [nginx](https://nginx.org/en/) - [Caddy](https://caddyserver.com/) - [Docker](https://www.docker.com/) diff --git a/docs/manifest.json b/docs/manifest.json index 402704f520..504b8ae2bc 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1411,8 +1411,8 @@ "href": "/docs/deployments/deploy-to-vercel" }, { - "title": "Deploy to a web server or container", - "href": "/docs/deployments/deploy-to-a-web-server" + "title": "Deploying behind a proxy", + "href": "/docs/deployments/deploying-behind-a-proxy" }, { "title": "Set up a staging environment",