forked from opea-project/GenAIExamples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation README update for ProductivitySuite example (opea-proje…
…ct#863) Signed-off-by: Yeoh, Hoong Tee <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
3fb6060
commit 6f4b00f
Showing
5 changed files
with
103 additions
and
65 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,23 +1,39 @@ | ||
| # OPEA Productivity Suite Application | ||
| # Productivity Suite Application | ||
|
|
||
| OPEA Productivity Suite streamlines your workflow to boost productivity. It leverages the OPEA microservices to provide a comprehensive suite of features to cater to the diverse needs of modern enterprises. | ||
| Productivity Suite, a tool designed to streamline your workflow and boost productivity! Our application leverages the power of OPEA microservices to deliver a comprehensive suite of features tailored to meet the diverse needs of modern enterprises. | ||
|
|
||
| ## Key Features | ||
| --- | ||
|
|
||
| - Chat with Documents: Engage in intelligent conversations with your documents using our advanced RAG Capabilities. Our Retrieval-Augmented Generation (RAG) model allows you to ask questions, receive relevant information, and gain insights from your documents in real-time. | ||
| ## 🛠️ Key Features | ||
|
|
||
| - Content Summarization: Save time and effort by automatically summarizing lengthy documents or articles, enabling you to quickly grasp the key takeaways. | ||
| ### 💬 Chat with Documents | ||
|
|
||
| - FAQ Generation: Effortlessly create comprehensive FAQs based on your documents, ensuring that your users have access to the information they need. | ||
| Engage in intelligent conversations with your documents using our advanced **Retrieval-Augmented Generation (RAG)** capabilities. Ask questions, receive relevant information, and gain insights from your documents in real-time! | ||
|
|
||
| - Code Generation: Boost your coding productivity with our code generation feature. Simply provide a description of the functionality you require, and the application will generate the corresponding code snippets, saving you valuable time and effort. | ||
| ### 📄 Content Summarization | ||
|
|
||
| - User Context Management: Maintain a seamless workflow by managing your user's context within the application. Our context management system keeps track of your documents and chat history, allowing for personalized experiences. | ||
| Summarize lengthy documents or articles, enabling you to grasp key takeaways quickly. Save time and effort with our intelligent summarization feature! | ||
|
|
||
| - Identity and access management: uses the open source platform Keycloak for single sign-on identity and access management. | ||
| ### ❓ FAQ Generation | ||
|
|
||
| Refer to the [Keycloak Configuration Guide](./docker_compose/intel/cpu/xeon/keycloak_setup_guide.md) for instructions to setup Keycloak. | ||
| Effortlessly create comprehensive FAQs based on your documents. Ensure your users have access to the information they need with minimal effort! | ||
|
|
||
| Refer to the [Xeon Guide](./docker_compose/intel/cpu/xeon/README.md) for instructions to build docker images from source and running the application via docker compose. | ||
| ### 💻 Code Generation | ||
|
|
||
| Refer to the [Xeon Kubernetes Guide](./kubernetes/intel/README.md) for instructions to deploy the application via kubernetes. | ||
| Boost your coding productivity by providing a description of the functionality you require. Our application generates corresponding code snippets, saving you valuable time and effort! | ||
|
|
||
| ### 🎛️ User Context Management | ||
|
|
||
| Maintain a seamless workflow by managing your user's context within the application. Our context management system keeps track of documents and chat history for a personalized experience. | ||
|
|
||
| ### 🔐 Identity and Access Management | ||
|
|
||
| Utilizes the open-source platform **Keycloak** for single sign-on identity and access management. This ensures secure and convenient access to your productivity tools. | ||
|
|
||
| --- | ||
|
|
||
| ## 📚 Setup Guide | ||
|
|
||
| - **[Keycloak Configuration Guide](./docker_compose/intel/cpu/xeon/keycloak_setup_guide.md)**: Instructions to set up Keycloak for identity and access management. | ||
| - **[Xeon Guide](./docker_compose/intel/cpu/xeon/README.md)**: Instructions to build Docker images from source and run the application via Docker Compose. | ||
| - **[Xeon Kubernetes Guide](./kubernetes/intel/README.md)**: Instructions to deploy the application via Kubernetes. |
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
22 changes: 14 additions & 8 deletions
22
ProductivitySuite/docker_compose/intel/cpu/xeon/keycloak_setup_guide.md
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,21 +1,27 @@ | ||
| # Keycloak Configuration Setup | ||
| # 🔐 Keycloak Configuration Setup | ||
|
|
||
| This document show you step-by-step how to configure Keycloak settings. | ||
| This README document provides a comprehensive, step-by-step guide on how to configure **Keycloak** settings. The user management is facilitated via Keycloak, and the configuration is outlined below: | ||
|
|
||
| The user management is done via Keycloak and the configuration steps look like this: | ||
|
|
||
| 1. Access the Keycloak admin console via url http:${host_ip}:8080 or endpoint that exposed from your kubernetes cluster to configure user. Use default username(admin) and password(admin) to login. | ||
| 1. Access the Keycloak admin console via url http:${host_ip}:8080 or endpoint that is exposed from your Kubernetes cluster to configure users. Use the default username(**admin**) and password(**admin**) to login. | ||
|  | ||
|
|
||
| 2. Create a new realm named **productivitysuite** within Keycloak. | ||
|  | ||
|
|
||
|  | ||
|
|
||
| 3. Create a new client called **productivitysuite** with default configurations. | ||
|  | ||
| 4. Select the **productivitysuite** client that created just now. Insert your ProductivitySuite UI url endpoint into "Valid redirect URIs" and "Web origins" field. Example as screenshot below: | ||
|
|
||
| 4. Select the **productivitysuite** client that you just created. Insert your ProductivitySuite UI url endpoint into **"Valid redirect URIs"** and **"Web origins"** field. Refer to screenshot below as an example: | ||
|  | ||
| 5. From the left pane select the Realm roles and create a new role name as user and another new role as viewer. | ||
|
|
||
| 5. From the left pane, select the Realm roles and create a new role named **user** and another new role as **viewer**. | ||
|  | ||
| 6. Create a new user name as for example mary and another user as bob. Set passwords for both users (set 'Temporary' to 'Off'). Select Role mapping on the top, assign the user role to mary and assign the viewer role to bob. | ||
|
|
||
| 6. Create a new user named, for example, **mary** and another user as **bob**. Set passwords for both users (set **'Temporary'** to **'Off'**).Select **Role mapping** on the top, assign the user role to mary and assign the viewer role to bob. | ||
|  | ||
|
|
||
|  | ||
|
|
||
|  |
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