From 94a9ff5f309fa16df2028ecb42b5df2effd51774 Mon Sep 17 00:00:00 2001 From: Tianzhou Chen Date: Fri, 21 Apr 2023 02:39:50 +0800 Subject: [PATCH] chore: improve readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 807421e..86a3256 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ SQL Chat is built by Next.js, it supports the following databases and will add m ## Deploy with Docker ```bash -docker run -d --name sqlchat -p 3000:3000 sqlchat/sqlchat:latest +docker run -d --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat:latest ``` You can set the following environment variables to customize the deployment: @@ -46,6 +46,10 @@ You can set the following environment variables to customize the deployment: - `OPENAI_API_KEY`: OpenAI API key. You can get one from [here](https://beta.openai.com/docs/developer-quickstart/api-keys). - `OPENAI_API_ENDPOINT`: OpenAI API endpoint. Defaults to `https://api.openai.com`. +```bash +docker run --name sqlchat --platform linux/amd64 --env OPENAI_API_KEY=xxx --env OPENAI_API_ENDPOINT=yyy -p 3000:3000 sqlchat/sqlchat +``` + ## Local Development 1. Make a copy of the example environment variables file; @@ -74,7 +78,7 @@ You can set the following environment variables to customize the deployment: - You can deploy your SQL Chat with docker in seconds ```bash - docker run -d --name sqlchat -p 3000:3000 sqlchat/sqlchat:latest + docker run -d --name sqlchat --platform linux/amd64 -p 3000:3000 sqlchat/sqlchat ```