### Start development server

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/dev.md

Commands to install dependencies and launch the development server.

```bash
pnpm install
pnpm dev
```

--------------------------------

### Install Dependencies and Start Bot

Source: https://github.com/msgbyte/tailchat/blob/master/apps/github-app/README.md

Use these commands to install project dependencies and start the Probot application.

```sh
npm install
```

```sh
npm start
```

--------------------------------

### Serve Plugin Locally

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/create-theme.md

Start a local HTTP server to host the compiled plugin files for development installation.

```bash
npx http-server .
```

--------------------------------

### Install project dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/apps/github-app/CONTRIBUTING.md

Run this command to install all required dependencies for the project.

```bash
npm install
```

--------------------------------

### Configure and Run Service

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/manual.md

Set up environment variables and start the microservices.

```bash
cp server/.env.example server/dist/.env
vim .env
```

```bash
SERVICEDIR=services,plugins pnpm start:service
```

--------------------------------

### One-Command Docker Installation

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/install-docker.md

Use this script for a quick Docker installation. It's suitable for users who prefer not to delve into the details of the installation process.

```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```

--------------------------------

### Create Node.js Project and Install Dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/openapp/bot.md

Set up a new Node.js project and install necessary packages including Koa, Koa-router, and the tailchat-client-sdk.

```bash
mkdir tailchat-bot && cd tailchat-bot
npm init -y
npm install koa koa-router tailchat-client-sdk
```

--------------------------------

### Start SWAG Service

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/https-gateway.md

After configuring the swag.env file, use this command to start the SWAG service. This will apply for an SSL certificate and start the reverse proxy.

```bash
docker compose -f ./swag.yml up -d
```

--------------------------------

### Initialize Environment Variables

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/mobile.md

Create the .env file from the provided example template.

```bash
cp.env.example.env
```

--------------------------------

### Start development environment

Source: https://github.com/msgbyte/tailchat/blob/master/client/desktop/README.md

Initiates the development server for local testing and hot-reloading.

```bash
yarn dev
```

--------------------------------

### Install Docker Compose Separately

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/install-docker.md

Download and install the standalone Docker Compose binary. This is an alternative if Docker is already installed but Docker Compose is not.

```bash
curl -SL https://github.com/docker/compose/releases/download/v2.4.1/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
docker-compose --version
```

--------------------------------

### Sample Domain Configuration

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/meeting/deployment.md

Example configuration for the URL and SUBDOMAINS environment variables.

```bash
URL=meeting.example.com # 这里请填入
SUBDOMAINS= # 该参数用于多域名证书申请，可留空
```

--------------------------------

### Initialize project with native MiniStar

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/start.mdx

Install MiniStar globally and use its commands to create and build plugins.

```bash
npm install --global mini-star
```

--------------------------------

### Environment Variable Configuration Examples

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/mobile.md

Examples showing correct and incorrect ways to define environment variables in the .env file.

```ini
GETUI_APPID=xxxxxxxxxxxx
GETUI_APPKEY=yyyyyyyyy
GETUI_APPSECRET=zzzzzzzzzz
GETUI_HUAWEI_APP_ID=
```

```ini
GETUI_APPID=xxxxxxxxxxxx
GETUI_APPKEY=yyyyyyyyy
GETUI_APPSECRET=zzzzzzzzzz
```

--------------------------------

### Initialize Project and Dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/init-env.md

Initializes the npm project and installs the required mini-star package.

```bash
npm init -y
npm install mini-star
```

--------------------------------

### Install tailchat-client-sdk

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/openapp/bot.md

Install the Tailchat client SDK using npm. This is the first step for Node.js bot development.

```bash
npm install tailchat-client-sdk
```

--------------------------------

### Install Mobile Dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/mobile.md

Navigate to the mobile client directory and install required packages using yarn.

```bash
cd client/mobile
yarn
```

--------------------------------

### Install Dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/manual.md

Install project dependencies using pnpm within the cloned directory.

```bash
cd tailchat
pnpm install
```

--------------------------------

### Install project dependencies

Source: https://github.com/msgbyte/tailchat/blob/master/client/desktop/README.md

Run this command to install all required project dependencies defined in the package manager configuration.

```bash
yarn
```

--------------------------------

### Configure Docker Environment

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/meeting/deployment.md

Prepare the environment variables by copying the example file and editing it.

```bash
cd tailchat-meeting/compose
cp docker-compose.env.example docker-compose.env
vi docker-compose.env
```

--------------------------------

### Build Error Log Example

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/mobile.md

Example of a build failure log that may occur during compilation.

