Skip to content

Commit 2ba9762

Browse files
authored
Cleaned up chatbot-ui READMEs (mudler#1075)
This PR cleans up the `chatbot-ui`/`-manual` examples: - Fixes `Dockerfile` vs `docker-compose` confusion - Makes it clear where to view the web UI in `## Run` sections --------- Signed-off-by: James Braza <[email protected]>
1 parent 30f120e commit 2ba9762

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

examples/chatbot-ui-manual/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,13 @@ docker-compose up -d --pull always
2424
# docker-compose up -d --build
2525
```
2626

27+
Then browse to `http://localhost:3000` to view the Web UI.
28+
2729
## Pointing chatbot-ui to a separately managed LocalAI service
2830

29-
If you want to use the [chatbot-ui example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) with an externally managed LocalAI service, you can alter the `docker-compose` file so that it looks like the below. You will notice the file is smaller, because we have removed the section that would normally start the LocalAI service. Take care to update the IP address (or FQDN) that the chatbot-ui service tries to access (marked `<<LOCALAI_IP>>` below):
30-
```
31+
If you want to use the [chatbot-ui example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) with an externally managed LocalAI service, you can alter the `docker-compose.yaml` file so that it looks like the below. You will notice the file is smaller, because we have removed the section that would normally start the LocalAI service. Take care to update the IP address (or FQDN) that the chatbot-ui service tries to access (marked `<<LOCALAI_IP>>` below):
32+
33+
```yaml
3134
version: '3.6'
3235

3336
services:
@@ -40,9 +43,8 @@ services:
4043
- 'OPENAI_API_HOST=http://<<LOCALAI_IP>>:8080'
4144
```
4245
43-
Once you've edited the Dockerfile, you can start it with `docker compose up`, then browse to `http://localhost:3000`.
46+
Once you've edited the `docker-compose.yaml`, you can start it with `docker compose up`, then browse to `http://localhost:3000` to view the Web UI.
4447

4548
## Accessing chatbot-ui
4649

4750
Open http://localhost:3000 for the Web UI.
48-

examples/chatbot-ui/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@ docker-compose up --pull always
2020
# docker-compose up -d --build
2121
```
2222

23+
Then browse to `http://localhost:3000` to view the Web UI.
24+
2325
## Pointing chatbot-ui to a separately managed LocalAI service
2426

25-
If you want to use the [chatbot-ui example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) with an externally managed LocalAI service, you can alter the `docker-compose` file so that it looks like the below. You will notice the file is smaller, because we have removed the section that would normally start the LocalAI service. Take care to update the IP address (or FQDN) that the chatbot-ui service tries to access (marked `<<LOCALAI_IP>>` below):
26-
```
27+
If you want to use the [chatbot-ui example](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) with an externally managed LocalAI service, you can alter the `docker-compose.yaml` file so that it looks like the below. You will notice the file is smaller, because we have removed the section that would normally start the LocalAI service. Take care to update the IP address (or FQDN) that the chatbot-ui service tries to access (marked `<<LOCALAI_IP>>` below):
28+
29+
```yaml
2730
version: '3.6'
2831

2932
services:
@@ -36,9 +39,8 @@ services:
3639
- 'OPENAI_API_HOST=http://<<LOCALAI_IP>>:8080'
3740
```
3841
39-
Once you've edited the Dockerfile, you can start it with `docker compose up`, then browse to `http://localhost:3000`.
42+
Once you've edited the `docker-compose.yaml`, you can start it with `docker compose up`, then browse to `http://localhost:3000` to view the Web UI.
4043

4144
## Accessing chatbot-ui
4245

4346
Open http://localhost:3000 for the Web UI.
44-

0 commit comments

Comments
 (0)