Skip to content

Document docker-compose usage for KGApp deployments #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpmccu merged 3 commits into from
Feb 5, 2026
+23 −0
Merged

Document docker-compose usage for KGApp deployments #351

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b12f9a3
Initial plan
Copilot Feb 5, 2026
3877add
Update install docs for docker compose
Copilot Feb 5, 2026
5117422
Clarify docker compose dev filename
Copilot Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down