PasarGuard

https://docs.pasarguard.org
Admin
PasarGuard is a censorship-resistant unified GUI solution that provides the best VPN panel with...
Tokens:118,638
Snippets:780
Trust Score:4.4
Update:9 months ago
Show doc for...
Tokens:
Raw
### One-Click Installation of PasarGuard Node

Source: https://docs.pasarguard.org/fa/node/installation

This script automates the installation of the PasarGuard Node. It handles dependency installation, node setup, basic configuration, and service auto-start. Recommended for its simplicity.

```bash
sudo bash -c "$(curl -sL https://github.com/PasarGuard/scripts/raw/main/pg-node.sh)" @ install
```

--------------------------------

### Start Go Node Bridge Example

Source: https://docs.pasarguard.org/fa/node/libraries

An example demonstrating how to initialize the Go `node_bridge` client and use it to start a backend configuration on the PasarGuard Node. It includes setting up backend details and user configurations.

```go
package main

import (
    "context"
    "log"
    
    "github.com/PasarGuard/node_bridge"
    pb "github.com/PasarGuard/node_bridge/proto"
)

func main() {
    client, _ := nodebridge.NewClient("https://node:443", "session-id")
    defer client.Close()

    backend := &pb.Backend{
        Type: pb.BackendType_XRAY,
        Config: `{
            "log": {"loglevel": "warning"},
            "inbounds": [...],
            "outbounds": [...] 
        }`,
        Users: []*pb.User{
            {
                Email: "user1@example.com",
                Proxies: &pb.Proxy{
                    Vmess: &pb.Vmess{
                        Id: "uuid-here",
                    },
                },
                Inbounds: []string{"inbound-tag"},
            },
        },
        KeepAlive: 60,
    }

    info, err := client.Start(context.Background(), backend)
    if err != nil {
        log.Fatal(err)
    }
    
    log.Printf("بکند شروع شد: %v", info)
}
```

--------------------------------

### Docker Installation and Management for PasarGuard Node

Source: https://docs.pasarguard.org/fa/node/installation

Instructions for installing and managing the PasarGuard Node using Docker and Docker Compose. This includes downloading the compose file, starting the node, viewing logs, stopping, restarting, and updating the service.

```bash
curl -fsSL https://get.docker.com | sh
```

```bash
wget https://raw.githubusercontent.com/PasarGuard/node/refs/heads/main/docker-compose.yml
```

```bash
docker compose up -d
```

```bash
docker compose logs -f
```

```bash
docker compose down
```

```bash
docker compose restart
```

```bash
docker compose pull
docker compose up -d
```

--------------------------------

### Start Python Node Bridge Example

Source: https://docs.pasarguard.org/fa/node/libraries

A quick start example showing how to initialize the Python `NodeClient` for PasarGuard Node and retrieve basic information about the node, such as its version and running status.

```python
from pasarguard_node_bridge import NodeClient

# ایجاد کلاینت
client = NodeClient(
    url="https://your-node:443",
    session_id="your-session-id"
)

# دریافت اطلاعات نود
info = client.get_base_info()
print(f"نسخه نود: {info.version}، در حال اجرا: {info.running}")
```

--------------------------------

### POST /start - Start Backend

Source: https://docs.pasarguard.org/fa/node/api

Starts the node with the specified configuration. This is the initial method called before establishing node communication.

```APIDOC
## POST /start

### Description
Starts the node with the specified configuration. This is the initial method called before establishing node communication.

### Method
POST

### Endpoint
`/start`

### Parameters
#### Request Body
- **Backend** (protobuf) - Required - The configuration for the backend.

### Request Example
```protobuf
// Example Backend message structure
// message Backend { ... }
```

### Response
#### Success Response (200)
- **BaseInfoResponse** (protobuf) - Contains basic information about the node.

### Response Example
```protobuf
// Example BaseInfoResponse message structure
// message BaseInfoResponse {
//   string version;
//   string core_type;
//   bool running;
// }
```
```

--------------------------------

