mtproto-checker 0.3.1 → 0.4.1

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -276,6 +276,121 @@ 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;
+        
+        # Объявляем переменную с таймаутом (600s = 10 минут)
+        set $custom_timeout 600s;
+
+        # Используем переменную для всех таймаутов
+        proxy_read_timeout          $custom_timeout;
+        proxy_connect_timeout       $custom_timeout;
+        proxy_send_timeout          $custom_timeout;
+        send_timeout                $custom_timeout;
+    }
+}
+
+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 |
@@ -287,4 +402,4 @@ Secrets: hex (`ee...`, `dd...`), plain hex, or base64url — auto-detected. `tg:
 
 ## 📜 License
 
-ISC
+[Unlicense](LICENSE) — completely free to use, no restrictions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mtproto-checker",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "Check Telegram MTProto proxies via a real TDLib handshake (testProxy), like tdesktop does",
   "main": "check.js",
   "exports": {
@@ -25,6 +25,7 @@
   "scripts": {
     "start": "node check.js"
   },
+  "license": "Unlicense",
   "engines": {
     "node": ">=18"
   },