Skip to content
This repository has been archived by the owner on Mar 25, 2024. It is now read-only.

Commit

Permalink
translate README
Browse files Browse the repository at this point in the history
  • Loading branch information
segfault-bilibili committed Feb 14, 2022
1 parent bc5e0f9 commit c3f3591
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,45 @@

> [Gost](https://github.com/ginuerzh/gost)[Shadowsocks Android](https://github.com/shadowsocks/shadowsocks-android) 插件,可以直接在Shadowsocks安卓客户端上连接 Gost 服务器
## 🚀 安装
> [Gost](https://github.com/ginuerzh/gost) Plugin for [Shadowsocks Android](https://github.com/shadowsocks/shadowsocks-android), which allows directly connecting to a Gost server from Shadowsocks-Android client
## 🚀 安装 Install

下载 [Release](https://github.com/xausky/ShadowsocksGostPlugin/releases) 内预编译好的APK安装到设备,同时也要安装 [Shadowsocks Android](https://github.com/shadowsocks/shadowsocks-android)

## 🔧 使用
Download prebuilt APK here [Release](https://github.com/xausky/ShadowsocksGostPlugin/releases) and then install it to the device, at same time [Shadowsocks Android](https://github.com/shadowsocks/shadowsocks-android) is required to be installed as well

## 🔧 使用 Usage

* 在 Shadowsocks 客户端选中本插件,即可在参数配置除了 `-L` 参数之外的 Gost 参数以连接远程服务器或者多段代理
* `-L` 参数会自动添加,只需要在 Shadowsocks 界面配置 `none` 无加密和空密码即可
* Gost 的参数配置里面可以用`#SS_HOST``#SS_PORT`代替 Shadowsocks 配置的主机和端口

## ❗ 注意
* Pick this plugin in Shadowsocks client, then Gost can be configured (except `-L` parameter) to connect to a remote server, or multi-hop proxies
* `-L` will be automatically added, it's only required to configure Shadowsocks to use `none` encryption and empty password
* In Gost's config parameters, `#SS_HOST``#SS_PORT` represents host and port configured in Shadowsocks

## ❗ 注意 Notices

* 使用#SS_HOST参数会先对填写的主机名进行DNS解析后才传递
* 如果是与主机名相关的远程协议比如ws协议必须直接在参数里配置域名
* 在参数里面配置的域名会忽略手机系统的DNS配置固定使用 Public DNS+
* 如果插件参数里面使用 `-F=` 形式的参数传递则后续参数不能含有 `=` 号,推荐使用 `-F ` 形式代替
* ~如果插件参数里面使用 `-F=` 形式的参数传递则后续参数不能含有 `=` 号,推荐使用 `-F ` 形式代替~ 使用新版配置格式(CFGBLOB)即可避开这个问题

## ❤ 关注我
* Host specified by #SS_HOST will be firstly resolved with DNS before being passed on
* If the hostname is tied to the protocol, like WebSocket (ws), you must directly use domain name in configuration parameters
* The domain name(s) appeared in configuration parameters is/are hard-coded to be resolved with Public DNS+, in other words, ignoring the OS's DNS configurations
* ~If you configure a parameter in the form of `-F=`, then the subsequent parameters can no longer contain `=`, so it's recommended to use the form of `-F ` instead~ This issue can be avoided simply by using new config format (CFGBLOB)

## ❤ 关注我 Follow me

* Github: [@xausky](https://github.com/xausky)
* BiliBili: [@xausky](https://space.bilibili.com/8419077)

## 🤝 贡献
## 🤝 贡献 Contribution

欢迎各种问题,需求,BUG报告和代码PR!<br />提交到这里就可以 [问题页面](https://github.com/xausky/ShadowsocksGostPlugin/issues).

### ⭐ 如果这个项目帮到你的话欢迎点个星
Any kind of questions, feature requests, bug reports or pull requests are welcomed!<br />Simply submit it here [issues](https://github.com/xausky/ShadowsocksGostPlugin/issues).

### ⭐ 如果这个项目帮到你的话欢迎点个星 If you feel this project can help you, you are welcomed to tick a star

0 comments on commit c3f3591

Please sign in to comment.