```text
error Failed to install the app. Make sure you have the Android development environment set up: https://reactnative.dev/docs/environment-setup.
Error: Command failed: gradlew.bat app:installDebug -PreactNativeDevServerPort=8081

FAILURE: Build failed with an exception.

* What went wrong:
Could not determine the dependencies of task ':app:compileDebugJavaWithJavac'.
> Could not resolve all dependencies for configuration ':app:debugRuntimeClasspath'.
    > Could not create task ':app:generateDebugLintModel'.
       > java.lang.NullPointerException (no error message)

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 27s
```

--------------------------------

### Install Traefik Helm Chart

Source: https://github.com/msgbyte/tailchat/blob/master/docker/simple/k8s/README.md

Add the Traefik Helm repository and install Traefik into the 'tailchat' namespace.

```bash
helm repo add traefik https://helm.traefik.io/traefik
helm install traefik traefik/traefik -n tailchat
```

--------------------------------

### Run MinIO container

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/dev.md

Starts a MinIO container with pre-configured credentials for object storage.

```bash
docker run -d \
  -p 19000:9000 \
  -p 19001:9001 \
  --name minio \
  -e "MINIO_ROOT_USER=tailchat" \
  -e "MINIO_ROOT_PASSWORD=com.msgbyte.tailchat" \
  minio/minio server /data --console-address ":9001"
```

--------------------------------

### Start application with admin support

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/admin.md

Launches the application using both the base docker-compose.yml and the admin.yml extension file.

```bash
docker compose -f docker-compose.yml -f admin.yml up -d
```

--------------------------------

### Install Tailchat CLI

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/cli/tailchat-cli.md

Installs the latest version of the Tailchat CLI globally using npm.

```bash
npm install -g tailchat-cli@latest # Install and update with the same command
```

--------------------------------

### Prepare Environment Variables

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md

Copy the example environment file to '.env' and configure necessary variables for compilation. Ensure all required variables are present, even if left empty, to avoid build errors.

```bash
cp .env.example .env
```

```ini
TAILCHAT_UPLOAD_STORE_FILE=
TAILCHAT_UPLOAD_STORE_PASSWORD=
TAILCHAT_UPLOAD_KEY_ALIAS=
TAILCHAT_UPLOAD_KEY_PASSWORD=

GETUI_APPID=
GETUI_APPKEY=
GETUI_APPSECRET=
GETUI_HUAWEI_APP_ID=
```

--------------------------------

### Start Tailchat Meeting

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/meeting/deployment.md

Command to start the application containers in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Start Docker Daemon

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/install-docker.md

If the Docker daemon is not running, use this command to start it. This is necessary for Docker commands to function correctly.

```bash
sudo systemctl start docker
```

--------------------------------

### Run Redis container

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/dev.md

Starts a Redis container for the development environment.

```bash
docker run -d --name redis -p 6379:6379 redis
```

--------------------------------

### Install Traefik using Helm

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/kubernetes/simple.md

Install Traefik in the Tailchat namespace using Helm. This command deploys Traefik as a reverse proxy and load balancer.

```bash
helm install traefik traefik/traefik -n tailchat
```

--------------------------------

### Minimal .env configuration

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/dev.md

Example environment variables required to run the Tailchat development server.

```ini
PORT=11000
MONGO_URL=mongodb://127.0.0.1:27017/tailchat
REDIS_URL=redis://localhost:6379/
MINIO_URL=127.0.0.1:19000
MINIO_USER=tailchat
MINIO_PASS=com.msgbyte.tailchat
```

--------------------------------

### Install Docker Engine and Compose Plugin

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/install-docker.md

Install Docker CE, the command-line interface, containerd, and the Docker Compose plugin. The plugin enables the 'docker compose' command.

```bash
sudo yum install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
```

--------------------------------

### Basic Koa Server Setup

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/openapp/bot.md

Initialize a Koa application with basic routes for the root and a bot callback endpoint. This server listens on port 3000.

```javascript
const Koa = require('koa');
const Router = require('koa-router');
const app = new Koa();
const router = new Router();

// Define route
router.get('/', async (ctx) => {
  ctx.body = 'Hello, World!';
});

router.post('/bot/callback', async (ctx) => {
  ctx.body = 'Bot Callback Page';
});

// Register middleware
app.use(router.routes());
app.use(router.allowedMethods());

// Start server
app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});
```

--------------------------------

### Run MongoDB container

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/dev.md

Starts a MongoDB 4 container for the development environment.

```bash
docker run -d --name mongo -p 27017:27017 mongo:4
```

--------------------------------

### Download SWAG Configuration Files

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/https-gateway.md

