feat: vision model (#489)

* mongo init

* perf: mongo connect

* perf: tts

perf: whisper and tts

peref: tts whisper permission

log

reabase (#488)

* perf: modal

* i18n

* perf: schema lean

* feat: vision model format

* perf: tts loading

* perf: static data

* perf: tts

* feat: image

* perf: image

* perf: upload image and title

* perf: image size

* doc

* perf: color

* doc

* speaking can not select file

* doc

.env.template

@@ -1,27 +0,0 @@
-# proxy
-# AXIOS_PROXY_HOST=127.0.0.1
-# AXIOS_PROXY_PORT=7890
-# OPENAI_BASE_URL=https://api.openai.com/v1
-# OPENAI_BASE_URL_AUTH=可选的安全凭证
-# 是否开启队列任务。 1-开启，0-关闭（请求parentUrl去执行任务,单机时直接填1）
-queueTask=1
-parentUrl=https://hostname/api/openapi/startEvents
-# email
-MY_MAIL=xxx@qq.com
-MAILE_CODE=xxx
-# ali ems
-aliAccessKeyId=xxx
-aliAccessKeySecret=xxx
-aliSignName=xxx
-aliTemplateCode=SMS_xxx
-# token
-TOKEN_KEY=xxx
-# openai
-OPENAIKEY=sk-xxx
-# db
-MONGODB_URI=mongodb://username:password@0.0.0.0:27017/test?authSource=admin
-PG_HOST=0.0.0.0
-PG_PORT=8100
-PG_USER=xxx
-PG_PASSWORD=xxx
-PG_DB_NAME=xxx

.github/ISSUE_TEMPLATE/bugs.md

@@ -0,0 +1,30 @@
+---
+name: 问题反馈
+about: 详细清晰的描述你遇到的问题
+title: ''
+labels: bug
+assignees: ''
+---
+
+**例行检查**
+
+[//]: # '方框内填 x 表示打钩'
+
+- [ ] 我已确认目前没有类似 issue
+- [ ] 我已完整查看过项目 README，以及[项目文档](https://doc.fastgpt.in/docs/intro/)
+- [ ] 我使用了自己的 key，并确认我的 key 是可正常使用的
+- [ ] 我理解并愿意跟进此 issue，协助测试和提供反馈
+- [x] 我理解并认可上述内容，并理解项目维护者精力有限，**不遵循规则的 issue 可能会被无视或直接关闭**
+
+**你的版本**
+
+- [ ] 公有云版本
+- [ ] 私有部署版本
+
+**问题描述**
+
+**复现步骤**
+
+**预期结果**
+
+**相关截图**

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 微信交流群
+    url: https://doc.fastgpt.in/wechat-fastgpt.webp
+    about: FastGPT 全是问题群

.github/ISSUE_TEMPLATE/features.md

@@ -0,0 +1,23 @@
+---
+name: 功能请求
+about: 详细描述你期望的功能
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+**例行检查**
+
+[//]: # '方框内填 x 表示打钩'
+
+- [ ] 我已确认目前没有类似 features
+- [ ] 我已确认我已升级到最新版本
+- [ ] 我已完整查看过项目 README，已确定现有版本无法满足需求
+- [ ] 我理解并愿意跟进此 features，协助测试和提供反馈
+- [x] 我理解并认可上述内容，并理解项目维护者精力有限，**不遵循规则的 features 可能会被无视或直接关闭**
+
+**功能描述**
+
+**应用场景**
+
+**相关示例**

.github/gh-bot.yml

@@ -0,0 +1,30 @@
+version: v1
+debug: true
+action:
+  printConfig: false
+  release:
+    retry: 15s
+    actionName: Release
+    allowOps:
+      - cuisongliu
+bot:
+  prefix: /
+  spe: _
+  allowOps:
+    - sealos-ci-robot
+    - sealos-release-robot
+  email: sealos-ci-robot@sealos.io
+  username: sealos-ci-robot
+repo:
+  org: false
+
+message:
+  success: |
+    🤖 says: Hooray! The action {{.Body}} has been completed successfully. 🎉
+  format_error: |
+    🤖 says: ‼️ There is a formatting issue with the action, kindly verify the action's format.
+  permission_error: |
+    🤖 says: ‼️ The action doesn't have permission to trigger.
+  release_error: |
+    🤖 says: ‼️ Release action failed.
+    Error details: {{.Error}}

.github/imgs/logo.svg

@@ -0,0 +1,14 @@
+<svg width="32" height="32" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M340.837 0.33933L681.068 0.338989V0.455643C684.032 0.378397 686.999 0.339702 689.967 0.339702C735.961 0.3397 781.504 9.62899 823.997 27.6772C866.49 45.7254 905.099 72.1791 937.622 105.528C970.144 138.877 995.942 178.467 1013.54 222.04C1031.14 265.612 1040.2 312.312 1040.2 359.474L340.836 359.474L340.836 1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49C169.357 1302.43 131.85 1275.95 100.257 1242.58C68.6636 1209.21 43.6023 1169.59 26.5041 1125.99C11.3834 1087.43 2.75216 1046.42 0.957956 1004.81H0.605869L0.605897 368.098H0.70363C0.105752 341.831 2.23741 315.443 7.14306 289.411C20.2709 219.745 52.6748 155.754 100.257 105.528C147.839 55.3017 208.462 21.0975 274.461 7.24017C296.426 2.62833 318.657 0.339101 340.837 0.33933Z" fill="url(#paint0_linear_1172_228)"/>
+<path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37C799.997 617.874 836.384 642.064 867.033 672.559C897.683 703.054 921.996 739.257 938.583 779.101C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645Z" fill="url(#paint1_linear_1172_228)"/>
+<defs>
+<linearGradient id="paint0_linear_1172_228" x1="520.404" y1="0.338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+<linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+</defs>
+</svg>

.github/workflows/bot-issues-translator.yml

@@ -0,0 +1,19 @@
+name: 'Github Rebot for issues-translator'
+on:
+  issues:
+    types: [ opened ]
+  issue_comment:
+    types: [ created ]
+jobs:
+  translate:
+    permissions:
+      issues: write
+      discussions: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: usthe/issues-translate-action@v2.7
+        with:
+          IS_MODIFY_TITLE: true
+          BOT_GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+          CUSTOM_BOT_NOTE: Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

.github/workflows/deploy-docs.yml

@@ -0,0 +1,70 @@
+name: deploy-docs
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'docSite/**'
+    branches:
+      - 'main'
+    tags:
+      - 'v*.*.*'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains jobs "deploy-production"
+  deploy-production:
+    # The environment this job references
+    environment:
+      name: Production
+      url: ${{ steps.vercel-action.outputs.preview-url }}
+
+    # The type of runner that the job will run on
+    runs-on: ubuntu-22.04
+
+    # Job outputs
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive # Fetch submodules
+          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+
+      # Step 2 Detect changes to Docs Content
+      - name: Detect changes in doc content
+        uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          filters: |
+            docs:
+              - 'docSite/content/docs/**'
+          base: main
+
+      # Step 3 - Install Hugo (specific version)
+      - name: Install Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.117.0'
+          extended: true
+
+      # Step 4 - Builds the site using Hugo
+      - name: Build
+        run: cd docSite && hugo mod get -u github.com/colinwilson/lotusdocs && hugo -v --minify
+
+      # Step 5 - Push our generated site to Vercel
+      - name: Deploy to Vercel
+        uses: amondnet/vercel-action@v25
+        id: vercel-action
+        with:
+          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
+          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }} #Required
+          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }} #Required
+          github-comment: false
+          vercel-args: '--prod --local-config ../vercel.json' # Optional
+          working-directory: docSite/public
+

.github/workflows/deploy-preview.yml

@@ -0,0 +1,94 @@
+name: deploy-docs-preview
+
+on:
+  pull_request_target:
+    paths:
+      - 'docSite/**'
+    branches:
+      - 'main'
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains jobs "deploy-production"
+  deploy-preview:
+    # The environment this job references
+    environment:
+      name: Preview
+      url: ${{ steps.vercel-action.outputs.preview-url }}
+
+    # The type of runner that the job will run on
+    runs-on: ubuntu-22.04
+
+    # Job outputs
+    outputs:
+      url: ${{ steps.vercel-action.outputs.preview-url }}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: recursive # Fetch submodules
+          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+
+      # Step 2 Detect changes to Docs Content
+      - name: Detect changes in doc content
+        uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          filters: |
+            docs:
+              - 'docSite/content/docs/**'
+          base: main
+
+      # Step 3 - Install Hugo (specific version)
+      - name: Install Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.117.0'
+          extended: true
+
+      # Step 4 - Builds the site using Hugo
+      - name: Build
+        run: cd docSite && hugo mod get -u github.com/colinwilson/lotusdocs && hugo -v --minify
+
+      # Step 5 - Push our generated site to Vercel
+      - name: Deploy to Vercel
+        uses: amondnet/vercel-action@v25
+        id: vercel-action
+        with:
+          vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required
+          vercel-org-id: ${{ secrets.VERCEL_ORG_ID }} #Required
+          vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }} #Required
+          github-comment: false
+          vercel-args: '--local-config ../vercel.json' # Optional
+          working-directory: docSite/public
+          alias-domains: | #Optional
+            fastgpt-staging.vercel.app
+  docsOutput:
+    needs: [ deploy-preview ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+      - name: Write md
+        run: |
+          echo "# 🤖 Generated by deploy action" > report.md
+          echo "[👀 Visit Preview](${{ needs.deploy-preview.outputs.url }})" >> report.md
+          cat report.md
+      - name: Gh Rebot for Sealos
+        uses: labring/gh-rebot@v0.0.6
+        if: ${{ (github.event_name == 'pull_request_target') }}
+        with:
+          version: v0.0.6
+        env:
+          GH_TOKEN: "${{ secrets.GH_PAT }}"
+          SEALOS_TYPE: "pr_comment"
+          SEALOS_FILENAME: "report.md"
+          SEALOS_REPLACE_TAG: "DEFAULT_REPLACE_DEPLOY"

.github/workflows/docs-image.yml

@@ -0,0 +1,98 @@
+name: Build FastGPT docs images and copy image to docker hub
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'docSite/**'
+    branches:
+      - 'main'
+    tags:
+      - 'v*.*.*'
+jobs:
+  build-fastgpt-docs-images:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+      - name: Set up QEMU (optional)
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt-docs:latest" >> $GITHUB_ENV
+          else
+            echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt-docs:${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+      - name: Build and publish image for main branch or tag push event
+        env:
+          DOCKER_REPO_TAGGED: ${{ env.DOCKER_REPO_TAGGED }}
+        run: |
+          docker buildx build \
+          --build-arg name=app \
+          --platform linux/amd64,linux/arm64 \
+          --label "org.opencontainers.image.source=  https://github.com/  ${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.description=fastgpt image" \
+          --label "org.opencontainers.image.licenses=Apache" \
+          --push \
+          --cache-from=type=local,src=/tmp/.buildx-cache \
+          --cache-to=type=local,dest=/tmp/.buildx-cache \
+          -t ${DOCKER_REPO_TAGGED} \
+          -f docSite/Dockerfile \
+          .
+  push-to-docker-hub:
+    needs: build-fastgpt-docs-images
+    runs-on: ubuntu-20.04
+    if: github.repository == 'labring/FastGPT'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_NAME }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "IMAGE_TAG=latest" >> $GITHUB_ENV
+          else
+            echo "IMAGE_TAG=${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+      - name: Pull image from GitHub Container Registry
+        run: docker pull ghcr.io/${{ github.repository_owner }}/fastgpt-docs:${{env.IMAGE_TAG}}
+      - name: Tag image with Docker Hub repository name and version tag
+        run: docker tag ghcr.io/${{ github.repository_owner }}/fastgpt-docs:${{env.IMAGE_TAG}} ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+      - name: Push image to Docker Hub
+        run: docker push ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+
+  update-docs-image:
+    needs: build-fastgpt-docs-images
+    runs-on: ubuntu-20.04
+    if: github.repository == 'labring/FastGPT'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: actions-hub/kubectl@master
+        env:
+          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
+        with:
+          args: rollout restart deployment fastgpt-docs

.github/workflows/fastgpt-image-personal.yml

@@ -0,0 +1,52 @@
+name: Build FastGPT images in Personal warehouse
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'projects/app/**'
+      - 'packages/**'
+    branches:
+      - 'main'
+jobs:
+  build-fastgpt-images:
+    runs-on: ubuntu-20.04
+    if: github.repository != 'labring/FastGPT'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt:latest" >> $GITHUB_ENV
+      - name: Build and publish image for main branch or tag push event
+        env:
+          DOCKER_REPO_TAGGED: ${{ env.DOCKER_REPO_TAGGED }}
+        run: |
+          docker buildx build \
+          --build-arg name=app \
+          --label "org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.description=fastgpt image" \
+          --push \
+          --cache-from=type=local,src=/tmp/.buildx-cache \
+          --cache-to=type=local,dest=/tmp/.buildx-cache \
+          -t ${DOCKER_REPO_TAGGED} \
+          -f Dockerfile \
+          .

.github/workflows/fastgpt-image.yml

@@ -0,0 +1,112 @@
+name: Build FastGPT images and copy image to docker hub
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'projects/app/**'
+      - 'packages/**'
+    tags:
+      - 'v*.*.*'
+jobs:
+  build-fastgpt-images:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+      - name: Install Dependencies
+        run: |
+          sudo apt update && sudo apt install -y nodejs npm
+      - name: Set up QEMU (optional)
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt:latest" >> $GITHUB_ENV
+          else
+            echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt:${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+      - name: Build and publish image for main branch or tag push event
+        env:
+          DOCKER_REPO_TAGGED: ${{ env.DOCKER_REPO_TAGGED }}
+        run: |
+          docker buildx build \
+          --build-arg name=app \
+          --platform linux/amd64,linux/arm64 \
+          --label "org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.description=fastgpt image" \
+          --push \
+          --cache-from=type=local,src=/tmp/.buildx-cache \
+          --cache-to=type=local,dest=/tmp/.buildx-cache \
+          -t ${DOCKER_REPO_TAGGED} \
+          -f Dockerfile \
+          .
+  push-to-docker-hub:
+    needs: build-fastgpt-images
+    runs-on: ubuntu-20.04
+    if: github.repository == 'labring/FastGPT'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_NAME }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "IMAGE_TAG=latest" >> $GITHUB_ENV
+          else
+            echo "IMAGE_TAG=${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+      - name: Pull image from GitHub Container Registry
+        run: docker pull ghcr.io/${{ github.repository_owner }}/fastgpt:${{env.IMAGE_TAG}}
+      - name: Tag image with Docker Hub repository name and version tag
+        run: docker tag ghcr.io/${{ github.repository_owner }}/fastgpt:${{env.IMAGE_TAG}} ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+      - name: Push image to Docker Hub
+        run: docker push ${{ secrets.DOCKER_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+  push-to-ali-hub:
+    needs: build-fastgpt-images
+    if: github.repository == 'labring/FastGPT'
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Login to Ali Hub
+        uses: docker/login-action@v2
+        with:
+          registry: registry.cn-hangzhou.aliyuncs.com
+          username: ${{ secrets.ALI_HUB_USERNAME }}
+          password: ${{ secrets.ALI_HUB_PASSWORD }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          if [[ "${{ github.ref_name }}" == "main" ]]; then
+            echo "IMAGE_TAG=latest" >> $GITHUB_ENV
+          else
+            echo "IMAGE_TAG=${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+      - name: Pull image from GitHub Container Registry
+        run: docker pull ghcr.io/${{ github.repository_owner }}/fastgpt:${{env.IMAGE_TAG}}
+      - name: Tag image with Docker Hub repository name and version tag
+        run: docker tag ghcr.io/${{ github.repository_owner }}/fastgpt:${{env.IMAGE_TAG}} ${{ secrets.ALI_IMAGE_NAME }}:${{env.IMAGE_TAG}}
+      - name: Push image to Docker Hub
+        run: docker push ${{ secrets.ALI_IMAGE_NAME }}:${{env.IMAGE_TAG}}

.github/workflows/preview-image.yml

@@ -0,0 +1,56 @@
+name: Preview FastGPT images
+on:
+  pull_request_target:
+    paths:
+      - 'projects/app/**'
+      - 'packages/**'
+    branches:
+      - 'main'
+  workflow_dispatch:
+
+jobs:
+  build-fastgpt-images:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: recursive # Fetch submodules
+          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GH_PAT }}
+      - name: Set DOCKER_REPO_TAGGED based on branch or tag
+        run: |
+          echo "DOCKER_REPO_TAGGED=ghcr.io/${{ github.repository_owner }}/fastgpt-pr:${{ github.event.pull_request.number }}" >> $GITHUB_ENV
+      - name: Build image for PR
+        env:
+          DOCKER_REPO_TAGGED: ${{ env.DOCKER_REPO_TAGGED }}
+        run: |
+          docker buildx build \
+          --build-arg name=app \
+          --label "org.opencontainers.image.source=  https://github.com/  ${{ github.repository_owner }}/FastGPT" \
+          --label "org.opencontainers.image.description=fastgpt-pr image" \
+          --label "org.opencontainers.image.licenses=Apache" \
+          --push \
+          --cache-from=type=local,src=/tmp/.buildx-cache \
+          --cache-to=type=local,dest=/tmp/.buildx-cache \
+          -t ${DOCKER_REPO_TAGGED} \
+          -f Dockerfile \
+          .

.github/workflows/release.yml

@@ -1,50 +0,0 @@
-name: Release
-
-on:
-  workflow_dispatch:
-
-  push:
-    branches:
-      - 'main'
-
-jobs:
-  release:
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 1
-
-      - name: Install Dependencies
-        run: |
-          sudo apt update && sudo  apt install  -y nodejs npm
-      - # Add support for more platforms with QEMU (optional)
-        # https://github.com/docker/setup-qemu-action
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-        with:
-          driver-opts: network=host
-
-      - name: Login to  gitbub
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GH_PAT }}
-      - name: build and publish image
-        env:
-          # fork friendly ^^
-          DOCKER_REPO: ghcr.io/${{ github.repository_owner }}/fast-gpt
-        run: |
-          docker buildx build \
-          --platform linux/amd64,linux/arm64 \
-          --label "org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/FastGPT" \
-          --label "org.opencontainers.image.description=fast-gpt image" \
-          --label "org.opencontainers.image.licenses=MIT" \
-          --push \
-          -t ${DOCKER_REPO}:latest \
-          -f Dockerfile \
-          .

.gitignore

@@ -1,19 +1,11 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
 # dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
+node_modules/
 # next.js
-/.next/
-/out/
-
+.next/
+out/
 # production
-/build
+build/
+.astro/
 
 # misc
 .DS_Store
@@ -34,6 +26,13 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
-/.vscode/
 platform.json
-testApi/
+testApi/
+local/
+dist/
+
+# hugo
+**/.hugo_build.lock
+docSite/public/
+docSite/resources/_gen/
+docSite/.vercel

.prettierignore

@@ -1,4 +1,5 @@
 dist
 .vscode
 **/.DS_Store
-node_modules
+node_modules
+docSite/

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "editor.formatOnSave": true,
+    "editor.mouseWheelZoom": true,
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "prettier.prettierPath": "./node_modules/prettier",
+    "i18n-ally.localesPaths": [
+        "projects/app/public/locales"
+    ],
+    "i18n-ally.enabledParsers": ["json"],
+    "i18n-ally.keystyle": "nested",
+    "i18n-ally.sortKeys": true,
+    "i18n-ally.keepFulfilled": true,
+    "i18n-ally.sourceLanguage": "zh", // 根据此语言文件翻译其他语言文件的变量和内容
+    "i18n-ally.displayLanguage": "en", // 显示语言
+}

