Last active
August 24, 2018 13:51
-
-
Save chenshaoju/9796bb4783b81f64d718065801b085ca to your computer and use it in GitHub Desktop.
non-sip003 support
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### Important | |
This manual only applicable on the non-SIP003 standard plugin, if your using plugin is in compliance with the SIP003 standard, read plugin manual or README file to config. | |
### Environment Variables | |
In Shadowsocks for Windows, can use 3rd plugins without [SIP003](https://github.com/shadowsocks/shadowsocks-org/wiki/Plugin) standard support. | |
Shadowsocks for Windows provided 4 environment variables for plugin config: | |
`%SS_LOCAL_HOST%` `%SS_LOCAL_PORT%` `%SS_REMOTE_HOST%` `%SS_REMOTE_PORT%` | |
These environment variables will inform plugin how to config localhost address, local port number, remote host address, and remote port number. | |
### QuickStart | |
Download plugin to Shadowsocks.exe directory or somewhere you must know, for example: | |
``` | |
D:\Shadowsocks\client_windows_amd64.exe | |
``` | |
Read plugin manual, find out how to use the parameter to config plugin and how to assign server host, server port, localhost and local port. | |
In most case, you can use `-h` parameter in the command line (cmd.exe) to get this information: | |
``` | |
client_windows_amd64.exe -h | |
``` | |
Open Shadowsocks for Windows "Edit Servers" window, Add server as usual. | |
In Server Port, write plugin port on server. | |
In Plugin Program, write the plugin path, for example: | |
``` | |
D:\Shadowsocks\client_windows_amd64.exe | |
``` | |
In Plugin Options, keep it blank. | |
In Plugin Arguments, for example, The plugin is [kcptun](https://github.com/xtaci/kcptun), The kcptun using `-l` parameter to assign `local:port`, `-r` parameter to assign `server:port`, Then: | |
``` | |
-l %SS_LOCAL_HOST%:%SS_LOCAL_PORT% -r %SS_REMOTE_HOST%:%SS_REMOTE_PORT% --key <Plugin Password> --crypt <Encryption algorithm> --mode <Selected mode> | |
``` | |
When everything is done, just click the OK button, and should be work. | |
### Troubleshooting | |
If not working, open Task Manager, go to Progress tab(or details tab), check progress list, is plugin program file name in the list? | |
If not, maybe is some wrong in the plugin parameter, usually is the spelling mistake or too many arguments. | |
If it's in Progress list, maybe is parameter variate is wrong, usually is password is not correct, encryption algorithm or mode not matching, check settings with server-side config. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### 重要 | |
本手册只针对非SIP003规范的插件进行配置,如果你是用的插件符合SIP003规范,请阅读插件的手册或帮助文档来进行配置。 | |
### 环境变量 | |
在 Shadowsocks for Windows 中,可通过环境变量来使用不支持[SIP003](https://github.com/shadowsocks/shadowsocks-org/wiki/Plugin)规范的插件。 | |
Shadowsocks for Windows 提供了四个环境变量对插件进行基本的配置: | |
`%SS_LOCAL_HOST%` `%SS_LOCAL_PORT%` `%SS_REMOTE_HOST%` `%SS_REMOTE_PORT%` | |
这些环境变量将会告知插件如何配置本机地址、本机端口、远程地址、远程端口。 | |
### 快速入门 | |
下载插件,并保存到 Shadowsocks.exe 所在的目录,或者其他你知道的路径中,例如: | |
``` | |
D:\Shadowsocks\client_windows_amd64.exe | |
``` | |
阅读插件的手册或说明文件,了解如何配置插件参数,以及如何指定本机地址、本机端口、远程地址和远程端口。 | |
对于大多数情况,可以在命令行(cmd.exe)下使用 `-h` 参数来获得这些信息: | |
``` | |
client_windows_amd64.exe -h | |
``` | |
打开 Shadowsocks for Windows 的“编辑服务器”对话框,像往常一样填写服务器信息。 | |
在服务器端输入框中,填写服务器端的插件端口号。 | |
在插件程序输入框中,输入插件路径,比如: | |
``` | |
D:\Shadowsocks\client_windows_amd64.exe | |
``` | |
插件选项保持空白。 | |
在插件参数中,以[kcptun](https://github.com/xtaci/kcptun)为例,kcptun使用`-l`参数来指定`本机地址:本机端口`,使用`-r`参数来指定`远程地址:远程端口`,那么: | |
``` | |
-l %SS_LOCAL_HOST%:%SS_LOCAL_PORT% -r %SS_REMOTE_HOST%:%SS_REMOTE_PORT% --key <插件密码> --crypt <加密方式> --mode <选择的模式> | |
``` | |
当一切配置完毕后,点击确定按钮,即可开始工作。 | |
### 疑难解答 | |
如果不工作,打开Windows 任务管理器,转到进程(或详情)选项卡,检查进程列表,插件程序的文件名是否出现在进程列表中? | |
如果没有出现,说明可能是由于指定的插件参数存在问题,通常是由于拼写错误或者参数冲突导致的。 | |
如果存在于进程列表中,可能是由于指定的参数变量有误,通常是由于密码不正确、加密协议或者模式不匹配,可配合服务端设置检查配置是否一致。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment