-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add translation button at bottom of doc page (#12) casdoor/casdoor-website#564 docs: Complete installation documentation for casibase (#11) * docs: Complete installation documentation for casibase * docs: Complete installation documentation for casibase feat: complete guides
- Loading branch information
Showing
64 changed files
with
668 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,45 @@ | ||
| --- | ||
| title: Casdoor-SSO | ||
| description: Introduction of casdoor in casibase | ||
| description: Setup Casdoor for casibase | ||
| keywords: [Casdoor, SSO, Security, Authentication, Authorization] | ||
| authors: [kv-chiu] | ||
| authors: [uestc-wxy] | ||
| --- | ||
|
|
||
| ```mdx-code-block | ||
| import styles from '.././styles.module.css'; | ||
| import CasdoorCard from "@site/src/components/CasdoorCard"; | ||
| ``` | ||
|
|
||
| ## Introduction | ||
| Casibase uses Casdoor as its backend service,so make sure to deploy it in advance. | ||
|
|
||
| Casdoor is a powerful and lightweight open-source [Identity Access Management (IAM)](https://en.wikipedia.org/wiki/Identity_management) / [Single-Sign-On (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) server. It's developed and maintained by [**Casbin**](https://casbin.org). | ||
| Please refer to: <https://casdoor.org/docs/basic/server-installation> to install and configure Casdoor. | ||
|
|
||
| ```mdx-code-block | ||
| <div className={styles.gradientborder}> | ||
| <CasdoorCard src="https://door.casdoor.com/login" /> | ||
| </div> | ||
| ``` | ||
| Follow these steps to setup Casdoor for casibase: | ||
|
|
||
| - Create an Organization | ||
|
|
||
|  | ||
|
|
||
| - Configure information about the Organization | ||
|
|
||
|  | ||
|
|
||
| - Create a new Application | ||
|
|
||
|  | ||
|
|
||
| Casdoor serves both the web UI and the login requests from the application users. | ||
| - Configuring Application Information (Remember Name, ClientID and ClientSecret) | ||
|
|
||
| ## Features | ||
|  | ||
|
|
||
| - **Single-Sign-On (SSO)**: Sign in to multiple applications with one set of login credentials. | ||
| - **Social Login**: Sign in with GitHub, Google, etc. | ||
| - **Integrated Provider Management**: Manage all your providers in one place. | ||
| - **Authentication**: Verify the identity of your users. | ||
| - Add a member to the newly created organization | ||
|
|
||
|  | ||
|  | ||
|
|
||
| :::tip | ||
|  | ||
|
|
||
| Casibase manages third-party service providers through Casdoor: | ||
| - Configure member information (remember its Name as well as Password) | ||
|
|
||
| - **Storage**: Manage your storage providers, such as AWS, Azure, etc. | ||
| - **AI**: Manage your chat providers, such as OpenAI, ChatGLM, etc. | ||
|  | ||
|
|
||
| ::: | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: Add an Embedding Provider | ||
| description: Explore how to integrate an embedding provider with Casibase. | ||
| keywords: [Casibase, Embedding Provider, Integration] | ||
| authors: [kv-chiu] | ||
| --- | ||
|
|
||
| This document is a step-by-step tutorial designed for beginners. It will guide you through the process of integrating an embedding provider with Casibase, our powerful knowledge base system. | ||
|
|
||
| ## Introduction | ||
|
|
||
| Embedding is a technique used to represent words and documents as vectors. Embedding providers allow you to analyze and process data within your knowledge base system, making it more intelligent and efficient. | ||
|
|
||
| Refer to the [Core Concepts](../basic/core-concepts) section of our previous documentation for more information about embedding. | ||
|
|
||
| In Casibase, you can add an embedding provider by following these steps: | ||
|
|
||
| ### Step 1: Deploy Casdoor and Casibase | ||
|
|
||
| Before you can add an embedding provider, make sure you have Casdoor and Casibase deployed. If you haven't done this yet, please refer to the [Deploy Casdoor and Casibase](./deploy-casdoor-and-casibase) tutorial in our previous documentation. | ||
|
|
||
| ### Step 2: Add a New Embedding Provider | ||
|
|
||
| Embedding providers are used to integrate embedding into Casibase. You can add them by following these steps: | ||
|
|
||
| Click the `Providers` button on the home page. | ||
|
|
||
|  | ||
|
|
||
| #### Step 2.1: Add an Embedding Provider | ||
|
|
||
| Click the `Add` button to add an embedding provider. | ||
|
|
||
|  | ||
|
|
||
| #### Step 2.2: Fill in Embedding Provider Details | ||
|
|
||
| Fill in the embedding provider details and click the `Save & Exit` button. | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
|
|
||
| Same as the [Model Provider](./add-a-model-provider) section, Casibase supports many embedding providers, including: | ||
|
|
||
| - [OpenAI](https://openai.com/) | ||
| - AdaSimilarity | ||
| - DavinciSimilarity | ||
| - AdaEmbedding2 | ||
| - ...... | ||
| - [Hugging Face](https://huggingface.co/) | ||
| - sentence-transformers/paraphrase-MiniLM-L6-v2 | ||
| - ...... | ||
|
|
||
| ::: | ||
|
|
||
| Return providers list page: | ||
|
|
||
|  | ||
|
|
||
| Now, you can use the embedding provider to convert text to vectors. | ||
|
|
||
| After adding an embedding provider, you can use it to retrieve similar documents in Casibase. For more information, please refer to the [Core Concepts](../basic/core-concepts) section of our previous documentation. | ||
|
|
||
| In the next chapter, we will learn how to integrate storage providers, model providers, and embedding providers with Casibase. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| title: Add a Model Provider | ||
| description: Learn how to add a model provider to enhance Casibase functionality. | ||
| keywords: [Casibase, Model Provider, Integration] | ||
| authors: [kv-chiu] | ||
| --- | ||
|
|
||
| This document is a step-by-step tutorial designed for beginners. It will guide you through the process of integrating a model provider with Casibase, our powerful knowledge base system. | ||
|
|
||
| ## Introduction | ||
|
|
||
| Adding a model provider to Casibase enables you to enhance its functionality by incorporating machine learning models and AI capabilities. Model providers allow you to analyze and process data within your knowledge base system, making it more intelligent and efficient. | ||
|
|
||
| If you're new to integrating model providers, don't worry. We've broken down the process into simple steps that anyone can follow. | ||
|
|
||
| ### Step 1: Deploy Casdoor and Casibase | ||
|
|
||
| Before you can add a model provider, make sure you have Casdoor and Casibase deployed. If you haven't done this yet, please refer to the [Deploy Casdoor and Casibase](./deploy-casdoor-and-casibase) tutorial in our previous documentation. | ||
|
|
||
| ### Step 2: Add a New Model Provider | ||
|
|
||
| Model providers are used to integrate LLM into Casibase. You can add them by following these steps: | ||
|
|
||
| Click the `Providers` button on the home page. | ||
|
|
||
|  | ||
|
|
||
| #### Step 2.1: Add a Model Provider | ||
|
|
||
| Click the `Add` button to add a model provider. | ||
|
|
||
|  | ||
|
|
||
| #### Step 2.2: Fill in Model Provider Details | ||
|
|
||
| Fill in the model provider details and click the `Save & Exit` button. | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
|
|
||
| Casibase supports many model providers, including: | ||
|
|
||
| - [Hugging Face](https://huggingface.co/) | ||
| - meta-llama/Llama-2-7b | ||
| - THUDM/chatglm2-6b | ||
| - baichuan-inc/Baichuan2-13B-chat | ||
| - gpt2 | ||
| - ...... | ||
| - [OpenRouter](https://openrouter.ai/) | ||
| - anthropic/claude-2 | ||
| - palm-2-chat-bison | ||
| - palm-2-codechat-bison | ||
| - openai/gpt-4 | ||
| - ...... | ||
| - [OpenAI](https://openai.com/) | ||
| - text-davinci-003 | ||
| - gpt-3.5-turbo | ||
| - gpt-4 | ||
| - ...... | ||
|
|
||
| ::: | ||
|
|
||
| :::caution | ||
|
|
||
| - Category: The first-level category of the model provider. For example, `Model` and `Embedding`. | ||
| - Type: The second-level category of the model provider. For example, `OpenAI` and `Hugging Face`. | ||
| - SecretKey: The secret key of your OpenAI account. | ||
|
|
||
| **Example** | ||
|
|
||
| ##### Add a OpenAI model provider | ||
|
|
||
|  | ||
|
|
||
| ::: | ||
|
|
||
| :::caution | ||
|
|
||
| Some models don't support **streaming-output**. Known models that support streaming-output include: | ||
|
|
||
| - `gpt-3.5-turbo-0613` | ||
|
|
||
| ::: | ||
|
|
||
| After adding a model provider, you can use it to analyze and process data in Casibase using chatbots, question answering, and other AI capabilities. | ||
|
|
||
| Return model provider list page: | ||
|
|
||
|  | ||
|
|
||
| Now that you've added a model provider, you can use it to analyze and process data in Casibase using chatbots, question answering, and other AI capabilities. | ||
|
|
||
| In the next chapter, we'll learn how to add an embedding provider to Casibase. |
Oops, something went wrong.