### Manual Installation of PasarGuard Node (Build and Run)

Source: https://docs.pasarguard.org/fa/node/installation

This section details the manual installation process for the PasarGuard Node, which requires Go (1.25+) and Git. It covers cloning the repository, building the binary, installing Xray core, generating SSL certificates, and running the node. Not recommended for beginners.

```bash
git clone https://github.com/PasarGuard/node.git
cd node
```

```bash
make deps
make
```

```bash
make install_xray
```

```bash
# For domain-based certificate
make generate_server_cert CN=example.com SAN="DNS:example.com"

# For IP-based certificate
make generate_server_cert CN=example.com SAN="IP:YOUR_SERVER_IP"

# For domain and IP
make generate_server_cert CN=example.com SAN="DNS:example.com,IP:YOUR_SERVER_IP"
```

```bash
./pasarguard-node
```

--------------------------------

### Full Development/Test Configuration Example

Source: https://docs.pasarguard.org/fa/panel/configuration

An example of environment variables for a development or testing environment, using SQLite for the database and enabling debug features.

```dotenv
# Admin Settings
SUDO_USERNAME = "admin"
SUDO_PASSWORD = "admin123"

# Database (SQLite for testing)
SQLALCHEMY_DATABASE_URL = "sqlite+aiosqlite:////var/lib/pasarguard/db.sqlite3"

# Web Server
UVICORN_HOST = "127.0.0.1"
UVICORN_PORT = 8000

# Security
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 1440

# Panel Settings
DOCS = true
DEBUG = true
```

--------------------------------

### Full Production Configuration Example

Source: https://docs.pasarguard.org/fa/panel/configuration

A complete example of environment variables for a production deployment, covering admin credentials, database connection, web server settings, security, and panel options.

```dotenv
# Admin Settings
SUDO_USERNAME = "admin"
SUDO_PASSWORD = "your-secure-password"

# Database (TimescaleDB recommended)
SQLALCHEMY_DATABASE_URL = "postgresql+asyncpg://pasarguard:password@localhost/pasarguard"

# Web Server
UVICORN_HOST = "0.0.0.0"
UVICORN_PORT = 8000
UVICORN_SSL_CERTFILE = "/var/lib/pasarguard/cert.pem"
UVICORN_SSL_KEYFILE = "/var/lib/pasarguard/key.pem"

# Security
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 1440

# Panel Settings
DOCS = false
DEBUG = false
```

--------------------------------

### Display PasarGuard Script Help

Source: https://docs.pasarguard.org/fa/panel/installation

Displays the help message for the PasarGuard installation script, showing available commands and options.

```bash
pasarguard --help
```

--------------------------------

### Systemd Service Setup for PasarGuard Node (Manual Install)

Source: https://docs.pasarguard.org/fa/node/installation

Configures the PasarGuard Node to run as a systemd service for automatic startup and management. This involves creating a service file and enabling/starting the service.

```bash
sudo nano /etc/systemd/system/pg-node.service
```

```ini
[Unit]
Description=PasarGuard Node
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/path/to/node
ExecStart=/path/to/node/pasarguard-node
Restart=on-failure
RestartSec=5s

[Install]
WantedBy=multi-user.target
```

```bash
sudo systemctl daemon-reload
sudo systemctl enable pg-node
sudo systemctl start pg-node
```

```bash
sudo systemctl status pg-node
```

--------------------------------

### Panel Settings Examples (Docs and Debug)

Source: https://docs.pasarguard.org/fa/panel/configuration

Demonstrates how to enable or disable the API documentation page (DOCS) and the debug mode (DEBUG). Debug mode provides more detailed logs.

```dotenv
DOCS = true
DEBUG = false
```

--------------------------------

### Install PasarGuard with TimescaleDB

Source: https://docs.pasarguard.org/fa/panel/installation

Installs PasarGuard using the provided script, specifically configuring it for TimescaleDB as the database backend. This is the recommended database for time-series data and optimized analytics.

