Add new pages for introduction, update, and assets

Mintlify-Source: dashboard-editor
2026-04-21 10:22:00 +00:00 · 2026-03-23 09:40:06 +05:00
parent ead0b899d3
commit 41697150e7
6 changed files with 232 additions and 30 deletions
--- a/assety.mdx
+++ b/assety.mdx
@@ -0,0 +1,36 @@
+---
+title: "Ассеты"
+description: "Настройка баннеров и переводов Remnashop"
+---
+
+## Баннеры
+
+Бот поддерживает кастомные баннеры для каждой категории страниц и локали: `menu`, `dashboard`, `subscription`, `promocode`, `referral`.
+
+Чтобы установить кастомный баннер, назовите файл в соответствии с целевой страницей и убедитесь, что он использует один из поддерживаемых форматов: `jpg`, `jpeg`, `png`, `gif`, `webp`.
+
+Баннеры должны быть размещены по пути: `/opt/remnashop/assets/banners/(locale)/`
+
+Пример: `/opt/remnashop/assets/banners/en/menu.gif`
+
+<Warning>
+  Не удаляйте файл `default.jpg` — он необходим для корректной работы бота.
+</Warning>
+
+---
+
+## Переводы
+
+Вы можете редактировать любой файл перевода, расположенный по пути: `/opt/remnashop/assets/translations/(locale)/`
+
+После внесения изменений необходимо перезапустить контейнер, чтобы они вступили в силу.
+
+<CodeGroup>
+```bash Перезапуск контейнера
+cd /opt/remnashop && docker compose down && docker compose up -d
+```
+</CodeGroup>
+
+<Warning>
+  В настоящее время сохранение переводов при обновлении бота не поддерживается. При обновлении ваши предыдущие ассеты будут заархивированы по пути: `/opt/remnashop/assets/*.bak`
+</Warning>
--- a/docs.json
+++ b/docs.json
@@ -9,13 +9,21 @@
  },
  "navigation": {
    "groups": [
+      {
+        "group": "Обзор",
+        "pages": [
+          "introduction",
+          "install/releases"
+        ]
+      },
      {
        "group": "Начало",
        "pages": [
-          "install/releases",
          "install/requirements",
          "install/installation",
-          "install/environment-variables"
+          "install/environment-variables",
+          "update",
+          "assety"
        ]
      },
      {
--- a/install/installation.mdx
+++ b/install/installation.mdx
@@ -11,7 +11,7 @@ description: "Краткое руководство по установке Remn

 ## Установка Docker

-Установите <Badge>Docker</Badge>, если он ещё не установлен.
+Установите `Docker`, если он ещё не установлен.

 <Accordion title="Установка Docker">
 ```text
@@ -39,7 +39,7 @@ description: "Краткое руководство по установке Remn

    #### Шаг 2: Загрузка необходимых файлов

-    <p>Загрузите файл <Badge>docker-compose.yml</Badge> и <Badge>.env</Badge>, выполнив следующие команды:</p>
+    <p>Загрузите файл `docker-compose.yml` и `.env`, выполнив следующие команды:</p>

    <CodeGroup>
 ```bash Получение файла .env
@@ -75,7 +75,7 @@ description: "Краткое руководство по установке Remn
      Дополнительную информацию о переменных окружения можно найти на странице [Переменные окружения](https://remnashop.mintlify.app/install/environment-variables).
    </Tip>

-    <p>Откройте файл <Badge>.env</Badge>:</p>
+    <p>Откройте файл `.env`:</p>

    <CodeGroup>
 ```bash Редактирование файла .env
@@ -129,19 +129,19 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Tip>
-      <Badge>REMNAWAVE_HOST=remnawave</Badge> использует имя контейнера из Docker-сети Remnawave.
+      `REMNAWAVE_HOST=remnawave` использует имя контейнера из Docker-сети Remnawave.
    </Tip>

    <Tip>
-      В переменной <Badge>REMNAWAVE_TOKEN</Badge> должен быть установлен API-токен панели. Создать токен можно в "Настройки Remnawave" → "API Токены".
+      В переменной `REMNAWAVE_TOKEN` должен быть установлен API-токен панели. Создать токен можно в "Настройки Remnawave" → "API Токены".
    </Tip>

    <Warning>
-      <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge> должен совпадать со значением <Badge>WEBHOOK_SECRET_HEADER</Badge> из <Badge>.env</Badge> панели.
+      `REMNAWAVE_WEBHOOK_SECRET` должен совпадать со значением `WEBHOOK_SECRET_HEADER` из `.env` панели.
    </Warning>

    <Warning>
-      Если вы используете Remnawave Reverse-Proxy от eGames, добавьте cookie для авторизации. Пример: <Badge>REMNAWAVE_COOKIE=rEmnaprx=aBCDefgh1</Badge>. Как получить cookie: [инструкция](https://wiki.egam.es/ru/troubleshooting/common-issues/#%D1%83%D1%82%D0%B5%D1%80%D1%8F%D0%BD%D0%BD%D1%8B%D0%B9-cookie-%D0%BF%D1%83%D1%82%D0%B8-%D0%BA-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D0%B8).
+      Если вы используете Remnawave Reverse-Proxy от eGames, добавьте cookie для авторизации. Пример: `REMNAWAVE_COOKIE=rEmnaprx=aBCDefgh1`. Как получить cookie: [инструкция](https://wiki.egam.es/ru/troubleshooting/common-issues/#%D1%83%D1%82%D0%B5%D1%80%D1%8F%D0%BD%D0%BD%D1%8B%D0%B9-cookie-%D0%BF%D1%83%D1%82%D0%B8-%D0%BA-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D0%B8).
    </Warning>

    #### Шаг 5: Настройка вебхука от панели к боту
@@ -150,7 +150,7 @@ description: "Краткое руководство по установке Remn
      Этот шаг критически важен для корректной работы бота.
    </Danger>

-    <p>Откройте файл <Badge>.env</Badge> панели Remnawave:</p>
+    <p>Откройте файл `.env` панели Remnawave:</p>

    <CodeGroup>
 ```bash Редактирование файла .env панели
@@ -158,7 +158,7 @@ description: "Краткое руководство по установке Remn
 ```
    </CodeGroup>

-    <p>Задайте <Badge>WEBHOOK_ENABLED=true</Badge> и установите <Badge>WEBHOOK_URL</Badge> на ваш реальный домен бота:</p>
+    <p>Задайте `WEBHOOK_ENABLED=true` и установите `WEBHOOK_URL` на ваш реальный домен бота:</p>

    <CodeGroup>
 ```bash Содержимое файла .env панели
@@ -168,10 +168,10 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Warning>
-      Замените <Badge>bot.domain.com</Badge> на ваш реальный домен.
+      Замените `bot.domain.com` на ваш реальный домен.
    </Warning>

-    <p>Найдите переменную <Badge>WEBHOOK_SECRET_HEADER</Badge> в этом же файле и скопируйте её значение:</p>
+    <p>Найдите переменную `WEBHOOK_SECRET_HEADER` в этом же файле и скопируйте её значение:</p>

    <CodeGroup>
 ```bash Содержимое файла .env панели
@@ -180,7 +180,7 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Tip>
-      Значение <Badge>ey1234567890qwertyuiopasdfghjklzxcvbnm</Badge> приведено в качестве примера.
+      Значение `ey1234567890qwertyuiopasdfghjklzxcvbnm` приведено в качестве примера.
    </Tip>

    <p>Перезапустите контейнер панели Remnawave для применения изменений:</p>
@@ -191,7 +191,7 @@ description: "Краткое руководство по установке Remn
 ```
    </CodeGroup>

-    <p>Вернитесь к файлу <Badge>.env</Badge> бота и вставьте скопированное значение в <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge>:</p>
+    <p>Вернитесь к файлу `.env` бота и вставьте скопированное значение в `REMNAWAVE_WEBHOOK_SECRET`:</p>

    <CodeGroup>
 ```bash Редактирование файла .env Remnashop
@@ -206,7 +206,7 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Warning>
-      <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge> должен совпадать со значением <Badge>WEBHOOK_SECRET_HEADER</Badge> из файла <Badge>.env панели</Badge>.
+      `REMNAWAVE_WEBHOOK_SECRET` должен совпадать со значением `WEBHOOK_SECRET_HEADER` из файла `.env панели`.
    </Warning>

    #### Шаг 6: Запуск бота
@@ -249,7 +249,7 @@ description: "Краткое руководство по установке Remn

    #### Шаг 2: Загрузка необходимых файлов

-    <p>Загрузите файл <Badge>docker-compose.yml</Badge> и <Badge>.env</Badge>, выполнив следующие команды:</p>
+    <p>Загрузите файл `docker-compose.yml` и `.env`, выполнив следующие команды:</p>

    <CodeGroup>
 ```bash Получение файла .env
@@ -285,7 +285,7 @@ description: "Краткое руководство по установке Remn
      Дополнительную информацию о переменных окружения можно найти на странице [Переменные окружения](https://remnashop.mintlify.app/install/environment-variables).
    </Tip>

-    <p>Откройте файл <Badge>.env</Badge>:</p>
+    <p>Откройте файл `.env`:</p>

    <CodeGroup>
 ```bash Редактирование файла .env
@@ -340,19 +340,19 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Tip>
-      В переменной <Badge>REMNAWAVE_HOST</Badge> укажите домен вашей панели Remnawave. Пример: <Badge>REMNAWAVE_HOST=panel.domain.com</Badge>
+      В переменной `REMNAWAVE_HOST` укажите домен вашей панели Remnawave. Пример: `REMNAWAVE_HOST=panel.domain.com`
    </Tip>

    <Tip>
-      В переменной <Badge>REMNAWAVE_TOKEN</Badge> должен быть установлен API-токен панели. Создать токен можно в "Настройки Remnawave" → "API Токены".
+      В переменной `REMNAWAVE_TOKEN` должен быть установлен API-токен панели. Создать токен можно в "Настройки Remnawave" → "API Токены".
    </Tip>

    <Warning>
-      <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge> должен совпадать со значением <Badge>WEBHOOK_SECRET_HEADER</Badge> из <Badge>.env</Badge> панели.
+      `REMNAWAVE_WEBHOOK_SECRET` должен совпадать со значением `WEBHOOK_SECRET_HEADER` из `.env` панели.
    </Warning>

    <Warning>
-      Если вы используете Remnawave Reverse-Proxy от eGames, добавьте cookie для авторизации. Пример: <Badge>REMNAWAVE_COOKIE=rEmnaprx=aBCDefgh1</Badge>. Как получить cookie: [инструкция](https://wiki.egam.es/ru/troubleshooting/common-issues/#%D1%83%D1%82%D0%B5%D1%80%D1%8F%D0%BD%D0%BD%D1%8B%D0%B9-cookie-%D0%BF%D1%83%D1%82%D0%B8-%D0%BA-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D0%B8).
+      Если вы используете Remnawave Reverse-Proxy от eGames, добавьте cookie для авторизации. Пример: `REMNAWAVE_COOKIE=rEmnaprx=aBCDefgh1`. Как получить cookie: [инструкция](https://wiki.egam.es/ru/troubleshooting/common-issues/#%D1%83%D1%82%D0%B5%D1%80%D1%8F%D0%BD%D0%BD%D1%8B%D0%B9-cookie-%D0%BF%D1%83%D1%82%D0%B8-%D0%BA-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D0%B8).
    </Warning>

    #### Шаг 5: Настройка вебхука от панели к боту
@@ -361,7 +361,7 @@ description: "Краткое руководство по установке Remn
      Этот шаг критически важен для корректной работы бота.
    </Danger>

-    <p>Откройте файл <Badge>.env</Badge> панели Remnawave:</p>
+    <p>Откройте файл `.env` панели Remnawave:</p>

    <CodeGroup>
 ```bash Редактирование файла .env панели
@@ -369,7 +369,7 @@ description: "Краткое руководство по установке Remn
 ```
    </CodeGroup>

-    <p>Задайте <Badge>WEBHOOK_ENABLED=true</Badge> и установите <Badge>WEBHOOK_URL</Badge> на ваш реальный домен бота:</p>
+    <p>Задайте `WEBHOOK_ENABLED=true` и установите `WEBHOOK_URL` на ваш реальный домен бота:</p>

    <CodeGroup>
 ```bash Содержимое файла .env панели
@@ -379,10 +379,10 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Warning>
-      Замените <Badge>bot.domain.com</Badge> на ваш реальный домен.
+      Замените `bot.domain.com` на ваш реальный домен.
    </Warning>

-    <p>Найдите переменную <Badge>WEBHOOK_SECRET_HEADER</Badge> в этом же файле и скопируйте её значение:</p>
+    <p>Найдите переменную `WEBHOOK_SECRET_HEADER` в этом же файле и скопируйте её значение:</p>

    <CodeGroup>
 ```bash Содержимое файла .env панели
@@ -391,7 +391,7 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Tip>
-      Значение <Badge>ey1234567890qwertyuiopasdfghjklzxcvbnm</Badge> приведено в качестве примера.
+      Значение `ey1234567890qwertyuiopasdfghjklzxcvbnm` приведено в качестве примера.
    </Tip>

    <p>Перезапустите контейнер панели Remnawave для применения изменений:</p>
@@ -402,7 +402,7 @@ description: "Краткое руководство по установке Remn
 ```
    </CodeGroup>

-    <p>Вернитесь к файлу <Badge>.env</Badge> бота и вставьте скопированное значение в <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge>:</p>
+    <p>Вернитесь к файлу `.env` бота и вставьте скопированное значение в `REMNAWAVE_WEBHOOK_SECRET`:</p>

    <CodeGroup>
 ```bash Редактирование файла .env Remnashop
@@ -417,7 +417,7 @@ description: "Краткое руководство по установке Remn
    </CodeGroup>

    <Warning>
-      <Badge>REMNAWAVE_WEBHOOK_SECRET</Badge> должен совпадать со значением <Badge>WEBHOOK_SECRET_HEADER</Badge> из файла <Badge>.env панели</Badge>.
+      `REMNAWAVE_WEBHOOK_SECRET` должен совпадать со значением `WEBHOOK_SECRET_HEADER` из файла `.env панели`.
    </Warning>

    #### Шаг 6: Запуск бота
--- a/install/requirements.mdx
+++ b/install/requirements.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Требования"
-description: "На этой странице перечислены аппаратные и программные требования для запуска Remnashop Telegram Bot"
+description: "На этой странице перечислены аппаратные и программные требования для запуска Remnashop"
 ---

 ---
--- a/introduction.mdx
+++ b/introduction.mdx
@@ -0,0 +1,136 @@
+---
+title: "Введение"
+description: "Remnashop — это Telegram-бот для продажи VPN-подписок, интегрированный с Remnawave."
+---
+
+## Возможности
+
+<AccordionGroup>
+
+  <Accordion title="📦 Планы">
+    - Конфигуратор планов прямо в интерфейсе бота.
+    - Уникальная архитектура, позволяющая гибко создавать тарифы и управлять их доступностью.
+    - Поддержка любых лимитов — по трафику, устройствам, вместе или без ограничений.
+    - Управление доступностью для конкретных пользователей или типов пользователей.
+    - Привязка внутренних и внешних сквадов к конкретным планам.
+    - Поддержка любых длительностей подписки.
+    - Возможность сделать план бесплатным.
+    - Мультивалютные цены для каждой длительности.
+    - Настраиваемый порядок отображения планов.
+    - Импорт/экспорт планов
+  </Accordion>
+
+  <Accordion title="🎟️ Промокоды">
+    - Различные типы наград: дополнительные дни, трафик, выдача подписки по плану, персональная скидка или скидка на следующую покупку.
+    - Настройка времени жизни: по времени или количеству активаций.
+    - Удобный конфигуратор промокодов.
+  </Accordion>
+
+  <Accordion title="📢 Рассылки">
+    - Просмотр всех отправленных сообщений с контентом.
+    - Отправка по категориям пользователей: всем, по плану, с подпиской, без подписки, с истекшей подпиской или с пробником.
+    - Поддержка фото, видео, GIF и стикеров.
+    - Поддержка HTML-тегов для форматирования текста.
+    - Предпросмотр перед отправкой.
+    - Возможность остановить активную рассылку.
+    - Возможность удалить отправленные сообщения.
+  </Accordion>
+
+  <Accordion title="🔔 Уведомления и ивенты">
+    - Настраиваемая система уведомлений прямо в интерфейсе бота.
+    - Пользовательские уведомления: истечение подписки, подписка истекла, исчерпан трафик и т.п.
+    - Системные уведомления: жизненный цикл бота, обновление бота, регистрация, оформление подписки, активация промокода, статус узла, первое подключение пользователя, добавление/удаление устройства и т.п.
+    - Возможность отправки уведомлений в топики чата для сортировки.
+  </Accordion>
+
+  <Accordion title="🧪 Пробный период">
+    - Настройка пробников через конфигуратор планов.
+    - Поддержка любых лимитов.
+    - Поддержка нескольких пробных планов.
+    - Привязка разных внутренних и внешних сквадов.
+    - Настройка доступности для пользователей с рекламных или реферальных ссылок.
+  </Accordion>
+
+  <Accordion title="👥 Реферальная система">
+    - Подробная статистика рефералов.
+    - Конфигуратор реферальной системы.
+    - Настройка наград: баллы или дни.
+    - Поддержка двухуровневых рефералов.
+  </Accordion>
+
+  <Accordion title="💳 Платёжные системы">
+    - Поддержка множества агрегаторов: Telegram Stars, YooKassa, YooMoney, Cryptomus, Heleket, FreeKassa, MulenPay, PayMaster, Platega, RoboKassa, UrlPay, WATA
+    - Конфигуратор платёжных шлюзов.
+    - Настройка валюты по умолчанию.
+    - Возможность проведения тестовых платежей.
+    - Настройка порядка отображения способов оплаты.
+  </Accordion>
+
+  <Accordion title="📱 Управление устройствами">
+    - Возможность пользователям управлять своими устройствами (при активной подписке и в рамках лимита).
+    - Настройка интервала между сбросами устройств.
+    - Возможность сброса ссылки подписки.
+  </Accordion>
+
+  <Accordion title="🏷️ Система скидок">
+    - Два типа скидок: персональная и на следующую покупку.
+    - Скидки не суммируются — применяется наибольшая.
+    - Отображение скидки на кнопках покупки.
+  </Accordion>
+
+  <Accordion title="🔐 Режим доступа">
+    - Пять режимов: полное ограничение, открытый доступ, по приглашениям, запрет покупок и запрет регистрации.
+    - Автоуведомления пользователям, пытавшимся купить при активном ограничении.
+    - Условия доступа: принятие правил и подписка на канал.
+  </Accordion>
+
+  <Accordion title="📈 Рекламные ссылки">
+    - Создание ссылок для отслеживания источников трафика и пользователей.
+    - Встроенный конфигуратор ссылок.
+    - Просмотр детальной аналитики.
+  </Accordion>
+
+  <Accordion title="📊 Статистика">
+    - Подробная статистика по категориям: пользователи, транзакции, подписки (планы), промокоды, рефералы.
+  </Accordion>
+
+  <Accordion title="👤 Редактор пользователей">
+    - Полная информация: данные, статистика, подписка, транзакции.
+    - Редактирование скидок.
+    - Управление ролями: разработчик, администратор, пользователь.
+    - Блокировка пользователя.
+    - Выдача доступа к покупке определенного плана.
+    - Редактор подписки: лимиты, сброс трафика, устройства, сквады, дата окончания, включение/отключение, удаление, получение ссылки на подключение.
+    - Просмотр заблокированных пользователей.
+    - Поиск по имени, username и идентификатору.
+    - Списки последних зарегистрированных и активных пользователей.
+    - Быстрый доступ через пересланные сообщения и уведомления.
+  </Accordion>
+
+  <Accordion title="🔄 Синхронизация пользователей">
+    - Автоматическая синхронизация с панелью.
+    - Возможность изменять данные пользователей как в боте, так и через панель.
+    - Импорт пользователей из панели 3X-UI
+    - Простая миграция с других ботов .
+  </Accordion>
+
+  <Accordion title="🎛 Редактор главного меню">
+    - Возможность добавлять и изменять допополнительные кнопки в главно меню
+  </Accordion>
+
+  <Accordion title="🌐 Интернационализация">
+    - Возможность задавать уникальные баннеры для каждой локали и определенных диалогов.
+    - Поддержка переводов интерфейса на разные языки.
+    - Возможность переводов названий и описаний планов
+    - Автоматическое определение языка при первой регистрации и последующих изменениях.
+  </Accordion>
+
+  <Accordion title="🪄 MiniApp">
+    - Интеграция со страницей подписки через Telegram MiniApp.
+  </Accordion>
+
+</AccordionGroup>
+
+<Warning>
+  Некоторые функции еще находятся в стадии разработки и тестирования!
+</Warning>
--- a/update.mdx
+++ b/update.mdx
@@ -0,0 +1,22 @@
+---
+title: "Обновление"
+description: "Как обновить Remnashop до последней версии"
+---
+
+Для обновления и перезапуска бота выполните следующую команду:
+
+<CodeGroup>
+```bash Обновление бота
+cd /opt/remnashop && docker compose pull && docker compose down && RESET_ASSETS=true docker compose up -d && docker compose logs -f
+```
+</CodeGroup>
+
+При использовании `RESET_ASSETS=true` выполняются следующие действия:
+
+- Все текущие ассеты архивируются с временной меткой (`/opt/remnashop/assets/*.bak`).
+- Новые ассеты из образа загружаются и распаковываются.
+- После обновления бот будет использовать актуальные файлы ассетов.
+
+<Warning>
+  Если вы не используете `RESET_ASSETS=true`, старые ассеты останутся без изменений. Это может привести к некорректной работе бота после обновления.
+</Warning>