opensource/sqlchat
1
0
Fork 0
mirror of https://github.com/sqlchat/sqlchat.git synced 2025-09-24 16:46:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve readme

Browse Source
This commit is contained in:
Tianzhou Chen
2023-04-21 02:39:50 +08:00
parent 22f56f07c3
commit 94a9ff5f30
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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
```
</p>