```bash
curl -fsSL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh -o /tmp/pg.sh \
  && sudo bash /tmp/pg.sh install --database timescaledb
```

--------------------------------

### Install PasarGuard with MySQL

Source: https://docs.pasarguard.org/fa/panel/installation

Installs PasarGuard using the provided script, configuring it for MySQL as the database backend. MySQL is a robust option suitable for production environments.

```bash
curl -fsSL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh -o /tmp/pg.sh \
  && sudo bash /tmp/pg.sh install --database mysql
```

--------------------------------

### Uvicorn Web Server Configuration Examples

Source: https://docs.pasarguard.org/fa/panel/configuration

Illustrates how to configure the Uvicorn web server with host, port, and SSL certificate/key file paths. These settings control the network interface and security of the web server.

```dotenv
UVICORN_HOST = "0.0.0.0"
UVICORN_PORT = 8000
UVICORN_SSL_CERTFILE = "/var/lib/pasarguard/cert.pem"
UVICORN_SSL_KEYFILE = "/var/lib/pasarguard/key.pem"
```

--------------------------------

### Install PasarGuard with PostgreSQL

Source: https://docs.pasarguard.org/fa/panel/installation

Installs PasarGuard using the provided script, configuring it for PostgreSQL as the database backend. PostgreSQL offers advanced capabilities and scalability for managing your data.

```bash
curl -fsSL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh -o /tmp/pg.sh \
  && sudo bash /tmp/pg.sh install --database postgresql
```

--------------------------------

### Start MySQL or MariaDB Service

Source: https://docs.pasarguard.org/fa/migration/marzban

Starts the MySQL or MariaDB Docker service. This is a prerequisite for database migration if you are using MySQL or MariaDB.

```bash
cd /opt/pasarguard && docker compose up -d mysql
```

```bash
cd /opt/pasarguard && docker compose up -d mariadb
```

--------------------------------

### Database Connection URL Examples

Source: https://docs.pasarguard.org/fa/panel/configuration

Provides examples of database connection strings for various database systems like PostgreSQL, MySQL, and SQLite. These URLs are used to configure the SQLAlchemy database connection.

```dotenv
SQLALCHEMY_DATABASE_URL = "postgresql+asyncpg://user:password@localhost/pasarguard"
SQLALCHEMY_DATABASE_URL = "mysql+asyncmy://user:password@localhost/pasarguard"
SQLALCHEMY_DATABASE_URL = "sqlite+aiosqlite:////var/lib/pasarguard/db.sqlite3"
```

--------------------------------

### Obtain Let's Encrypt SSL Certificate

Source: https://docs.pasarguard.org/fa/panel/configuration

Example command using certbot to obtain a free SSL certificate from Let's Encrypt for a specified domain, essential for secure web server communication.

```bash
# Use Let's Encrypt
sudo certbot certonly --standalone -d your-domain.com

# Update .env
UVICORN_SSL_CERTFILE = "/etc/letsencrypt/live/your-domain.com/fullchain.pem"
UVICORN_SSL_KEYFILE = "/etc/letsencrypt/live/your-domain.com/privkey.pem"
```

--------------------------------

### Start PasarGuard Backend

Source: https://docs.pasarguard.org/fa/node/api

Initiates the PasarGuard node with a specified configuration. This is the first method to be called before establishing any communication with the node. Supports both REST and gRPC.

```http
POST /start
Authorization: Bearer <api_key>
Content-Type: application/x-protobuf

Body: Backend (protobuf)
```

```grpc
rpc Start(Backend) returns (BaseInfoResponse)
```

--------------------------------

### Setup wgcf executable on Linux

Source: https://docs.pasarguard.org/fa/learn/warp

Moves the downloaded wgcf asset to /usr/bin/, renames it to 'wgcf', and makes it executable. This prepares the system to run wgcf commands for Wireguard configuration generation.

```shell
mv wgcf_2.2.22_linux_amd64 /usr/bin/wgcf
chmod +x /usr/bin/wgcf
```