Dockerfile

@@ -1,36 +1,44 @@
 # Install dependencies only when needed
-FROM node:current-alpine AS deps
+FROM node:18.15-alpine AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk add --no-cache libc6-compat && npm install -g pnpm
 WORKDIR /app
 
-# Install dependencies based on the preferred package manager
-COPY package.json pnpm-lock.yaml* ./
-RUN \
-  [ -f pnpm-lock.yaml ] && pnpm install || \
-  (echo "Lockfile not found." && exit 1)
+ARG name
+
+# copy packages and one project
+COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./
+COPY ./packages ./packages
+COPY ./projects/$name/package.json ./projects/$name/package.json
+
+RUN [ -f pnpm-lock.yaml ] || (echo "Lockfile not found." && exit 1)
+
+RUN pnpm install
 
 # Rebuild the source code only when needed
-FROM node:current-alpine AS builder
+FROM node:18.15-alpine AS builder
 WORKDIR /app
-COPY --from=deps /app/node_modules ./node_modules
-COPY . .
 
-# Next.js collects completely anonymous telemetry data about general usage.
-# Learn more here: https://nextjs.org/telemetry
+ARG name
+
+# copy common node_modules and one project node_modules
+COPY package.json pnpm-workspace.yaml ./
+COPY --from=deps /app/node_modules ./node_modules
+COPY --from=deps /app/packages ./packages
+COPY ./projects/$name ./projects/$name
+COPY --from=deps /app/projects/$name/node_modules ./projects/$name/node_modules
+
 # Uncomment the following line in case you want to disable telemetry during the build.
 ENV NEXT_TELEMETRY_DISABLED 1
