Remnawave Migration Tool

A command-line tool for migrating users from various VPN management panels to Remnawave.

Supported Source Panels

• Marzban
• Marzneshin

Overview

This tool helps you migrate user accounts from various VPN management panels to a Remnawave. It supports batch processing, selective migration of recent users, and customization of traffic reset strategies.

Key features:

• Batch processing with configurable batch size
• Migration of selected number of most recent users
• Automatic handling of existing users
• Support for environment variables
• Customizable traffic reset strategy
• Flexible status handling

Migrated User Fields

The following user fields are migrated to Remnawave:

Field	Description
Username	User's unique identifier
Status	User's status (can be preserved or set to ACTIVE)
ShortUUID	Generated from subscription URL hash
TrojanPassword	Password for Trojan protocol
VlessUUID	UUID for VLESS protocol
SsPassword	Password for Shadowsocks protocol
TrafficLimitBytes	Traffic limit in bytes
TrafficLimitStrategy	Traffic reset strategy (can be customized)
ExpireAt	Account expiration date (UTC)
Description	User notes/description

Configuration

The tool can be configured using command-line flags or environment variables:

Flag	Environment Variable	Description	Default
--panel-type	PANEL_TYPE	Source panel type (marzban or marzneshin)	marzban
--panel-url	PANEL_URL	Source panel URL
--panel-username	PANEL_USERNAME	Source panel admin username
--panel-password	PANEL_PASSWORD	Source panel admin password
--remnawave-url	REMNAWAVE_URL	Destination panel URL
--remnawave-token	REMNAWAVE_TOKEN	Destination panel API token
--batch-size	BATCH_SIZE	Number of users to process in one batch	100
--last-users	LAST_USERS	Only migrate last N users (0 means all users)	0
--preferred-strategy	PREFERRED_STRATEGY	Preferred traffic reset strategy for all users
--preserve-status	PRESERVE_STATUS	Preserve user status from source panel	false

Usage

Basic Usage

# Migrate all users (sets all users to ACTIVE status)
./remnawave-migrate \
    --panel-type=marzban \
    --panel-url="http://marzban.example.com" \
    --panel-username="admin" \
    --panel-password="password" \
    --remnawave-url="http://remnawave.example.com" \
    --remnawave-token="your-token"

Preserve User Status

# Migrate users preserving their original status
./remnawave-migrate \
    [other flags...] \
    --preserve-status

Migrate Last N Users

# Migrate only the last 50 users
./remnawave-migrate \
    [other flags...] \
    --last-users=50

Set Preferred Traffic Reset Strategy

# Migrate users with a specific reset strategy
./remnawave-migrate \
    [other flags...] \
    --preferred-strategy=MONTH

Available strategy values:

• NO_RESET - No traffic limit reset
• DAY - Reset daily
• WEEK - Reset weekly
• MONTH - Reset monthly

Note: If not specified, the original strategy from Marzban will be used (with YEAR strategy converted to NO_RESET as Remnawave doesn't support yearly resets).

Using Environment Variables

export PANEL_TYPE="marzban"
export PANEL_URL="http://marzban.example.com"
export PANEL_USERNAME="admin"
export PANEL_PASSWORD="password"
export REMNAWAVE_URL="http://remnawave.example.com"
export REMNAWAVE_TOKEN="your-token"
export BATCH_SIZE="200"
export LAST_USERS="50"
export PREFERRED_STRATEGY="MONTH"
export PRESERVE_STATUS="true"

./remnawave-migrate

Contribute

1. Fork & Branch: Fork this repository and create a branch for your work.
2. Implement Changes: Work on your feature or fix, keeping code clean and well-documented.
3. Test: Ensure your changes maintain or improve current functionality, adding tests for new features.
4. Commit & PR: Commit your changes with clear messages, then open a pull request detailing your work.
5. Feedback: Be prepared to engage with feedback and further refine your contribution.