Skip to content

Commit 81044f4

Browse files
committed
README_english.md updates
1 parent 7457ad7 commit 81044f4

File tree

1 file changed

+121
-105
lines changed

1 file changed

+121
-105
lines changed

README_english.md

Lines changed: 121 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# SiteProxy 2.0
2-
- [简体中文](README.md)
2+
- [Chinese ver](README.md)
3+
4+
SiteProxy is a **powerful online proxy tool** that leverages the latest technology to enhance proxy stability and compatibility. We are committed to providing a **simple, efficient, and secure** proxy service, delivering the best internet access experience for users.
5+
6+
- **Ultra-High Performance**: Utilizes Hono instead of traditional Express servers, achieving a 4x performance boost for a smoother user experience.
7+
- **Cloud Deployment**: Seamlessly supports Cloudflare Worker deployment, fast and efficient.
8+
- **AI-Powered Chat**: Integrates DuckDuckGo AI Chat, offering free access to GPT-3.5 and Claude 3, making your proxy service smarter.
9+
- **Advanced Security Protection**: Supports password-controlled proxy access, ensuring only authorized users can connect, significantly enhancing security.
10+
- **Zero Configuration**: No client-side setup required; simply visit the proxy URL to access the global internet.
11+
- **Convenient Login**: Fully supports GitHub and Telegram Web login, making operations simple and fast.
12+
- **Robust Encryption**: Employs `RSA + AES` dual encryption to protect user login credentials and prevent man-in-the-middle attacks.
13+
- **Privacy Protection**: Access the global internet through the proxy URL while hiding your real IP address to safeguard privacy.
14+
- **Seamless Experience**: No software installation or browser configuration required, providing an exceptionally convenient user experience.
315

4-
SiteProxy is a **powerful online proxy tool** that uses the latest technology to improve proxy stability and compatibility. We are committed to providing **simple, efficient, and secure** proxy services to offer users the best internet access experience.
5-
- **Ultra-high performance**: Replaces traditional Express servers with Hono, improving performance by 4 times for a smoother user experience.
6-
- **Cloud deployment**: Fully supports deployment on Cloudflare Workers, which is fast and efficient.
7-
- **AI intelligent chat**: Integrates DuckDuckGo AI Chat, providing free access to GPT-3.5 and Claude 3, making your proxy service smarter.
8-
- **Advanced security protection**: Supports password control for the proxy, allowing only authorized users to access it, greatly enhancing security.
9-
- **Zero-configuration usage**: Users do not need any client configuration; simply access the proxy URL to browse the global internet.
10-
- **Convenient login**: Fully supports GitHub and Telegram Web login, with simple and quick operations.
11-
- **Strong encryption**: Uses `RSA + AES` dual encryption technology to protect user login passwords and prevent man-in-the-middle attacks.
12-
- **Privacy protection**: Accesses the global internet through the proxy URL while hiding the user's real IP to protect privacy.
13-
- **Seamless experience**: No software installation or browser configuration is required; you can use it immediately for ultimate convenience.
1416
<details>
15-
<summary>View Principle</summary>
17+
<summary>View Architecture</summary>
1618

