|
| 1 | + |
| 2 | +# 🌐 MikroTik NAT Sync for Pelican Panel |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +**MikroTik NAT Sync** — це плагін для автоматизації прокидання портів (Port Forwarding) між панеллю Pelican та маршрутизаторами MikroTik через REST API. |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## 🇺🇸 English |
| 13 | + |
| 14 | +### 🚀 Features |
| 15 | +* **Full Automation**: Automatically creates/removes DST-NAT rules based on Pelican allocations. |
| 16 | +* **Security First**: Define a "Forbidden Ports" list to protect sensitive services (SSH, SFTP, etc.). |
| 17 | +* **Smart Tags**: Manages only its own rules using the `Pelican:` comment tag. |
| 18 | +* **Easy Setup**: Configure everything (IP, credentials, intervals) directly in the Admin UI. |
| 19 | + |
| 20 | +### 🛠 MikroTik Configuration |
| 21 | +Enable the REST API on your router to allow communication: |
| 22 | +```Bash |
| 23 | +/ip service set www-ssl disabled=no port=9443 |
| 24 | +``` |
| 25 | +Note: We recommend creating a dedicated user with specific firewall permissions. |
| 26 | + |
| 27 | +### 📦 Installation / Встановлення |
| 28 | + |
| 29 | +**Method 1: Via Web Interface (Easiest)** |
| 30 | +1. Copy the direct link to the plugin ZIP archive: |
| 31 | + `https://github.com/avalon0077/mikrotik-nat-sync/archive/refs/heads/main.zip` |
| 32 | +2. In your Pelican Admin Panel, go to **Plugins** -> **Import**. |
| 33 | +3. Paste the URL or upload the downloaded ZIP file. |
| 34 | +4. Click **Install** and configure via the Gear icon. |
| 35 | + |
| 36 | +**Method 2: Manual (CLI)** |
| 37 | +1. Download and extract the archive to `/var/www/pelican/plugins/mikrotik-nat-sync`. |
| 38 | +2. Make sure the folder name is exactly `mikrotik-nat-sync`. |
| 39 | +3. Head to the **Plugins** page and click **Install**. |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +## 🇺🇦 Українською |
| 44 | + |
| 45 | +### 🚀 Можливості |
| 46 | +* **Повна автоматизація**: Автоматично керує правилами DST-NAT на основі активних алокацій. |
| 47 | + |
| 48 | +* **Безпека**: Список "Заборонених портів" для захисту системних сервісів. |
| 49 | + |
| 50 | +* **Розумні теги**: Керує лише своїми правилами через коментар Pelican:. |
| 51 | + |
| 52 | +* **Зручне налаштування**: Налаштуйте IP, логін, пароль та інтервали прямо в адмінці. |
| 53 | + |
| 54 | +### 🛠 Налаштування MikroTik |
| 55 | +Увімкніть REST API для можливості віддаленого керування: |
| 56 | + |
| 57 | +```Bash |
| 58 | +/ip service set www-ssl disabled=no port=9443 |
| 59 | +``` |
| 60 | +Порада: Створіть окремого користувача з правами на роботу лише з Firewall. |
| 61 | + |
| 62 | +### 📦 Installation / Встановлення |
| 63 | + |
| 64 | +**Спосіб 1: Через веб-інтерфейс (Найпростіший)** |
| 65 | +1. Скопіюйте пряме посилання на ZIP-архів плагіна: |
| 66 | + `https://github.com/avalon0077/mikrotik-nat-sync/archive/refs/heads/main.zip` |
| 67 | +2. В адмін-панелі Pelican перейдіть у **Plugins** -> **Import**. |
| 68 | +3. Вставте посилання або завантажте попередньо скачаний ZIP-файл. |
| 69 | +4. Натисніть **Install** та налаштуйте через іконку шестерні. |
| 70 | + |
| 71 | +**Спосіб 2: Вручну (через консоль)** |
| 72 | +1. Скачайте та розпакуйте архів у папку `/var/www/pelican/plugins/mikrotik-nat-sync`. |
| 73 | +2. Переконайтеся, що папка називається саме `mikrotik-nat-sync`. |
| 74 | +3. Перейдіть на сторінку **Plugins** та натисніть **Install**. |
| 75 | + |
| 76 | +>Developed with AI Assistance (Gemini) Розроблено за допомогою ШІ (Gemini) |
0 commit comments