```shell
mv wgcf_2.2.22_linux_arm64 /usr/bin/wgcf
chmod +x /usr/bin/wgcf
```

--------------------------------

### Install Pasarguard Management Script

Source: https://docs.pasarguard.org/fa/migration/marzban

Downloads and installs a management script for Pasarguard. This script provides convenient commands for managing the Pasarguard installation.

```bash
curl -sL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh | sudo bash -s -- @ install-script
```

--------------------------------

### Install PasarGuard with MariaDB

Source: https://docs.pasarguard.org/fa/panel/installation

Installs PasarGuard using the provided script, configuring it for MariaDB as the database backend. MariaDB is a popular open-source alternative to MySQL.

```bash
curl -fsSL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh -o /tmp/pg.sh \
  && sudo bash /tmp/pg.sh install --database mariadb
```

--------------------------------

### Example of Data Limit and Reset Strategy Application

Source: https://docs.pasarguard.org/fa/panel/user_template

This example demonstrates how a user with a specific data limit and reset strategy is configured. It shows the initial limit and the recurring reset dates based on the chosen strategy ('month' in this case).

```plaintext
Template:
  data_limit = 1073741824 (1 GB)
  data_limit_reset_strategy = "month"

User created: 2024-01-01
Result:
  - کاربر محدودیت 1 GB دارد
  - محدودیت در 2024-01-31، 2024-03-01 و غیره بازنشانی می‌شود
```

--------------------------------

### Username Construction Examples

Source: https://docs.pasarguard.org/fa/panel/user_template

Illustrates how usernames are constructed by combining template prefixes, provided usernames, and suffixes. It covers cases with prefixes, suffixes, both, or neither, demonstrating the final username output for each scenario.

```text
Template: prefix = "premium_", suffix = null
Provided: username = "john"
Result: "premium_john"
```

```text
Template: prefix = null, suffix = "_vip"
Provided: username = "john"
Result: "john_vip"
```

```text
Template: prefix = "premium_", suffix = "_vip"
Provided: username = "john"
Result: "premium_john_vip"
```

```text
Template: prefix = null, suffix = null
Provided: username = "john"
Result: "john"
```

--------------------------------

### GET /info - Get Base Information

Source: https://docs.pasarguard.org/fa/node/api

Retrieves basic information about the node and checks its connection status.

```APIDOC
## GET /info

### Description
Retrieves basic information about the node and checks its connection status.

### Method
GET

### Endpoint
`/info`

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **BaseInfoResponse** (protobuf) - Contains basic information about the node.

### Response Example
```protobuf
message BaseInfoResponse {
  string version;
  string core_type;
  bool running;
}
```
```

--------------------------------

### Install PasarGuard (Default - SQLite)

Source: https://docs.pasarguard.org/fa/panel/installation

Installs PasarGuard using the provided script without specifying a database, which defaults to SQLite. This is suitable for smaller deployments and testing purposes.

```bash
curl -fsSL https://github.com/PasarGuard/scripts/raw/main/pasarguard.sh -o /tmp/pg.sh \
  && sudo bash /tmp/pg.sh install
```

--------------------------------

### Shadowsocks Encryption Method Example

Source: https://docs.pasarguard.org/fa/panel/user_template

Shows an example of setting the Shadowsocks encryption method using the `extra_settings` field in a template. This configuration affects the Shadowsocks proxy settings for a user.

```json
{
  "extra_settings": {
    "method": "aes-256-gcm"
  }
}
```

--------------------------------

### GET /stats/system - Get System Statistics

Source: https://docs.pasarguard.org/fa/node/api

Retrieves system-level statistics including memory, CPU usage, and network bandwidth.

