Release v0.3.2

- refactor: MusharingChatbot -> v2 chatbotapi - fix #27 - build: docker network debug - apply changes from #30 - docs: update README: - add help to externalsayer - add troubleshooting
cdfmlr · Apr 16, 2023 · ec3af81 · ec3af81
1 parent 8402761
commit ec3af81
Show file tree

Hide file tree

Showing 5 changed files with 113 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -80,7 +80,46 @@ docker compose restart muvtuberdriver
    - 语音 AudioView：`http://127.0.0.1:51082/?controller=ws://127.0.0.1:51081/`
    - 弹幕 Blivechat：先用浏览器打开 http://localhost:12450，按需配置，然后复制粘贴链接和样式。
 
-## OBS 配置详解
+## 配置详解
+
+### externalsayer 配置详解
+
+> 这里将配置使用免费、高质量的 Azure 的 TTS 服务。（目前也只支持这一种。）
+> 该服务的介绍: 
+> https://azure.microsoft.com/zh-cn/products/cognitive-services/text-to-speech/
+
+这一块的配置在 `configs/externalsayer/config.yaml` 中：
+
+```yaml
+SrvAddr: "localhost:50010"
+EnabledSayer: "azure"
+AzureSayer:
+  SpeechKey: "your-key"
+  SpeechRegion: "eastus"
+  FormatMicrosoft: "audio-16khz-32kbitrate-mono-mp3"
+  FormatMimeSubtype: "mp3"
+  Roles:
+    "default": '<speak version="1.0" xml:lang="zh-CN"><voice name="zh-CN-XiaoxiaoNeural">{{.}}</voice></speak>'
+```
+
+你需要更改：SpeechKey, SpeechRegion 以及 Roles。
+
+- SpeechKey, SpeechRegion： 你在 Azure 上申请的 TTS 服务的 key 和 region。
+   - 具体的申请流程可以参考文档：[快速入门：将文本转换为语音](https://learn.microsoft.com/zh-CN/azure/cognitive-services/speech-service/get-started-text-to-speech)
+- Roles：`<voice name="xx-XX-Xxx">`这里的 name 应该填写 voice，即“发音人”的名字。具体的列表可以通过以下命令获取：
+
+```sh
+curl https://eastus.tts.speech.microsoft.com/cognitiveservices/voices/list --header 'Ocp-Apim-Subscription-Key: xxx'
+```
+
+我把请求的结果格式化放到了这个文件里，方便查找：[`externalsayer/azuresayer/voices
+/voices-list.json`](https://github.com/cdfmlr/externalsayer/blob/23e32a07de224d6ac19cf3aee0575a3e81e9836a/azuresayer/voices/voices-list.json)。
+
+你可以在网页上的「[Speech Studio](https://aka.ms/speechstudio/voicegallery)」里试听、选择声音。然后在文件里找到对应 voice 的 `"ShortName": "xx-XX-Xxx"` 填写到 `<voice name="xx-XX-Xxx">`。
+
+🌟 更推荐的一种方式是，在「[Speech Studio](https://aka.ms/speechstudio/voicegallery)」中随便写点内容，选择声音让它说，并微调各种参数，满意之后，把 SSML 导出出来，把内容替换为 `{{.}}`，去掉换行（我写了个脚本帮助做这件事，[可以点这里找到](https://github.com/cdfmlr/externalsayer/tree/23e32a07de224d6ac19cf3aee0575a3e81e9836a/azuresayer/voices)）写到配置里。
+
+###  OBS 配置详解
 
 给新手的 OBS 配置详解：
 
@@ -276,6 +315,48 @@ brew install obs
 
 > 使用前文的 docker compose 方式部署。不再提供散装微服务的部署文档了。
 
+## Troubleshooting  
+
+### docker compose up 构建 musharing_chatbot 镜像时 ProxyError
+
+如果出现 ProxyError，或者：
+
+- Cannot connect to proxy.
+- Name or service not known.
+
+需要修改 `musharing_chatbot/Dockerfile` 中的代理设置。
+
+```docker
+# TODO: modify port 1000 to your own port to your local proxy
+RUN	HTTPS_PROXY=http://host.docker.internal:1000 poetry run python -m spacy download en_core_web_sm
+```
+
+这个东西必须访问 GitHub，如果你的网络环境不允许直接访问 GitHub，可以使用代理。如果你可以直接访问 GitHub（你用旁路由也算），可以删除 `HTTPS_PROXY=http://host.docker.internal:1000`。
+
+### 启动后 chatgpt_chatbot 一直出现网络问题
+
+查看日志发现：
+
+```
+...
+muvtuber-chatgpt_chatbot-1    |     raise ProxyError(e, request=request)
+muvtuber-chatgpt_chatbot-1    | requests.exceptions.ProxyError: HTTPSConnectionPool(host='openaipublic.blob.core.windows.net', port=443): Max retries exceeded with url: /encodings/cl100k_base.tiktoken (Caused by ProxyError('Cannot connect to proxy.', NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f968bfdbac0>: Failed to establish a new connection: [Errno -2] Name or service not known')))
+```
+
+需要在 `docker-compose.yml` 中修改代理配置：
+
+```yaml
+  chatgpt_chatbot:
+    ...
+    environment:
+      - HTTP_PROXY=http://host.docker.internal:10809
+      - HTTPS_PROXY=http://host.docker.internal:10809
+```
+
+如果你的网络环境不允许直接访问 OpenAI 的 API，可以使用代理。如果你可以直接访问 ChatGPT（你用旁路由也算），需要删除两行配置。
+
+如果配置后，仍然有 `Name or service not known` 的错误，可以尝试通过 Docker Desktop 的 `settings-resources-proxies` 写宿主机的 IP（就是宿主机以太网下的本地 IPv4 地址）。（感谢 [@RAINighty](https://github.com/RAINighty) 提供的解决方案，详见 https://github.com/cdfmlr/muvtuber/issues/30 的讨论）
+
 ## FAQ
 
 我（个人/商业/以及任意情况）可以使用这个项目嘛？

diff --git a/configs/muvtuberdriver/config.yaml b/configs/muvtuberdriver/config.yaml
@@ -9,22 +9,27 @@ live2d:
     forwarder: http://live2ddriver:9002/live2d
 chatbot:
     musharing:
-        disabled: false
         server: musharing_chatbot:50051
-    chatgpt:
         disabled: false
+    chatgpt:
         server: chatgpt_chatbot:50052
         configs:
             - version: 3
-              apikey: sk-xxx
-              initialprompt: "you are muli, an AI VTuber live streaming."
+              apikey: sk_xxx
+              initialprompt: You are muli, an AI VTuber live streaming.
         cooldown: 15
+        disabled: false
 sayer:
     server: externalsayer:50010
-    role: default
+    role: miku
 listen:
     textinhttp: 0.0.0.0:51080
     audiocontrollerws: 0.0.0.0:51081
 readdm: true
 reduceduration: 5
-toolongdontsay: 500
+toolong:
+    maxwords: 500
+    quibbles:
+        - 太长了，不想说。
+        - 禁則事項です。
+        - 爬。
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -4,59 +4,45 @@ services:
     image: cdfmlr/muvtuber-blivechat:v1.6.1-muvtb.2
     build: ./blivechat/
     ports:
-      - "127.0.0.1:51060:12450"
+      - "51060:12450"
     dns:
       - 1.1.1.1
       - 8.8.8.8
-    networks:
-      - default
     restart: unless-stopped
   emotext:
     image: cdfmlr/muvtuber-emotext:v0.0.1
     build: ./emotext/
     ports:
-      - "127.0.0.1:51061:9003"
-    dns:
-      - 1.1.1.1
-      - 8.8.8.8
+      - "51061:9003"
     restart: unless-stopped
   chatgpt_chatbot:
     image: cdfmlr/muvtuber-chatgpt_chatbot:v0.0.2
     build: ./chatgpt_chatbot/
     ports:
-      - "127.0.0.1:51052:50052"
+      - "51052:50052"
     dns:
       - 1.1.1.1
       - 8.8.8.8
-    networks:
-      - default
     environment:
-      # 192.168.5.2 是我的 docker vm 访问宿主机的 ip
-      # 需要根据每个人的情况具体设置。
-      - HTTP_PROXY=http://192.168.5.2:1000
-      - HTTPS_PROXY=http://192.168.5.2:1000
+      # 本地代理的地址：需要根据每个人的情况具体设置
+      # host.docker.internal 是 docker desktop 默认带有的访问宿主机的域名，
+      # 但不一定有效，例如我的 docker vm 访问宿主机的 ip 需要用 192.168.5.2
+      - HTTP_PROXY=http://host.docker.internal:1000
+      - HTTPS_PROXY=http://host.docker.internal:1000
     restart: unless-stopped
   musharing_chatbot:
-    image: cdfmlr/muvtuber-musharing_chatbot:v0.0.1
+    image: cdfmlr/muvtuber-musharing_chatbot:v0.0.2
     build: ./musharing_chatbot/
     ports:
-      - "127.0.0.1:51051:50051"
-    dns:
-      - 1.1.1.1
-      - 8.8.8.8
+      - "51051:50051"
     restart: unless-stopped
   live2ddriver:
     image: cdfmlr/muvtuber-live2ddriver:v0.0.2
     build: ./live2ddriver/
     ports:
-      - "127.0.0.1:51071:9001"
-      - "127.0.0.1:51072:9002"
-      - "127.0.0.1:51074:9004"
-    dns:
-      - 1.1.1.1
-      - 8.8.8.8
-    links:
-      - emotext
+      - "51071:9001"
+      - "51072:9002"
+      - "51074:9004"
     environment:
       - EMOTEXT_SERVER=http://emotext:9003
     depends_on:
@@ -66,16 +52,13 @@ services:
     image: cdfmlr/muvtuber-live2dview:v0.0.1
     build: ./live2dview/
     ports:
-      - "127.0.0.1:51070:80"
-    dns:
-      - 1.1.1.1
-      - 8.8.8.8
+      - "51070:80"
     restart: unless-stopped
   externalsayer:
     image: cdfmlr/muvtuber-externalsayer:v0.0.2
     build: ./externalsayer/
     ports:
-      - "127.0.0.1:51065:50010"
+      - "51065:50010"
     volumes:
       - ./configs/externalsayer:/app/config
     restart: unless-stopped
@@ -86,11 +69,11 @@ services:
       - "51082:80"
     restart: unless-stopped
   muvtuberdriver:
-    image: cdfmlr/muvtuber-muvtuberdriver:v0.0.3
+    image: cdfmlr/muvtuber-muvtuberdriver:v0.0.6
     build: ./muvtuberdriver/
     ports:
-      - "127.0.0.1:51080:51080"
-      - "127.0.0.1:51081:51081"
+      - "51080:51080"
+      - "51081:51081"
     volumes:
       - ./configs/muvtuberdriver:/app/config
     depends_on:
@@ -100,7 +83,4 @@ services:
       - chatgpt_chatbot
       - externalsayer
     restart: unless-stopped
-networks:
-  default:
-    driver: bridge
 
diff --git a/musharing_chatbot b/musharing_chatbot
diff --git a/muvtuberdriver b/muvtuberdriver