SamNet-dev/paqctl
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: correct client config format in offline installation docs

Browse Source 
The offline/manual installation section had incorrect config.yaml format:
- Wrong: socks5.port → Correct: socks5[].listen
- Wrong: server.address → Correct: server.addr
- Wrong: transport.mode/key → Correct: transport.kcp.mode/key
- Missing: network.ipv4.addr, network.ipv4.router_mac, log.level
- Wrong command: -config → Correct: run -c

Added instructions for finding local IP and router MAC on each OS.
Fixed both English and Farsi sections.
This commit is contained in:
SamNet-dev
2026-02-04 17:30:09 -06:00
parent 6f7fdcb3a2
commit c619da9d96
1 changed files with 76 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
View File

@@ -799,39 +799,65 @@ scp paqet user@CLIENT_IP:/home/user/paqet
On your **client machine**, create a file called `config.yaml` in the same folder as paqet. On your **client machine**, create a file called `config.yaml` in the same folder as paqet.
**First, find your network info:**
| OS | Find Local IP | Find Router MAC |
|----|---------------|-----------------|
| Linux | `ip addr` or `hostname -I` | `ip neigh \| grep default` |
| macOS | `ifconfig en0 \| grep inet` | `arp -a \| grep gateway` |
| Windows | `ipconfig` | `arp -a` (look for your gateway IP) |
**Copy this and fill in your values:** **Copy this and fill in your values:**
```yaml ```yaml
role: "client" role: "client"
log:
level: "info"
socks5: socks5:
port: 1080 - listen: "127.0.0.1:1080"
network: network:
interface: "" interface: "eth0" # Linux: eth0/wlan0, macOS: en0, Windows: see note below
ipv4:
addr: "YOUR_LOCAL_IP:0" # e.g., 192.168.1.100:0
router_mac: "YOUR_ROUTER_MAC" # e.g., aa:bb:cc:dd:ee:ff
server: server:
address: "SERVER_IP:PORT" addr: "YOUR_SERVER_IP:8443"
transport: transport:
protocol: "kcp"
kcp:
mode: "fast" mode: "fast"
key: "YOUR_KEY" key: "YOUR_SECRET_KEY"
``` ```
> **Windows note:** Leave `interface: ""` empty - paqet will auto-detect. Or find your interface name in Network Connections.
**Example with real values:** **Example with real values:**
```yaml ```yaml
role: "client" role: "client"
log:
level: "info"
socks5: socks5:
port: 1080 - listen: "127.0.0.1:1080"
network: network:
interface: "" interface: "eth0"
ipv4:
addr: "192.168.1.100:0"
router_mac: "aa:bb:cc:dd:ee:ff"
server: server:
address: "185.1.2.3:8443" addr: "185.1.2.3:8443"
transport: transport:
protocol: "kcp"
kcp:
mode: "fast" mode: "fast"
key: "mySecretKey123" key: "mySecretKey123"
``` ```
@@ -843,7 +869,7 @@ transport:
**Linux/macOS:** **Linux/macOS:**
```bash ```bash
cd ~/paqet # Go to the folder with paqet cd ~/paqet # Go to the folder with paqet
sudo ./paqet -config config.yaml sudo ./paqet run -c config.yaml
``` ```
**Windows (must run as Administrator):** **Windows (must run as Administrator):**
@@ -851,7 +877,7 @@ sudo ./paqet -config config.yaml
2. Run: 2. Run:
```cmd ```cmd
cd C:\paqet cd C:\paqet
paqet.exe -config config.yaml paqet.exe run -c config.yaml
``` ```
You should see: You should see:
@@ -1659,39 +1685,65 @@ scp paqet user@CLIENT_IP:/home/user/paqet
روی **دستگاه کلاینت**، یک فایل به نام `config.yaml` در همان پوشه‌ای که paqet است بسازید. روی **دستگاه کلاینت**، یک فایل به نام `config.yaml` در همان پوشه‌ای که paqet است بسازید.
**اول اطلاعات شبکه خود را پیدا کنید:**
| سیستم‌عامل | پیدا کردن IP محلی | پیدا کردن MAC روتر |
|-----------|------------------|-------------------|
| لینوکس | `ip addr` یا `hostname -I` | `ip neigh \| grep default` |
| مک | `ifconfig en0 \| grep inet` | `arp -a \| grep gateway` |
| ویندوز | `ipconfig` | `arp -a` (دنبال IP گیت‌وی بگردید) |
**این را کپی کنید و مقادیر خود را بگذارید:** **این را کپی کنید و مقادیر خود را بگذارید:**
```yaml ```yaml
role: "client" role: "client"
log:
level: "info"
socks5: socks5:
port: 1080 - listen: "127.0.0.1:1080"
network: network:
interface: "" interface: "eth0" # لینوکس: eth0/wlan0، مک: en0، ویندوز: نکته پایین را ببینید
ipv4:
addr: "YOUR_LOCAL_IP:0" # مثلاً 192.168.1.100:0
router_mac: "YOUR_ROUTER_MAC" # مثلاً aa:bb:cc:dd:ee:ff
server: server:
address: "IP_SERVER:PORT" addr: "YOUR_SERVER_IP:8443"
transport: transport:
protocol: "kcp"
kcp:
mode: "fast" mode: "fast"
key: "YOUR_KEY" key: "YOUR_SECRET_KEY"
``` ```
> **نکته ویندوز:** مقدار `interface: ""` را خالی بگذارید - paqet خودش تشخیص می‌دهد. یا نام اینترفیس را در Network Connections پیدا کنید.
**مثال با مقادیر واقعی:** **مثال با مقادیر واقعی:**
```yaml ```yaml
role: "client" role: "client"
log:
level: "info"
socks5: socks5:
port: 1080 - listen: "127.0.0.1:1080"
network: network:
interface: "" interface: "eth0"
ipv4:
addr: "192.168.1.100:0"
router_mac: "aa:bb:cc:dd:ee:ff"
server: server:
address: "185.1.2.3:8443" addr: "185.1.2.3:8443"
transport: transport:
protocol: "kcp"
kcp:
mode: "fast" mode: "fast"
key: "mySecretKey123" key: "mySecretKey123"
``` ```
@@ -1703,7 +1755,7 @@ transport:
**لینوکس/مک:** **لینوکس/مک:**
```bash ```bash
cd ~/paqet # به پوشه paqet بروید cd ~/paqet # به پوشه paqet بروید
sudo ./paqet -config config.yaml sudo ./paqet run -c config.yaml
``` ```
**ویندوز (باید به عنوان Administrator اجرا شود):** **ویندوز (باید به عنوان Administrator اجرا شود):**
@@ -1711,7 +1763,7 @@ sudo ./paqet -config config.yaml
2. اجرا کنید: 2. اجرا کنید:
```cmd ```cmd
cd C:\paqet cd C:\paqet
paqet.exe -config config.yaml paqet.exe run -c config.yaml
``` ```
باید این را ببینید: باید این را ببینید: