Skip to content

Commit 2c98d39

Browse files
M03EDM03ED
committed
feat: xray ip tracking
1 parent 60140ee commit 2c98d39

4 files changed

Lines changed: 336 additions & 8 deletions

File tree

‎content/docs/en/panel/core.mdx‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ This document explains how PasarGuard validates and processes XRay configuration
1616
4. [Supported Protocols](#supported-protocols)
1717
5. [Network Types](#network-types)
1818
6. [Security Settings](#security-settings)
19-
7. [API Limits and Constraints](#api-limits-and-constraints)
20-
8. [Common Validation Errors](#common-validation-errors)
19+
7. [Viewing Connected IPs](#viewing-connected-ips)
20+
8. [API Limits and Constraints](#api-limits-and-constraints)
21+
9. [Common Validation Errors](#common-validation-errors)
2122

2223
---
2324

@@ -378,6 +379,87 @@ The following network/transport types are supported:
378379

379380
---
380381

382+
## Viewing Connected IPs
383+
384+
You can enable tracking of user online statistics to see the latest IP addresses connected to your core. This feature allows you to monitor which IPs are currently connected to your XRay core.
385+
386+
### Enabling User Online Statistics
387+
388+
To enable this feature, you need to add a `policy` section to the root of your XRay configuration JSON file. Add the following configuration:
389+
390+
```json
391+
{
392+
"policy": {
393+
"levels": {
394+
"0": {
395+
"statsUserOnline": true
396+
}
397+
}
398+
},
399+
"inbounds": [
400+
// ... your inbound configurations
401+
],
402+
"outbounds": [
403+
// ... your outbound configurations
404+
]
405+
}
406+
```
407+
408+
<Callout type="info" title="Policy Configuration">
409+
The `policy` section should be added at the root level of your JSON configuration file, alongside `inbounds` and `outbounds`. The `statsUserOnline: true` setting enables tracking of user connection statistics.
410+
</Callout>
411+
412+
### Viewing Connected IPs
413+
414+
After enabling the `statsUserOnline` policy and restarting your node:
415+
416+
1. **First Connection Required**: The IP tracking will start working after the first user connection is established
417+
2. **Access Statistics**: Once enabled and after the first connection, you can view the latest connected IPs through your panel's statistics interface
418+
419+
<Callout type="warning" title="Restart Required">
420+
After adding the policy configuration, you must restart your core for the changes to take effect.
421+
</Callout>
422+
423+
### Complete Example
424+
425+
Here's a complete example configuration with the policy section enabled:
426+
427+
```json
428+
{
429+
"policy": {
430+
"levels": {
431+
"0": {
432+
"statsUserOnline": true
433+
}
434+
}
435+
},
436+
"inbounds": [
437+
{
438+
"tag": "vless-ws-443",
439+
"port": 443,
440+
"protocol": "vless",
441+
"settings": {
442+
"clients": []
443+
},
444+
"streamSettings": {
445+
"network": "ws",
446+
"wsSettings": {
447+
"path": "/path"
448+
}
449+
}
450+
}
451+
],
452+
"outbounds": [
453+
{
454+
"tag": "direct",
455+
"protocol": "freedom"
456+
}
457+
]
458+
}
459+
```
460+
461+
---
462+
381463
## API Limits and Constraints
382464

383465
When creating or modifying core configurations through the API, these limits apply:

‎content/docs/fa/panel/core.mdx‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ icon: Server
1616
4. [پروتکل‌های پشتیبانی شده](#supported-protocols)
1717
5. [انواع شبکه](#network-types)
1818
6. [تنظیمات امنیتی](#security-settings)
19-
7. [محدودیت‌ها و قیود API](#api-limits-and-constraints)
20-
8. [خطاهای رایج اعتبارسنجی](#common-validation-errors)
19+
7. [مشاهده IPهای متصل](#viewing-connected-ips)
20+
8. [محدودیت‌ها و قیود API](#api-limits-and-constraints)
21+
9. [خطاهای رایج اعتبارسنجی](#common-validation-errors)
2122

2223
---
2324

@@ -378,6 +379,87 @@ PasarGuard این پروتکل‌ها را پردازش و اعتبارسنجی
378379

379380
---
380381

382+
## مشاهده IPهای متصل
383+
384+
شما می‌توانید ردیابی آمار آنلاین کاربران را فعال کنید تا آخرین آدرس‌های IP متصل به هسته خود را مشاهده کنید. این ویژگی به شما امکان می‌دهد که IPهای در حال حاضر متصل به هسته XRay خود را نظارت کنید.
385+
386+
### فعال‌سازی آمار آنلاین کاربران
387+
388+
برای فعال‌سازی این ویژگی، باید یک بخش `policy` به ریشه فایل JSON پیکربندی XRay خود اضافه کنید. پیکربندی زیر را اضافه کنید:
389+
390+
```json
391+
{
392+
"policy": {
393+
"levels": {
394+
"0": {
395+
"statsUserOnline": true
396+
}
397+
}
398+
},
399+
"inbounds": [
400+
// ... پیکربندی‌های inbound شما
401+
],
402+
"outbounds": [
403+
// ... پیکربندی‌های outbound شما
404+
]
405+
}
406+
```
407+
408+
<Callout type="info" title="پیکربندی Policy">
409+
بخش `policy` باید در سطح ریشه فایل JSON پیکربندی شما، در کنار `inbounds` و `outbounds` اضافه شود. تنظیم `statsUserOnline: true` ردیابی آمار اتصال کاربران را فعال می‌کند.
410+
</Callout>
411+
412+
### مشاهده IPهای متصل
413+
414+
پس از فعال‌سازی policy `statsUserOnline` و راه‌اندازی مجدد نود شما:
415+
416+
1. **نیاز به اولین اتصال**: ردیابی IP پس از برقراری اولین اتصال کاربر شروع به کار می‌کند
417+
2. **دسترسی به آمار**: پس از فعال‌سازی و بعد از اولین اتصال، می‌توانید آخرین IPهای متصل را از طریق رابط آمار پنل خود مشاهده کنید
418+
419+
<Callout type="warning" title="نیاز به راه‌اندازی مجدد">
420+
پس از اضافه کردن پیکربندی policy، باید هسته خود را راه‌اندازی مجدد کنید تا تغییرات اعمال شوند.
421+
</Callout>
422+
423+
### مثال کامل
424+
425+
در اینجا یک مثال کامل از پیکربندی با بخش policy فعال شده آورده شده است:
426+
427+
```json
428+
{
429+
"policy": {
430+
"levels": {
431+
"0": {
432+
"statsUserOnline": true
433+
}
434+
}
435+
},
436+
"inbounds": [
437+
{
438+
"tag": "vless-ws-443",
439+
"port": 443,
440+
"protocol": "vless",
441+
"settings": {
442+
"clients": []
443+
},
444+
"streamSettings": {
445+
"network": "ws",
446+
"wsSettings": {
447+
"path": "/path"
448+
}
449+
}
450+
}
451+
],
452+
"outbounds": [
453+
{
454+
"tag": "direct",
455+
"protocol": "freedom"
456+
}
457+
]
458+
}
459+
```
460+
461+
---
462+
381463
## محدودیت‌ها و قیود API
382464

383465
هنگام ایجاد یا تغییر پیکربندی‌های هسته از طریق API، این محدودیت‌ها اعمال می‌شوند:

‎content/docs/ru/panel/core.mdx‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ icon: Server
1616
4. [Поддерживаемые протоколы](#supported-protocols)
1717
5. [Типы сетей](#network-types)
1818
6. [Настройки безопасности](#security-settings)
19-
7. [Ограничения и ограничения API](#api-limits-and-constraints)
20-
8. [Частые ошибки валидации](#common-validation-errors)
19+
7. [Просмотр подключенных IP](#viewing-connected-ips)
20+
8. [Ограничения и ограничения API](#api-limits-and-constraints)
21+
9. [Частые ошибки валидации](#common-validation-errors)
2122

2223
---
2324

@@ -378,6 +379,87 @@ PasarGuard обрабатывает и проверяет эти протоко
378379

379380
---
380381

382+
## Просмотр подключенных IP
383+
384+
Вы можете включить отслеживание статистики онлайн-пользователей, чтобы видеть последние IP-адреса, подключенные к вашему ядру. Эта функция позволяет вам отслеживать, какие IP-адреса в настоящее время подключены к вашему ядру XRay.
385+
386+
### Включение статистики онлайн-пользователей
387+
388+
Чтобы включить эту функцию, вам нужно добавить раздел `policy` в корень вашего JSON-файла конфигурации XRay. Добавьте следующую конфигурацию:
389+
390+
```json
391+
{
392+
"policy": {
393+
"levels": {
394+
"0": {
395+
"statsUserOnline": true
396+
}
397+
}
398+
},
399+
"inbounds": [
400+
// ... ваши конфигурации inbound
401+
],
402+
"outbounds": [
403+
// ... ваши конфигурации outbound
404+
]
405+
}
406+
```
407+
408+
<Callout type="info" title="Конфигурация Policy">
409+
Раздел `policy` должен быть добавлен на корневом уровне вашего JSON-файла конфигурации, вместе с `inbounds` и `outbounds`. Настройка `statsUserOnline: true` включает отслеживание статистики подключений пользователей.
410+
</Callout>
411+
412+
### Просмотр подключенных IP
413+
414+
После включения policy `statsUserOnline` и перезапуска вашего узла:
415+
416+
1. **Требуется первое подключение**: Отслеживание IP начнет работать после установления первого подключения пользователя
417+
2. **Доступ к статистике**: После включения и после первого подключения вы можете просматривать последние подключенные IP через интерфейс статистики вашей панели
418+
419+
<Callout type="warning" title="Требуется перезапуск">
420+
После добавления конфигурации policy вы должны перезапустить ваше ядро, чтобы изменения вступили в силу.
421+
</Callout>
422+
423+
### Полный пример
424+
425+
Вот полный пример конфигурации с включенным разделом policy:
426+
427+
```json
428+
{
429+
"policy": {
430+
"levels": {
431+
"0": {
432+
"statsUserOnline": true
433+
}
434+
}
435+
},
436+
"inbounds": [
437+
{
438+
"tag": "vless-ws-443",
439+
"port": 443,
440+
"protocol": "vless",
441+
"settings": {
442+
"clients": []
443+
},
444+
"streamSettings": {
445+
"network": "ws",
446+
"wsSettings": {
447+
"path": "/path"
448+
}
449+
}
450+
}
451+
],
452+
"outbounds": [
453+
{
454+
"tag": "direct",
455+
"protocol": "freedom"
456+
}
457+
]
458+
}
459+
```
460+
461+
---
462+
381463
## Ограничения и ограничения API
382464

383465
При создании или изменении конфигураций ядра через API применяются следующие ограничения:

‎content/docs/zh/panel/core.mdx‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ icon: Server
1616
4. [支持的协议](#supported-protocols)
1717
5. [网络类型](#network-types)
1818
6. [安全设置](#security-settings)
19-
7. [API 限制和约束](#api-limits-and-constraints)
20-
8. [常见验证错误](#common-validation-errors)
19+
7. [查看连接的 IP](#viewing-connected-ips)
20+
8. [API 限制和约束](#api-limits-and-constraints)
21+
9. [常见验证错误](#common-validation-errors)
2122

2223
---
2324

@@ -378,6 +379,87 @@ PasarGuard 处理并验证以下协议：
378379

379380
---
380381

382+
## 查看连接的 IP
383+
384+
您可以启用用户在线统计跟踪功能，以查看连接到您核心的最新 IP 地址。此功能允许您监控当前连接到您的 XRay 核心的 IP。
385+
386+
### 启用用户在线统计
387+
388+
要启用此功能，您需要在 XRay 配置 JSON 文件的根目录添加 `policy` 部分。添加以下配置：
389+
390+
```json
391+
{
392+
"policy": {
393+
"levels": {
394+
"0": {
395+
"statsUserOnline": true
396+
}
397+
}
398+
},
399+
"inbounds": [
400+
// ... 您的 inbound 配置
401+
],
402+
"outbounds": [
403+
// ... 您的 outbound 配置
404+
]
405+
}
406+
```
407+
408+
<Callout type="info" title="Policy 配置">
409+
`policy` 部分应添加到 JSON 配置文件的根级别，与 `inbounds` 和 `outbounds` 一起。`statsUserOnline: true` 设置启用用户连接统计跟踪。
410+
</Callout>
411+
412+
### 查看连接的 IP
413+
414+
启用 `statsUserOnline` policy 并重启您的节点后：
415+
416+
1. **需要首次连接**：IP 跟踪将在建立第一个用户连接后开始工作
417+
2. **访问统计**：启用后并在首次连接后，您可以通过面板的统计界面查看最新连接的 IP
418+
419+
<Callout type="warning" title="需要重启">
420+
添加 policy 配置后，您必须重启核心才能使更改生效。
421+
</Callout>
422+
423+
### 完整示例
424+
425+
以下是启用 policy 部分的完整配置示例：
426+
427+
```json
428+
{
429+
"policy": {
430+
"levels": {
431+
"0": {
432+
"statsUserOnline": true
433+
}
434+
}
435+
},
436+
"inbounds": [
437+
{
438+
"tag": "vless-ws-443",
439+
"port": 443,
440+
"protocol": "vless",
441+
"settings": {
442+
"clients": []
443+
},
444+
"streamSettings": {
445+
"network": "ws",
446+
"wsSettings": {
447+
"path": "/path"
448+
}
449+
}
450+
}
451+
],
452+
"outbounds": [
453+
{
454+
"tag": "direct",
455+
"protocol": "freedom"
456+
}
457+
]
458+
}
459+
```
460+
461+
---
462+
381463
## API 限制和约束
382464

383465
通过 API 创建或修改核心配置时，适用以下限制：

0 commit comments

Comments
 (0)