Update README
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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/)
|
||||
🔹 **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
|
||||
@@ -1 +1,24 @@
|
||||
Docs https://v2.hysteria.network/docs/advanced/Full-Client-Config/
|
||||
## 🌐 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
|
||||
@@ -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)
|
||||
## ⚙️ 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
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
58
box/v2fly/README.md
Executable file
58
box/v2fly/README.md
Executable file
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
54
box/xray/README.md
Executable file
54
box/xray/README.md
Executable file
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user