```APIDOC
## GET /stats/system

### Description
Retrieves system-level statistics including memory, CPU usage, and network bandwidth.

### Method
GET

### Endpoint
`/stats/system`

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **SystemStatsResponse** (protobuf) - Contains system statistics.

### Response Example
```protobuf
message SystemStatsResponse {
  uint64 mem_total;                  // Total memory
  uint64 mem_used;                   // Used memory
  uint64 cpu_cores;                  // CPU cores
  double cpu_usage;                  // CPU usage %
  uint64 incoming_bandwidth_speed;   // Download speed
  uint64 outgoing_bandwidth_speed;   // Upload speed
}
```
```

--------------------------------

### GET /logs - Get Logs

Source: https://docs.pasarguard.org/fa/node/api

Retrieves real-time backend logs. This endpoint returns a Server-Sent Events (SSE) stream.

```APIDOC
## GET /logs

### Description
Retrieves real-time backend logs. This endpoint returns a Server-Sent Events (SSE) stream.

### Method
GET

### Endpoint
`/logs`

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **Log** (stream) - A stream of log messages.

### Response Example
```protobuf
message Log {
  string detail;  // Log message
}
```
```

--------------------------------

### Pasargard CLI Installation and Help

Source: https://docs.pasarguard.org/fa/interfaces/cli

Demonstrates how to install and access help for the Pasargard CLI. The CLI is typically installed with Pasargard, and its help can be accessed directly or via the project root.

```bash
pasarguard cli --help

# Or from the project root
uv run pasarguard-cli.py --help
```

--------------------------------

### Pasargard CLI Example: Creating a New Admin

Source: https://docs.pasarguard.org/fa/interfaces/cli

An example demonstrating how to create a new administrator user with the Pasargard CLI. It prompts the user for a password and sudo access.

```bash
pasarguard cli admins --create john_admin
# You will be prompted to enter the password and sudo access
```

--------------------------------

### GET /stats - Get Traffic Statistics

Source: https://docs.pasarguard.org/fa/node/api

Retrieves traffic statistics for users, inbound, or outbound connections. Requires a StatRequest body.

```APIDOC
## GET /stats

### Description
Retrieves traffic statistics for users, inbound, or outbound connections. Requires a StatRequest body.

### Method
GET

### Endpoint
`/stats`

### Parameters
#### Request Body
- **StatRequest** (protobuf) - Required - Specifies the type of statistics and whether to reset them.

### Request Example
#### Get all user statistics:
```protobuf
StatRequest {
  type: UsersStat,
  reset: false
}
```

#### Get specific user statistics (and reset):
```protobuf
StatRequest {
  name: "user@example.com",
  type: UserStat,
  reset: true
}
```

### Response
#### Success Response (200)
- **StatResponse** (protobuf) - Contains a list of traffic statistics.

### Response Example
```protobuf
message StatResponse {
  repeated Stat stats;
}

message Stat {
  string name;   // User email or tag
  string type;   // Stat type
  string link;   // Link identifier
  int64 value;   // Traffic value in bytes
}
```
```

--------------------------------

### GET /stats/backend - Get Backend Statistics

Source: https://docs.pasarguard.org/fa/node/api

Retrieves statistics related to the backend's performance, such as goroutine count, memory allocation, and uptime.

```APIDOC
## GET /stats/backend

### Description
Retrieves statistics related to the backend's performance, such as goroutine count, memory allocation, and uptime.

### Method
GET

### Endpoint
`/stats/backend`

### Parameters
No parameters required.

### Response
#### Success Response (200)
- **BackendStatsResponse** (protobuf) - Contains backend statistics.

### Response Example
```protobuf
message BackendStatsResponse {
  uint32 num_goroutine;    // Active goroutines
  uint32 num_gc;           // GC runs
  uint64 alloc;            // Allocated memory
  uint64 total_alloc;      // Total allocated
  uint64 sys;              // System memory
  uint64 mallocs;          // Malloc count
  uint64 frees;            // Free count
  uint64 live_objects;     // Live objects
  uint64 pause_total_ns;   // Total GC pause
  uint32 uptime;           // Uptime in seconds
}
```
```

--------------------------------

### TLS Security Configuration Example

Source: https://docs.pasarguard.org/fa/panel/core

