From 21ac1c537292c052af21f085100a7d356cf29907 Mon Sep 17 00:00:00 2001 From: lvsi <15239928381@163.com> Date: Sat, 11 Feb 2023 17:38:28 +0800 Subject: [PATCH] doc: update README.md --- README.md | 21 ++++++++++++++------- README.zh-CN.md | 21 ++++++++++++++------- 2 files changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 48d388f..4be93dd 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ GitHub release (latest by date) - + -
+

A high-performance and lightweight Nginx gateway service based on Openresty.

Document ：中文 / English

@@ -51,7 +51,7 @@ bash install.sh ## 4. Configuration -Some common functions of ngxway are defined in the [bin/common.sh](./bin/common.sh) file, which includes these configuration options. +Some common functions of ngxway are defined in the [conf/ngxway.conf](./conf/ngxway.conf) file, which includes these configuration options. - ```local_volume_logs_dir```: The local log directory mapped by ngxway - ```ngxway_addr```: ngxway startup address and port number @@ -64,7 +64,7 @@ Some common functions of ngxway are defined in the [bin/common.sh](./bin/common. Execute the following command to start the ngxway service. In development mode, the ngxway page will be automatically opened in Chrome after success. ```bash -bash start.sh +ngxway start ``` image @@ -73,14 +73,21 @@ bash start.sh Execute the following command to safely stop the ngxway service. ```bash -bash stop.sh +ngxway stop +``` + +### (3) Stop service +Execute the following command to safely stop the ngxway service. + +```bash +ngxway restart ``` image -### (3) Service log +### (4) Service log -The logs of ngxway during operation will be recorded in the ```local_volume_logs_dir``` log directory defined in the [bin/common.sh](./bin/common.sh) file, the default is ```/tmp /logs``` directory. +The logs of ngxway during operation will be recorded in the ```local_volume_logs_dir``` log directory defined in the [conf/ngxway.conf](./conf/ngxway.conf) file, the default is ```/tmp /logs``` directory. image diff --git a/README.zh-CN.md b/README.zh-CN.md index afdc46d..cacf619 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -9,10 +9,10 @@ GitHub release (latest by date) - +
-
+

基于Openresty的高性能轻量级Nginx网关服务

Document ：中文 / English

@@ -45,7 +45,7 @@ bash install.sh ## 四、配置 -在 [bin/common.sh](./bin/common.sh) 文件中定义了ngxway通用的一些功能，其中就包括了这些配置选项。 +在 [conf/ngxway.conf](./conf/ngxway.conf) 文件中定义了ngxway通用的一些功能，其中就包括了这些配置选项。 - ```local_volume_logs_dir```: ngxway映射在本地的日志目录 - ```ngxway_addr```: ngxway启动地址和端口号 @@ -58,7 +58,7 @@ bash install.sh 执行以下命令以启动ngxway服务。在开发模式下，成功后会自动在Chrome中打开ngxway页面。 ```bash -bash start.sh +ngxway start ``` image @@ -67,14 +67,21 @@ bash start.sh 执行以下命令即可安全停止 ngxway 服务。 ```bash -bash stop.sh +ngxway stop +``` + +### 3、重启服务 +执行以下命令即可自动重启 ngxway 服务。 + +```bash +ngxway restart ``` image -### 3、服务日志 +### 4、服务日志 -ngxway在运行过程中的日志会记录到您在 [bin/common.sh](./bin/common.sh) 文件中定义的 ```local_volume_logs_dir``` 日志目录中，默认为 ```/tmp/logs``` 目录。 +ngxway在运行过程中的日志会记录到您在 [conf/ngxway.conf](./conf/ngxway.conf) 文件中定义的 ```local_volume_logs_dir``` 日志目录中，默认为 ```/tmp/logs``` 目录。 image