From 128006d6e443c2c19b496421f5de555a73006938 Mon Sep 17 00:00:00 2001 From: taamarin <71506581+taamarin@users.noreply.github.com> Date: Sun, 20 Jul 2025 02:40:50 +0700 Subject: [PATCH] Update `README` --- README.md | 2 +- box/clash/README.md | 39 ++++++++++++++++++++++++---- box/hysteria/README.md | 25 +++++++++++++++++- box/sing-box/README.md | 44 +++++++++++++++++++++++++++++--- box/v2fly/README.md | 58 ++++++++++++++++++++++++++++++++++++++++++ box/xray/README.md | 54 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 211 insertions(+), 11 deletions(-) create mode 100755 box/v2fly/README.md create mode 100755 box/xray/README.md diff --git a/README.md b/README.md index e23cf75..16102b2 100755 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ ## Apk Manager You can use the **BFR Manager** app (optional) to manage Box for Root on your device. -[Download BFR Manager](https://github.com/taamarin/box.manager) +[Download BFR Manager](https://t.me/taamarin/365415/489307) > โš ๏ธ If you receive continuous notifications, open Magisk Manager, navigate to SuperUser, search for `BoxForRoot`, and disable logs and notifications. ## Module Directory diff --git a/box/clash/README.md b/box/clash/README.md index 3166d87..c328f26 100644 --- a/box/clash/README.md +++ b/box/clash/README.md @@ -1,8 +1,37 @@ +# ๐Ÿ“„ Example Configuration & Documentation -######################## -example configuration / documentation -######################## +A quick reference guide for setting up **Clash Premium** or **Mihomo (Clash Meta)** configurations properly. -~[clash premium documentation](http://dreamacro.github.io/clash/)~ +## ๐Ÿ“˜ Official Documentation -[mihomo documentation](https://wiki.metacubex.one/) \ No newline at end of file +๐Ÿ”น **Mihomo (Clash)** +๐Ÿ“š [wiki.metacubex.one](https://wiki.metacubex.one/) + +## ๐Ÿงช Sample Configuration (YAML) + +```yaml +mixed-port: 7890 +allow-lan: true +mode: rule +log-level: info + +proxies: + - name: "Example Proxy" + type: vmess + server: server.example.com + port: 443 + uuid: abcdefgh-1234-5678-90ab-cdef12345678 + alterId: 0 + cipher: auto + tls: true + +proxy-groups: + - name: "PROXY" + type: select + proxies: + - "Example Proxy" + - DIRECT + +rules: + - DOMAIN-SUFFIX,example.com,PROXY + - MATCH,DIRECT \ No newline at end of file diff --git a/box/hysteria/README.md b/box/hysteria/README.md index ec0a5af..4852523 100644 --- a/box/hysteria/README.md +++ b/box/hysteria/README.md @@ -1 +1,24 @@ -Docs https://v2.hysteria.network/docs/advanced/Full-Client-Config/ \ No newline at end of file +## ๐ŸŒ Hysteria v2 Documentation + +๐Ÿ”น **Hysteria v2 (UDP-based VPN / Proxy Protocol)** +๐Ÿ“š Full Client Config: [v2.hysteria.network/docs/advanced/Full-Client-Config](https://v2.hysteria.network/docs/advanced/Full-Client-Config/) + +## โš™๏ธ Sample Hysteria2 Client Configuration + +```yaml +server: your-server.com:443 +auth: your-password-or-token +alpn: + - h3 +protocol: udp +obfs: + type: salamander + password: obfs-password +tls: + sni: your-server.com + insecure: true +bandwidth: + up: 50 Mbps + down: 100 Mbps +fastOpen: true +retry: 3 \ No newline at end of file diff --git a/box/sing-box/README.md b/box/sing-box/README.md index 33f3a45..504ec22 100644 --- a/box/sing-box/README.md +++ b/box/sing-box/README.md @@ -1,6 +1,42 @@ +## ๐Ÿงฑ Sing-box Documentation -######################## -example configuration / documentation -######################## +๐Ÿ”น **Sing-box (Universal Proxy Core by SagerNet)** +๐Ÿ“š Official Docs: [sing-box.sagernet.org/configuration](http://sing-box.sagernet.org/configuration) -[sing-box documentation](http://sing-box.sagernet.org/configuration) \ No newline at end of file +## โš™๏ธ Sample Sing-box Configuration (VMess over WS + TLS) + +```json +{ + "log": { + "level": "info" + }, + "inbounds": [ + { + "type": "mixed", + "listen": "::", + "listen_port": 7890 + } + ], + "outbounds": [ + { + "type": "vmess", + "tag": "vmess-ws", + "server": "example.com", + "server_port": 443, + "uuid": "abcdefgh-1234-5678-90ab-cdef12345678", + "security": "auto", + "transport": { + "type": "ws", + "path": "/websocket", + "headers": { + "Host": "example.com" + } + }, + "tls": { + "enabled": true, + "server_name": "example.com", + "insecure": true + } + } + ] +} \ No newline at end of file diff --git a/box/v2fly/README.md b/box/v2fly/README.md new file mode 100755 index 0000000..e40f016 --- /dev/null +++ b/box/v2fly/README.md @@ -0,0 +1,58 @@ +## โšก V2Ray / v2fly Documentation + +๐Ÿ”น **V2Ray / v2fly** +๐Ÿ“š Official Docs: [v2fly.org/en_US](https://www.v2fly.org/en_US/) + +## โš™๏ธ Sample V2Ray Configuration (VMess over WS + TLS) + +```json +{ + "log": { + "loglevel": "warning" + }, + "inbounds": [ + { + "port": 1080, + "listen": "127.0.0.1", + "protocol": "socks", + "settings": { + "auth": "noauth", + "udp": true + } + } + ], + "outbounds": [ + { + "protocol": "vmess", + "settings": { + "vnext": [ + { + "address": "example.com", + "port": 443, + "users": [ + { + "id": "abcdefgh-1234-5678-90ab-cdef12345678", + "alterId": 0, + "security": "auto" + } + ] + } + ] + }, + "streamSettings": { + "network": "ws", + "security": "tls", + "tlsSettings": { + "serverName": "example.com", + "allowInsecure": true + }, + "wsSettings": { + "path": "/websocket", + "headers": { + "Host": "example.com" + } + } + } + } + ] +} \ No newline at end of file diff --git a/box/xray/README.md b/box/xray/README.md new file mode 100755 index 0000000..ef708a3 --- /dev/null +++ b/box/xray/README.md @@ -0,0 +1,54 @@ +## โœด๏ธ Xray (XTLS) Documentation + +๐Ÿ”น **Xray Core (XTLS, Reality, and enhancements)** +๐Ÿ“š Official Docs: [xtls.github.io](https://xtls.github.io/) + +## โš™๏ธ Sample Xray Configuration (VLESS + XTLS / Reality) + +```json +{ + "log": { + "loglevel": "info" + }, + "inbounds": [ + { + "port": 1080, + "listen": "127.0.0.1", + "protocol": "socks", + "settings": { + "udp": true + } + } + ], + "outbounds": [ + { + "protocol": "vless", + "settings": { + "vnext": [ + { + "address": "your-server.com", + "port": 443, + "users": [ + { + "id": "abcdefgh-1234-5678-90ab-cdef12345678", + "encryption": "none", + "flow": "xtls-rprx-vision" + } + ] + } + ] + }, + "streamSettings": { + "network": "tcp", + "security": "reality", + "realitySettings": { + "show": false, + "serverName": "target-sni.com", + "publicKey": "Base64ServerPubKeyHere", + "shortId": "0123456789abcdef", + "fingerprint": "chrome" + } + } + } + ] +} \ No newline at end of file