Dev

README.md

@@ -2,7 +2,7 @@
 
 <h1 align="center">
   <br>
-  <a href="https://kuwaai.org/en-US/">
+  <a href="https://kuwaai.tw/">
   <img src="./src/multi-chat/public/images/kuwa.png" alt="Kuwa GenAI OS" width="200"></a>
   <br>
   Kuwa GenAI OS
@@ -13,13 +13,28 @@
 
 <p align="center">
   <a href="http://makeapullrequest.com">
-    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?logo=github&logoColor=white">
   </a>
   <a href="#">
     <img src="https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square">
   </a>
   <a href="https://laravel.com/docs/10.x/releases">
-    <img src="https://img.shields.io/badge/maintained%20with-Laravel-cc00ff.svg">
+    <img src="https://img.shields.io/badge/maintained%20with-Laravel-cc00ff.svg?logo=laravel&logoColor=white">
+  </a>
+  <a href="https://discord.gg/Gu7zPavEmN">
+    <img src="https://img.shields.io/badge/discord-active-blue?logo=discord&logoColor=white">
+  </a>
+  <a href="#">
+    <img src="https://img.shields.io/github/v/release/kuwaai/genai-os">
+  </a>
+  <a href="#">
+    <img src="https://img.shields.io/github/downloads/kuwaai/genai-os/total">
+  </a>
+  <a href="#">
+    <img src="https://img.shields.io/github/license/kuwaai/genai-os">
+  </a>
+  <a href="#">
+    <img src="https://img.shields.io/github/stars/kuwaai">
   </a>
 </p>
 
@@ -45,7 +60,7 @@
 ## Architecture
 > **Warning**: This a preliminary draft and may be subject to further changes.
 
