Skip to content

Commit 3d4c5ef

Browse files
docs: Update README
1 parent 2f6e4b5 commit 3d4c5ef

1 file changed

Lines changed: 82 additions & 4 deletions

File tree

README.md

Lines changed: 82 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# surenav
2-
"Open-source web unblocker for AI agents - no API keys required"
31
# 🧭 SureNav
42

53
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
@@ -8,7 +6,7 @@
86

97
**SureNav** is a fully open-source web navigation and scraping toolkit for AI agents that requires **zero API keys**. It provides anti-detection browser automation, intelligent proxy rotation, and web unblocking capabilities—completely free.
108

11-
> 🚀 **Drop-in replacement for paid services** like Massive's ClawPod, but open source and free forever.
9+
> 🚀 **Drop-in replacement for paid services** like Massive's ClawPod, but open source and free forever.
1210
1311
## ✨ Features
1412

@@ -25,4 +23,84 @@
2523
### Docker (Easiest)
2624

2725
```bash
28-
docker run -p 8000:8000 ghcr.io/YOUR_USERNAME/surenav:latest
26+
docker run -p 8000:8000 ghcr.io/colomboai-com/surenav:latest
27+
```
28+
29+
### Local Installation
30+
31+
```bash
32+
pip install surenav
33+
playwright install chromium
34+
surenav-server
35+
```
36+
37+
## 📖 Usage
38+
39+
### Fetch a Web Page
40+
41+
```bash
42+
curl "http://localhost:8000/browser?url=https://example.com"
43+
```
44+
45+
### Search Google
46+
47+
```bash
48+
# JSON output
49+
curl "http://localhost:8000/search?terms=open+source+ai&format=json"
50+
51+
# HTML output
52+
curl "http://localhost:8000/search?terms=python+tutorial"
53+
```
54+
55+
### Python SDK
56+
57+
```python
58+
from surenav import StealthBrowser
59+
60+
browser = StealthBrowser()
61+
result = await browser.fetch_page("https://example.com")
62+
print(result["content"])
63+
```
64+
65+
## 🏗️ Architecture
66+
67+
```mermaid
68+
graph LR
69+
A[Client Request] --> B[FastAPI Server]
70+
B --> C[Proxy Manager]
71+
C --> D[Free Proxy Lists]
72+
B --> E[Stealth Browser]
73+
E --> F[Playwright + Stealth]
74+
F --> G[Target Website]
75+
G --> H[Clean Content]
76+
H --> A
77+
```
78+
79+
## ⚙️ Configuration
80+
81+
Environment variables:
82+
83+
| Variable | Default | Description |
84+
|----------|---------|-------------|
85+
| `SURENAV_PORT` | 8000 | Server port |
86+
| `SURENAV_PROXY_REFRESH` | 300 | Proxy refresh interval (seconds) |
87+
| `SURENAV_HEADLESS` | true | Run browser headless |
88+
| `SURENAV_MAX_RETRIES` | 3 | Retry attempts per request |
89+
90+
## 🛡️ Anti-Detection Features
91+
92+
- ✅ User agent rotation
93+
- ✅ Viewport fingerprint randomization
94+
- ✅ WebGL/Canvas noise injection
95+
- ✅ Automation flag removal
96+
- ✅ Mouse movement humanization
97+
- ✅ Cookie/session handling
98+
- ✅ TLS/JA3 fingerprint randomization (planned)
99+
100+
## 🤝 Contributing
101+
102+
Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
103+
104+
## 📜 License
105+
106+
MIT - Free for personal and commercial use.

0 commit comments

Comments
 (0)