This example shows how to configure TLS security, including specifying certificate and key files. If 'certificateFile' is used, 'keyFile' is mandatory.

```json
{
  "streamSettings": {
    "security": "tls",
    "tlsSettings": {
      "certificates": [{
        "certificateFile": "/path/to/cert.pem",
        "keyFile": "/path/to/key.pem"
      }]
    }
  }
}
```

--------------------------------

### Create User Template with Username Prefix

Source: https://docs.pasarguard.org/fa/panel/user_template

This example shows the creation of a user template that enforces a specific username prefix ('premium_'). Any user created with this template will have this prefix prepended to their username.

```json
{
  "name": "Premium Plan",
  "username_prefix": "premium_",
  "group_ids": [1]
}
```

--------------------------------

### VLESS Flow Extra Settings Example

Source: https://docs.pasarguard.org/fa/panel/user_template

Demonstrates how to configure the VLESS flow control setting within the `extra_settings` of a template. This is applied to the VLESS proxy settings of a user.

```json
{
  "extra_settings": {
    "flow": "xtls-rprx-vision"
  }
}
```

--------------------------------

### Template Application Process

Source: https://docs.pasarguard.org/fa/panel/user_template

This section explains the sequence of operations when a template is applied to create a new user, detailing the validation, field loading, and configuration steps.

```APIDOC
## How Templates Work

### Template Application Process
When creating a user from a template:
1.  **Template Validation:** The template must exist and not be disabled.
2.  **Field Loading:** Base fields are loaded from the template.
3.  **Username Construction:** Prefix + username + suffix are combined.
4.  **Settings Application:** Additional settings (flow, method) are applied.
5.  **User Creation:** The user is created with all template values.

### Field Application Order
```
Template Fields → User Creation → Final User
```

**Applied Fields:**
*   `data_limit` → User's data limit
*   `expire_duration` → User's expiration (calculated from now)
*   `group_ids` → User's groups
*   `status` → Initial user status
*   `data_limit_reset_strategy` → User's reset strategy
*   `username_prefix` + `username` + `username_suffix` → Final username
*   `extra_settings.flow` → VLESS flow setting
*   `extra_settings.method` → Shadowsocks method setting
*   `on_hold_timeout` → User's on_hold timeout (if status is `on_hold`)

**Not Applied Fields:**
*   `name` - Template name is not copied to the user.
*   `is_disabled` - Template's disabled status does not affect created users.
*   `reset_usages` - Only used when modifying existing users.
```

--------------------------------

### Install Go Node Bridge Library

Source: https://docs.pasarguard.org/fa/node/libraries

This section provides the command to install the official Go library for connecting to PasarGuard Node using `go get`.

```go
go get github.com/PasarGuard/node_bridge
```

--------------------------------

### Priority Sorting Example (JSON)

Source: https://docs.pasarguard.org/fa/panel/host

Shows how the 'priority' field is used to sort hosts, with lower numbers indicating higher priority and appearing earlier in subscriptions.

```json
{
  "priority": 1
}
```

```json
{
  "priority": 100
}
```

--------------------------------

### Get User Online Status

Source: https://docs.pasarguard.org/fa/node/api

Retrieves the number of active connections for a specific user.

```APIDOC
## GET /stats/user/online

### Description
Retrieves the number of active connections for a specific user.

### Method
GET

### Endpoint
`/stats/user/online`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Bearer token for authentication.

#### Request Body
- **StatRequest** (protobuf) - Required - Protobuf message containing the request details.

### Request Example
```protobuf
// StatRequest message definition would be here
```

### Response
#### Success Response (200)
- **name** (string) - User's email address.
- **value** (int64) - The count of online connections for the user.

#### Response Example
```json
{
  "name": "user@example.com",
  "value": 5
}
```
```

--------------------------------

### Pasargard CLI Example: Listing Admins

Source: https://docs.pasarguard.org/fa/interfaces/cli

An example showing how to list all administrators with beautiful formatting using the Pasargard CLI. The output is presented as a visually appealing table.

