mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-01 13:25:18 +08:00
Xiaoyu SuandJunyan Chin
310c566148
* 重构文档结构：移除 docs 目录，调整文件组织结构 * Reorder "插件 SDK API" section in docs.json * Refactor and clarify various documentation sections * Refine warnings and info boxes across multiple docs * Refactor and simplify Japanese documentation content * Update package.json to include mintlify as a dependency and add pnpm-lock.yaml for dependency management * Update blog link and add description in docs.json --------- Co-authored-by: Junyan Chin <[email protected]>
42 lines
1.5 KiB
Plaintext
42 lines
1.5 KiB
Plaintext
---
|
|
title: "Welcome to LangBot Documentation"
|
|
---
|
|
|
|
LangBot is an open-source Large Language Model (LLM) native instant messaging bot platform that supports multiple messaging platforms and model providers. It provides support for LLMOps platforms such as Dify. It also offers a WebUI for users to quickly deploy and use.
|
|
|
|
## Documentation Structure
|
|
|
|
The documentation is divided into the following sections:
|
|
|
|
- Deployment and Usage (Must Read): Detailed steps for deploying and using LangBot
|
|
- Plugins: Information related to plugin usage and development
|
|
- Practice: Many excellent use cases for LangBot
|
|
- Development: Information related to participating in LangBot development
|
|
|
|
## Quick Start Guide
|
|
|
|
> Two ways to get started quickly:
|
|
>
|
|
> - Use the simplified tutorial from community resources (see left sidebar)
|
|
> - Read the documentation to deploy it yourself (method described below)
|
|
|
|
### 1. Deploy LangBot
|
|
|
|
Read the **Deploy LangBot** section on the left and choose a method to deploy LangBot
|
|
|
|
After deployment, open `http://127.0.0.1:5300` or `http://your-server-public-ip:5300`
|
|
|
|
Complete the initialization by entering an email and password, and make sure to save them
|
|
|
|
### 2. Configure Bots
|
|
|
|
Check [Configure Bots](/en/deploy/platforms/readme) in the left sidebar
|
|
|
|
### 3. Configure Models
|
|
|
|
Check [Configure Dialogue Models](/en/deploy/models/readme) in the left sidebar
|
|
|
|
<br />
|
|
|
|
After completing the above two steps, you can start using LangBot. If you need to configure more features, you can set them in the [Pipeline](/en/deploy/pipelines/readme) section
|