diff --git a/docs/install.md b/docs/install.md index 1b665fe0..559bebfd 100644 --- a/docs/install.md +++ b/docs/install.md @@ -51,6 +51,29 @@ 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.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: + +``` +docker compose up -d +``` + +For a build/development run, build and start the dev container: + +``` +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 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: