From 8baab6b6a7636e4991649763088c156c0e85b93e Mon Sep 17 00:00:00 2001 From: touamano <40252925+touamano@users.noreply.github.com> Date: Thu, 2 Sep 2021 10:51:29 +0800 Subject: [PATCH] Correct and adding punctuations to readme.md --- .../README-CN.md | 2 +- .../Domainsocket-or-Redirect-Approach/README.md | 16 +++++++++------- Shadowsocks-Websocket-Web-TLS/README-CN.md | 2 +- Shadowsocks-Websocket-Web-TLS/README.md | 14 +++++++------- Shadowsocks-gRPC-Web-TLS/README-CN.md | 6 +++--- Shadowsocks-gRPC-Web-TLS/README.md | 8 ++++---- 6 files changed, 25 insertions(+), 23 deletions(-) diff --git a/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README-CN.md b/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README-CN.md index 8c51324..35efefe 100644 --- a/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README-CN.md +++ b/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README-CN.md @@ -2,7 +2,7 @@ > 完整的设置还需要一个 web 服务器解密 TLS 后,将请求转发给位于 127.0.0.1:10000 的 v2ray。由于 [https://guide.v2fly.org/advanced/wss_and_web.html#%E9%85%8D%E7%BD%AE](https://guide.v2fly.org/advanced/wss_and_web.html#%E9%85%8D%E7%BD%AE) 已经有了服务器的设置这里不再赘述，可以按需参考白话文教程里的 web 服务器设置。 -config_server_redirect.json 和 config_server_domainsocket.json 选其一 +config_server_redirect.json 和 config_server_domainsocket.json 选其一。 如果使用 domain socket 需要修改`/etc/systemd/system/v2ray.service`。否则由于 fhs 脚本使用的 nobody 用户的权限不够，无法在/var/run 里新建文件夹`ss-loop`而导致启动失败。 diff --git a/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README.md b/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README.md index 93a031a..ed3301c 100644 --- a/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README.md +++ b/Shadowsocks-Websocket-Web-TLS/Domainsocket-or-Redirect-Approach/README.md @@ -1,16 +1,18 @@ # This is the server config.json example to utilizing V2ray as the server for Shadowsocks + V2Ray Plugin > The complete setup also requires a web server to handle the TLS and proxy pass the deciphered request to the backend v2ray server at 127.0.0.1:10000. -> You can find the web server config example at [https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration](https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration) +> You can find the web server config example at [https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration](https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration). -中文用户请看[这里](./README-CN.md) +中文用户请看[这里](./README-CN.md)。 -Choose one of the server config config_server_redirect.json and config_server_domainsocket.json +Choose one of the server config `config_server_redirect.json` and `config_server_domainsocket.json`. -If you choose to use config_server_domainsocket.json, the following extra steps are required. Since the default service file created by fhs installation scripts is using nobody as the runtime user, this user does not have the permission to create the `ss-loop` folder in `/var/run`. +If you choose to use `config_server_domainsocket.json`, the following extra steps are required. Since the default service file created by [`fhs-release.sh`](https://github.com/v2fly/fhs-install-v2ray) is using nobody as the runtime user, this user does not have the permission to create the `ss-loop` folder in `/var/run`. -Use your prefered editor to modify the systemd service file at `/etc/systemd/system/v2ray.service`. -Add the following line to the block starting with `[Service]` +> You shall repeat the following steps after using [`fhs-release.sh`](https://github.com/v2fly/fhs-install-v2ray) scripts to upgrade v2ray-core versions each time. Since this script will always override the v2ray.service file. + +Use your prefered editor to modify the systemd service file at `/etc/systemd/system/v2ray.service`.\ +Add the following line to the block starting with `[Service]`. ```properties RuntimeDirectory=ss-loop @@ -33,7 +35,7 @@ systemctl restart v2ray ## Client configuration examples -> You should change the following configurations according to your server configs +> You should change the following configurations according to your server configs. ### shadowsocks windows client configuration examples diff --git a/Shadowsocks-Websocket-Web-TLS/README-CN.md b/Shadowsocks-Websocket-Web-TLS/README-CN.md index 8c80e04..16af4eb 100644 --- a/Shadowsocks-Websocket-Web-TLS/README-CN.md +++ b/Shadowsocks-Websocket-Web-TLS/README-CN.md @@ -4,7 +4,7 @@ ## 客户端配置示意 -你应该按照服务端的设置修改对应的参数 +你应该按照服务端的设置修改对应的参数。 ### shadowsocks windows 客户端关键部分示例如下 diff --git a/Shadowsocks-Websocket-Web-TLS/README.md b/Shadowsocks-Websocket-Web-TLS/README.md index 8e4102d..0a5f3b6 100644 --- a/Shadowsocks-Websocket-Web-TLS/README.md +++ b/Shadowsocks-Websocket-Web-TLS/README.md @@ -1,17 +1,17 @@ # These settings are also compatible with Shadowsocks client + V2Ray-plugin > The complete setup also requires a web server to handle the TLS and proxy pass the deciphered request to the backend v2ray server listeing on 127.0.0.1:10000. -> You can find the web server config examples at [https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration](https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration) +> You can find the web server config examples at [https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration](https://guide.v2fly.org/en_US/advanced/wss_and_web.html#server-side-configuration). -中文用户请看[这里](./README-CN.md) +中文用户请看[这里](./README-CN.md)。 ## Shadowsocks client configuration examples -> You should change the following configurations according to your server configs +> You should change the following configurations according to your server configs. ### Shadowsocks windows client configuration examples -> mux=0 is indispensable when connecting with V2Ray-plugin, if you wish to use mux you need to try the [Domainsocket or Redirect Approach](./Domainsocket-or-Redirect-Approach/) +> `mux=0` is indispensable when connecting with V2Ray-plugin, if you wish to use mux you need to try the [Domainsocket or Redirect Approach](./Domainsocket-or-Redirect-Approach/). ```properties Server_IP: example.com or your server IP @@ -24,8 +24,8 @@ Plugin_Options: mux=0;tls;mode=websocket;path=/path;host=example.com ### shadowsocks Android plugin configuration examples -> Both the shadowsocks android and the V2Ray plugin android are mandatory, they are available on Google Play Store. -*Concurrent connections must be 0* +> Both the shadowsocks android and the V2Ray plugin android are mandatory, they are available on Google Play Store.\ +> _`Concurrent connections must be 0.`_ ```properties Plugin: v2ray @@ -33,6 +33,6 @@ Configuration: Transport_mode: websocket-tls Hostname: example.com Path: /path - Concurrent_connections: 0 + Concurrent_connections: 0 Certificate_for_TLS_verification: Not set ``` diff --git a/Shadowsocks-gRPC-Web-TLS/README-CN.md b/Shadowsocks-gRPC-Web-TLS/README-CN.md index e782a88..9dc19e6 100644 --- a/Shadowsocks-gRPC-Web-TLS/README-CN.md +++ b/Shadowsocks-gRPC-Web-TLS/README-CN.md @@ -1,16 +1,16 @@ # 最低版本要求 NGINX 的最低版本要求为 1.13.10:\ -[https://www.nginx.com/blog/nginx-1-13-10-grpc/](https://www.nginx.com/blog/nginx-1-13-10-grpc/) +[https://www.nginx.com/blog/nginx-1-13-10-grpc/](https://www.nginx.com/blog/nginx-1-13-10-grpc/)。 V2Ray-core 的最低版本要求为 v4.36.0:\ -[https://www.v2fly.org/config/transport/grpc.html#grpcobject](https://www.v2fly.org/config/transport/grpc.html#grpcobject) +[https://www.v2fly.org/config/transport/grpc.html#grpcobject](https://www.v2fly.org/config/transport/grpc.html#grpcobject)。 ## 本设置同样适用于 Shadowsocks 客户端搭配 V2Ray-plugin 使用 _你需要一个兼容 gRPC 的 v2ray-plugin 程序。 例如由[TeddySun](https://github.com/teddysun)维护的 v2ray-plugin 叉子: \ -[https://github.com/teddysun/v2ray-plugin](https://github.com/teddysun/v2ray-plugin)_ +[https://github.com/teddysun/v2ray-plugin](https://github.com/teddysun/v2ray-plugin)。_ ### 客户端设置 diff --git a/Shadowsocks-gRPC-Web-TLS/README.md b/Shadowsocks-gRPC-Web-TLS/README.md index 7b03885..f3cf439 100644 --- a/Shadowsocks-gRPC-Web-TLS/README.md +++ b/Shadowsocks-gRPC-Web-TLS/README.md @@ -1,18 +1,18 @@ # Minimum Versions -中文用户请看[这里](./README-CN.md) +中文用户请看[这里](./README-CN.md)。 Minimum NGINX version is 1.13.10:\ -[https://www.nginx.com/blog/nginx-1-13-10-grpc/](https://www.nginx.com/blog/nginx-1-13-10-grpc/) +[https://www.nginx.com/blog/nginx-1-13-10-grpc/](https://www.nginx.com/blog/nginx-1-13-10-grpc/). Minimum V2Ray-Core version is v4.36.0:\ -[https://www.v2fly.org/config/transport/grpc.html#grpcobject](https://www.v2fly.org/config/transport/grpc.html#grpcobject) +[https://www.v2fly.org/config/transport/grpc.html#grpcobject](https://www.v2fly.org/config/transport/grpc.html#grpcobject). ## These settings are also compatible with shadowsocks + v2ray-plugins _You need a grpc compatible v2ray-plugin program to use with shadowsocks client. For example the one maintained by [TeddySun](https://github.com/teddysun): \ -[https://github.com/teddysun/v2ray-plugin](https://github.com/teddysun/v2ray-plugin)_ +[https://github.com/teddysun/v2ray-plugin](https://github.com/teddysun/v2ray-plugin)._ ### Client Configurations