jsproxy/README.md

113 lines
3.4 KiB
Markdown
Raw Normal View History

2019-03-04 04:47:46 +00:00
# 在线预览
2019-04-23 04:14:27 +00:00
https://zjcqoo.github.io/-----https://www.google.com
2019-03-04 04:47:46 +00:00
(目前仍在更新中,最好使用隐身模式访问,避免缓存导致的问题)
2019-04-23 04:14:27 +00:00
[之前版本](https://github.com/EtherDream/jsproxy/tree/first-ver)已不再更新,但[演示服务](https://jsproxy.tk/)仍保留一段时间。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
# 安装
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
新建一个名为 `jsproxy` 用户,在其主目录安装 nginx
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
```bash
useradd jsproxy -g nobody
su jsproxy
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
cd ~
2019-04-23 04:18:45 +00:00
git clone --depth=1 https://github.com/EtherDream/jsproxy.git server
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
cd server
./setup-nginx.sh
```
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
安装过程若有依赖缺失可尝试CentOS 为例):
2019-03-04 04:47:46 +00:00
```bash
2019-04-23 04:14:27 +00:00
yum install -y \
gcc gcc-c++ \
pcre pcre-devel \
openssl openssl-devel \
zlib zlib-devel
2019-03-04 04:47:46 +00:00
```
2019-04-23 04:14:27 +00:00
## 测试
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
启动服务:
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
```bash
2019-04-23 05:00:31 +00:00
~/server/run.sh
2019-03-04 04:47:46 +00:00
```
2019-04-23 04:14:27 +00:00
访问https://etherdream.github.io/jsproxy-localtest/-----https://github.com/
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
![](https://raw.githubusercontent.com/EtherDream/jsproxy-localtest/temp/preview.png)
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
注意,**当前项目只提供接口服务**,浏览器端脚本和页面不在本项目。这样做是为了让接口和界面分离,意义参见后续。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
# 部署
2019-03-04 04:47:46 +00:00
2019-04-23 06:18:38 +00:00
参考 `gen-cert` 目录,为自己的域名申请证书。(不申请证书也可以,例如通过 CloudFlare
修改 `nginx.conf` 中域名相关的配置(默认被注释),以及 DNS 地址(默认是 114.114.114.114)。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
浏览器端项目位于https://github.com/EtherDream/jsproxy-browser
2019-03-04 04:47:46 +00:00
2019-04-23 05:12:56 +00:00
参考备注,修改线路服务器地址,之后将 www 目录发布到 Web 空间即可。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
(目前还不完善,之后将实现动态配置,无需修改 JS 代码)
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
# 安全策略
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
如果不希望代理访问内网,可执行 `setup-ipset.sh`,避免 SSRF 风险。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
该脚本可禁止 `jsporxy` 用户访问内网(针对 TCP。nginx 之外的程序也生效,但不影响其他用户。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
# 服务管理
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
重启服务:`./run.sh reload`
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
关闭服务:`./run.sh quit`
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
参数和 nginx -s 相同。
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
# CHANGELOG
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
## v0.0.1
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
虽然目前仍为概念演示状态,但相比[最初版本](https://github.com/EtherDream/jsproxy/tree/first-ver),有了很大变化:
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
### 不再使用子域名
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
使用子域名编码目标域名(例如 gg.jsproxy.tk存在太多缺陷。例如 HTTPS 证书问题DNS 性能和安全问题等。因此目前不再使用子域名,只用固定的域名,目标 URL 放在路径里。例如:
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
https://zjcqoo.github.io/-----https://www.google.com
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
当然这也会产生很多新问题,例如无法支持 Cookie、页面之间没有同源策略限制等。
2019-03-04 04:47:46 +00:00
2019-04-23 05:12:56 +00:00
对于 Cookie目前通过 JS 来维护,而不用浏览器原生(当然还有不少细节没实现)。这样的好处是前后端可以分离,前端页面可以放在第三方 Web 服务器上(例如 CDN、GitHub Pages我们的服务器只提供代理接口。
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
这样一个页面可使用多个服务器的代理接口,并能实现线路切换、负载均衡等效果。
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
同源策略方面的限制目前暂未实现,因此不要进行登陆等操作,避免隐私泄露。
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
### 服务端优化
2019-03-04 04:47:46 +00:00
2019-04-23 04:14:27 +00:00
安全改进:由于 Web 页面托管在第三方站点上,自己的服务器无需开启 443 端口,因此也无需 root 运行。同时支持 IP 黑名单功能,防止 SSRF 攻击。
2019-03-04 04:47:46 +00:00
2019-04-23 05:12:56 +00:00
代码改进:接口代理使用固定的 URL参见 `api.conf`),不再使用任意路径,代码干净了很多。
2019-03-04 04:47:46 +00:00
2019-04-23 04:45:31 +00:00
### 提供一个首页
2019-03-04 04:47:46 +00:00
2019-04-23 05:12:56 +00:00
虽然依旧简陋,但比之前好。提供了线路切换、预加载的功能。
2019-03-04 04:47:46 +00:00
# License
MIT