update docs

This commit is contained in:
雾聪 2023-10-23 11:17:24 +08:00
parent 6eb0dfced4
commit bbcf0d87ac
8 changed files with 12 additions and 16 deletions

View File

@ -84,7 +84,7 @@ nohup bash run_server.sh \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt > log.out 2>&1 &
--hotword ../../hotwords.txt > log.out 2>&1 &
```
Introduction to run_server.sh parameters:
@ -103,7 +103,7 @@ Introduction to run_server.sh parameters:
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close sslset 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
--hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service

View File

@ -79,8 +79,7 @@ nohup bash run_server.sh \
--io-thread-num 8 \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt
--keyfile ../../../ssl_key/server.key > log.out 2>&1 &
```
Introduction to run_server.sh parameters:
@ -99,7 +98,6 @@ Introduction to run_server.sh parameters:
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close sslset 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
--hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service

View File

@ -162,8 +162,7 @@ nohup bash run_server.sh \
--io-thread-num 8 \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt > log.out 2>&1 &
--keyfile ../../../ssl_key/server.key > log.out 2>&1 &
```
**run_server.sh命令参数介绍**
```text
@ -180,7 +179,6 @@ nohup bash run_server.sh \
--io-thread-num 服务端启动的IO线程数默认为 1
--certfile ssl的证书文件默认为../../../ssl_key/server.crt如果需要关闭ssl参数设置为0
--keyfile ssl的密钥文件默认为../../../ssl_key/server.key
--hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt
```
### 关闭FunASR服务

View File

@ -166,7 +166,7 @@ nohup bash run_server.sh \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt > log.out 2>&1 &
--hotword ../../hotwords.txt > log.out 2>&1 &
```
**run_server.sh命令参数介绍**
```text
@ -183,7 +183,7 @@ nohup bash run_server.sh \
--io-thread-num 服务端启动的IO线程数默认为 1
--certfile ssl的证书文件默认为../../../ssl_key/server.crt如果需要关闭ssl参数设置为0
--keyfile ssl的密钥文件默认为../../../ssl_key/server.key
--hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt
--hotword 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt
```
### 关闭FunASR服务

View File

@ -73,7 +73,7 @@ nohup bash run_server_2pass.sh \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt > log.out 2>&1 &
--hotword ../../hotwords.txt > log.out 2>&1 &
# If you want to close sslplease add--certfile 0
# If you want to deploy the timestamp or hotword model, please set --model-dir to the corresponding model:
@ -98,7 +98,7 @@ nohup bash run_server_2pass.sh \
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close sslset 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
--hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service

View File

@ -82,7 +82,7 @@ nohup bash run_server_2pass.sh \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
--hotwordsfile ../../hotwords.txt > log.out 2>&1 &
--hotword ../../hotwords.txt > log.out 2>&1 &
```
**run_server_2pass.sh命令参数介绍**
```text
@ -100,7 +100,7 @@ nohup bash run_server_2pass.sh \
--io-thread-num 服务端启动的IO线程数默认为 1
--certfile ssl的证书文件默认为../../../ssl_key/server.crt如果需要关闭ssl参数设置为0
--keyfile ssl的密钥文件默认为../../../ssl_key/server.key
--hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt
--hotword 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt
```
### 关闭FunASR服务

View File

@ -113,7 +113,7 @@ int main(int argc, char* argv[]) {
false, "../../../ssl_key/server.key", "string");
TCLAP::ValueArg<std::string> hotwordsfile(
"", "hotwordsfile",
"", "hotword",
"default: ../../hotwords.txt, path of hotwordsfile"
"connection",
false, "../../hotwords.txt", "string");

View File

@ -99,7 +99,7 @@ int main(int argc, char* argv[]) {
false, "../../../ssl_key/server.key", "string");
TCLAP::ValueArg<std::string> hotwordsfile(
"", "hotwordsfile",
"", "hotword",
"default: ../../hotwords.txt, path of hotwordsfile"
"connection",
false, "../../hotwords.txt", "string");