Skip to content

Commit

Permalink
📝 docs: Update docs to fit next RSC (#1939)
Browse files Browse the repository at this point in the history
* 📝 docs: Update docs to fit next rsc

* 📝 docs: Replace links

* chore: fix i18n config

* 📝 docs: update seo
  • Loading branch information
canisminor1990 authored Apr 10, 2024
1 parent 975d125 commit e97f62f
Show file tree
Hide file tree
Showing 110 changed files with 1,564 additions and 272 deletions.
20 changes: 13 additions & 7 deletions .i18nrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,26 @@ module.exports = defineConfig({
'vi-VN',
],
temperature: 0,
modelName: 'gpt-3.5-turbo-1106',
modelName: 'gpt-3.5-turbo-0125',
splitToken: 1024,
experimental: {
jsonMode: true,
},
reference: '你需要保持 mdx 的组件格式,输出文本不需要在最外层包裹任何代码块语法',
reference:
'You need to maintain the component format of MDX, and the output text does not need to be wrapped in any code block syntax at the outermost level.',
markdown: {
entry: ['./README.zh-CN.md', './docs/**/*.zh-CN.md', './docs/**/*.zh-CN.mdx'],
entry: ['./README.zh-CN.md', './contributing/**/*.zh-CN.md', './docs/**/*.zh-CN.mdx'],
entryLocale: 'zh-CN',
entryExtension: '.zh-CN.md',
outputLocales: ['en-US'],
outputExtensions: (locale, { getDefaultExtension }) => {
if (locale === 'en-US') return '.md';
return getDefaultExtension(locale);
exclude: ['./contributing/_Sidebar.md', './contributing/_Footer.md', './contributing/Home.md'],
outputExtensions: (locale, { filePath }) => {
if (filePath.includes('.mdx')) {
if (locale === 'en-US') return '.mdx';
return `.${locale}.mdx`;
} else {
if (locale === 'en-US') return '.md';
return `.${locale}.md`;
}
},
},
});
9 changes: 9 additions & 0 deletions .seorc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
const { defineConfig } = require('@lobehub/seo-cli');

module.exports = defineConfig({
entry: ['./docs/**/*.mdx'],
modelName: 'gpt-3.5-turbo-0125',
experimental: {
jsonMode: true,
},
});
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,27 +656,27 @@ This project is [MIT](./LICENSE) licensed.
[docker-release-shield]: https://img.shields.io/docker/v/lobehub/lobe-chat?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
[docker-size-link]: https://hub.docker.com/r/lobehub/lobe-chat
[docker-size-shield]: https://img.shields.io/docker/image-size/lobehub/lobe-chat?color=369eff&labelColor=black&style=flat-square
[docs]: https://chat-docs.lobehub.com/en
[docs]: https://lobehub.com/docs
[docs-dev-guide]: https://github.com/lobehub/lobe-chat/wiki/index
[docs-docker]: https://chat-docs.lobehub.com/en/self-hosting/platform/docker
[docs-env-var]: https://chat-docs.lobehub.com/en/self-hosting/environment-variables
[docs-feat-agent]: https://chat-docs.lobehub.com/en/usage/features/agent-market
[docs-feat-local]: https://chat-docs.lobehub.com/en/usage/features/local-llm
[docs-feat-mobile]: https://chat-docs.lobehub.com/en/usage/features/mobile
[docs-feat-plugin]: https://chat-docs.lobehub.com/en/usage/features/plugin-system
[docs-feat-provider]: https://chat-docs.lobehub.com/en/usage/features/multi-ai-providers
[docs-feat-pwa]: https://chat-docs.lobehub.com/en/usage/features/pwa
[docs-feat-t2i]: https://chat-docs.lobehub.com/en/usage/features/text-to-image
[docs-feat-theme]: https://chat-docs.lobehub.com/en/usage/features/theme
[docs-feat-tts]: https://chat-docs.lobehub.com/en/usage/features/tts
[docs-feat-vision]: https://chat-docs.lobehub.com/en/usage/features/vision
[docs-docker]: https://lobehub.com/docs/self-hosting/platform/docker
[docs-env-var]: https://lobehub.com/docs/self-hosting/environment-variables
[docs-feat-agent]: https://lobehub.com/docs/usage/features/agent-market
[docs-feat-local]: https://lobehub.com/docs/usage/features/local-llm
[docs-feat-mobile]: https://lobehub.com/docs/usage/features/mobile
[docs-feat-plugin]: https://lobehub.com/docs/usage/features/plugin-system
[docs-feat-provider]: https://lobehub.com/docs/usage/features/multi-ai-providers
[docs-feat-pwa]: https://lobehub.com/docs/usage/features/pwa
[docs-feat-t2i]: https://lobehub.com/docs/usage/features/text-to-image
[docs-feat-theme]: https://lobehub.com/docs/usage/features/theme
[docs-feat-tts]: https://lobehub.com/docs/usage/features/tts
[docs-feat-vision]: https://lobehub.com/docs/usage/features/vision
[docs-functionc-call]: https://platform.openai.com/docs/guides/function-calling
[docs-lighthouse]: https://github.com/lobehub/lobe-chat/wiki/Lighthouse
[docs-plugin-dev]: https://chat-docs.lobehub.com/en/usage/plugins/development
[docs-self-hosting]: https://chat-docs.lobehub.com/en/self-hosting/start
[docs-upstream-sync]: https://chat-docs.lobehub.com/en/self-hosting/advanced/upstream-sync
[docs-usage-ollama]: https://chat-docs.lobehub.com/en/usage/providers/ollama
[docs-usage-plugin]: https://chat-docs.lobehub.com/en/usage/plugins/basic
[docs-plugin-dev]: https://lobehub.com/docs/usage/plugins/development
[docs-self-hosting]: https://lobehub.com/docs/self-hosting/start
[docs-upstream-sync]: https://lobehub.com/docs/self-hosting/advanced/upstream-sync
[docs-usage-ollama]: https://lobehub.com/docs/usage/providers/ollama
[docs-usage-plugin]: https://lobehub.com/docs/usage/plugins/basic
[fossa-license-link]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
[fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
[github-action-release-link]: https://github.com/actions/workflows/lobehub/lobe-chat/release.yml
Expand Down
36 changes: 18 additions & 18 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -678,25 +678,25 @@ This project is [MIT](./LICENSE) licensed.
[docker-size-link]: https://hub.docker.com/r/lobehub/lobe-chat
[docker-size-shield]: https://img.shields.io/docker/image-size/lobehub/lobe-chat?color=369eff&labelColor=black&style=flat-square
[docs-dev-guide]: https://github.com/lobehub/lobe-chat/wiki/index
[docs-docker]: https://chat-docs.lobehub.com/zh/self-hosting/platform/docker
[docs-env-var]: https://chat-docs.lobehub.com/zh/self-hosting/environment-variables
[docs-feat-agent]: https://chat-docs.lobehub.com/zh/usage/features/agent-market
[docs-feat-local]: https://chat-docs.lobehub.com/zh/usage/features/local-llm
[docs-feat-mobile]: https://chat-docs.lobehub.com/zh/usage/features/mobile
[docs-feat-plugin]: https://chat-docs.lobehub.com/zh/usage/features/plugin-system
[docs-feat-provider]: https://chat-docs.lobehub.com/zh/usage/features/multi-ai-providers
[docs-feat-pwa]: https://chat-docs.lobehub.com/zh/usage/features/pwa
[docs-feat-t2i]: https://chat-docs.lobehub.com/zh/usage/features/text-to-image
[docs-feat-theme]: https://chat-docs.lobehub.com/zh/usage/features/theme
[docs-feat-tts]: https://chat-docs.lobehub.com/zh/usage/features/tts
[docs-feat-vision]: https://chat-docs.lobehub.com/zh/usage/features/vision
[docs-docker]: https://lobehub.com/docs/self-hosting/platform/docker
[docs-env-var]: https://lobehub.com/docs/self-hosting/environment-variables
[docs-feat-agent]: https://lobehub.com/docs/usage/features/agent-market
[docs-feat-local]: https://lobehub.com/docs/usage/features/local-llm
[docs-feat-mobile]: https://lobehub.com/docs/usage/features/mobile
[docs-feat-plugin]: https://lobehub.com/docs/usage/features/plugin-system
[docs-feat-provider]: https://lobehub.com/docs/usage/features/multi-ai-providers
[docs-feat-pwa]: https://lobehub.com/docs/usage/features/pwa
[docs-feat-t2i]: https://lobehub.com/docs/usage/features/text-to-image
[docs-feat-theme]: https://lobehub.com/docs/usage/features/theme
[docs-feat-tts]: https://lobehub.com/docs/usage/features/tts
[docs-feat-vision]: https://lobehub.com/docs/usage/features/vision
[docs-functionc-call]: https://platform.openai.com/docs/guides/function-calling
[docs-lighthouse]: https://github.com/lobehub/lobe-chat/wiki/Lighthouse.zh-CN
[docs-plugin-dev]: https://chat-docs.lobehub.com/zh/usage/plugins/development
[docs-self-hosting]: https://chat-docs.lobehub.com/zh/self-hosting/start
[docs-upstream-sync]: https://chat-docs.lobehub.com/zh/self-hosting/advanced/upstream-sync
[docs-usage-ollama]: https://chat-docs.lobehub.com/zh/usage/providers/ollama
[docs-usage-plugin]: https://chat-docs.lobehub.com/zh/usage/plugins/basic
[docs-plugin-dev]: https://lobehub.com/docs/usage/plugins/development
[docs-self-hosting]: https://lobehub.com/docs/self-hosting/start
[docs-upstream-sync]: https://lobehub.com/docs/self-hosting/advanced/upstream-sync
[docs-usage-ollama]: https://lobehub.com/docs/usage/providers/ollama
[docs-usage-plugin]: https://lobehub.com/docs/usage/plugins/basic
[fossa-license-link]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
[fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
[github-action-release-link]: https://github.com/lobehub/lobe-chat/actions/workflows/release.yml
Expand All @@ -705,7 +705,7 @@ This project is [MIT](./LICENSE) licensed.
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-chat/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat?color=c4f042&labelColor=black&style=flat-square
[github-document-link]: https://chat-docs.lobehub.com/zh
[github-document-link]: https://lobehub.com/docs
[github-forks-link]: https://github.com/lobehub/lobe-chat/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-chat?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-chat/issues
Expand Down
2 changes: 1 addition & 1 deletion contributing/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

LobeChat is an open-source, extensible ([Function Calling][fc-url]), high-performance chatbot framework. <br/> It supports one-click free deployment of your private ChatGPT/LLM web application.

[Usage Documents](https://chat-docs.lobehub.com/en) | [使用指南](https://chat-docs.lobehub.com/zh)
[Usage Documents](https://lobehub.com/docs) | [使用指南](https://lobehub.com/docs)

</div>

Expand Down
12 changes: 12 additions & 0 deletions docs/self-hosting/advanced/analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
---
title: Integrating Data Analytics Services in LobeChat for User Usage Analysis
description: >-
Learn how to integrate free/open-source data analytics services in LobeChat to
collect user usage data efficiently.
tags:
- LobeChat
- data analytics
- user usage analysis
- Vercel Analytics
- web analytics
---
# Data Analysis

To better help analyze the usage of LobeChat users, we have integrated several free/open-source data analytics services in LobeChat for collecting user usage data, which you can enable as needed.
Expand Down
10 changes: 10 additions & 0 deletions docs/self-hosting/advanced/analytics.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
title: LobeChat 数据分析集成服务介绍
description: 了解如何在 LobeChat 中集成免费/开源的数据统计服务,帮助分析用户使用情况。包括 Vercel Analytics 的设置和使用教程。
tags:
- LobeChat
- 数据分析
- Vercel Analytics
- 数据统计服务
- 用户使用情况
---
# 数据分析

为更好地帮助分析 LobeChat 的用户使用情况,我们在 LobeChat 中集成了若干免费 / 开源的数据统计服务,用于收集用户的使用情况,你可以按需开启。
Expand Down
19 changes: 19 additions & 0 deletions docs/self-hosting/advanced/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
---
title: >-
LobeChat Identity Verification Service - Centralized User Authorization
Management
description: >-
Learn about LobeChat's support for configuring external identity verification
services for centralized user authorization within enterprises/organizations.
Explore supported services like Auth0, Microsoft Entra ID, Authentik, Github,
and ZITADEL.
tags:
- Identity Verification Service
- Centralized User Authorization
- SSO Providers
- Auth0
- Microsoft Entra ID
- Authentik
- Github
- ZITADEL
---
# Identity Verification Service

LobeChat supports the configuration of external identity verification services for internal use within enterprises/organizations to centrally manage user authorization.
Expand Down
15 changes: 15 additions & 0 deletions docs/self-hosting/advanced/authentication.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
---
title: LobeChat 外部身份验证服务配置指南
description: >-
了解如何配置外部身份验证服务以统一管理用户授权。支持的身份验证服务包括 Auth0, Microsoft Entra ID, Authentik,
Github, 和 ZITADEL。
tags:
- 身份验证服务
- LobeChat
- SSO
- Auth0
- Microsoft Entra ID
- Authentik
- Github
- ZITADEL
---
# 身份验证服务

LobeChat 支持配置外部身份验证服务,供企业 / 组织内部使用,统一管理用户授权。
Expand Down
21 changes: 19 additions & 2 deletions docs/self-hosting/advanced/sso-providers/auth0.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
---
title: Configure Auth0 Identity Verification Service for LobeChat
description: >-
Learn how to configure Auth0 Identity Verification Service for LobeChat for
your organization, including creating applications, adding users, and
configuring environment variables.
tags:
- Auth0
- Identity Verification
- Single Sign-On
- Environment Variables
- User Management
- SSO Integrations
- Social Login
---
# Configure Auth0 Identity Verification Service

<Steps>
Expand Down Expand Up @@ -26,7 +41,8 @@
<Callout type={'important'}>
You can fill in or modify Allowed Callback URLs after deployment, but make sure the filled URL is
consistent with the deployed URL.
</Callout>

</Callout>

### Add Users

Expand All @@ -51,7 +67,8 @@

<Callout type={'tip'}>
You can refer to the related variable details at [📘Environment Variables](/en/self-hosting/environment-variable#auth0).
</Callout>

</Callout>
</Steps>

<Callout>
Expand Down
17 changes: 15 additions & 2 deletions docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
---
title: 在 LobeChat 中配置 Auth0 身份验证服务 - 详细步骤和环境变量设置
description: 学习如何在 LobeChat 中配置 Auth0 身份验证服务,包括创建应用、新增用户、配置环境变量等。了解如何连接现有的单点登录服务和配置社交登录。
tags:
- Auth0
- 身份验证
- 单点登录
- 社交登录
- 环境变量
- 用户管理
---
# 配置 Auth0 身份验证服务

<Steps>
Expand Down Expand Up @@ -25,7 +36,8 @@

<Callout type={'important'}>
可以在部署后再填写或修改 Allowed Callback URLs,但是务必保证填写的 URL 与部署的 URL 一致
</Callout>

</Callout>

### 新增用户

Expand All @@ -50,7 +62,8 @@

<Callout type={'tip'}>
前往 [📘 环境变量](/zh/self-hosting/environment-variable#auth0) 可查阅相关变量详情。
</Callout>

</Callout>
</Steps>

<Callout type={'info'}>部署成功后,用户将可以使用 Auth0 中配置的用户通过身份认证并使用 LobeChat。</Callout>
Expand Down
21 changes: 18 additions & 3 deletions docs/self-hosting/advanced/sso-providers/authentik.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
---
title: Configuring Authentik Authentication Service for LobeChat
description: >-
Learn how to configure Authentik for Single Sign-On (SSO) for LobeChat,
including creating an application provider, setting environment variables, and
deployment instructions.
tags:
- Authentik Configuration
- Single Sign-On (SSO)
- LobeChat Authentication
- Environment Variables
- Deployment Instructions
---
## Configuring Authentik Authentication Service

## Authentik Configuration Flow
Expand All @@ -18,9 +31,10 @@
<Callout type={'info'}>
- You can fill in or modify the `Redirect URL/Origin (regex)` later, but make sure the filled in URL matches the deployed URL.
- Replace `your-domain` with your own domain name
</Callout>

</Callout>

<Image alt="Create Authentik Provider" inStep src="[https://github.com/lobehub/lobe-chat/assets/67304509/4244634e-5f68-48d5-aac0-e5f4b06d1c4b](https://github.com/lobehub/lobe-chat/assets/67304509/4244634e-5f68-48d5-aac0-e5f4b06d1c4b)" />
<Image alt="Create Authentik Provider" inStep src="https://github.com/lobehub/lobe-chat/assets/67304509/4244634e-5f68-48d5-aac0-e5f4b06d1c4b](https://github.com/lobehub/lobe-chat/assets/67304509/4244634e-5f68-48d5-aac0-e5f4b06d1c4b)" />

Click **Done**

Expand All @@ -47,7 +61,8 @@

<Callout type={'tip'}>
Go to Environment Variables: /en/self-hosting/environment-variable#Authentik for details about the variables.
</Callout>

</Callout>
</Steps>

<Callout type={'info'}>
Expand Down
16 changes: 14 additions & 2 deletions docs/self-hosting/advanced/sso-providers/authentik.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
title: 在 LobeChat 中配置 Authentik 身份验证服务
description: 学习如何在 LobeChat 中配置 Authentik 身份验证服务,包括创建提供程序、配置环境变量和部署 LobeChat。详细步骤和必要环境变量设置。
tags:
- Authentik
- 身份验证
- 单点登录
- 环境变量
- LobeChat
---
# 配置 Authentik 身份验证服务

## Authentik 配置流程
Expand All @@ -18,7 +28,8 @@
<Callout type={'info'}>
- 可以之后再填写或修改 `重定向 URL/Origin(正则)`,但是务必保证填写的 URL 与部署的 URL 一致。
- your-domain 请替换为自己的域名
</Callout>

</Callout>

<Image alt="创建 Authentik 提供程序" inStep src="https://github.com/lobehub/lobe-chat/assets/67304509/4244634e-5f68-48d5-aac0-e5f4b06d1c4b" />

Expand Down Expand Up @@ -46,7 +57,8 @@

<Callout type={'tip'}>
前往 [📘 环境变量](/zh/self-hosting/environment-variable#Authentik) 可查阅相关变量详情。
</Callout>

</Callout>
</Steps>

<Callout type={'info'}>
Expand Down
13 changes: 13 additions & 0 deletions docs/self-hosting/advanced/sso-providers/github.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
---
title: Configuring Github Authentication Service for LobeChat
description: >-
Learn how to configure Github authentication service for LobeChat, including
creating a Github provider, setting up environment variables, and deploying
LobeChat.
tags:
- Github authentication
- LobeChat
- Environment variables
- Single Sign-On
- OAuth authentication
---
# Configuring Github Authentication Service

## Github Configuration Process
Expand Down
Loading

0 comments on commit e97f62f

Please sign in to comment.