opensource/sqlchat
1
0
Fork 0
mirror of https://github.com/sqlchat/sqlchat.git synced 2025-08-02 14:01:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: further tweak readme

Browse Source
This commit is contained in:
Tianzhou Chen
2023-12-17 22:57:21 +08:00
parent 4bbf7dce16
commit eb9ec23838
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -60,14 +60,14 @@ the database connection setting.
<img src="https://raw.githubusercontent.com/sqlchat/sqlchat/main/docs/docker-connection-setting.webp" /> <img src="https://raw.githubusercontent.com/sqlchat/sqlchat/main/docs/docker-connection-setting.webp" />
### Startup options ## Startup options
* Run without database, check [.env.nodb](https://github.com/sqlchat/sqlchat/blob/main/.env.nodb). * Run without database, check [.env.nodb](https://github.com/sqlchat/sqlchat/blob/main/.env.nodb).
This is suitable if you just want to use for yourself. This is suitable if you just want to use for yourself.
* Run with database, check [.env.usedb](https://github.com/sqlchat/sqlchat/blob/main/.env.usedb). * Run with database, check [.env.usedb](https://github.com/sqlchat/sqlchat/blob/main/.env.usedb).
This is suitable if you want to run a similar multi-tenant service as [sqlchat.ai](https://sqlchat.ai) where you need manage account, usage and etc. This is suitable if you want to run a similar multi-tenant service as [sqlchat.ai](https://sqlchat.ai) where you need manage account, usage and etc.
#### OpenAI related ### OpenAI related
- `OPENAI_API_KEY`: OpenAI API key. You can get one from [here](https://beta.openai.com/docs/developer-quickstart/api-keys). - `OPENAI_API_KEY`: OpenAI API key. You can get one from [here](https://beta.openai.com/docs/developer-quickstart/api-keys).
@ -75,7 +75,7 @@ This is suitable if you want to run a similar multi-tenant service as [sqlchat.a
- `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: Set to `true` to allow users to bring their own OpenAI API key. - `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: Set to `true` to allow users to bring their own OpenAI API key.
#### Database related ### Database related
- `NEXT_PUBLIC_USE_DATABASE`: Set to `true` to start SQL Chat with database. This will - `NEXT_PUBLIC_USE_DATABASE`: Set to `true` to start SQL Chat with database. This will
enable following features: enable following features:

BIN
docs/docker-connection-setting.png.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
docs/docker-connection-setting.webp
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 15 KiB