mirror of
https://github.com/lobehub/lobehub
synced 2026-04-21 17:47:27 +00:00
📝 docs: add self-hosting button
This commit is contained in:
parent
192d85b24b
commit
a1f1610b2a
2 changed files with 28 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -23,6 +23,8 @@ Lobe Chat is an open-source chatbot client using OpenAI and Next.js
|
|||
[![stargazers][stargazers-shield]][stargazers-url]
|
||||
[![issues][issues-shield]][issues-url]
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Your%20OpenAI%20API%20Key&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat)
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
|
@ -32,13 +34,35 @@ Lobe Chat is an open-source chatbot client using OpenAI and Next.js
|
|||
|
||||
#### TOC
|
||||
|
||||
- [🛳 Self Hosting](#-self-hosting)
|
||||
|
||||
- [Deploy to Vercel](#deploy-to-vercel)
|
||||
|
||||
- [⌨️ Local Development](#️-local-development)
|
||||
|
||||
- [🤝 Contributing](#-contributing)
|
||||
|
||||
####
|
||||
|
||||
</details>
|
||||
|
||||
## 🛳 Self Hosting
|
||||
|
||||
If you want to deploy this service by yourself, you can follow the steps below.
|
||||
|
||||
### Deploy to Vercel
|
||||
|
||||
Click button below to deploy your private plugins' gateway.
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Your%20OpenAI%20API%20Key&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat)
|
||||
|
||||
If you want to make some customization, you can add environment variable:
|
||||
|
||||
| Environment variable | Description | Example |
|
||||
| -------------------- | --------------------------------------------------------------------------------- | ----------------------------- |
|
||||
| `OPENAI_PROXY_URL` | OpenAI API 代理 URL,例如:`https://api.chatanywhere.cn` | `https://api.chatanywhere.cn` |
|
||||
| `ACCESS_CODE` | Add Password to access this service, the password should be 6 digits or alphabets | `awCT74` \| `e3@09!` |
|
||||
|
||||
## ⌨️ Local Development
|
||||
|
||||
You can use Gitpod for online development:
|
||||
|
|
@ -51,7 +75,7 @@ Or clone it for local development:
|
|||
$ git clone https://github.com/lobehub/lobe-chat.git
|
||||
$ cd lobe-chat
|
||||
$ pnpm install
|
||||
$ pnpm start
|
||||
$ pnpm dev
|
||||
```
|
||||
|
||||
<div align="right">
|
||||
|
|
|
|||
3
vercel.json
Normal file
3
vercel.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"installCommand": "pnpm i"
|
||||
}
|
||||
Loading…
Reference in a new issue