change readme for more detail

This commit is contained in:
zhaomingwork 2023-05-15 07:00:16 +00:00
parent 98c71103ae
commit c8fe32c5bc

View File

@ -9,42 +9,53 @@ pyOpenSSL
```
### javascript
[html5录音](https://github.com/xiangyuecn/Recorder)
```shell
Recorder [html5录音](https://github.com/xiangyuecn/Recorder)
Recorder
```
## html5服务配置
### 启动html5服务
### demo页面如下
![img](https://github.com/alibaba-damo-academy/FunASR/blob/for-html5-demo/funasr/runtime/html5/demo.gif)
## 具体数据流向:
浏览器https麦克风 --> html5 demo服务 --> js wss接口 --> nginx服务 --> ws asr online srv
## 1.html5 demo服务启动
### 启动html5服务需要ssl证书(自己生成请往后看)
```shell
usage: h5Server.py [-h] [--host HOST] [--port PORT] [--certfile CERTFILE]
[--keyfile KEYFILE]
python h5Server.py --port 1337
```
注:
wsconnecter.js里配置online asr wss路径
## 2.启动ws asr online srv
[具体请看online asr](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/websocket)
目前online asr只提供ws接口需要通过nginx将wss转发到该online asr端口上
## 3.修改wsconnecter.js里asr接口地址
wsconnecter.js里配置online asr服务地址路径这里配置的是nginx的wss端口)
var Uri = "wss://xxx:xxx/"
### 浏览器打开地址
## 4.配置nginx并启动
## 5.浏览器打开地址测试
https://127.0.0.1:1337/static/index.html
### demo页面如下
![img](https://github.com/alibaba-damo-academy/FunASR/blob/for-html5-demo/funasr/runtime/html5/demo.gif)
## 后端配置
## nginx配置说明(了解的可以跳过)
h5打开麦克风需要https协议同时后端的asr websocket也必须是wss协议而目前[online asr](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/websocket)模型只支持ws协议所以我们通过nginx配置实现wss协议到ws协议的转换。
## 具体过程如下:
浏览器htts --> html5 demo服务 --> js wss接口 --> nginx服务 --> ws asr online srv
## 配置nginx wss协议(了解的可以跳过)
## 自行生成证书
生成证书(注意这种证书并不能被所有浏览器认可,部分手动授权可以访问,最好使用其他认证的官方ssl证书)
### 生成私钥,按照提示填写内容
```shell
### 1)生成私钥,按照提示填写内容
openssl genrsa -des3 -out server.key 1024
### 生成csr文件 ,按照提示填写内容
### 2)生成csr文件 ,按照提示填写内容
openssl req -new -key server.key -out server.csr
### 去掉pass
@ -53,6 +64,7 @@ openssl rsa -in server.key.org -out server.key
### 生成crt文件有效期1年365天
openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt
```
## nginx转发配置示例
```shell
@ -76,7 +88,7 @@ http {
location /wss/ {
proxy_pass http://127.0.0.1:1111/; # asr online model ws address:port
proxy_pass http://127.0.0.1:1111/; # asr online model ws address and port
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";