Use these commands to download the necessary SWAG configuration files and create a config directory. Ensure you have wget installed.

```bash
wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker/swag.yml
wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker/swag.env.example -O swag.env
mkdir config
wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker/config/nginx.conf -O ./config/nginx.conf
```

--------------------------------

### Troubleshoot Build Errors

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md

If build fails with environment setup errors, ensure all necessary environment variables (like GETUI_APPID, GETUI_APPKEY, GETUI_APPSECRET) are present in the .env file, even if they are empty.

```ini
GETUI_APPID=xxxxxxxxxxxx
GETUI_APPKEY=yyyyyyyyy
GETUI_APPSECRET=zzzzzzzzzz
GETUI_HUAWEI_APP_ID=
```

--------------------------------

### Troubleshoot Build Errors (Incomplete)

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md

A build error example indicating missing environment variables. Ensure all required variables are declared in the .env file.

```ini
GETUI_APPID=xxxxxxxxxxxx
GETUI_APPKEY=yyyyyyyyy
GETUI_APPSECRET=zzzzzzzzzz
```

--------------------------------

### Define plugin manifest configuration

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/start.mdx

Create a manifest.json file to define plugin metadata and entry points for manual installation.

```json
{
  "label": "Web Panel Plugin",
  "name": "com.msgbyte.webview",
  "url": "/plugins/com.msgbyte.webview/index.js",
  "version": "0.0.0",
  "author": "msgbyte",
  "description": "Provides groups with the ability to create web panels",
  "requireRestart": false
}
```

--------------------------------

### Configure Cloudflare R2 External Storage

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/external-storage.md

Example environment variable configuration for using Cloudflare R2 as an external storage provider.

```bash
MINIO_URL=<account-id>.r2.cloudflarestorage.com:443
MINIO_PATH_STYLE=Path
```

--------------------------------

### BBCode syntax examples

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/richtext.md

Common BBCode tags for formatting text, links, images, and mentions.

```text
[b]foo[/b]
```

```text
[i]foo[/i]
```

```text
[u]foo[/u]
```

```text
[s]foo[/s]
```

```text
[url]https://tailchat.msgbyte.com[/url]
```

```text
[url=https://tailchat.msgbyte.com ]Official website[/url]
```

```text
[img]https://tailchat.msgbyte.com/img/logo.svg[/img]
```

```text
[at=<hereisuserid>]moonrailgun[/at]
```

```text
[emoji]smile[/emoji]
```

```text
[markdown]## Heading[/markdown]
```

```text
[md]## Heading[/md]
```

--------------------------------

### Tailchat CLI Commands and Options

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli/tailchat-cli.md

This output shows the available commands and options after a successful installation. Use `tailchat <command>` to execute specific functionalities.

```bash
tailchat <command>

Commands:
  tailchat create [template]     创建 Tailchat 项目代码
  tailchat connect               连接到 Tailchat 节点网络
  tailchat app                   Tailchat cli 版本(WIP)
  tailchat bench                 压力测试
  tailchat declaration <source>  Tailchat 插件类型声明
  tailchat docker                Tailchat 镜像管理

Options:
      --version  Show version number                                   [boolean]
  -h, --help     Show help                                             [boolean]
```

--------------------------------

### Android Build Failure Example

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md

An example of a Gradle build failure during the Android compilation process, often related to environment setup or dependency resolution.

```bash
error Failed to install the app. Make sure you have the Android development environment set up: https://reactnative.dev/docs/environment-setup.
Error: Command failed: gradlew.bat app:installDebug -PreactNativeDevServerPort=8081

FAILURE: Build failed with an exception.

* What went wrong:
Could not determine the dependencies of task ':app:compileDebugJavaWithJavac'.
> Could not resolve all dependencies for configuration ':app:debugRuntimeClasspath'.
   > Could not create task ':app:generateDebugLintModel'.
      > java.lang.NullPointerException (no error message)

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 27s
```

--------------------------------

### Remove Old Docker Versions

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/install-docker.md

Before manual installation, remove any existing Docker packages to ensure a clean setup. This command is specific to systems using yum package manager.

```bash
sudo yum remove \
                docker \
                docker-client \
                docker-client-latest \
                docker-common \
                docker-latest \
                docker-latest-logrotate \
                docker-logrotate \
                docker-engine
```

--------------------------------

### Initialize project with Tailchat CLI

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/start.mdx

Use the CLI to scaffold a new plugin project.

```bash
tailchat create
```

--------------------------------

### Install LESS Dependency

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/create-theme.md

Install the required less package to enable compilation of theme files.

```bash
npm install less
```

