From b12f9a38bdf0eb4bfc724affbe505f0f48123d18 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 5 Feb 2026 16:39:49 +0000 Subject: [PATCH 1/3] Initial plan From 3877addc7368b42547a6886842e5f6e38adf9fa8 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 5 Feb 2026 16:42:18 +0000 Subject: [PATCH 2/3] Update install docs for docker compose Co-authored-by: jpmccu <602385+jpmccu@users.noreply.github.com> --- docs/install.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/install.md b/docs/install.md index 1b665fe0c..eb3490a67 100644 --- a/docs/install.md +++ b/docs/install.md @@ -51,6 +51,27 @@ Note that `$PWD` binds the current directory as the working dir in the container Whyis commands can be run from inside the container using `docker exec`. +## Using docker-compose in a KGApp + +When you initialize a Whyis KGApp (the cookiecutter project slug directory), it includes two compose files for containerized deployments: + +* `docker-compose.yml` for production-style runs (Gunicorn + Redis, Celery, and Fuseki). +* `docker-compose-dev.yml` for build/development runs (builds from `Dockerfile.dev`); in the template this file is named `docker-compose-dev.yaml`. + +For a production-style run, start the stack from your KGApp directory: + +``` +docker compose up -d +``` + +For a build/development run, build and start the dev container (use the `.yaml` filename if you have not renamed it): + +``` +docker compose -f docker-compose-dev.yml up --build +``` + +This will expose the application on http://localhost:5000. Use `docker compose down` to stop the stack. + ## Deploying a kgapp to a Server If you need to deploy your knowledge graph to a server, copy your kgapp dir to the server, and run the following scripts from within the kgapp dir: From 51174228498680d774b49d223b91f7cfdf03b928 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 5 Feb 2026 16:43:08 +0000 Subject: [PATCH 3/3] Clarify docker compose dev filename Co-authored-by: jpmccu <602385+jpmccu@users.noreply.github.com> --- docs/install.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/install.md b/docs/install.md index eb3490a67..559bebfde 100644 --- a/docs/install.md +++ b/docs/install.md @@ -56,7 +56,7 @@ Whyis commands can be run from inside the container using `docker exec`. When you initialize a Whyis KGApp (the cookiecutter project slug directory), it includes two compose files for containerized deployments: * `docker-compose.yml` for production-style runs (Gunicorn + Redis, Celery, and Fuseki). -* `docker-compose-dev.yml` for build/development runs (builds from `Dockerfile.dev`); in the template this file is named `docker-compose-dev.yaml`. +* `docker-compose-dev.yaml` for build/development runs (builds from `Dockerfile.dev`); some projects rename this to `docker-compose-dev.yml`. For a production-style run, start the stack from your KGApp directory: @@ -64,12 +64,14 @@ For a production-style run, start the stack from your KGApp directory: docker compose up -d ``` -For a build/development run, build and start the dev container (use the `.yaml` filename if you have not renamed it): +For a build/development run, build and start the dev container: ``` -docker compose -f docker-compose-dev.yml up --build +docker compose -f docker-compose-dev.yaml up --build ``` +If your project uses `docker-compose-dev.yml`, substitute that filename in the command above. + This will expose the application on http://localhost:5000. Use `docker compose down` to stop the stack. ## Deploying a kgapp to a Server