Skip to content

Commit 563e3ef

Browse files
authored
Update README.md
1 parent 60199e5 commit 563e3ef

1 file changed

Lines changed: 54 additions & 41 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 54 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,78 @@
1-
# cloudscraper-proxy
2-
A simple local proxy server, powered by [cloudscraper](https://github.com/VeNoMouS/cloudscraper)
3-
<br></br>
1+
# πŸ‘» cloudscraper-proxy
42

5-
## Example
6-
Before (standard request, contents blocked by cloudflare)
3+
A simple local proxy server, powered by [cloudscraper](https://github.com/VeNoMouS/cloudscraper) library ☁️.
4+
> πŸ’‘ This allows you to easily bypass Cloudflare "restrictions" in your project, without having to add additional code
5+
6+
---
7+
8+
## πŸ‘€ See it in Action!
9+
10+
**Before** (Standard request, 🧱 contents blocked by Cloudflare):
711
![image](https://github.com/user-attachments/assets/3ce7e244-8084-4e67-a904-e5a18d229899)
812

9-
After (using the local server, contents can be accessed normally)
13+
**After** (Using the local proxy βœ…, contents accessed normally):
1014
![image](https://github.com/user-attachments/assets/1b282213-6646-4011-abf0-5c19dc3de6d7)
1115

16+
---
1217

13-
## Usage
14-
Replace the requests you'd like to make in your project
15-
```
16-
https://www.google.com
17-
```
18-
with a request to the bypass server
19-
```
20-
localhost:port/api/proxy/https://www.google.com
21-
```
22-
Then start the server so your project can make requests to it
23-
```
24-
python server.py
25-
```
26-
That's it!
27-
<br></br>
18+
## πŸš€ Getting Started
2819

29-
## Configuration
30-
Changing the port can be done simply by editing the bottom of the file
31-
```
20+
1. **Modify Your Requests:**
21+
Instead of directly requesting a URL like:
22+
```
23+
https://www.google.com
24+
```
25+
Point it to your local proxy server:
26+
```
27+
http://localhost:5000/api/proxy/https://www.google.com
28+
```
29+
*(Replace `5000` if you change the default port)*
30+
31+
2. **Start the Proxy Server:**
32+
Run the Python server:
33+
```bash
34+
python server.py
35+
```
36+
37+
That's it! πŸŽ‰ Your project can now make requests through the proxy.
38+
39+
---
40+
41+
## βš™οΈ Configuration
42+
43+
Want to change the port? Easy!
44+
45+
Edit the `server.py` file at the bottom:
46+
```python
3247
if __name__ == "__main__":
33-
print('Starting cloudflare bypass proxy server')
48+
print('Starting Cloudflare bypass proxy server...')
3449
from waitress import serve
35-
serve(app, host="0.0.0.0", port=5000) # change the port here
50+
# πŸ‘‡ Change the port here
51+
serve(app, host="0.0.0.0", port=5000)
3652
```
37-
Feel free to configure flask or other options to suite your needs
38-
39-
## Using Make Commands
40-
The project includes several Make commands to help manage the Docker container:
4153

42-
```bash
43-
# Build the Docker image
54+
## 🐳 Docker & Make Commands
55+
> πŸ’‘ The project includes several make commands to help manage the Docker container:
56+
```
57+
# πŸ—οΈ Build the Docker image
4458
make build
4559
46-
# Run the container
47-
make run
60+
# ▢️ Run the Docker container (defaults to port 5000)
61+
make run
4862
49-
# Build and run in one command
63+
# πŸš€ Build and run in one go
5064
make up
5165
52-
# Stop and remove the container
66+
# πŸ›‘ Stop and remove the container
5367
make clean
5468
55-
# View container logs
69+
# πŸ“œ View container logs
5670
make logs
5771
58-
# Restart the container
72+
# πŸ”„ Restart the container
5973
make restart
6074
61-
# Check container status
75+
# πŸ“Š Check container status
6276
make status
6377
```
64-
65-
You can change the port and container settings by editing the variables at the top of the Makefile.
78+
> πŸ”§ You can change the port and container settings by editing the variables at the top of the makefile.

0 commit comments

Comments
Β (0)