docs: update readme (#37)

* docs: update readme with `deploy with docker`

* chore: add common questions section
This commit is contained in:
boojack
2023-04-19 10:45:11 +08:00
committed by GitHub
parent 8ee07db655
commit 609f6c3dec

View File

@ -35,6 +35,17 @@ SQL Chat is built by Next.js, it supports the following databases and will add m
- Only the database schema will be sent to the OpenAI API. No table data will be sent there.
## Deploy with Docker
```bash
docker run -d --name sqlchat -p 3000:3000 sqlchat/sqlchat:latest
```
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`.
## Local Development
1. Make a copy of the example environment variables file;
@ -51,6 +62,32 @@ SQL Chat is built by Next.js, it supports the following databases and will add m
pnpm i && pnpm dev
```
## Common questions
<details><summary>How to self host SQL Chat?</summary>
<p>
- You can deploy SQL Chat to Vercel with one click
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsqlchat%2Fsqlchat&env=OPENAI_API_KEY"><img src="https://img.shields.io/badge/deploy%20on-Vercel-brightgreen.svg?style=for-the-badge&logo=vercel" alt="vercel"></a>
- You can deploy your SQL Chat with docker in seconds
```bash
docker run -d --name sqlchat -p 3000:3000 sqlchat/sqlchat:latest
```
</p>
</details>
<details><summary>It always says that I have a network connection issue?</summary>
<p>
Please make sure you have a stable network connection which can access the OpenAI API endpoint. If you cannot access the OpenAI API endpoint, you can try to set the `OPENAI_API_ENDPOINT` in UI or environment variable.
</p>
</details>
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=sqlchat/sqlchat&type=Date)](https://star-history.com/#sqlchat/sqlchat&Date)