Skip to content

Commit b749aa3

Browse files
committed
docker compose documentation
dashjoin/dashjoin-aas#703
1 parent b35d64a commit b749aa3

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ For anyone who is planning a development project, faces a tight schedule, needs
9191
## Getting Started
9292

9393
* Docker: ```docker run -p 8080:8080 -e DJ_ADMIN_PASS=djdjdj dashjoin/platform```
94+
* [Docker Compose](https://github.com/dashjoin/docker-compose) including out of the box AI features
9495
* [Download](https://download.dashjoin.com/)
9596
* [Playground](https://playground.dashjoin.com/)
9697
* [Book your fully managed PaaS tenant (Platform plus PostgreSQL)](https://dashjoin.com/#getstarted)

dashjoin-docs/docs/installation.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,63 @@ If you would like to make the registered databases and credentials persistent, y
147147
docker run -p 8080:8080 -v PERSISTENT_FOLDER:/deployments/model dashjoin/platform
148148
```
149149

150+
## Docker Compose
151+
152+
If you plan to use AI features, we recommend running the following containers orchestrated by Docker compose:
153+
154+
* Platform: the main Dashjoin Platform
155+
* AIA: the AI Assistant
156+
* MCP-Proxy: Allows installing MCP tools to be used by AI Assistant
157+
* Postgres: the pgvector database for both platform and AIA
158+
159+
First, clone the GitHub repository to get access to the environment:
160+
161+
```
162+
git clone https://github.com/dashjoin/docker-compose
163+
cd docker-compose
164+
```
165+
166+
### Configuring your Settings
167+
168+
If you are running ollama (http://host.docker.internal:11434) locally, you are good to go.
169+
If you want to use an external AI service, please enter your API key in the .env file.
170+
171+
The files [mcp-proxy-config.json](https://github.com/dashjoin/docker-compose/blob/main/config-docker/mcp-proxy-config.json) and [settings.yml](https://github.com/dashjoin/docker-compose/blob/main/config-docker/settings.yml) contain the default setup for your AI models and MCP servers. Usually, there is no need to make changes here.
172+
173+
### Starting
174+
175+
To start, stop, and delete the setup, run these commands:
176+
177+
```
178+
# start containers
179+
docker compose up
180+
181+
# stop containers
182+
docker compose stop
183+
184+
# delete containers
185+
docker compose down
186+
```
187+
188+
### Volumes
189+
190+
In your working directory, you will find a folder called "volumes". It contains the persistent volumes for the dashjoin, aia, and postgres containers.
191+
Note that the data is retained even after "docker compose down" is run.
192+
193+
### Docker MCP
194+
195+
You can run MCP servers installed in the MCP toolkit in docker desktop. To expose them to clients, run this command:
196+
197+
```
198+
source .env
199+
export MCP_GATEWAY_AUTH_TOKEN=${MCP_GATEWAY_AUTH_TOKEN}
200+
docker mcp gateway run --transport=http
201+
```
202+
203+
## Kubernetes
204+
205+
Please contact us if you are running a Kubernetes cluster and deploy workloads via helm charts.
206+
150207
## Run local Dashjoin installation as service
151208

152209
If you have installed Dashjoin locally and want to run the application as a service,

0 commit comments

Comments
 (0)