Add README.md for Docker configuration guide for multi-service setup
Browse files- docker/README.md +80 -0
docker/README.md
ADDED
@@ -0,0 +1,80 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Docker Configuration Guide
|
2 |
+
|
3 |
+
The application can be run with different configurations using Docker Compose:
|
4 |
+
|
5 |
+
- `docker-compose.yml`: Core application
|
6 |
+
- `docker/ollama/compose.yml`: Ollama service for local LLM inference
|
7 |
+
- `docker/argilla/compose.yml`: Argilla service for data curation
|
8 |
+
|
9 |
+
## Ollama Integration
|
10 |
+
|
11 |
+
The `MODEL` variable in your `.env` file determines which model Ollama will download and use. For example:
|
12 |
+
```env
|
13 |
+
MODEL=llama3.2:1b
|
14 |
+
```
|
15 |
+
|
16 |
+
- Ollama will automatically download and set up the specified model
|
17 |
+
- No manual commands or downloads are needed
|
18 |
+
|
19 |
+
|
20 |
+
## Setup Options
|
21 |
+
|
22 |
+
### Full Setup (App + Ollama + Argilla)
|
23 |
+
```bash
|
24 |
+
# Keep all sections uncommented in .env
|
25 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml -f docker/argilla/compose.yml build
|
26 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml -f docker/argilla/compose.yml up -d
|
27 |
+
```
|
28 |
+
|
29 |
+
### App + Ollama
|
30 |
+
```bash
|
31 |
+
# Comment out ARGILLA section in .env
|
32 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml build
|
33 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml up -d
|
34 |
+
```
|
35 |
+
|
36 |
+
### App + Argilla
|
37 |
+
```bash
|
38 |
+
# Comment out OLLAMA section in .env
|
39 |
+
docker compose -f docker-compose.yml -f docker/argilla/compose.yml build
|
40 |
+
docker compose -f docker-compose.yml -f docker/argilla/compose.yml up -d
|
41 |
+
```
|
42 |
+
|
43 |
+
### App Only
|
44 |
+
```bash
|
45 |
+
# Comment out both OLLAMA and ARGILLA sections in .env
|
46 |
+
docker compose -f docker-compose.yml build
|
47 |
+
docker compose -f docker-compose.yml up -d
|
48 |
+
```
|
49 |
+
|
50 |
+
## Managing Services
|
51 |
+
|
52 |
+
Services are built separately but are linked together. If you already have some services built and want to add another:
|
53 |
+
|
54 |
+
1. You don't need to rebuild existing services
|
55 |
+
2. Just build the new service
|
56 |
+
3. Stop everything with `down` and start again with `up`
|
57 |
+
|
58 |
+
For example, if you have App + Ollama and want to add Argilla:
|
59 |
+
```bash
|
60 |
+
docker compose -f docker/argilla/compose.yml build # only build Argilla
|
61 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml -f docker/argilla/compose.yml down
|
62 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml -f docker/argilla/compose.yml up -d
|
63 |
+
```
|
64 |
+
|
65 |
+
Similarly, if you have built all services but want to run only some of them:
|
66 |
+
> **Important**: When running specific services, remember to comment out unused services in `.env` first
|
67 |
+
|
68 |
+
```bash
|
69 |
+
# No need to build again, just start the services you need
|
70 |
+
docker compose -f docker-compose.yml -f docker/ollama/compose.yml up -d # start only App + Ollama
|
71 |
+
```
|
72 |
+
|
73 |
+
## Service URLs
|
74 |
+
|
75 |
+
Once running, access the services at:
|
76 |
+
- App: http://localhost:7860
|
77 |
+
- Argilla: http://localhost:6900 (if enabled)
|
78 |
+
- Ollama: http://localhost:11434 (if enabled)
|
79 |
+
|
80 |
+
> Note: Services will be available after a few seconds while they initialize. Ollama models and Argilla datasets are persisted and available after restarts
|