oiupoyt/katproxy
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: remove api endpoints and simplify readme to minimal style

Browse source
This commit is contained in:
katR 2026-09-25 18:00:47 +05:30
parent a890e12736
commit 199faef82f
1 changed files with 21 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -1,67 +1,36 @@
# katproxy
Minimal proxy list aggregator and live TCP latency prober.
minimal proxy list aggregator and live TCP latency prober.
↗ [katproxy.oiupoyt.space](https://katproxy.oiupoyt.space)
## features
---
- autofetches public proxy lists from multiple upstream sources
- concurrent non-blocking TCP socket prober measuring live round-trip latency
- clean, square brutalist dark interface with interactive constellation background
- protocol filters (HTTP, HTTPS, SOCKS4, SOCKS5)
- instant search, sort by latency, and alive-only filter
- one-click copy for `host:port`, cURL commands, and proxy URLs
- export full proxy lists as `.txt` or copy all visible to clipboard
- auto-refresh timer loop with manual re-probe trigger
## Overview
katproxy collects proxies from multiple public repositories (`monosans/proxy-list`, `TheSpeedX/PROXY-List`, `hookzof/socks5_list`), normalizes them, and runs concurrent TCP socket checks to verify responsiveness and record round-trip latency.
The backend runs as a lightweight daemon on an Android tablet (Termux) exposed via Cloudflare Tunnel. The frontend is a static web app hosted on Cloudflare Pages.
---
## API Reference
Base URL: `https://katproxy-api.oiupoyt.space`
| Method | Endpoint | Parameters | Description |
|---|---|---|---|
| `GET` | `/api/health` | — | Service uptime and status |
| `GET` | `/api/stats` | — | Total count, alive count, protocol breakdown, avg latency |
| `GET` | `/api/proxies` | `protocol`, `alive`, `search`, `sort`, `limit`, `page` | Filtered and paginated proxy list |
| `GET` | `/api/raw` | `protocol`, `alive`, `format` (`ip:port` or `url`) | Plaintext list for shell scripts and curl |
| `POST` | `/api/refresh` | — | Trigger upstream re-fetch and verification cycle |
### Usage Examples
## backend (rust)
```bash
# Fetch fastest alive SOCKS5 proxies
curl "https://katproxy-api.oiupoyt.space/api/proxies?protocol=socks5&alive=true&limit=10"
cd backend
# Stream raw IP:PORT pairs
curl -s "https://katproxy-api.oiupoyt.space/api/raw?protocol=socks5&alive=true"
# run in development
cargo run
# or run optimized release
cargo run --release
```
---
Environment variables:
- `PORT` (default: `5050`)
- `HOST` (default: `0.0.0.0`)
## Architecture
- **Backend (`/backend`)**: High-performance Rust (Axum + Tokio) service running on port `5050`. Features non-blocking TCP socket prober and automated refresh background worker.
- **Frontend (`/public`)**: Vanilla JavaScript, CSS, and HTML with JetBrains Mono typography, auto-refresh countdown, and one-click copy actions.
- **Tunnel**: Managed by `cloudflared` routing `katproxy-api.oiupoyt.space` to `localhost:5050`.
---
## Tablet Service Management
```bash
# Check status and recent logs
~/katproxy-backend/status.sh
# Start or restart daemon
~/katproxy-backend/start.sh
# Stop daemon
~/katproxy-backend/stop.sh
```
---
## License
## license
MIT