Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
netptop committed Sep 19, 2020
1 parent 972c7a6 commit daa4509
Showing 1 changed file with 29 additions and 16 deletions.
45 changes: 29 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,28 @@ user browser +-------------->+ siteproxy +-------> wikipedia
+----------------+ |
+----> chinese forums
```
## 目录

## features
- [特点](#特点)
- [原理](#原理)
- [支持代理的网站](#支持代理的网站)
- [部署到cloudflare worker](#部署到cloudflare worker)
- [部署到now.sh服务器](#部署到now.sh服务器)
- [部署到heroku服务器](#部署到heroku服务器)
- [部署到vps服务器](#部署到vps服务器)
- [now.sh deployment](#now.sh deployment)
- [vps deployment](#vps deployment)
- [联系方式](#联系方式)

### 特点
- 代码量只有jsproxy的十分之一左右
- 不使用service worker,不会和网站本身的service worker冲突
- enter siteproxy's address, and go surf on internet without censorship
- no proxy setting from client side is needed. zero configuration from client browser
- easy deployment to now.sh
- support downloading files

## Mechanism
### 原理
```
1. user browser url: https://siteproxy.herokuapp.com/https/www.google.com
2. siteproxy.herokuapp.com received the url and request www.google.com, and get response from www.google.com
Expand All @@ -30,34 +44,35 @@ user browser +-------------->+ siteproxy +-------> wikipedia
4. send back the modified html/javascript to user browser.
```

## supported websites
### 支持代理的网站
```
1. www.google.com, and search action.
2. www.youtube.com, only firefox browser is supported.
3. zh.wikipedia.org, and search action.
4. facebook, login is not verified.
5. twitter, search in twitter, login is not supported.
6. telegram web login
7. 中文论坛等
```

## 部署到cloudflare worker
### 部署到cloudflare worker
```
1. 注册一个cloudflare账户
2. 在cloudflare上创建一个worker, 记下这个worker的子域名, 比如 abcd123.xxxx.workers.dev
3. 找到本repo的build/worker.js文件,用文本编辑器打开,搜索siteproxy.netptop.workers.dev,替换成你的子域名
4. 在cloudflare上编辑刚刚创建的worker, 将worker.js所有内容拷贝粘贴到worker里面,保存
5. 现在应该可以在浏览器中 访问你的子域名了
```
## 部署到now.sh服务器(可能有问题,暂时没有now账户测试)
### 部署到now.sh服务器
```
(可能有问题,暂时没有now账户测试)
1. 注册一个now账户https://zeit.co/home
2. 没有github账户的话, 注册一个github账户,fork本repo
3. 在now的控制台里面创建一个应用, 且绑定到你刚才fork的repo上, 会得到一个域名类似的域名:your-domain-name.now.sh
4. 在github上修改你刚fork的repo, 将config.js里的serverName修改为你的新域名:
serverName: 'siteproxy.netptop.com' ====> 'your-domain-name.now.sh'
5. 现在可以在浏览器里面访问你的新域名了: https://your-domain-name.now.sh
```
## 部署到heroku服务器
### 部署到heroku服务器
```
1. 注册一个heroku账户: https://www.heroku.com/
2. 没有github账户的话, 注册一个github账户,fork本repo
Expand All @@ -68,7 +83,7 @@ user browser +-------------->+ siteproxy +-------> wikipedia
====> "web: herokuAddr=your-domain-name.herokuapp.com npm run start"
6. 现在可以在浏览器里面访问你的新域名了: https://your-domain-name.herokuapp.com
```
## 部署到vps服务器
### 部署到vps服务器
```
1. 创建一个ssl website(使用certbot and nginx, google下用法), 配置nginx,
/etc/nginx/conf.d/default.conf 需要包含以下内容:
Expand Down Expand Up @@ -96,7 +111,7 @@ user browser +-------------->+ siteproxy +-------> wikipedia
8. 如果想套CloudFlare加速, 可以参考CloudFlare说明
```

## now.sh deployment (local deployment)
### now.sh deployment
```
1. register one now.sh account from https://zeit.co/home
2. npm install -g now
Expand All @@ -110,7 +125,7 @@ user browser +-------------->+ siteproxy +-------> wikipedia
9. done
```
## vps deployment
### vps deployment
```
1. create ssl website(using certbot and nginx), and configure nginx as follow:
vi /etc/nginx/sites-available/default:
Expand All @@ -132,9 +147,7 @@ user browser +-------------->+ siteproxy +-------> wikipedia
6. forever start -c 'node --tls-min-v1.0' index.js
7. done, now you can access your domain name from browser.
```
## Telegram群: @siteproxy
## email: [email protected]

## issues
- 部分网站加载有问题;
- twitter暂时无法看视频;
### 联系方式
Telegram群: @siteproxy
<br />
email: [email protected]

0 comments on commit daa4509

Please sign in to comment.