[self-hosted] docs for custom router (#34859)

add documentation for how to run the docker setup on a server. There are all sorts of ways you can do this, but some tips are general, like explaining which URLs to configure via env vars.

Also I noticed that BASE_URL is somewhat confusing. it might make sense to configure the PORT, because you want to avoid port conflicts on your host machine. However, if you're overriding the BASE_URL, then you're probably hosting the site somewhere non-local, which means the port should also change and you should set all of the env var together. So remove BASE_URL

GitOrigin-RevId: 43ddab886919aef289a2171e0f1e160de5445b13

Author: ldanilek

self-hosted/README.md

@@ -170,6 +170,70 @@ You can run the Convex backend on a hosting provider of your choice. We include
 [Fly.io](https://fly.io/). See our dedicated [Fly instructions](./fly/README.md)
 to get started.
 
+## Backend hosting on your own infrastructure
+
+It's possible to run Convex on your own servers, with your own routing.
+
+Download the
+[`docker-compose.yml` file](https://github.com/get-convex/convex-backend/tree/main/self-hosted/docker/docker-compose.yml)
+onto the server you want to run Convex on.
+
+```sh
+curl -O https://raw.githubusercontent.com/get-convex/convex-backend/main/self-hosted/docker/docker-compose.yml
+```
+
+Your Convex backend will be running on this server at port 3210, with HTTP
+actions exposed at port 3211, and the dashboard running on port 6791.
+
+Set up routing to forward requests from your domain to these ports. For example:
+
+- `https://api.my-domain.com` forwards to `http://localhost:3210`
+- `https://my-domain.com` forwards to `http://localhost:3211`
+- `https://dashboard.my-domain.com` forwards to `http://localhost:6791`
+
+In a `.env` file beside the `docker-compose.yml` file, set the following
+environment variables:
+
+```sh
+# URL of the Convex API as accessed by the client/frontend.
+CONVEX_CLOUD_ORIGIN='https://api.my-domain.com'
+# URL of Convex HTTP actions as accessed by the client/frontend.
+CONVEX_SITE_ORIGIN='https://my-domain.com'
+# URL of the Convex API as accessed by the dashboard (browser).
+NEXT_PUBLIC_DEPLOYMENT_URL='https://api.my-domain.com'
+```
+
+On the server, start the backend with:
+
+```sh
+docker compose up
+```
+
+Get an admin key with:
+
+```sh
+docker compose exec backend ./generate_admin_key.sh
+```
+
+Go to the dashboard at `https://dashboard.my-domain.com` and use the admin key
+to authenticate.
+
+In your Convex project (on your local machine, probably not on the hosting
+server), add the url and admin key to a `.env.local` file (which should not be
+committed to source control):
+
+```sh
+CONVEX_SELF_HOSTED_URL='https://api.my-domain.com'
+CONVEX_SELF_HOSTED_ADMIN_KEY='<your admin key>'
+```
+
+Now you can run commands in your Convex project, to push code, run queries,
+import data, etc.
+
+```sh
+npx convex dev
+```
+
 ## Running the database on Postgres or MySQL
 
 The Convex backend is designed to work well with SQLite, Postgres, or MySQL. If

self-hosted/docker/docker-compose.yml

@@ -11,8 +11,8 @@ services:
       - INSTANCE_SECRET=${INSTANCE_SECRET:-}
       - CONVEX_RELEASE_VERSION_DEV=${CONVEX_RELEASE_VERSION_DEV:-}
       - ACTIONS_USER_TIMEOUT_SECS=${ACTIONS_USER_TIMEOUT_SECS:-}
-      - CONVEX_CLOUD_ORIGIN=${URL_BASE:-http://127.0.0.1}:${PORT:-3210}
-      - CONVEX_SITE_ORIGIN=${URL_BASE:-http://127.0.0.1}:${SITE_PROXY_PORT:-3211}
+      - CONVEX_CLOUD_ORIGIN=http://127.0.0.1:${PORT:-3210}
+      - CONVEX_SITE_ORIGIN=http://127.0.0.1:${SITE_PROXY_PORT:-3211}
       - DATABASE_URL=${DATABASE_URL:-}
       - DISABLE_BEACON=${DISABLE_BEACON:-}
       - REDACT_LOGS_TO_CLIENT=${REDACT_LOGS_TO_CLIENT:-}