+RUN npm install -g pnpm
+RUN pnpm --filter=$name run build
 
-RUN npm install -g pnpm && pnpm run build
-
-# Production image, copy all the files and run next
-FROM node:current-alpine AS runner
+FROM node:18.15-alpine AS runner
 WORKDIR /app
 
-ENV NODE_ENV production
-# Uncomment the following line in case you want to disable telemetry during runtime.
-ENV NEXT_TELEMETRY_DISABLED 1
+ARG name
 
+# create user and use it
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
 
@@ -39,19 +47,22 @@ RUN apk add curl \
   && apk add ca-certificates \
   && update-ca-certificates
 
-# You only need to copy next.config.js if you are NOT using the default configuration
-# COPY --from=builder /app/next.config.js ./
-COPY --from=builder /app/public ./public
-COPY --from=builder /app/package.json ./package.json
-# COPY --from=builder /app/.env* .
+# copy running files
+COPY --from=builder /app/projects/$name/public ./projects/$name/public
+COPY --from=builder /app/projects/$name/next.config.js ./projects/$name/next.config.js
+COPY --from=builder --chown=nextjs:nodejs /app/projects/$name/.next/standalone ./
+COPY --from=builder --chown=nextjs:nodejs /app/projects/$name/.next/static ./projects/$name/.next/static
+# copy package.json to version file
+COPY --from=builder /app/projects/$name/package.json ./package.json 
 
-# Automatically leverage output traces to reduce image size
-# https://nextjs.org/docs/advanced-features/output-file-tracing
-COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
-COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
-
-USER nextjs
+ENV NODE_ENV production
+ENV NEXT_TELEMETRY_DISABLED 1
+ENV PORT=3000
 
 EXPOSE 3000
 
-CMD ["node", "server.js"]
+USER nextjs
+
+ENV serverPath=./projects/$name/server.js
+
+ENTRYPOINT ["sh","-c","node ${serverPath}"]

LICENSE

@@ -0,0 +1,35 @@
+# FastGPT Open Source License
+
+The FastGPT is licensed under the Apache License 2.0, with the following additional conditions:
+
+1. FastGPT is permitted to be used for commercialization. You can use FastGPT as a "backend-as-a-service" for your other applications, or delivering it to enterprises as an application development platform. However, when the following conditions are met, you must contact the producer to obtain a commercial license:
+
+a. Multi-tenant SaaS service: Unless explicitly authorized by FastGPT in writing, you may not use the FastGPT.AI source code to operate a multi-tenant SaaS service that is similar to the FastGPT.
+b. LOGO and copyright information: In the process of using FastGPT, you may not remove or moFastGPT the LOGO or copyright information in the FastGPT console.
+
+Please contact yujinlong@sealos.io by email to inquire about licensing matters.
+
+2. As a contributor, you should agree that your contributed code:
+
+a. The producer can adjust the open-source agreement to be more strict or relaxed.
+b. Can be used for commercial purposes, such as FastGPT's cloud business.
+
+Apart from this, all other rights and restrictions follow the Apache License 2.0. If you need more detailed information, you can refer to the full version of Apache License 2.0.
+
+The interactive design of this product is protected by appearance patent.
+
+© 2023 Sealos.
+
+---
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

Makefile

@@ -1,47 +0,0 @@
-SERVICE_NAME=fast-gpt
-# Image URL to use all building/pushing image targets
-IMG ?= $(SERVICE_NAME):latest
-
-.PHONY: all
-all: build
-
-##@ General
-
-# The help target prints out all targets with their descriptions organized
-# beneath their categories. The categories are represented by '##@' and the
-# target descriptions by '##'. The awk commands is responsible for reading the
-# entire set of makefiles included in this invocation, looking for lines of the
-# file as xyz: ## something, and then pretty-format the target and help. Then,
-# if there's a line with ##@ something, that gets pretty-printed as a category.
-# More info on the usage of ANSI control characters for terminal formatting:
-# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
-# More info on the awk command:
-# http://linuxcommand.org/lc3_adv_awk.php
-
-.PHONY: help
-help: ## Display this help.
-	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
-
-##@ Build
-
-.PHONY: build
-build: ## Build desktop-frontend binary.
-	pnpm run build
-
-.PHONY: run
-run: ## Run a dev service from host.
-	pnpm run start
-
-.PHONY: docker-build
-docker-build: ## Build docker image with the desktop-frontend.
-	docker build -t c121914yu/fast-gpt:latest . --network host  --build-arg HTTP_PROXY=http://127.0.0.1:7890 --build-arg HTTPS_PROXY=http://127.0.0.1:7890
-
-##@ Deployment
-
-.PHONY: docker-run
-docker-run:  ## Push docker image.
-	docker run -d -p 8008:3000 --name fast-gpt -v /web_project/yjl/fast-gpt/logs:/app/.next/logs c121914yu/fast-gpt:latest
-
-#TODO: add support of docker push
-
-#TODO: add support of sealos apply

README.md

@@ -1,283 +1,167 @@
-# Fast GPT
+<div align="center">
 
-Fast GPT 允许你使用自己的 openai API KEY 来快速的调用 openai 接口，目前集成了 gpt35 和 embedding. 可构建自己的知识库。
+<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.svg" width="120" height="120" alt="fastgpt logo"></a>
 
-## 知识库原理
+# FastGPT
 
-![KBProcess](docs/imgs/KBProcess.jpg?raw=true 'KBProcess')
+<p align="center">
+  <a href="./README_en.md">English</a> |
+  <a href="./README.md">简体中文</a>
+</p>
 
-## 开发
+FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开箱即用的数据处理、模型调用等能力。同时可以通过 Flow 可视化进行工作流编排，从而实现复杂的问答场景！
 
-**配置环境变量**
-复制.env.template 文件，生成一个.env.local 环境变量文件夹，修改.env.local 内容，参考下方：
+</div>
 