-[![screenshot](./src/multi-chat/public/images/architecture.svg)](https://kuwaai.org/os/Intro)
+[![screenshot](./src/multi-chat/public/images/architecture.svg)](https://kuwaai.tw/os/Intro)
 
 ## Installation Guide
 ### Quick Installation
@@ -56,9 +71,9 @@ Download the script or the executable file, run it, and follow its steps to have
 
 * **Linux/Docker**
 
-  Download and run [build.sh](./docker/build.sh) , or invoke the following command to automatically install Docker, Cuda, and Kuwa
+  Download and run sudo [build.sh](./docker/build.sh) , or invoke the following command to automatically install Docker, CUDA, and Kuwa. You may need to reboot after installing CUDA. Before finishing installation, you will be asked to set your administration passwords for your Kuwa and database. After installation, it will invoke run.sh to start the system and you can log in with admin@localhost. Enjoy!
   ```
-  curl -fsSL https://github.com/kuwaai/genai-os/tree/main/docker/build.sh | sh
+  curl -fsSL https://raw.githubusercontent.com/kuwaai/genai-os/main/docker/build.sh | sudo sh
   ```
 ###  Step-by-step Installation
 You can build your own customized Kuwa by following the step-by-step documents.

README_TW.md

@@ -2,7 +2,7 @@
 
 <h1 align="center">
   <br>
-  <a href="https://kuwaai.org/zh-Hant/">
+  <a href="https://kuwaai.tw/zh-Hant/">
   <img src="./src/multi-chat/public/images/kuwa.png" alt="Kuwa GenAI OS" width="200"></a>
   <br>
   Kuwa GenAI OS
@@ -33,29 +33,29 @@
 </p>
 
 ## 關鍵功能
-* 提供多語言生成式人工智慧的使用、開發與部署的整體解決方案，支援Windows、Linux及MacOS
+* 提供生成式人工智慧的使用、開發與部署的整體解決方案，支援多語言及Windows、Linux、MacOS
 * 提供多模型群聊、引用、劇本匯入、生成內容完整匯出、多樣分享等自主編導與指揮的友善使用功能 
-* 支援多模態模型，整合多項現有RAG/Agent開發工具，可串接傳統應用程式、自建Store應用商店
-* 可免寫程式，靈活組合「提示劇本x知識庫x模型x工具x腳本」等即可打造個人化強大的GenAI應用
+* 支援多模態模型，整合多項現有RAG/Agent開發工具，也可串接傳統應用程式、自建Store應用商店
+* 可免寫程式，藉由靈活組合「提示劇本x知識庫x模型x工具x腳本」即可打造個人化強大的GenAI應用
 * 支援單板電腦、筆記型電腦、個人電腦、虛擬主機、地端伺服器，以及公私或混合雲端等各種環境
-* 開放原始碼，允許開發人員貢獻並根據自己的需求打造自己的客製系統
+* 開放原始碼，允許開發人員或企業根據自己的需求打造自己的客製系統，快速對內或對外提供服務
 
 ![screenshot](./src/multi-chat/public/images/demo.gif)
 
 ## 架構
 > **警告**: 本草案為初步版本，可能會有進一步的更改。
 
-[![screenshot](./src/multi-chat/public/images/architecture.svg)](https://kuwaai.org/os/Intro)
+[![screenshot](./src/multi-chat/public/images/architecture.svg)](https://kuwaai.tw/os/Intro)
 
 ## 安裝指南
 ### 快速安裝
 可下載單一Script或檔案，依指示操作即可快速安裝
 * **Windows**
 下載最新版本GenAI OS的[Windows版單一執行檔](https://github.com/kuwaai/genai-os/releases)
 * **Linux/Docker**
-可利用 [build.sh](./docker/build.sh) 或在Linux下執行以下指令即可自動下載及安裝Docker、CUDA及Kuwa
+可下載 [build.sh](./docker/build.sh) 後執行 **sudo build.sh**，或在Linux下執行以下指令即可自動下載及安裝Docker、CUDA及Kuwa。安裝CUDA後需重開機，安裝完成前會設定管理者及資料庫密碼，全部安裝完成後會執行 run.sh 自動啟動Kuwa，預設用 admin@localhost 帳號登入。
   ```
-  curl -fsSL https://github.com/kuwaai/genai-os/tree/main/docker/build.sh | sh
+  curl -fsSL https://raw.githubusercontent.com/kuwaai/genai-os/main/docker/build.sh | sudo sh
   ```
 ### 手動安裝
 可參考安裝文件逐步進行手動安裝

docker/.env.sample

@@ -4,4 +4,16 @@ PUBLIC_BASE_URL="http://${DOMAIN_NAME}/"
 ADMIN_NAME="Kuwa Admin"
 ADMIN_EMAIL="admin@${DOMAIN_NAME}"
 DB_USERNAME=kuwa
-DB_DATABASE=kuwa-genai-os
+DB_DATABASE=kuwa-genai-os
+
+# To enable offline mode for the execution of transformers, set the environment
+# variable TRANSFORMERS_OFFLINE to 1 before running executors in
+# firewall-restricted or network-unavailable environments.
+# TRANSFORMERS_OFFLINE=1
+
+# To configure an HTTPS service using a reverse proxy, designate the reverse proxy
+# as a trusted entity, allowing it to automatically prepend the "https://" prefix
+# when generating links.
+# Example1: TRUSTED_PROXIES=*
+# Example2: TRUSTED_PROXIES=192.168.1.1,192.168.1.2
+TRUSTED_PROXIES=

docker/build.sh

@@ -0,0 +1,188 @@
+#!/bin/bash
+# set -x
+
+
+REBOOT_FLAG=".reboot_flag"
+NOW_PATH=$(pwd)
+
+install_docker() {
+        # Add official GPG key
+        if ! command -v docker &> /dev/null; then
+                echo "Installing Docker..."
+
+                # Setup repository
+                echo \
+                        "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
+                        "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
+                        tee /etc/apt/sources.list.d/docker.list > /dev/null
+                apt-get update
+
+                # Install necessary package
+                apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+
+                # Enable the service
+                systemctl --now enable docker
+
+                # Enable unattended-update
+                cat <<EOT | tee /etc/apt/apt.conf.d/51unattended-upgrades-docker
+                Unattended-Upgrade::Origins-Pattern {
+                        "origin=Docker";
+                };
+EOT
+        else
+                echo "Docker is already installed."
+        fi
+}
+
+install_nvidia_driver() {
+        if ! command -v nvidia-smi &> /dev/null; then
+                echo "Installing Nvidia driver..."
+                apt update
+                apt upgrade -y
+
+                # Remove previous NVIDIA installation
+                apt autoremove nvidia* --purge -y
+                apt autoclean
+
+                # Install Ubuntu and NVIDIA drivers
+                local version=$(ubuntu-drivers devices 2>/dev/null | grep recommended | grep -oP 'nvidia-driver-\d+')
+                #echo "$version"
+                ubuntu-drivers autoinstall
+                apt install -y $version
+
+                # Reboot
+                touch "$REBOOT_FLAG"
+                reboot
+        else
+                echo "Nvidia Driver is already installed."
+        fi
+
+}
+
+install_cuda_toolkit() {
+        if ! command -v nvcc --version &> /dev/null; then
+                echo "Installing CUDA toolkit..."
+                apt update
+                apt upgrade -y
+
+                # Install CUDA toolkit
+                apt install -y nvidia-cuda-toolkit
+        else
+                echo "CUDA toolkit is already installed."
+        fi
+}
+
+install_nvidia_container_toolkit() {
+        if ! command -v which nvidia-container-toolkit &> /dev/null; then
+                echo "Installing Nvidia continaer toolkit"
+
+                # Setup GPG key
+                curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg
+
+                # Setup the repository
+                local distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
+                curl -s -L https://nvidia.github.io/libnvidia-container/$distribution/libnvidia-container.list | \
+                        sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
+                        tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
+                apt-get update
+                apt-get install -y nvidia-container-toolkit
+
+                # Configure the NVIDIA runtime to be the default docker runtime
+                nvidia-ctk runtime configure --runtime=docker --set-as-default
+                systemctl restart docker
+        else
+                echo "Nvidia toolkit is already installed."
+        fi
+}
+
+install_kuwa() {
+        # Download Kuwa repository
+        cd "$NOW_PATH"
+        git clone https://github.com/kuwaai/genai-os/
+        cd genai-os/docker
+
+        # Change configuration files
+        cp .admin-password.sample .admin-password
+        cp .db-password.sample .db-password
+        cp .env.sample .env
+
+        # Set admin password
+        while true; do
+                read -sp "Enter admin password: " admin_passwd
+                echo
+                read -sp "Confirm admin password: " admin_passwd_confirm
+                echo
+
+                if [ "$admin_passwd" == "$admin_passwd_confirm" ]; then
+                        echo "Admin password set successfully."
+                        echo "$admin_passwd" > .admin-password
+                        break
+                else
+                        echo "Passwords do not match. Please enter your password again."
+                fi
+        done
+
+        # Set database password
+        while true; do
+                read -sp "Enter database password: " db_passwd
+                echo
+                read -sp "Confirm database password: " db_passwd_confirm
+                echo
+
+                if [ "$db_passwd" == "$db_passwd_confirm" ]; then
+                        echo "Database password set successfully."
+                        echo "$db_passwd" > .db-password
+                        break
+                else
+                        echo "Passwords do not match. Please enter your password again."
+                fi
+        done
+}
+
+fix() {
+        cd executor
+        echo "llama-cpp-python @ https://github.com/abetlen/llama-cpp-python/releases/download/v0.2.77/llama_cpp_python-0.2.77-cp310-cp310-linux_x86_64.whl" > requirements.txt
+        cd ../../src/executor
+        sed -i 's/==/ == /g' requirements.txt
+        cd ../../docker/executor
+        local LINES_TO_ADD=$(cat << 'EOF'
+        COPY docker/executor/requirements.txt ./requirements-docker.txt
+EOF
+        )
+        sed -i "8a${LINES_TO_ADD}" "Dockerfile"
+        LINES_TO_ADD=$(cat << 'EOF'
+        RUN pip install --no-cache-dir -r requirements-docker.txt
+EOF
+        )
+        sed -i "9a${LINES_TO_ADD}" "Dockerfile"
+        cd ..
+}
+
+install_all() {
+        if [[ -f "$REBOOT_FLAG" ]]; then
+                echo "System has been rebooted. Continuing installation."
+                install_cuda_toolkit
+                install_nvidia_container_toolkit
+                rm -f "$REBOOT_FLAG"
+        elif ! command -v nvidia-smi &> /dev/null; then
+                apt-get update
+                apt-get upgrade
+        else
+                apt-get install curl
+                read -p "Do you want to install NVIDIA GPU drivers? [y/N]: " install_gpu
+                if [[ "$install_gpu" == "y" || "$install_gpu" == "Y" ]]; then
+                        install_nvidia_driver
+                fi
+        fi
+        install_docker
+        install_kuwa
+        fix
+        #cd "$PATH/genai-os/docker"
+        cp run.sh.sample run.sh
+        ./run.sh
+}
+
+echo "Kuwa docker build script v0.1.0"
+echo "This will install kuwa automatically on Ubuntu 22.04"
+sleep 2
+install_all

docker/compose/.gitignore

@@ -0,0 +1 @@
+custom

docker/compose/base.yaml

@@ -39,7 +39,11 @@ services:
       ADMIN_PASSWORD_FILE: /run/secrets/admin-password
     secrets:
       - admin-password
-    volumes: ["multi-chat-storage:/app/storage:rw"]
+    volumes: [
+      "multi-chat-storage:/app/storage:rw",
+      "../root/custom:/app/resources/views/components/custom:ro",
+      "../root/bootstrap/bot:/var/kuwa/docker/root/bootstrap/bot:ro",
+    ]
     healthcheck:
       test: ["CMD-SHELL", "php-fpm-healthcheck"]
       timeout: 10s
@@ -61,6 +65,12 @@ services:
 
 volumes:
   multi-chat-storage: {}
+  kuwa-root: # The root of Kuwa filesystem hierarchy to store user-uploaded data during runtime.
+    driver: local
+    driver_opts:
+      type: none
+      device: "../root"
+      o: bind
 
 secrets:
   admin-password:

docker/compose/custom-dbqa.yaml

@@ -0,0 +1,27 @@
+services:
+  custom-dbqa-executor:
+    build:
+      context: ../../
+      dockerfile: docker/executor/Dockerfile
+    image: kuwa-executor
+    environment:
+      CUSTOM_EXECUTOR_PATH: ./docqa/docqa.py
+      EXECUTOR_ACCESS_CODE: db-qa:custom-db
+      EXECUTOR_NAME: DB QA (Custom DB)
+      TRANSFORMERS_OFFLINE: ${TRANSFORMERS_OFFLINE:-0} # For embedding model
+    volumes: [
+      "</path/to/vector-database>:/var/database/",
+      "kuwa-root:/var/kuwa/docker/root:rw", # The root of Kuwa filesystem hierarchy to store user-uploaded data during runtime.
+      "~/.cache/huggingface:/root/.cache/huggingface"
+    ]
+    depends_on:
+      - kernel
+      - multi-chat
+    command: [
+      "--api_base_url", "http://web/",
+      "--model", "gemini-pro",
+      "--database", "/var/database/",
+      "--log", "debug"
+      ]
+    restart: unless-stopped
+    networks: ["backend", "frontend"]

docker/compose/dall-e.yaml

@@ -0,0 +1,22 @@
+services:
+  painter-executor:
+    build:
+      context: ../../
+      dockerfile: docker/executor/Dockerfile
+    image: kuwa-executor
+    environment:
+      CUSTOM_EXECUTOR_PATH: ./image_generation/dall_e.py
+      EXECUTOR_ACCESS_CODE: dall-e
+      EXECUTOR_NAME: DALL-E
+      EXECUTOR_IMAGE: dall-e.png # Refer to src/multi-chat/public/images
+    depends_on:
+      - kernel
+      - multi-chat
+    command: []
+    volumes: [
+      "~/.cache/huggingface:/root/.cache/huggingface",
+    ]
+    extra_hosts:
+      - "localhost:host-gateway"
+    restart: unless-stopped
+    networks: ["backend", "frontend"]