1719
```
1820
+----> google/youtube
@@ -23,64 +25,76 @@ user browser +-------------->+ siteproxy +-------> wikipedia
2325
+----------------+ |
2426
+----> chinese forums
2527
```
28+
2629
</details>
30+
2731
> [!CAUTION]
28-
> Strictly prohibited to use this project for any illegal purposes, otherwise bear the consequences yourself.
32+
> Strictly prohibited to use this project for any illegal purposes; violators bear the consequences.
33+
2934
> [!WARNING]
30-
> Due to support for login to multiple websites, to reduce phishing risks, SiteProxy has obfuscated the code in version 2.0 and prohibited modification of the default homepage URL.
31-
## Showcase
32-
From a Telegram user, showcasing SiteProxy after deployment with optimized IP, speed test results:
33-
![Download Speed test](https://raw.githubusercontent.com/netptop/siteproxy/master/test.png)
35+
> To reduce phishing risks, SiteProxy 2.0 obfuscates its code and prohibits modification of the default homepage URL.
36+
37+
## Notes
38+
39+
- Recommended to deploy using VPS or Docker. Cloudflare deployment may result in some websites being inaccessible due to IP restrictions imposed by certain sites.
40+
- Recommended to use DuckDuckGo for searches, as Google Search and YouTube have implemented anti-ad and anti-bot mechanisms that may limit access.
41+
3442
## Deploy to Cloudflare Pages
35-
1. **Ensure domain management**:
36-
- Ensure that your domain is managed under Cloudflare.
37-
2. **Clone repository and install dependencies**:
38-
- Ensure Node.js version 22 or higher is installed, and ensure Git is installed.
39-
- Run the command: `git clone https://github.com/netptop/siteproxy.git`
40-
- Run the command: `cd siteproxy`
41-
- Run the command: `npm install`
42-
3. **Log in to Cloudflare and create a page, if already created, skip this step**:
43-
- Go to the **Workers and Pages** section, select **Create a Page using direct upload**, and upload the `siteproxy/build/cf_page` directory that you just cloned for deployment.
44-
4. **Configure custom domain, if already configured, skip this step**:
45-
- In the **Workers & Pages** page, open the Page you just deployed.
46-
- Click on **Custom Domains** at the top, then select **Add a custom domain**, set it to your proxy domain, and activate the domain.
47-
5. **Edit configuration file**:
48-
- Open the `siteproxy/wrangler.jsonc` file with a text editor, modify the following fields and save:
49-
"name": "xxx", // Replace with the name of your Cloudflare Page
50-
"proxy_url": "https://your-proxy-domain.com", // Replace with your proxy server domain, must be HTTPS
51-
"token_prefix": "/default/" // Replace with the access password you want to set. If the password is empty, no password is required for access.
52-
6. **Re-deploy the page**:
53-
- In the cloned siteproxy directory, run: `npm run wrangler-login`
43+
1. **Ensure Domain Management**:
44+
- Confirm your domain is managed under Cloudflare.
45+
2. **Clone Repository and Install Dependencies**:
46+
- Ensure Node.js v22 or higher and Git are installed.
47+
- Run: `git clone https://github.com/netptop/siteproxy.git`
48+
- Run: `cd siteproxy`
49+
- Run: `npm install`
50+
3. **Create Cloudflare Page (Skip if already created)**:
51+
- Go to **Workers and Pages**, select **Create using direct upload**, and upload the `siteproxy/build/cf_page` directory for deployment.
52+
4. **Configure Custom Domain (Skip if already configured)**:
53+
- In **Workers & Pages**, open the deployed Page.
54+
- Click **Custom Domains** at the top, select **Add Custom Domain**, set your proxy domain, and activate it.
55+
5. **Edit Configuration File**:
56+
- Open `siteproxy/wrangler.jsonc` with a text editor, modify the following fields, and save:
57+
```json
58+
"name": "xxx", // Replace with your Cloudflare Page name
59+
"proxy_url": "https://your-proxy-domain.com", // Replace with your proxy server domain, must be HTTPS
60+
"token_prefix": "/default/" // Replace with your desired access password. Keep leading/trailing slashes. Empty password means no password is required.
61+
```
62+
6. **Redeploy Page**:
63+
- In the cloned `siteproxy` directory, run: `npm run wrangler-login`. For non-GUI VPS environments, refer to [non-GUI wrangler login](api_token_setup.md).
5464
- Run: `npm run deploy-cf-page`
55-
7. **Access the proxy service**:
56-
- Now you can access the proxy service via `https://your-proxy-domain.com/your-password/` (ensure the trailing slash exists). Remember to replace the domain and password with your own.
65+
7. **Access Proxy Service**:
66+
- Visit `https://your-proxy-domain.com/your-password/` to access the proxy service (ensure the trailing slash is included). Replace the domain and password with your own.
67+
5768
## Deploy to Cloudflare Workers
58-
1. **Ensure domain management**:
59-
- Ensure that your domain is managed under Cloudflare.
60-
2. **Clone repository and install dependencies**:
61-
- Ensure Node.js version 22 or higher is installed, and ensure Git is installed.
62-
- Run the command: `git clone https://github.com/netptop/siteproxy.git`
63-
- Run the command: `cd siteproxy`
64-
- Run the command: `npm install`
65-
3. **Create a Worker, if already created, skip this step**:
66-
- Log in to Cloudflare, go to the **Workers and Pages** section, and create a 'hello world' Worker with your own name.
67-
4. **Configure custom domain, if already configured, skip this step**:
68-
- In the **Workers and Pages** page, open the Worker you just saved.
69-
- Click on **Settings -> Custom Domains** at the top, set it to your proxy domain, and activate the custom domain.
70-
5. **Edit configuration file**:
71-
- Open the `siteproxy/wrangler.worker.jsonc` file with a text editor, modify the following fields and save:
72-
"name": "xxx", // Replace with the name of your Cloudflare Worker
73-
"proxy_url": "https://your-proxy-domain.com", // Replace with your proxy server domain, must be HTTPS
74-
"token_prefix": "/xxx/" // Replace with the access password you want to set. If the password is empty, no password is required for access.
75-
6. **Re-deploy the Worker**:
76-
- In the cloned siteproxy directory, run: `npm run wrangler-login`
69+
1. **Ensure Domain Management**:
70+
- Confirm your domain is managed under Cloudflare.
71+
2. **Clone Repository and Install Dependencies**:
72+
- Ensure Node.js v22 or higher and Git are installed.
73+
- Run: `git clone https://github.com/netptop/siteproxy.git`
74+
- Run: `cd siteproxy`
75+
- Run: `npm install`
76+
3. **Create Worker (Skip if already created)**:
77+
- Log in to Cloudflare, go to **Workers and Pages**, and create a 'hello world' Worker with your chosen name.
78+
4. **Configure Custom Domain (Skip if already configured)**:
79+
- In **Workers & Pages**, open the saved Worker.
80+
- Click **Settings -> Custom Domains**, set your proxy domain, and activate it.
81+
5. **Edit Configuration File**:
82+
- Open `siteproxy/wrangler.worker.jsonc` with a text editor, modify the following fields, and save:
83+
```json
84+
"name": "xxx", // Replace with your Cloudflare Worker name
85+
"proxy_url": "https://your-proxy-domain.com", // Replace with your proxy server domain, must be HTTPS
86+
"token_prefix": "/xxx/" // Replace with your desired access password. Keep leading/trailing slashes. Empty password means no password is required.
87+
```
88+
6. **Redeploy Worker**:
89+
- In the cloned `siteproxy` directory, run: `npm run wrangler-login`. For non-GUI VPS environments, refer to [non-GUI wrangler login](api_token_setup.md).
7790
- Run: `npm run deploy-cf-worker`
78-
7. **Access the proxy service**:
79-
- Now you can access the proxy service via `https://your-proxy-domain.com/your-password/` (ensure the trailing slash exists). Remember to replace the domain and password with your own.
91+
7. **Access Proxy Service**:
92+
- Visit `https://your-proxy-domain.com/your-password/` to access the proxy service (ensure the trailing slash is included). Replace the domain and password with your own.
93+
8094
## Deploy to VPS or Cloud Server
81-
1. **Create an SSL website**:
82-
- Use `certbot` and `nginx` to create an SSL website. You can search Google for specific usage.
83-
- Configure `nginx` to ensure the `/etc/nginx/conf.d/default.conf` file contains the following:
95+
1. **Set Up SSL Website**:
96+
- Use `certbot` and `nginx` to create an SSL website. Search Google for specific instructions.
97+
- Configure `nginx` to include the following in `/etc/nginx/conf.d/default.conf`:
8498
```nginx
8599
server {
86100
server_name your-proxy.domain.name; # Replace with your actual domain
@@ -89,64 +103,66 @@ From a Telegram user, showcasing SiteProxy after deployment with optimized IP, s
89103
}
90104
}
91105
```
92-
2. **Restart nginx**:
93-
- Run the command: `sudo systemctl restart nginx`
94-
3. **Install Node.js version 22 or higher**:
95-
- Run the following commands:
106+
2. **Restart Nginx**:
107+
- Run: `sudo systemctl restart nginx`
108+
3. **Install Node.js v22 or Higher**:
109+
- Run:
96110
```bash
97111
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
98112
source ~/.bashrc
99113
nvm install v22
100114
```
101-
4. **Clone the repository**:
102-
- Run the command: `git clone https://github.com/netptop/siteproxy.git`
103-
5. **Enter the project directory**:
104-
- Run the command: `cd siteproxy`
105-
6. **Test run**:
106-
- Run the command: `node bundle.cjs`
107-
- If there are no errors, press `Ctrl+C` to end the program.
108-
7. **Modify configuration file**:
109-
- Open and edit the `config.json` file with the following content:
115+
4. **Clone Repository**:
116+
- Run: `git clone https://github.com/netptop/siteproxy.git`
117+
5. **Enter Project Directory**:
118+
- Run: `cd siteproxy`
119+
6. **Test Run**:
120+
- Run: `node bundle.cjs`
121+
- If no errors, press `Ctrl+C` to stop the program.
122+
7. **Modify Configuration File**:
123+
- Open and edit `config.json` with the following content:
110124
```json
111125
{
112-
"proxy_url": "https://your-proxy.domain.name", // Replace with HTTPS plus your proxy server domain, ensure it uses https
113-
"token_prefix": "/user-SetYourPasswordHere/", // Set the website password to prevent unauthorized access, keep the leading and trailing slashes. Empty means no password is set
114-
"local_listen_port": 5006, // Do not modify to ensure consistency with nginx configuration
115-
"description": "Note: token_prefix acts as the website password, set it carefully. proxy_url and token_prefix together form the access URL."
126+
"proxy_url": "https://your-proxy.domain.name", // Replace with HTTPS and your proxy server domain
127+
"token_prefix": "/user-SetYourPasswordHere/", // Set website password to prevent unauthorized access; keep leading/trailing slashes. Empty means no password
128+
"local_listen_port": 5006, // Do not modify to ensure compatibility with nginx configuration
129+
"description": "Note: token_prefix acts as the website password; set it carefully. proxy_url and token_prefix combine to form the access URL."
116130
}
117131
```
118132
8. **Install Forever**:
119-
- Run the command: `npm install -g forever`
120-
9. **Start the application**:
121-
- Run the command: `forever stopall && forever start bundle.cjs`
122-
10. **Access the proxy service**:
123-
- Now you can access the proxy service via `https://your-proxy-domain.com/user-your-password/`. Please replace the domain and password with your own.
124-
11. **Use Cloudflare for acceleration (optional)**:
125-
- Refer to Cloudflare's official documentation for setup.
126-
Now, your proxy service has been successfully deployed and can be accessed via a browser.
133+
- Run: `npm install -g forever`
134+
9. **Start Application**:
135+
- Run: `forever stopall && forever start bundle.cjs`
136+
10. **Access Proxy Service**:
137+
- Visit `https://your-proxy-domain.com/user-your-password/` to access the proxy service. Replace the domain and password with your own.
138+
11. **Use Cloudflare Acceleration (Optional)**:
139+
- Refer to Cloudflares official documentation for setup instructions.
140+
127141
## Docker Deployment
128-
1. **Configure SSL certificate and Nginx**:
129-
- Configure the SSL certificate and Nginx for your domain, pointing to local port 5006.
130-
2. **Clone the repository**:
131-
- Run the command: `git clone https://github.com/netptop/siteproxy.git`
132-
3. **Edit configuration file**:
133-
- Open and modify the `config.json` file with the following content:
142+
1. **Configure SSL Certificate and Nginx**:
143+
- Set up an SSL certificate and Nginx for your domain, pointing to local port 5006.
144+
2. **Clone Repository**:
145+
- Run: `git clone https://github.com/netptop/siteproxy.git`
146+
3. **Edit Configuration File**:
147+
- Open and modify `config.json` with the following content:
134148
```json
135149
{
136-
"proxy_url": "https://your-proxy-domain.com", // Replace with the proxy server domain you applied for
137-
"token_prefix": "/user-SetYourPasswordHere/", // Set the website password to prevent unauthorized access, keep the leading and trailing slashes
138-
"description": "Note: token_prefix acts as the website password, set it carefully. proxy_url and token_prefix together form the access URL."
150+
"proxy_url": "https://your-proxy-domain.com", // Replace with your proxy server domain
151+
"token_prefix": "/user-SetYourPasswordHere/", // Set website password to prevent unauthorized access; keep leading/trailing slashes
152+
"description": "Note: token_prefix acts as the website password; set it carefully. proxy_url and token_prefix combine to form the access URL."
139153
}
140154
```
141155
- Save the file.
142-
4. **Start the Docker container**:
156+
4. **Start Docker Container**:
143157
- Enter the `docker-node` subdirectory.
144-
- Run the command: `sudo docker compose up`
145-
5. **Access the proxy service**:
146-
- Now you can access the proxy service via `https://your-proxy-domain.com/user-your-password/`. Please replace the domain and password with your own.
147-
## Thanks
148-
- The default homepage of netptop.com was designed by Telegram user SenZyo, thank you for the contribution!
149-
- The documentation was written by [LAGSNES](https://github.com/SNESNya)
158+
- Run: `sudo docker compose up`
159+
5. **Access Proxy Service**:
160+
- Visit `https://your-proxy-domain.com/user-your-password/` to access the proxy service. Replace the domain and password with your own.
161+
162+
## Acknowledgments
163+
- The default homepage of netptop.com was designed by Telegram user SenZyo. Thank you for your contribution!
164+
- Documentation written by [LAGSNES](https://github.com/SNESNya).
165+
150166
## Contact
151-
Telegram group: https://siteproxy.t.me
152-
167+
Telegram Group: https://siteproxy.t.me
168+

0 commit comments

Comments
 (0)