mtproto-checker 0.3.0 → 0.4.0

package/README.md

@@ -5,7 +5,7 @@ Telegram MTProto proxy health checker powered by **TDLib**. Performs a real `tes
 ## ⚡ Features
 
 - 🤝 Real MTProto handshake (not just a port scan)
-- 📡 Check from remote URLs, local files, or single proxy links
+- 📡 Check from remote URLs, local files, direct proxy links, or any mix
 - 🔄 Multi-iteration filtering — only survivors advance
 - 🌐 Built-in HTTP API server with Basic Auth
 - 🧹 Auto de-duplication by `server:port:secret`
@@ -15,10 +15,14 @@ Telegram MTProto proxy health checker powered by **TDLib**. Performs a real `tes
 ## 📦 Install
 
 ```bash
+# Global — gives you the `mtproto-checker` command
+npm install -g mtproto-checker
+
+# Local dependency
 npm install mtproto-checker
 ```
 
-Or clone locally:
+Or clone:
 
 ```bash
 git clone https://github.com/Tar4s/mtproto-checker.git
@@ -44,32 +48,46 @@ npm install @tar4s/mtproto-checker
 | `TG_API_HASH` | ✅ | Telegram API Hash |
 | `CHECK_AUTH_USER` | 🌐 | HTTP Basic Auth username (server mode) |
 | `CHECK_AUTH_PASSWORD` | 🌐 | HTTP Basic Auth password (server mode) |
-| `PORT` | ❌ | Server port (default `3080`) |
+| `PORT` | ❌ | Server port (default `8080`) |
+
+## 🚀 Quick Start (Global)
+
+After `npm i -g mtproto-checker`:
+
+```bash
+# Start HTTP server (no arguments)
+TG_API_ID=12345 TG_API_HASH=abcdef \
+CHECK_AUTH_USER=admin CHECK_AUTH_PASSWORD=secret \
+check-proxies
 
-## 🚀 CLI Usage
+# CLI mode (with arguments)
+TG_API_ID=12345 TG_API_HASH=abcdef check-proxies --sources urls.txt
+```
+
+## 🖥 CLI Usage
 
 ```bash
-TG_API_ID=12345 TG_API_HASH=abcdef node check.js [sources] [options]
+TG_API_ID=12345 TG_API_HASH=abcdef check-proxies [sources] [options]
 ```
 
 ### Input Methods
 
 ```bash
 # Single proxy link
-node check.js --proxy "tg://proxy?server=1.2.3.4&port=443&secret=ee..."
+check-proxies --proxy "tg://proxy?server=1.2.3.4&port=443&secret=ee..."
 
 # Remote URLs (positional or --url flag, repeatable)
-node check.js https://example.com/proxies.txt
-node check.js --url URL1 --url URL2
+check-proxies https://example.com/proxies.txt
+check-proxies --url URL1 --url URL2
 
 # File with source URLs (one per line, # comments ok)
-node check.js --sources urls.txt
+check-proxies --sources urls.txt
 
 # Local proxy file
-node check.js ./my-proxies.txt
+check-proxies ./my-proxies.txt
 
 # Stdin
-cat proxies.txt | node check.js
+cat proxies.txt | check-proxies
 ```
 
 ### ⚙️ Options
@@ -94,23 +112,29 @@ cat proxies.txt | node check.js
 
 ## 🌐 HTTP API Server
 
-Start with **no arguments**:
+Start with **no arguments** — works both globally and locally:
 
 ```bash
+# Global
+TG_API_ID=12345 TG_API_HASH=abcdef \
+CHECK_AUTH_USER=admin CHECK_AUTH_PASSWORD=secret \
+check-proxies
+
+# Local
 TG_API_ID=12345 TG_API_HASH=abcdef \
 CHECK_AUTH_USER=admin CHECK_AUTH_PASSWORD=secret \
 node check.js
 ```
 
 ```
-[mtproto-checker] ⚡ HTTP server listening on http://localhost:3080
+[mtproto-checker] ⚡ HTTP server listening on http://localhost:8080
 [mtproto-checker]   POST /check (Basic auth: admin:***)
 ```
 
 ### `POST /check`
 
 ```bash
