From 2ba97622559115cf49d762494cb53f224168355c Mon Sep 17 00:00:00 2001 From: James Braza Date: Mon, 18 Sep 2023 07:43:06 -0700 Subject: [PATCH] Cleaned up chatbot-ui READMEs (#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 --- examples/chatbot-ui-manual/README.md | 10 ++++++---- examples/chatbot-ui/README.md | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/examples/chatbot-ui-manual/README.md b/examples/chatbot-ui-manual/README.md index 7cf4bbb2..3238f326 100644 --- a/examples/chatbot-ui-manual/README.md +++ b/examples/chatbot-ui-manual/README.md @@ -24,10 +24,13 @@ docker-compose up -d --pull always # docker-compose up -d --build ``` +Then browse to `http://localhost:3000` to view the Web UI. + ## Pointing chatbot-ui to a separately managed LocalAI service -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 `<>` below): -``` +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 `<>` below): + +```yaml version: '3.6' services: @@ -40,9 +43,8 @@ services: - 'OPENAI_API_HOST=http://<>:8080' ``` -Once you've edited the Dockerfile, you can start it with `docker compose up`, then browse to `http://localhost:3000`. +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. ## Accessing chatbot-ui Open http://localhost:3000 for the Web UI. - diff --git a/examples/chatbot-ui/README.md b/examples/chatbot-ui/README.md index fa7ee368..3817aa85 100644 --- a/examples/chatbot-ui/README.md +++ b/examples/chatbot-ui/README.md @@ -20,10 +20,13 @@ docker-compose up --pull always # docker-compose up -d --build ``` +Then browse to `http://localhost:3000` to view the Web UI. + ## Pointing chatbot-ui to a separately managed LocalAI service -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 `<>` below): -``` +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 `<>` below): + +```yaml version: '3.6' services: @@ -36,9 +39,8 @@ services: - 'OPENAI_API_HOST=http://<>:8080' ``` -Once you've edited the Dockerfile, you can start it with `docker compose up`, then browse to `http://localhost:3000`. +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. ## Accessing chatbot-ui Open http://localhost:3000 for the Web UI. -