--------------------------------

### Initialize Plugin Project

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/create-theme.md

Use the Tailchat CLI to scaffold a new client-side plugin project.

```bash
tailchat create --template client-plugin
```

--------------------------------

### Build Project

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/manual.md

Compile front-end and back-end code for production.

```bash
NODE_ENV=production pnpm build
```

--------------------------------

### Create MongoDB Instance

Source: https://github.com/msgbyte/tailchat/blob/master/docker/simple/k8s/README.md

Apply the MongoDB definition file to set up the database for Tailchat.

```bash
kubectl apply -f mongo.yml
```

--------------------------------

### Start Specific Tailchat Meeting Service

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/meeting/deployment.md

If you have existing gateway and redis services, you can start only the tailchat-meeting instance using this command.

```bash
docker compose up tailchat-meeting -d # 仅运行 tailchat-meeting 实例
```

--------------------------------

### Install tailchat-cli Globally

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/cli/tailchat-cli.md

Use this command to install the tailchat-cli globally on your system. This allows you to run tailchat commands directly from your terminal.

```bash
npm install -g tailchat-cli@latest # 安装与更新同一命令
```

--------------------------------

### Create Minio Instance

Source: https://github.com/msgbyte/tailchat/blob/master/docker/simple/k8s/README.md

Apply the Minio definition file to set up the object storage for Tailchat.

```bash
kubectl apply -f minio.yml
```

--------------------------------

### Install pnpm Package Manager

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/docker-compose.mdx

Install pnpm globally using npm. pnpm is recommended for managing Node.js dependencies to ensure consistency with developer environments.

```bash
npm install -g pnpm
```

--------------------------------

### Create Plugin Directory

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/init-env.md

Initializes a new directory for the plugin project.

```bash
mkdir tailchat-plugin-test && cd tailchat-plugin-test
```

--------------------------------

### Generic API Call Example

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/openapp/bot.md

This example demonstrates a generic POST request to the Tailchat API. Ensure you include the 'Content-Type' and 'X-Token' headers for authentication and content specification.

```http
POST /api/xxx

Header
Content-Type: application/json
X-Token: <your-jwt>

Body
{
  ...
}
```

--------------------------------

### SMTP_URI Examples for Different Providers

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/smtp.md

Examples of SMTP URIs for common email providers. Ensure your username, password, and other details are correctly formatted according to the provider's specifications.

```plaintext
smtps://<username>:<password>@smtp.exmail.qq.com/?pool=true
```

```plaintext
smtps://<username>:<password>@smtp.163.com/?pool=true
```

```plaintext
smtps://<qqNumber>:<password>@smtp.qq.com/?pool=true
```

--------------------------------

### Create Redis Instance

Source: https://github.com/msgbyte/tailchat/blob/master/docker/simple/k8s/README.md

Apply the Redis definition file to set up the cache for Tailchat.

```bash
kubectl apply -f redis.yml
```

--------------------------------

### Download Source Code

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/manual.md

Create a directory and clone the Tailchat repository.

```bash
mkdir msgbyte && cd msgbyte

git clone https://github.com/msgbyte/tailchat.git
```

--------------------------------

### Build and Run Docker Container

Source: https://github.com/msgbyte/tailchat/blob/master/apps/github-app/README.md

Instructions for building a Docker image for the GitHub App and running it with necessary environment variables.

```sh
docker build -t github-app .

```

```sh
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> github-app
```

--------------------------------

### Package the application

Source: https://github.com/msgbyte/tailchat/blob/master/client/desktop/README.md

Builds the project into a distributable package.

```bash
yarn package
```

--------------------------------

### Mail Service Error Response

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/troubleshooting.md

Example of the error output when SMTP configuration is invalid.

```text
code:'EENVELOPE',
response: '502 Invalid paramenters',
responseCode: 502,
command: 'MAIL FROM'
```

--------------------------------

### Initialize Tailchat Project with CLI

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/docker-compose.mdx

Use this command to quickly initialize a Tailchat project with Docker. It interactively prompts for configuration details.

```bash
npx tailchat-cli docker init
```

--------------------------------

### Get Single Message by ID

Source: https://context7.com/msgbyte/tailchat/llms.txt

Fetches a single message using its unique ID.

```typescript
// Get Single Message by ID
const message = await fetch('/api/chat/message/getMessage', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Token': 'your-jwt-token'
  },
  body: JSON.stringify({ messageId: '64message123' })
});
```

--------------------------------

### Configure Environment Variables Locally

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/environment.md

Commands to initialize the local environment configuration file.

```bash
mv .env.example .env
vi .env
```