-curl -u admin:secret http://localhost:3080/check \
+curl -u admin:secret http://localhost:8080/check \
   -H "Content-Type: application/json" \
   -d '{"url": "https://example.com/proxies.txt", "iterations": 2, "concurrency": 20}'
 ```
@@ -119,21 +143,39 @@ curl -u admin:secret http://localhost:3080/check \
 
 | Field | Type | Default | Description |
 |-------|------|:-------:|-------------|
-| `url` | string | — | Proxy list URL or single `tg://proxy` link |
+| `url` / `urls` / `uri` / `uris` | string \| string[] | — | Proxy link(s), list URL(s), or any mix |
 | `iterations` | int | `1` | Check rounds |
 | `concurrency` | int | `30` | Parallel checks |
 
+All input formats work:
+
+```json
+// Single proxy link
+{ "url": "tg://proxy?server=1.2.3.4&port=443&secret=ee..." }
+
+// Single list URL
+{ "url": "https://example.com/proxies.txt" }
+
+// Array — mix of direct links and list URLs
+{ "urls": [
+    "tg://proxy?server=1.2.3.4&port=443&secret=ee...",
+    "https://t.me/proxy?server=5.6.7.8&port=443&secret=dd...",
+    "https://example.com/list.txt"
+  ]
+}
+```
+
 **Response:**
 
 ```json
 {
-  "url": "https://example.com/proxies.txt",
+  "uris": ["https://example.com/proxies.txt"],
   "iterations": 2,
   "concurrency": 20,
   "count": 150,
   "working": 42,
   "results": [
-    { "server": "1.2.3.4", "port": 443, "sni": "example.com", "ok": true, "ms": 312, "error": null, "link": "tg://proxy?..." }
+    { "proxy": { "raw": "tg://proxy?...", "server": "1.2.3.4", "port": 443, "secret": "ee...", "sni": "example.com" }, "ok": true, "ms": 312, "error": null }
   ]
 }
 ```
