Move docker instructions to docker directory (#34158)

GitOrigin-RevId: 45a05440903ecbb75eba8d243824a41158970275

Author: emmaling27

.github/workflows/release_local_backend.yml

@@ -45,7 +45,7 @@ jobs:
           DOCKER_BUILD_RECORD_UPLOAD: false
         with:
           context: .
-          file: self-hosted/Dockerfile.backend
+          file: self-hosted/docker-build/Dockerfile.backend
           tags: |
             ghcr.io/get-convex/self-hosted-backend
           cache-from: |

.github/workflows/release_local_dashboard.yml

@@ -42,7 +42,7 @@ jobs:
           DOCKER_BUILD_RECORD_UPLOAD: false
         with:
           context: .
-          file: self-hosted/Dockerfile.dashboard
+          file: self-hosted/docker-build/Dockerfile.dashboard
           tags: |
             ghcr.io/get-convex/self-hosted-dashboard
           cache-from: |

npm-packages/js-integration-tests/Justfile

@@ -46,7 +46,7 @@ test-self-hosted *ARGS:
     just rush build -t .
     cargo build -p backend_harness --bin backend-harness
     just _test self-hosted-backend "$@"
-    docker compose -f ../../self-hosted/docker-compose.yml down
+    docker compose -f ../../self-hosted/docker/docker-compose.yml down
 
 # Run tests without building the NPM packages or binaries
 _test *ARGS:

self-hosted/README.md

@@ -24,62 +24,7 @@ repository synced with any internal development work within a handful of days.
 
 # Self Hosting Via Docker
 
-You'll need to have [Docker](https://docs.docker.com/desktop/) installed to run
-convex in Docker.
-
-```sh
-cd self-hosted
-# Pull the latest docker images
-docker compose pull
-# Run the containers
-docker compose up
-```
-
-Note: if you see permissions issues, try `docker logout ghcr.io`.
-
-Once your Convex backend is running in Docker, you can ask it to generate admin
-keys for use from the dashboard/CLI.
-
-```sh
-docker exec convex-local-backend ./generate_admin_key.sh
-```
-
-Using your admin key, push code to your backend. Admin key should be kept secure
-to just the developers who are administering the application on your backend.
-
-Visit the dashboard at `http://localhost:6791`. The backend listens on
-`http://127.0.0.1:3210`. The backend's http actions are available at
-`http://127.0.0.1:3211`.
-
-In your Convex project, add your url and admin key to a `.env.local` file (which
-should not be committed to source control):
-
-```sh
-CONVEX_SELF_HOST_URL='http://127.0.0.1:3210'
-CONVEX_SELF_HOST_ADMIN_KEY='<your deploy key>'
-```
-
-Now you can run commands in your Convex project, to push code, run queries,
-import data, etc. To use these commands, you'll need the latest alpha version of
-Convex.
-
-```sh
-npm install convex@alpha
-```
-
-```sh
-npx convex self-host dev
-npx convex self-host run <run args>
-npx convex self-host import <import args>
-npx convex self-host --help  # see all available commands
-```
-
-By default, the backend will store its data in a volume managed by Docker. Note
-that you'll need to set up persistent storage on whatever cloud hosting platform
-you choose to run the Docker container on (e.g. AWS EBS). The default database
-is SQLite, but for production workloads, we recommend running Convex backed by
-Postgres. Follow [these instructions](#self-hosting-on-postgres-with-neon) to
-connect to Postgres.
+See the [Docker instructions](./docker/README.md)
 
 # Self Hosting with [Fly.io](https://fly.io/)
 

self-hosted/Dockerfile.backend renamed to self-hosted/docker-build/Dockerfile.backend

@@ -0,0 +1,6 @@
+# Building docker images
+
+The contents of this directory are used to build the docker images for the
+self-hosted backend and dashboard. If you're looking for ways to run self-hosted
+Convex, see the [these instructions](../README.md). You may build the images
+locally from here, but we recommend using the images we provide on GHCR.

self-hosted/Dockerfile.dashboard renamed to self-hosted/docker-build/Dockerfile.dashboard

@@ -0,0 +1,59 @@
+# Self Hosting Via Docker
+
+You'll need to have [Docker](https://docs.docker.com/desktop/) installed to run
+convex in Docker.
+
+```sh
+cd self-hosted
+# Pull the latest docker images
+docker compose pull
+# Run the containers
+docker compose up
+```
+
+Note: if you see permissions issues, try `docker logout ghcr.io`.
+
+Once your Convex backend is running in Docker, you can ask it to generate admin
+keys for use from the dashboard/CLI.
+
+```sh
+docker exec convex-local-backend ./generate_admin_key.sh
+```
+
+Using your admin key, push code to your backend. Admin key should be kept secure
+to just the developers who are administering the application on your backend.
+
+Visit the dashboard at `http://localhost:6791`. The backend listens on
+`http://127.0.0.1:3210`. The backend's http actions are available at
+`http://127.0.0.1:3211`.
+
+In your Convex project, add your url and admin key to a `.env.local` file (which
+should not be committed to source control):
+
+```sh
+CONVEX_SELF_HOST_URL='http://127.0.0.1:3210'
+CONVEX_SELF_HOST_ADMIN_KEY='<your deploy key>'
+```
+
+Now you can run commands in your Convex project, to push code, run queries,
+import data, etc. To use these commands, you'll need the latest alpha version of
+Convex.
+
+```sh
+npm install convex@alpha
+```
+
+```sh
+npx convex self-host dev
+npx convex self-host run <run args>
+npx convex self-host import <import args>
+npx convex self-host --help  # see all available commands
+```
+
+By default, the backend will store its data in a volume managed by Docker. Note
+that you'll need to set up persistent storage on whatever cloud hosting platform
+you choose to run the Docker container on (e.g. AWS EBS). The default database
+is SQLite, but for production workloads, we recommend running Convex backed by
+Postgres. Follow
+[these instructions](../README.md#self-hosting-on-postgres-with-neon) to connect
+to Postgres.

self-hosted/docker-build/README.md

@@ -23,9 +23,6 @@ services:
       start_period: 5s
 
   dashboard:
-    build:
-      context: .
-      dockerfile: Dockerfile.dashboard
     image: ghcr.io/get-convex/self-hosted-dashboard:latest
     ports:
       - "${DASHBOARD_PORT:-6791}:6791"