--------------------------------

### Get User Info by ID API

Source: https://context7.com/msgbyte/tailchat/llms.txt

Retrieves specific user information by their user ID.

```APIDOC
## POST /api/user/getUserInfo

### Description
Retrieves detailed information for a specific user identified by their ID.

### Method
POST

### Endpoint
/api/user/getUserInfo

### Parameters
#### Headers
- **X-Token** (string) - Required - The JWT token for authentication.
#### Request Body
- **userId** (string) - Required - The unique identifier of the user to retrieve.

### Request Example
```json
{
  "userId": "64abc123def456"
}
```

### Response
#### Success Response (200)
- **_id** (string) - The unique identifier for the user.
- **email** (string) - The user's email address.
- **nickname** (string) - The user's display name.
- **discriminator** (string) - A discriminator string for the user.
- **avatar** (string) - URL to the user's avatar.
- **createdAt** (string) - Timestamp of user creation.
```

--------------------------------

### Navigate to Plugin Configuration

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/custom-builtin-plugin.md

Locate the builtin plugin configuration file within the cloned repository.

```bash
cd tailchat
vim client/web/src/plugin/builtin.ts
```

--------------------------------

### GET /open/auth

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/advanced-usage/openapp/oauth.md

Initiates the OAuth authorization process by redirecting the user to the Tailchat login page.

```APIDOC
## GET /open/auth

### Description
Redirects the user to the Tailchat platform for login authorization.

### Method
GET

### Endpoint
/open/auth

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The client ID of the open platform application.
- **redirect_uri** (string) - Required - The callback URL registered in the application whitelist.
- **scope** (string) - Required - Authorization scope, default is 'openid profile'.
- **response_type** (string) - Required - Must be 'code'.
- **state** (string) - Optional - Custom parameters to be returned after redirection.
```

--------------------------------

### 单独安装 Docker Compose

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/install-docker.md

在已预装 Docker 的服务器上，通过下载二进制文件手动安装 Docker Compose。

```bash
curl -SL https://github.com/docker/compose/releases/download/v2.4.1/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose # 下载二进制文件
sudo chmod +x /usr/local/bin/docker-compose # 给予执行权限
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose # 软链接到path, 可以直接调用
docker-compose --version # 该行命令返回版本号则成功安装
```

--------------------------------

### Compile Tailchat Front-end

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/cdn.md

Navigate to the front-end directory and build the project. Ensure `SERVICE_URL` is set to your API backend address.

```bash
cd client/web
SERVICE_URL=<your-api-url> pnpm build
```

--------------------------------

### Execute Tailchat CLI via npx

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/cli/tailchat-cli.md

Runs the Tailchat CLI directly without a global installation.

```bash
npx tailchat-cli <command>
```

--------------------------------

### Define Environment Variables with Spaces

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/environment.md

Example of how to escape and quote environment variable values containing spaces.

```bash
SMTP_SENDER="\"Tailchat\" example@163.com" # If there are repeated double quotes, they need to be escaped with an escape character
```

--------------------------------

### Get Tailchat Services

Source: https://github.com/msgbyte/tailchat/blob/master/docker/simple/k8s/README.md

Retrieve a list of services within the 'tailchat' namespace to check their status and ClusterIPs.

```bash
kubectl get svc -n tailchat
```

--------------------------------

### Add Traefik Helm Repository

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/deployment/other-way/kubernetes/simple.md

Add the Traefik Helm repository to your Helm client to manage Traefik installations.

```bash
helm repo add traefik https://helm.traefik.io/traefik
```

--------------------------------

### Compile Plugin

Source: https://github.com/msgbyte/tailchat/blob/master/website/docs/plugins/guide/create-theme.md

Build the plugin project to generate the distribution files.

```bash
npm run plugins:all
```

--------------------------------

### 配置 Docker 仓库

Source: https://github.com/msgbyte/tailchat/blob/master/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/install-docker.md

安装 yum-utils 并添加 Docker CE 官方仓库。

```bash
sudo yum install -y yum-utils # yum-utils 提供了 yum-config-manager 命令

sudo yum-config-manager \
    --add-repo \
    https://download.docker.com/linux/centos/docker-ce.repo
```

--------------------------------

### Get Conversation Info

Source: https://context7.com/msgbyte/tailchat/llms.txt

Retrieve details about a specific conversation using its `converseId`. This is useful for fetching conversation metadata.

```typescript
const converseInfo = await fetch('/api/chat/converse/findConverseInfo', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Token': 'your-jwt-token'
  },
  body: JSON.stringify({ converseId: '64converse123' })
});
```