Интеграция подписок с Chumpy

Открытие подписки по ссылке

Chumpy поддерживает одну команду своей схемы:

chumpy://add/https://sub.example.com/example-token?format=xray

После chumpy://add/ вставьте полный HTTP(S)-адрес подписки. Параметры после ? сохраняются. Целиком кодировать вложенный URL не нужно. Chumpy покажет окно подтверждения, а затем запросит подписку.

Для сайта можно использовать обычную ссылку. В HTML экранируйте амперсанды в параметрах как &.

<a href="chumpy://add/https://sub.example.com/example-token?format=xray&amp;lang=ru">
  Открыть в Chumpy
</a>

В Remnawave тип кнопки — subscriptionLink, значение — chumpy://add/. Готовый JSON и шаги импорта находятся в папке Remnawave.

Что Chumpy отправляет серверу

Chumpy запрашивает подписку методом GET. Обычный User-Agent:

Chumpy/1.0 (Android) v2rayNG/1.10

При включённой совместимости с Happ формат меняется:

Happ/<версия Happ>/<платформа>/Chumpy/<версия приложения>/<идентификатор клиента>

В этом режиме также передаются x-device-locale, x-hwid, x-device-os, x-ver-os и x-device-model. Для правила, которое должно совпадать с обоими режимами, проверяйте, что User-Agent содержит Chumpy/.

Какие заголовки читает Chumpy

Заголовок ответа Значение
profile-title Название подписки. Обычный текст, URL-кодированный текст или base64:<UTF-8 в Base64>.
content-disposition Имя файла используется как запасное название, если profile-title не задан.
subscription-userinfo Трафик в байтах и срок действия в секундах Unix. Например, upload=0; download=12345; total=1073741824; expire=1893456000.
profile-update-interval Интервал автообновления в часах, если оно включено.
profile-logo URL иконки подписки.
profile-web-page-url HTTP(S)-ссылка на сайт подписки.
support-url HTTP(S)-ссылка на поддержку.
announce Текст объявления в карточке подписки. Допускается base64:<UTF-8 в Base64>. Для кириллицы в HTTP-заголовке используйте Base64.
routing Из формата Happ Chumpy читает ссылки на базы Geoipurl и Geositeurl.

Те же поля, кроме content-disposition, можно передать строками в теле подписки. Это работает и для списка, целиком закодированного в Base64. Непустой HTTP-заголовок имеет приоритет над одноимённой строкой тела.

#profile-title: Example VPN
#profile-logo: https://cdn.example.com/logo.png
#support-url: https://t.me/example_support
#announce: Тарифы и продление — в личном кабинете.

После этих строк разместите обычные ссылки на серверы.

Передайте URL изображения в заголовке ответа сервера подписки:

profile-logo: https://cdn.example.com/logo.png

Chumpy скачивает и кеширует иконку при добавлении или обновлении подписки. Подойдут PNG и SVG до 2 МиБ по обычному HTTP(S)-адресу. В значении должен быть URL, по которому сервер отдаёт саму картинку.

Если поле отсутствует или значение не подходит, отображается стандартная иконка. Если загрузка по корректному адресу временно не удалась, Chumpy сохраняет предыдущую иконку, если она есть.

Remnawave для всех клиентов

Откройте Подписка → Настройки → Заголовки ответа и добавьте пару profile-logo и https://cdn.example.com/logo.png. В JSON эта настройка выглядит так:

{
  "profile-logo": "https://cdn.example.com/logo.png"
}

Только для Chumpy

В разделе Подписка → Правила ответов добавьте profile-logo в правило, которое обслуживает Chumpy. Если создаёте отдельное правило, поставьте его выше общего правила и выберите тот же формат ответа, который уже получает клиент. В примере ниже используется XRAY_BASE64. Remnawave останавливается на первом совпавшем правиле. Документация правил ответов

{
  "name": "Chumpy icon",
  "enabled": true,
  "operator": "AND",
  "conditions": [
    {
      "headerName": "user-agent",
      "operator": "CONTAINS",
      "value": "Chumpy/",
      "caseSensitive": false
    }
  ],
  "responseType": "XRAY_BASE64",
  "responseModifications": {
    "applyHeadersToEnd": true,
    "headers": [
      { "key": "profile-logo", "value": "https://cdn.example.com/logo.png" }
    ]
  }
}

Разные иконки для внешних сквадов

Откройте Users → External Squads, выберите сквад и добавьте profile-logo в его заголовки ответа. Для каждого сквада можно указать свой URL. Если правило ответа задаёт этот же заголовок с applyHeadersToEnd: true, оно может переопределить значение сквада. Документация внешних сквадов

Через API Remnawave

Получите UUID настроек и текущие заголовки запросом GET /api/subscription-settings. Используйте API-токен панели в переменной REMNA_TOKEN.

curl -fsS 'https://panel.example.com/api/subscription-settings' \
  -H "Authorization: Bearer ${REMNA_TOKEN}"

Передайте в customResponseHeaders все заголовки, которые хотите сохранить, вместе с новым profile-logo. В примере ниже он единственный.

curl -fsS -X PATCH 'https://panel.example.com/api/subscription-settings' \
  -H "Authorization: Bearer ${REMNA_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{
    "uuid": "<settings-uuid>",
    "customResponseHeaders": {
      "profile-logo": "https://cdn.example.com/logo.png"
    }
  }'

Проверка

Выполните обычный GET с User-Agent Chumpy. Команда выводит заголовки, а тело подписки отбрасывает.

curl -fsSL -D - -o /dev/null \
  -A 'Chumpy/1.0 (Android) v2rayNG/1.10' \
  'https://sub.example.com/example-token' | grep -i '^profile-logo:'

Если сервер вернул profile-logo: https://…, обновите подписку в Chumpy и проверьте иконку на карточке.


This site uses Just the Docs, a documentation theme for Jekyll.