@@ -164,32 +206,31 @@ const results = await checkProxyLink(
 
 ### `checkProxiesFromURIs(uris, opts)` → `Promise<Array>`
 
-Check proxies from remote URLs, local files, or both. Auto-detects type per entry.
+Check proxies from remote URLs, local files, direct proxy links, or any mix. Auto-detects type per entry, de-duplicates automatically.
 
 ```js
-// Remote
-const results = await checkProxiesFromURIs(
-  'https://example.com/proxies.txt',
-  { apiId: 12345, apiHash: 'abcdef' }
-)
+// Single source
+await checkProxiesFromURIs('https://example.com/proxies.txt', opts)
 
-// Local
-const results = await checkProxiesFromURIs('./proxies.txt', opts)
+// Direct proxy link
+await checkProxiesFromURIs('tg://proxy?server=1.2.3.4&port=443&secret=ee...', opts)
 
-// Mix
-const results = await checkProxiesFromURIs([
-  'https://example.com/list1.txt',
-  './local-list.txt',
-  'https://example.com/list2.txt'
+// Mix of everything
+await checkProxiesFromURIs([
+  'tg://proxy?server=1.2.3.4&port=443&secret=ee...',
+  'https://t.me/proxy?server=5.6.7.8&port=443&secret=dd...',
+  'https://example.com/list.txt',
+  './local-list.txt'
 ], { apiId: 12345, apiHash: 'abcdef', iterations: 2, concurrency: 20 })
 ```
 
 ```
-[mtproto-checker] Loading 3 source(s)...
-  ↓ https://example.com/list1.txt
+[mtproto-checker] Loading 4 source(s)...
+  ⚡ 1.2.3.4:443
+  ⚡ 5.6.7.8:443
+  ↓ https://example.com/list.txt
   ◈ ./local-list.txt
-  ↓ https://example.com/list2.txt
-[mtproto-checker] Checking 150 proxies (dc=2, timeout=10s, concurrency=30, iterations=2)...
+[mtproto-checker] Checking 150 proxies (dc=2, timeout=10s, concurrency=20, iterations=2)...
 
   [  1/150] ✓   312ms  1.2.3.4:443 [example.com]
   [  2/150] ✗ Timeout  5.6.7.8:443
@@ -235,6 +276,113 @@ https://t.me/proxy?server=1.2.3.4&port=443&secret=ee...
 
 Secrets: hex (`ee...`, `dd...`), plain hex, or base64url — auto-detected. `tg://socks` links are ignored.
 
+## 🐳 Docker Deployment
+
+Structure on the server:
+
+```
+/etc/mtproto-checker/          ← source code (auto-pulled)
+├── check.js
+├── Dockerfile
+├── package.json
+└── ...
+
+/opt/mtproto-checker/          ← configs & certs (manual)
+├── docker-compose.yml
+├── default.conf
+├── fullchain.pem
+└── privkey.key
+```
+
+### `docker-compose.yml`
+
+```yaml
+services:
+  app:
+    container_name: mtproto-checker
+    build: /etc/mtproto-checker
+    restart: unless-stopped
+    environment:
+      - TG_API_ID=your_api_id
+      - TG_API_HASH=your_api_hash
+      - CHECK_AUTH_USER=admin
+      - CHECK_AUTH_PASSWORD=your_password
+      - PORT=8080
+    expose:
+      - "8080"
+
+  nginx:
+    container_name: mtproto-checker-nginx
+    image: nginx:alpine
+    restart: unless-stopped
+    ports:
+      - "443:443"
+      - "80:80"
+    volumes:
+      - ./default.conf:/etc/nginx/conf.d/default.conf:ro
+      - ./privkey.key:/etc/nginx/ssl/privkey.key:ro
+      - ./fullchain.pem:/etc/nginx/ssl/fullchain.pem:ro
+    depends_on:
+      - app
+```
+
+### `default.conf`
+
+```nginx
+server {
+    listen 443 ssl;
+    server_name _;
+
+    ssl_certificate     /etc/nginx/ssl/fullchain.pem;
+    ssl_certificate_key /etc/nginx/ssl/privkey.key;
+
+    ssl_protocols TLSv1.2 TLSv1.3;
+    ssl_ciphers HIGH:!aNULL:!MD5;
+
+    location / {
+        proxy_pass http://app:8080;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_read_timeout 120s;
+    }
+}
+
+server {
+    listen 80;
+    server_name _;
+    return 301 https://$host$request_uri;
+}
+```
+
+### SSL Certificate
+
+Install acme.sh:
+
+```bash
+sudo apt-get install cron socat
+curl https://get.acme.sh | sh -s email=your@email.com && source ~/.bashrc
+acme.sh --set-default-ca --server letsencrypt
+```
+
+Issue certificate:
+
+```bash
+acme.sh --issue --standalone -d 'your-domain.example.com' \
+  --key-file /opt/mtproto-checker/privkey.key \
+  --fullchain-file /opt/mtproto-checker/fullchain.pem
+```
+
+Auto-renewal is set up via cron automatically. Verify with `crontab -l | grep acme`.
+
+### Deploy
+
+```bash
+docker compose build --no-cache
+docker compose up -d
+```
+
 ## 🛠 Troubleshooting
 
 | Problem | Fix |

package/check.js

@@ -19,7 +19,7 @@
  *
  * CLI usage:
  *   TG_API_ID=12345 TG_API_HASH=abcdef CHECK_AUTH_USER=admin CHECK_AUTH_PASSWORD=secret node check.js
- *   # starts the HTTP API server on PORT (default 3080)
+ *   # starts the HTTP API server on PORT (default 8080)
  *   TG_API_ID=12345 TG_API_HASH=abcdef... node check.js [sources] [options]
  *   # sources: any positional http(s) URL, a local file path, or stdin
  *   node check.js https://raw.githubusercontent.com/u/r/main/list.txt
@@ -726,7 +726,7 @@ async function startServer(opts = {}) {
   const apiHash = opts.apiHash ?? process.env.TG_API_HASH
   const user = opts.user ?? process.env.CHECK_AUTH_USER
   const password = opts.password ?? process.env.CHECK_AUTH_PASSWORD
-  const port = opts.port ?? parseInt(process.env.PORT || '3080', 10)
+  const port = opts.port ?? parseInt(process.env.PORT || '8080', 10)
 
   if (!apiId || !apiHash) throw new Error('Set TG_API_ID and TG_API_HASH (get them at https://my.telegram.org).')
   if (!user || !password) throw new Error('Set CHECK_AUTH_USER and CHECK_AUTH_PASSWORD for HTTP Basic auth.')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mtproto-checker",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Check Telegram MTProto proxies via a real TDLib handshake (testProxy), like tdesktop does",
   "main": "check.js",
   "exports": {
@@ -15,7 +15,7 @@
   },
   "homepage": "https://github.com/Tar4s/mtproto-checker#readme",
   "bin": {
-    "check-proxies": "check.js"
+    "mtproto-checker": "check.js"
   },
   "files": [
     "check.js",