-```bash
-# proxy（可选）
-AXIOS_PROXY_HOST=127.0.0.1
-AXIOS_PROXY_PORT=7890
-# openai 中转连接（可选）
-OPENAI_BASE_URL=https://api.openai.com/v1
-OPENAI_BASE_URL_AUTH=可选的安全凭证
-# 是否开启队列任务。 1-开启，0-关闭（请求 parentUrl 去执行任务,单机时直接填1）
-queueTask=1
-parentUrl=https://hostname/api/openapi/startEvents
-# 发送邮箱验证码配置。参考 nodeMail 获取参数，自行百度。
-MY_MAIL=xxx@qq.com
-MAILE_CODE=xxx
-# 阿里短信服务（邮箱和短信至少二选一）
-aliAccessKeyId=xxx
-aliAccessKeySecret=xxx
-aliSignName=xxx
-aliTemplateCode=SMS_xxx
-# token（随便填，作为登录凭证）
-TOKEN_KEY=xxx
-# openai key
-OPENAIKEY=sk-xxx
-# mongo连接地址
-MONGODB_URI=mongodb://username:password@0.0.0.0:27017/test?authSource=admin
-# mongo数据库名称
-MONGODB_NAME=xxx
-# pg 数据库相关内容，和 docker-compose pg 部分对上
-PG_HOST=0.0.0.0
-PG_PORT=8102
-PG_USER=fastgpt
-PG_PASSWORD=1234
-PG_DB_NAME=fastgpt
-```
+<p align="center">
+  <a href="https://fastgpt.run/">
+    <img height="21" src="https://img.shields.io/badge/在线使用-d4eaf7?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
+  </a>
+  <a href="https://doc.fastgpt.in/docs/intro">
+    <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
+  </a>
+  <a href="https://doc.fastgpt.in/docs/development">
+    <img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
+  </a>
+  <a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
+    <img height="21" src="https://img.shields.io/badge/相关项目-7d09f1?style=flat-square" alt="project">
+  </a>
+  <a href="https://github.com/labring/FastGPT/blob/main/LICENSE">
+    <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=7d09f1" alt="license">
+  </a>
+</p>
 
-**运行**
+https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
 
-```
-pnpm dev
-```
+## 🛸 在线使用
 