```bash
pasarguard cli admins --list
# Displays a beautiful table with admin details
```

--------------------------------

### Host Filtering Logic Example (Conceptual)

Source: https://docs.pasarguard.org/fa/panel/host

Illustrates how hosts are filtered during subscription generation, emphasizing inbound access checks via user groups, disabled status, and status matching.

```text
User "john" belongs to:
  - Group "Premium" (inbound_tags: ["vless-443", "trojan-8443"])
  - Group "Standard" (inbound_tags: ["vmess-8080"])

Hosts:
  - Host A (inbound_tag: "vless-443") ✅ Appears (in Premium group)
  - Host B (inbound_tag: "trojan-8443") ✅ Appears (in Premium group)
  - Host C (inbound_tag: "vmess-8080") ✅ Appears (in Standard group)
  - Host D (inbound_tag: "shadowsocks-9090") ❌ Does not appear (not in any group)
```

--------------------------------

### Get User Online IPs

Source: https://docs.pasarguard.org/fa/node/api

Retrieves the list of IP addresses for a user's active connections.

```APIDOC
## GET /stats/user/online_ip

### Description
Retrieves the list of IP addresses for a user's active connections.

### Method
GET

### Endpoint
`/stats/user/online_ip`

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Bearer token for authentication.

#### Request Body
- **StatRequest** (protobuf) - Required - Protobuf message containing the request details.

### Request Example
```protobuf
// StatRequest message definition would be here
```

### Response
#### Success Response (200)
- **name** (string) - User's email address.
- **ips** (array of strings) - List of IP addresses for the user's active connections.

#### Response Example
```json
{
  "name": "user@example.com",
  "ips": ["192.168.1.100", "10.0.0.5"]
}
```
```

--------------------------------

### Address Template Example - Pasargard

Source: https://docs.pasarguard.org/fa/panel/host

Illustrates the use of format variables within an address configuration, allowing for dynamic generation of server addresses. This example shows how to include server IP and a dynamically generated hostname.

```json
{
  "address": ["{SERVER_IP}", "cdn-{USERNAME}.example.com"]
}
// Result in random selection: "1.2.3.4" or "cdn-john_doe.example.com"
```

--------------------------------

### Application Configuration (JSON)

Source: https://docs.pasarguard.org/fa/panel/settings

Defines client applications with deep links for easy one-click subscription sharing. Includes details like platform, icon, deep link URL, descriptions, and download links. Ensure the 'import_url' placeholder '{url}' is present.

```json
{
  "applications": [
    {
      "name": "v2rayNG",
      "platform": "android",
      "icon_url": "https://cdn.example.com/icons/v2rayng.png",
      "import_url": "v2rayng://install-config?url={url}",
      "description": {
        "en": "Fast and lightweight VPN client for Android",
        "fa": "کلاینت سریع و سبک برای اندروید",
        "ru": "Быстрый VPN-клиент для Android",
        "zh": "适用于Android的快速VPN客户端"
      },
      "recommended": true,
      "download_links": [
        {
          "name": "Google Play",
          "url": "https://play.google.com/store/apps/details?id=com.v2ray.ang",
          "language": "en"
        },
        {
          "name": "GitHub Release",
          "url": "https://github.com/2dust/v2rayNG/releases",
          "language": "en"
        }
      ]
    }
  ]
}
```

--------------------------------

### JWT Access Token Expiration Examples

Source: https://docs.pasarguard.org/fa/panel/configuration

Shows how to set the expiration time for JWT access tokens in minutes. This impacts the security and user session duration.

```dotenv
# Token expires after 24 hours
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 1440

# Token expires after 7 days
JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 10080
```

--------------------------------

### Rename Marzban Directory to PasarGuard

Source: https://docs.pasarguard.org/fa/migration/marzban

This command renames the main Marzban installation directory to PasarGuard. This is a crucial step for the in-place migration. It requires root privileges.

```bash
sudo mv /opt/marzban /opt/pasarguard
```
Tokens:
Raw