-## 部署
+- 🌐 国内版：[ai.fastgpt.in](https://ai.fastgpt.in/)
+- 🌍 海外版：[fastgpt.run](https://fastgpt.run/)
 
-### 代理环境（国外服务器可忽略）
+|                                    |                                    |
+| ---------------------------------- | ---------------------------------- |
+| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
+| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
 
-1. [clash 方案](./docs/proxy/clash.md) - 仅需一台服务器（需要有 clash）
-2. [nginx 方案](./docs/proxy/nginx.md) - 需要一台国外服务器
-3. [cloudflare 方案](./docs/proxy/cloudflare.md) - 需要有域名（每日免费 10w 次代理请求）
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-### docker 部署
+## 💡 功能
 
-#### 1. 安装 docker 和 docker-compose
+1. 强大的可视化编排，轻松构建 AI 应用
+   - [x] 提供简易模式，无需操作编排
+   - [x] 用户对话前引导，全局字符串变量
+   - [x] 知识库搜索
+   - [x] 多 LLM 模型对话
+   - [x] 文本内容提取成结构化数据
+   - [x] HTTP 扩展
+   - [ ] 嵌入 Laf，实现在线编写 HTTP 模块
+   - [x] 对话下一步指引
+   - [ ] 对话多路线选择
+   - [x] 源文件引用追踪
+   - [x] 模块封装，实现多级复用
+2. 丰富的知识库预处理
+   - [x] 多库复用，混用
+   - [x] chunk 记录修改和删除
+   - [x] 支持手动输入，直接分段，QA 拆分导入
+   - [x] 支持 url 读取、CSV 批量导入
+   - [x] 支持知识库单独设置向量模型
+   - [x] 源文件存储
+   - [ ] 文件学习 Agent
+3. 多种效果测试渠道
+   - [x] 知识库单点搜索测试
+   - [x] 对话时反馈引用并可修改与删除
+   - [x] 完整上下文呈现
+   - [x] 完整模块中间值呈现
+4. OpenAPI
+   - [x] completions 接口 (对齐 GPT 接口)
+   - [ ] 知识库 CRUD
+5. 运营功能
+   - [x] 免登录分享窗口
+   - [x] Iframe 一键嵌入
+   - [x] 统一查阅对话记录，并对数据进行标注
 
-这个不同系统略有区别，百度安装下。验证安装成功后进行下一步。下面给出一个例子：
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-```bash
-# 安装docker
-curl -L https://get.daocloud.io/docker | sh
-sudo systemctl start docker
-# 安装 docker-compose
-curl -L https://github.com/docker/compose/releases/download/1.23.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
-sudo chmod +x /usr/local/bin/docker-compose
-# 验证安装
-docker -v
-docker-compose -v
-```
+## 👨‍💻 开发
 
-#### 2. 创建 3 个初始化文件
+项目技术栈：NextJs + TS + ChakraUI + Mongo + Postgres (Vector 插件)
 
-手动创建或者直接把 deploy 里内容复制过去
+- **⚡ 快速部署**
 
-**/root/fast-gpt/pg/init.sql**
+  > Sealos 的服务器在国外，不需要额外处理网络问题，无需服务器、无需魔法、无需域名，支持高并发 & 动态伸缩。点击以下按钮即可一键部署 👇
 
-```sql
-set -e
-psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
+  [![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt)
 
-CREATE EXTENSION vector;
--- init table
-CREATE TABLE modelData (
-    id BIGSERIAL PRIMARY KEY,
-    vector VECTOR(1536),
-    status VARCHAR(50) NOT NULL,
-    user_id VARCHAR(50) NOT NULL,
-    model_id VARCHAR(50) NOT NULL,
-    q TEXT NOT NULL,
-    a TEXT NOT NULL
-);
--- create index
-CREATE INDEX modelData_status_index ON modelData USING HASH (status);
-CREATE INDEX modelData_userId_index ON modelData USING HASH (user_id);
-CREATE INDEX modelData_modelId_index ON modelData USING HASH (model_id);
-EOSQL
-```
+  由于需要部署数据库，部署完后需要等待 2~4 分钟才能正常访问。默认用了最低配置，首次访问时会有些慢。
 
-**/root/fast-gpt/nginx/nginx.conf**
+* [快开始本地开发](https://doc.fastgpt.in/docs/development/intro/)
+* [部署 FastGPT](https://doc.fastgpt.in/docs/installation)
+* [系统配置文件说明](https://doc.fastgpt.in/docs/development/configuration/)
+* [多模型配置](https://doc.fastgpt.in/docs/installation/one-api/)
+* [版本更新/升级介绍](https://doc.fastgpt.in/docs/installation/upgrading)
+* [OpenAPI API 文档](https://doc.fastgpt.in/docs/development/openapi/)
+* [知识库结构详解](https://doc.fastgpt.in/docs/use-cases/datasetengine/)
 
-```conf
-user nginx;
-worker_processes auto;
-worker_rlimit_nofile 51200;
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-events {
-    worker_connections 1024;
-}
+## 🏘️ 社区交流群
 
-http {
-    resolver 8.8.8.8;
-    proxy_ssl_server_name on;
+添加 wx 小助手加入：
 
-    access_log off;
-    server_names_hash_bucket_size 512;
-    client_header_buffer_size 64k;
-    large_client_header_buffers 4 64k;
-    client_max_body_size 50M;
+![](https://otnvvf-imgs.oss.laf.run/wx300.jpg)
 
-    proxy_connect_timeout       240s;
-    proxy_read_timeout          240s;
-    proxy_buffer_size 128k;
-    proxy_buffers 4 256k;
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-    gzip  on;
-    gzip_min_length   1k;
-    gzip_buffers  4 8k;
-    gzip_http_version 1.1;
-    gzip_comp_level 6;
-    gzip_vary on;
-    gzip_types  text/plain application/x-javascript text/css application/javascript application/json application/xml;
-    gzip_disable "MSIE [1-6]\.";
+## 💪 相关项目
 
-    open_file_cache max=1000 inactive=1d;
-    open_file_cache_valid 30s;
-    open_file_cache_min_uses 8;
-    open_file_cache_errors off;
+- [Laf：3 分钟快速接入三方应用](https://github.com/labring/laf)
+- [Sealos：快速部署集群应用](https://github.com/labring/sealos)
+- [One API：多模型管理，支持 Azure、文心一言等](https://github.com/songquanpeng/one-api)
+- [TuShan：5 分钟搭建后台管理系统](https://github.com/msgbyte/tushan)
 
-    server {
-        listen 443 ssl;
-        server_name docgpt.ahapocket.cn;
-        ssl_certificate /ssl/docgpt.pem;
-        ssl_certificate_key /ssl/docgpt.key;
-        ssl_session_timeout 5m;
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-        location / {
-            proxy_pass http://localhost:3000;
-            proxy_set_header Host $host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        }
-    }
-    server {
-        listen 80;
-        server_name docgpt.ahapocket.cn;
-        rewrite ^(.*) https://$server_name$1 permanent;
-    }
-}
-```
+## 👀 其他
 
-**/root/fast-gpt/docker-compose.yml**
+- [保姆级 FastGPT 教程](https://www.bilibili.com/video/BV1n34y1A7Bo/?spm_id_from=333.999.0.0)
+- [接入飞书](https://www.bilibili.com/video/BV1Su4y1r7R3/?spm_id_from=333.999.0.0)
+- [接入企微](https://www.bilibili.com/video/BV1Tp4y1n72T/?spm_id_from=333.999.0.0)
 
-```yml
-version: '3.3'
-services:
-  fast-gpt:
-    image: c121914yu/fast-gpt:latest
-    network_mode: host
-    restart: always
-    container_name: fast-gpt
-    environment:
-      # - AXIOS_PROXY_HOST=127.0.0.1
-      # - AXIOS_PROXY_PORT=7890
-      # - OPENAI_BASE_URL=https://api.openai.com/v1
-      # - OPENAI_BASE_URL_AUTH=可选的安全凭证
-      - MY_MAIL=xxxx@qq.com
-      - MAILE_CODE=xxxx
-      - aliAccessKeyId=xxxx
-      - aliAccessKeySecret=xxxx
-      - aliSignName=xxxxx
-      - aliTemplateCode=SMS_xxxx
-      - TOKEN_KEY=xxxx
-      - queueTask=1
-      - parentUrl=https://hostname/api/openapi/startEvents
-      - MONGODB_URI=mongodb://username:passsword@0.0.0.0:27017/?authSource=admin
-      - MONGODB_NAME=xxx
-      - PG_HOST=0.0.0.0
-      - PG_PORT=8100
-      - PG_USER=fastgpt
-      - PG_PASSWORD=1234
-      - PG_DB_NAME=fastgpt
-      - OPENAIKEY=sk-xxxxx
-  nginx:
-    image: nginx:alpine3.17
-    container_name: nginx
-    restart: always
-    network_mode: host
-    volumes:
-      - /root/fast-gpt/nginx/nginx.conf:/etc/nginx/nginx.conf:ro
-      - /root/fast-gpt/nginx/logs:/var/log/nginx
-      - /root/fast-gpt/nginx/ssl/docgpt.key:/ssl/docgpt.key
-      - /root/fast-gpt/nginx/ssl/docgpt.pem:/ssl/docgpt.pem
-  pg:
-    image: ankane/pgvector
-    container_name: pg
-    restart: always
-    ports:
-      - 8100:5432
-    environment:
-      - POSTGRES_USER=fastgpt
-      - POSTGRES_PASSWORD=1234
-      - POSTGRES_DB=fastgpt
-    volumes:
-      - /root/fast-gpt/pg/data:/var/lib/postgresql/data
-      - /root/fast-gpt/pg/init.sql:/docker-entrypoint-initdb.d/init.sh
-      - /etc/localtime:/etc/localtime:ro
-  mongodb:
-    image: mongo:6.0.4
-    container_name: mongo
-    restart: always
-    ports:
-      - 27017:27017
-    environment:
-      - MONGO_INITDB_ROOT_USERNAME=username
-      - MONGO_INITDB_ROOT_PASSWORD=password
-    volumes:
-      - /root/fast-gpt/mongo/data:/data/db
-      - /root/fast-gpt/mongo/logs:/var/log/mongodb
-      - /etc/localtime:/etc/localtime:ro
-```
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-#### 3. 运行 docker-compose
+## 🤝 第三方生态
 
-下面是一个辅助脚本，也可以直接 docker-compose up -d
+- [OnWeChat 个人微信/企微机器人](https://doc.fastgpt.in/docs/use-cases/onwechat/)
 
-**run.sh 运行文件**
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-```bash
-#!/bin/bash
-docker-compose pull
-docker-compose up -d
+## 🌟 Star History
 
-echo "Docker Compose 重新拉取镜像完成！"
+[![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)
 
-# 删除本地旧镜像
-images=$(docker images --format "{{.ID}} {{.Repository}}" | grep fast-gpt)
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-返回顶部-7d09f1.svg" alt="#" align="right">
+</a>
 
-# 将镜像 ID 和名称放入数组中
-IFS=$'\n' read -rd '' -a image_array <<<"$images"
+## 使用协议
 
-# 遍历数组并删除所有旧的镜像
-for ((i=1; i<${#image_array[@]}; i++))
-do
-    image=${image_array[$i]}
-    image_id=${image%% *}
-    docker rmi $image_id
-done
-```
+本仓库遵循 [FastGPT Open Source License](./LICENSE) 开源协议。
 
-## 其他优化点
-
-### Git Action 自动打包镜像
-
-.github 里拥有一个 git 提交到 main 分支时自动打包 amd64 和 arm64 镜像的 actions。你仅需要提前在 git 配置好 session。
-
-1. 创建账号 session: 头像 -> settings -> 最底部 Developer settings -> Personal access tokens -> tokens(classic) -> 创建新 session，把一些看起来需要的权限勾上。
-2. 添加 session 到仓库: 仓库 -> settings -> Secrets and variables -> Actions -> 创建 secret
-3. 填写 secret: Name-GH_PAT, Secret-第一步的 tokens
-
-## 其他问题
-
-### Mac 可能的问题
-
-> 因为教程有部分镜像不兼容 arm64，所以写个文档指导新手如何快速在 mac 上面搭建 fast-gpt[如何在 mac 上面部署 fastgpt](./docs/mac.md)
+1. 允许作为后台服务直接商用，但不允许提供 SaaS 服务。
+2. 未经商业授权，任何形式的商用服务均需保留相关版权信息。
+3. 完整请查看 [FastGPT Open Source License](./LICENSE)
+4. 联系方式：yujinlong@sealos.io，[点击查看商业版定价策略](https://doc.fastgpt.in/docs/commercial)

README_en.md

@@ -0,0 +1,158 @@
+<div align="center">
+
+<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.svg" width="120" height="120" alt="fastgpt logo"></a>
+
+# FastGPT
+
+<p align="center">
+  <a href="./README_en.md">English</a> |
+  <a href="./README.md">简体中文</a>
+</p>
+
+FastGPT is a knowledge-based Q&A system built on the LLM, offers out-of-the-box data processing and model invocation capabilities, allows for workflow orchestration through Flow visualization!
+
+</div>
+
+<p align="center">
+  <a href="https://fastgpt.run/">
+    <img height="21" src="https://img.shields.io/badge/在线使用-d4eaf7?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
+  </a>
+  <a href="https://doc.fastgpt.run/docs/intro">
+    <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
+  </a>
+  <a href="https://doc.fastgpt.run/docs/development">
+    <img height="21" src="https://img.shields.io/badge/本地开发-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
+  </a>
+  <a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
+    <img height="21" src="https://img.shields.io/badge/相关项目-7d09f1?style=flat-square" alt="project">
+  </a>
+  <a href="https://github.com/labring/FastGPT/blob/main/LICENSE">
+    <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=7d09f1" alt="license">
+  </a>
+</p>
+
+https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
+
+## 🛸 Use Cloud Services
+
+[fastgpt.run](https://fastgpt.run/)
+| | |
+| ---------------------------------- | ---------------------------------- |
+| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
+| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 💡 Features
+
+1. Powerful visual workflows: Effortlessly craft AI applications
+
+   - [x] Simple mode on deck - no need for manual arrangement
+   - [x] User dialogue pre-guidance
+   - [x] Global variables
+   - [x] Knowledge base search
+   - [x] Dialogue via multiple LLM models
+   - [x] Text magic - convert to structured data
+   - [x] Extend with HTTP
+   - [ ] Embed Laf for on-the-fly HTTP module crafting
+   - [x] Directions for the next dialogue steps
+   - [x] Tracking source file references
+   - [ ] Custom file reader
+   - [ ] Modules are packaged into plug-ins to achieve reuse
+
+2. Extensive knowledge base preprocessing
+
+   - [x] Reuse and mix multiple knowledge bases
+   - [x] Track chunk modifications and deletions
+   - [x] Supports manual entries, direct segmentation, and QA split imports
+   - [x] Supports URL fetching and batch CSV imports
+   - [x] Supports Set unique vector models for knowledge bases
+   - [x] Store original files
+   - [ ] File learning Agent
+
+3. Multiple effect testing channels
+
+   - [x] Single-point knowledge base search test
+   - [x] Feedback references and ability to modify and delete during dialogue
+   - [x] Complete context presentation
+   - [ ] Complete module intermediate value presentation
+
+4. OpenAPI
+
+   - [x] completions interface (aligned with GPT interface)
+   - [ ] Knowledge base CRUD
+
+5. Operational functions
+
+   - [x] Login-free sharing window
+   - [x] One-click embedding with Iframe
+   - [ ] Unified access to dialogue records
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 👨‍💻 Development
+
+Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
+
+- **⚡ Deployment**
+
+  [![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt)
+
+  Give it a 2-4 minute wait after deployment as it sets up the database. Initially, it might be a tad slow since we're using the basic settings.
+
+- [Getting Started with Local Development](https://doc.fastgpt.run/docs/development)
+- [Deploying FastGPT](https://doc.fastgpt.run/docs/installation)
+- [Guide on System Configs](https://doc.fastgpt.run/docs/installation/reference)
+- [Configuring Multiple Models](https://doc.fastgpt.run/docs/installation/reference/models)
+- [Version Updates & Upgrades](https://doc.fastgpt.run/docs/installation/upgrading)
+
+<!-- ## :point_right: RoadMap
+- [FastGPT RoadMap](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) -->
+
+<!-- ## 🏘️ Community
+
+| Community Group                                   | Assistant                                      |
+| ------------------------------------------------- | ---------------------------------------------- |
+| ![](https://otnvvf-imgs.oss.laf.run/wxqun300.jpg) | ![](https://otnvvf-imgs.oss.laf.run/wx300.jpg) | -->
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 👀 Others
+
+- [FastGPT FAQ](https://kjqvjse66l.feishu.cn/docx/HtrgdT0pkonP4kxGx8qcu6XDnGh)
+- [Docker Deployment Tutorial Video](https://www.bilibili.com/video/BV1jo4y147fT/)
+- [Official Account Integration Video Tutorial](https://www.bilibili.com/video/BV1xh4y1t7fy/)
+- [FastGPT Knowledge Base Demo](https://www.bilibili.com/video/BV1Wo4y1p7i1/)
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 💪 Related Projects
+
+- [Laf: 3-minute quick access to third-party applications](https://github.com/labring/laf)
+- [Sealos: Rapid deployment of cluster applications](https://github.com/labring/sealos)
+- [One API: Multi-model management, supports Azure, Wenxin Yiyuan, etc.](https://github.com/songquanpeng/one-api)
+- [TuShan: Build a backend management system in 5 minutes](https://github.com/msgbyte/tushan)
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 🤝 Third-party Ecosystem
+
+- [luolinAI: Enterprise WeChat bot, ready to use](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot)
+
+<a href="#readme">
+    <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right">
+</a>
+
+## 🌟 Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=labring/FastGPT&type=Date)](https://star-history.com/#labring/FastGPT&Date)

deploy/docker-compose.yml

@@ -1,66 +0,0 @@
-version: '3.3'
-services:
-  fast-gpt:
-    image: c121914yu/fast-gpt:latest
-    network_mode: host
-    restart: always
-    container_name: fast-gpt
-    environment:
-      # - AXIOS_PROXY_HOST=127.0.0.1
-      # - AXIOS_PROXY_PORT=7890
-      # - OPENAI_BASE_URL=https://api.openai.com/v1
-      # - OPENAI_BASE_URL_AUTH=可选的安全凭证
-      - MY_MAIL=xxxx@qq.com
-      - MAILE_CODE=xxxx
-      - aliAccessKeyId=xxxx
-      - aliAccessKeySecret=xxxx
-      - aliSignName=xxxxx
-      - aliTemplateCode=SMS_xxxx
-      - TOKEN_KEY=xxxx
-      - queueTask=1
-      - parentUrl=https://hostname/api/openapi/startEvents
-      - MONGODB_URI=mongodb://username:passsword@0.0.0.0:27017/?authSource=admin
-      - MONGODB_NAME=xxx
-      - PG_HOST=0.0.0.0
-      - PG_PORT=8100
-      - PG_USER=xxx
-      - PG_PASSWORD=xxx
-      - PG_DB_NAME=xxx
-      - OPENAIKEY=sk-xxxxx
-  nginx:
-    image: nginx:alpine3.17
-    container_name: nginx
-    restart: always
-    network_mode: host
-    volumes:
-      - /root/fast-gpt/nginx/nginx.conf:/etc/nginx/nginx.conf:ro
-      - /root/fast-gpt/nginx/logs:/var/log/nginx
-      - /root/fast-gpt/nginx/ssl/docgpt.key:/ssl/docgpt.key
-      - /root/fast-gpt/nginx/ssl/docgpt.pem:/ssl/docgpt.pem
-  pg:
-    image: ankane/pgvector
-    container_name: pg
-    restart: always
-    ports:
-      - 8100:5432
-    environment:
-      - POSTGRES_USER=xxx
-      - POSTGRES_PASSWORD=xxx
-      - POSTGRES_DB=xxx
-    volumes:
-      - /root/fast-gpt/pg/data:/var/lib/postgresql/data
-      - /root/fast-gpt/pg/init.sql:/docker-entrypoint-initdb.d/init.sh
-      - /etc/localtime:/etc/localtime:ro
-  mongodb:
-    image: mongo:6.0.4
-    container_name: mongo
-    restart: always
-    ports:
-      - 27017:27017
-    environment:
-      - MONGO_INITDB_ROOT_USERNAME=username
-      - MONGO_INITDB_ROOT_PASSWORD=password
-    volumes:
-      - /root/fast-gpt/mongo/data:/data/db
-      - /root/fast-gpt/mongo/logs:/var/log/mongodb
-      - /etc/localtime:/etc/localtime:ro

deploy/docker-compose/init.sh

@@ -1 +0,0 @@
-sudo chmod +x /usr/local/bin/docker-compose

deploy/nginx/nginx.conf

@@ -1,57 +0,0 @@
-user nginx;
-worker_processes auto;
-worker_rlimit_nofile 51200;
-
-events {
-    worker_connections 1024;
-}
-
-http {
-    resolver 8.8.8.8;
-    proxy_ssl_server_name on;
-
-    access_log off;
-    server_names_hash_bucket_size 512;
-    client_header_buffer_size 64k;
-    large_client_header_buffers 4 64k;
-    client_max_body_size 50M;
-
-    proxy_connect_timeout       240s;
-    proxy_read_timeout          240s;
-    proxy_buffer_size 128k;
-    proxy_buffers 4 256k;
- 
-    gzip  on;
-    gzip_min_length   1k;
-    gzip_buffers  4 8k;
-    gzip_http_version 1.1;
-    gzip_comp_level 6;
-    gzip_vary on;
-    gzip_types  text/plain application/x-javascript text/css application/javascript application/json application/xml;
-    gzip_disable "MSIE [1-6]\.";
-
-    open_file_cache max=1000 inactive=1d;
-    open_file_cache_valid 30s;
-    open_file_cache_min_uses 8;
-    open_file_cache_errors off;
-
-    server {
-        listen 443 ssl;
-        server_name docgpt.ahapocket.cn;
-        ssl_certificate /ssl/docgpt.pem;
-        ssl_certificate_key /ssl/docgpt.key;
-        ssl_session_timeout 5m;
-
-        location / {
-            proxy_pass http://localhost:3000;
-            proxy_set_header Host $host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;        
-        }
-    }
-    server {
-        listen 80;
-        server_name docgpt.ahapocket.cn;
-        rewrite ^(.*) https://$server_name$1 permanent;
-    }
-}

deploy/pg/init.sql

@@ -1,19 +0,0 @@
-set -e
-psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
-
-CREATE EXTENSION vector;
--- init table
-CREATE TABLE modelData (
-    id BIGSERIAL PRIMARY KEY,
-    vector VECTOR(1536),
-    status VARCHAR(50) NOT NULL,
-    user_id VARCHAR(50) NOT NULL,
-    model_id VARCHAR(50) NOT NULL,
-    q TEXT NOT NULL,
-    a TEXT NOT NULL
-);
--- create index
-CREATE INDEX modelData_status_index ON modelData USING HASH (status);
-CREATE INDEX modelData_userId_index ON modelData USING HASH (user_id);
-CREATE INDEX modelData_modelId_index ON modelData USING HASH (model_id);
-EOSQL

docSite/.zhlintignore

@@ -0,0 +1 @@
+*.html

docSite/.zhlintrc

@@ -0,0 +1,6 @@
+{
+  "preset": "default",
+  "rules": {
+    "adjustedFullWidthPunctuation": ""
+  }
+}

docSite/Dockerfile

@@ -0,0 +1,12 @@
+FROM hugomods/hugo:0.117.0 AS builder
+
+WORKDIR /app
+
+ADD ./docSite hugo
+RUN cd /app/hugo && hugo mod get -u github.com/colinwilson/lotusdocs && hugo -v --minify
+
+FROM fholzer/nginx-brotli:latest
+
+LABEL org.opencontainers.image.source https://github.com/labring/FastGPT
+
+COPY --from=builder /app/hugo/public /usr/share/nginx/html

docSite/README.md

@@ -0,0 +1,9 @@
+# 文档
+
+## 本地运行
+
+1. 安装 go 语言环境。
+2. 安装 hugo。[二进制下载](https://github.com/gohugoio/hugo/releases/tag/v0.117.0)，注意需要安装 extended 版本。
+3. cd docSite
+4. hugo serve
+5. 访问 http://localhost:1313

docSite/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

docSite/assets/docs/scss/custom/pages/_custom.scss

@@ -0,0 +1,145 @@
+.docs-content .main-content img, .docs-content .main-content  svg:not(.gitinfo svg):not(a svg) {
+    max-width: 80% !important;
+    height: auto;
+    display: block !important;
+    margin: 0 auto !important;
+    border-radius: .25rem;
+}
+
+div.code-toolbar {
+    padding-top: 1.95rem !important;
+}
+
+.docs-content .main-content pre code::before {
+    background: #fc625d;
+    border-radius: 50%;
+    box-shadow: 20px 0 #fdbc40, 40px 0 #35cd4b;
+    content: ' ';
+    height: 12px;
+    left: 12px;
+    margin-top: -21px;
+    position: absolute;
+    width: 12px;
+    z-index: 1;
+}
+
+li p {
+    margin-top: 1rem !important;
+    margin-bottom: 1rem;
+}
+
+footer {
+	height: 118px !important;
+}
+
+/*
+footer a:hover {
+    text-decoration: none !important;
+}
+*/
+
+.medium-zoom-overlay,
+.medium-zoom-image--opened {
+  z-index: 1999;
+}
+
+/* 徽章样式 */
+.github-badge {
+	display: inline-block;
+	border-radius: 4px;
+	text-shadow: none;
+	font-size: 12px;
+	color: #fff;
+	line-height: 15px;
+    margin-bottom: 5px;
+    margin-top: 5px;
+}
+.github-badge .badge-subject {
+	display: inline-block;
+	background-color: #4D4D4D;
+	padding: 4px 4px 4px 6px;
+	border-top-left-radius: 4px;
+	border-bottom-left-radius: 4px;
+}
+.github-badge .badge-value {
+	display: inline-block;
+	padding: 4px 6px 4px 4px;
+	border-top-right-radius: 4px;
+	border-bottom-right-radius: 4px;
+}
+.github-badge .bg-brightgreen {
+	background-color: #4DC820 !important;
+}
+.github-badge .bg-orange {
+	background-color: #FFA500 !important;
+}
+.github-badge .bg-yellow {
+	background-color: #D8B024 !important;
+}
+.github-badge .bg-blueviolet {
+	background-color: #8833D7 !important;
+}
+.github-badge .bg-pink {
+	background-color: #F26BAE !important;
+}
+.github-badge .bg-red {
+	background-color: #e05d44 !important;
+}
+.github-badge .bg-blue {
+	background-color: #007EC6 !important;
+}
+.github-badge .bg-lightgrey {
+	background-color: #9F9F9F !important;
+}
+.github-badge .bg-grey, .github-badge .bg-gray {
+	background-color: #555 !important;
+}
+.github-badge .bg-lightgrey, .github-badge .bg-lightgray {
+	background-color: #9f9f9f !important;
+}
+
+#fixed-box {
+	position: fixed;
+	z-index: 9999;
+}
+
+@media (max-width: 600px) {
+	#fixed-box {
+		display: none
+	}
+}
+
+.feedback-btn-wrapper {
+	position: fixed;
+	z-index: 1000;
+	bottom: 0;
+	left: 0;
+	margin: 2rem;
+}
+#feedback-btn {
+	height: 30px;
+	display: flex;
+	align-items: center;
+	padding: 1.2rem 0.7rem;
+	border-radius: 0.4rem;
+	cursor: pointer;
+	box-shadow: 0 10px 15px -3px rgba(0, 0, 0, 0.1),
+	  0 4px 6px -2px rgba(0, 0, 0, 0.05);
+	user-select: none;
+	border: 0;
+	outline: 0;
+	color: #fff;
+	background-color: #4d698e;
+	transition: filter 0.4s ease;
+}
+
+#feedback-btn svg {
+	width: 1.25rem;
+	height: 1.25rem;
+}
+
+#feedback-btn span {
+	font-weight: 700;
+	font-size: 1rem;
+	margin-left: 0.5rem;
+}

docSite/assets/docs/scss/style.scss

@@ -0,0 +1,77 @@
+/* Template Name: Lotus Docs
+   Author: Colin Wilson
+   E-mail: colin@aigis.uk
+   Created: October 2022
+   Version: 1.2.0
+   File Description: Main CSS file for Lotus Docs
+*/
+
+// Custom Font Variables
+$font-family-secondary:  {{ .Site.Params.secondary_font | default "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Helvetica Neue', 'Ubuntu'" }};
+$font-family-sans-serif: {{ .Site.Params.sans_serif_font | default "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Helvetica Neue', 'Ubuntu'" }};
+$font-family-monospace:  {{ .Site.Params.mono_font | default "SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace" }};
+
+// Code Padding Variables
+$code-block-padding-top: {{ if eq .Site.Params.docs.prism true -}}0{{ else }}1.25rem 0 0 0{{ end }};
+
+// Icon Fonts
+@import "custom/plugins/icons/google-material";
+
+// Core files
+@import "../../scss/bootstrap/functions";
+@import "../../scss/bootstrap/variables";
+@import {{ printf "'%s%s'" "custom/colors/" (.Site.Params.docs.themeColor | default "blue") }}; // current theme color
+@import "../../scss/bootstrap/mixins";
+@import "../../scss/bootstrap/bootstrap";
+@import "variables";
+
+{{ if and (.Site.Params.docsearch.appID) (.Site.Params.docsearch.apiKey) -}}
+@import "custom/plugins/docsearch/style";
+{{ end }}
+
+// Structure
+@import "custom/structure/general";
+@import "custom/structure/content";
+@import "custom/structure/sidebar";
+@import "custom/structure/doc-nav";
+@import "custom/structure/toc";
+@import "custom/structure/footer";
+
+// Components
+@import "custom/components/buttons";
+@import "custom/components/modal";
+@import "custom/components/breadcrumb";
+@import "custom/components/badge";
+@import "custom/components/backgrounds";
+@import "custom/components/alerts";
+@import "custom/components/card";
+@import "custom/components/forms";
+@import "custom/components/table";
+@import "custom/components/tabs";
+@import "custom/components/tooltip";
+
+// Pages
+@import "custom/pages/features";
+@import "custom/pages/helper";
+
+// Plugins
+
+// Prism / Chroma
+{{- if eq .Site.Params.docs.prism true }}
+@import {{ printf "'%s%s'" "custom/plugins/prism/themes/" (.Site.Params.docs.prismTheme | default "lotusdocs") }}; // current prism theme
+@import "custom/plugins/prism/prism";
+{{- else }}
+@import "custom/plugins/chroma/default";
+{{- end -}}
+
+// FlexSearch
+{{ if or (not (isset .Site.Params.flexsearch "enabled")) (eq .Site.Params.flexsearch.enabled true) -}}@import "custom/plugins/flexsearch/flexsearch";{{ end }}
+
+// Feedback Widget
+{{ if .Site.Params.feedback.enabled | default false -}}@import "custom/plugins/feedback/feedback";{{ end}}
+
+// Mermaid
+@import "custom/plugins/mermaid/mermaid";
+
+// change
+@import "custom/pages/custom";

docSite/assets/images/logos/logo.svg

@@ -0,0 +1,14 @@
+<svg width="26" height="26" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M340.837 0.33933L681.068 0.338989V0.455643C684.032 0.378397 686.999 0.339702 689.967 0.339702C735.961 0.3397 781.504 9.62899 823.997 27.6772C866.49 45.7254 905.099 72.1791 937.622 105.528C970.144 138.877 995.942 178.467 1013.54 222.04C1031.14 265.612 1040.2 312.312 1040.2 359.474L340.836 359.474L340.836 1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49C169.357 1302.43 131.85 1275.95 100.257 1242.58C68.6636 1209.21 43.6023 1169.59 26.5041 1125.99C11.3834 1087.43 2.75216 1046.42 0.957956 1004.81H0.605869L0.605897 368.098H0.70363C0.105752 341.831 2.23741 315.443 7.14306 289.411C20.2709 219.745 52.6748 155.754 100.257 105.528C147.839 55.3017 208.462 21.0975 274.461 7.24017C296.426 2.62833 318.657 0.339101 340.837 0.33933Z" fill="url(#paint0_linear_1172_228)"/>
+<path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37C799.997 617.874 836.384 642.064 867.033 672.559C897.683 703.054 921.996 739.257 938.583 779.101C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645Z" fill="url(#paint1_linear_1172_228)"/>
+<defs>
+<linearGradient id="paint0_linear_1172_228" x1="520.404" y1="0.338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+<linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+</defs>
+</svg>

docSite/assets/images/logos/mark.svg

@@ -0,0 +1,14 @@
+<svg width="26" height="26" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M340.837 0.33933L681.068 0.338989V0.455643C684.032 0.378397 686.999 0.339702 689.967 0.339702C735.961 0.3397 781.504 9.62899 823.997 27.6772C866.49 45.7254 905.099 72.1791 937.622 105.528C970.144 138.877 995.942 178.467 1013.54 222.04C1031.14 265.612 1040.2 312.312 1040.2 359.474L340.836 359.474L340.836 1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49C169.357 1302.43 131.85 1275.95 100.257 1242.58C68.6636 1209.21 43.6023 1169.59 26.5041 1125.99C11.3834 1087.43 2.75216 1046.42 0.957956 1004.81H0.605869L0.605897 368.098H0.70363C0.105752 341.831 2.23741 315.443 7.14306 289.411C20.2709 219.745 52.6748 155.754 100.257 105.528C147.839 55.3017 208.462 21.0975 274.461 7.24017C296.426 2.62833 318.657 0.339101 340.837 0.33933Z" fill="url(#paint0_linear_1172_228)"/>
+<path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37C799.997 617.874 836.384 642.064 867.033 672.559C897.683 703.054 921.996 739.257 938.583 779.101C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645Z" fill="url(#paint1_linear_1172_228)"/>
+<defs>
+<linearGradient id="paint0_linear_1172_228" x1="520.404" y1="0.338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+<linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse">
+<stop stop-color="#326DFF"/>
+<stop offset="1" stop-color="#8EAEFF"/>
+</linearGradient>
+</defs>
+</svg>

docSite/assets/images/social/wechat.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="28" height="28" viewBox="0 0 28 28" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+<title>微信群</title>
+<path d="M21.6696 15.9962C21.9464 15.9925 22.2107 15.881 22.4064 15.6853C22.6021 15.4896 22.7137 15.2252 22.7173 14.9485C22.7173 14.3675 22.2518 13.9008 21.6696 13.9008C21.0875 13.9008 20.622 14.3675 20.622 14.9485C20.622 15.5318 21.0886 15.9962 21.6696 15.9962ZM16.5071 15.9962C16.7839 15.9925 17.0482 15.881 17.2439 15.6853C17.4396 15.4896 17.5512 15.2252 17.5548 14.9485C17.5548 14.3675 17.0881 13.9008 16.5071 13.9008C15.9238 13.9008 15.4595 14.3675 15.4595 14.9485C15.4595 15.5318 15.925 15.9962 16.5071 15.9962ZM24.1686 21.8762C24.0939 21.9177 24.0342 21.9818 23.9981 22.0594C23.9621 22.1369 23.9515 22.2239 23.968 22.3078C23.968 22.3638 23.968 22.421 23.9971 22.4793C24.1115 22.9658 24.3401 23.7405 24.3401 23.7697C24.3401 23.8548 24.3693 23.912 24.3693 23.9703C24.3693 24.0041 24.3626 24.0376 24.3496 24.0688C24.3367 24.1 24.3177 24.1284 24.2937 24.1522C24.2697 24.1761 24.2413 24.195 24.21 24.2078C24.1788 24.2206 24.1453 24.2272 24.1115 24.227C24.0531 24.227 24.0251 24.199 23.968 24.171L22.2775 23.1957C22.154 23.1277 22.0168 23.0886 21.8761 23.0813C21.791 23.0813 21.7046 23.0813 21.6475 23.1093C20.8448 23.3392 20.0141 23.4535 19.1263 23.4535C14.8563 23.4535 11.4181 20.587 11.4181 17.031C11.4181 13.4762 14.8563 10.6085 19.1263 10.6085C23.3951 10.6085 26.8333 13.4762 26.8333 17.031C26.8333 18.9525 25.802 20.7013 24.1686 21.8773V21.8762ZM19.4518 9.44883C19.3429 9.44521 19.234 9.44327 19.1251 9.443C14.2555 9.443 10.2515 12.7797 10.2515 17.0322C10.2515 17.6785 10.3448 18.3038 10.5175 18.8988H10.4136C9.39426 18.8885 8.38067 18.7442 7.39896 18.4695C7.31263 18.4403 7.22629 18.4403 7.13996 18.4403C6.96754 18.444 6.79921 18.4935 6.65229 18.5838L4.61296 19.7563C4.55463 19.7855 4.49746 19.8147 4.44029 19.8147C4.35703 19.8138 4.27744 19.7803 4.21856 19.7214C4.15968 19.6625 4.1262 19.5829 4.12529 19.4997C4.12529 19.4133 4.15329 19.3562 4.18246 19.2698C4.21046 19.2418 4.46946 18.2968 4.61296 17.7252C4.61296 17.6668 4.64096 17.5817 4.64096 17.5245C4.64065 17.4245 4.61721 17.3259 4.57248 17.2364C4.52775 17.147 4.46295 17.0691 4.38313 17.0088C2.40096 15.6053 1.16663 13.517 1.16663 11.1977C1.16663 6.93583 5.33163 3.5 10.4416 3.5C14.8341 3.5 18.5266 6.0305 19.4518 9.44767V9.44883ZM13.4388 9.9365C14.1073 9.9365 14.6358 9.38 14.6358 8.7395C14.6358 8.071 14.1073 7.5425 13.4388 7.5425C12.7703 7.5425 12.2418 8.071 12.2418 8.7395C12.2418 9.408 12.7703 9.9365 13.4388 9.9365ZM7.30213 9.9365C7.97063 9.9365 8.50029 9.38 8.50029 8.7395C8.50029 8.071 7.97063 7.5425 7.30213 7.5425C6.63479 7.5425 6.10513 8.071 6.10513 8.7395C6.10513 9.408 6.63479 9.9365 7.30213 9.9365Z"/>
+</svg>

docSite/assets/images/social/wechat1.svg

@@ -0,0 +1,10 @@
+<svg width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_280_54)">
+<path d="M21.6696 15.9962C21.9464 15.9925 22.2107 15.881 22.4064 15.6853C22.6021 15.4896 22.7137 15.2252 22.7173 14.9485C22.7173 14.3675 22.2518 13.9008 21.6696 13.9008C21.0875 13.9008 20.622 14.3675 20.622 14.9485C20.622 15.5318 21.0886 15.9962 21.6696 15.9962ZM16.5071 15.9962C16.7839 15.9925 17.0482 15.881 17.2439 15.6853C17.4396 15.4896 17.5512 15.2252 17.5548 14.9485C17.5548 14.3675 17.0881 13.9008 16.5071 13.9008C15.9238 13.9008 15.4595 14.3675 15.4595 14.9485C15.4595 15.5318 15.925 15.9962 16.5071 15.9962ZM24.1686 21.8762C24.0939 21.9177 24.0342 21.9818 23.9981 22.0594C23.9621 22.1369 23.9515 22.2239 23.968 22.3078C23.968 22.3638 23.968 22.421 23.9971 22.4793C24.1115 22.9658 24.3401 23.7405 24.3401 23.7697C24.3401 23.8548 24.3693 23.912 24.3693 23.9703C24.3693 24.0041 24.3626 24.0376 24.3496 24.0688C24.3367 24.1 24.3177 24.1284 24.2937 24.1522C24.2697 24.1761 24.2413 24.195 24.21 24.2078C24.1788 24.2206 24.1453 24.2272 24.1115 24.227C24.0531 24.227 24.0251 24.199 23.968 24.171L22.2775 23.1957C22.154 23.1277 22.0168 23.0886 21.8761 23.0813C21.791 23.0813 21.7046 23.0813 21.6475 23.1093C20.8448 23.3392 20.0141 23.4535 19.1263 23.4535C14.8563 23.4535 11.4181 20.587 11.4181 17.031C11.4181 13.4762 14.8563 10.6085 19.1263 10.6085C23.3951 10.6085 26.8333 13.4762 26.8333 17.031C26.8333 18.9525 25.802 20.7013 24.1686 21.8773V21.8762ZM19.4518 9.44883C19.3429 9.44521 19.234 9.44327 19.1251 9.443C14.2555 9.443 10.2515 12.7797 10.2515 17.0322C10.2515 17.6785 10.3448 18.3038 10.5175 18.8988H10.4136C9.39426 18.8885 8.38067 18.7442 7.39896 18.4695C7.31263 18.4403 7.22629 18.4403 7.13996 18.4403C6.96754 18.444 6.79921 18.4935 6.65229 18.5838L4.61296 19.7563C4.55463 19.7855 4.49746 19.8147 4.44029 19.8147C4.35703 19.8138 4.27744 19.7803 4.21856 19.7214C4.15968 19.6625 4.1262 19.5829 4.12529 19.4997C4.12529 19.4133 4.15329 19.3562 4.18246 19.2698C4.21046 19.2418 4.46946 18.2968 4.61296 17.7252C4.61296 17.6668 4.64096 17.5817 4.64096 17.5245C4.64065 17.4245 4.61721 17.3259 4.57248 17.2364C4.52775 17.147 4.46295 17.0691 4.38313 17.0088C2.40096 15.6053 1.16663 13.517 1.16663 11.1977C1.16663 6.93583 5.33163 3.5 10.4416 3.5C14.8341 3.5 18.5266 6.0305 19.4518 9.44767V9.44883ZM13.4388 9.9365C14.1073 9.9365 14.6358 9.38 14.6358 8.7395C14.6358 8.071 14.1073 7.5425 13.4388 7.5425C12.7703 7.5425 12.2418 8.071 12.2418 8.7395C12.2418 9.408 12.7703 9.9365 13.4388 9.9365ZM7.30213 9.9365C7.97063 9.9365 8.50029 9.38 8.50029 8.7395C8.50029 8.071 7.97063 7.5425 7.30213 7.5425C6.63479 7.5425 6.10513 8.071 6.10513 8.7395C6.10513 9.408 6.63479 9.9365 7.30213 9.9365Z" fill="#2CE25E"/>
+</g>
+<defs>
+<clipPath id="clip0_280_54">
+<rect width="28" height="28" fill="white"/>
+</clipPath>
+</defs>
+</svg>