Перейти к содержимому

Своя сборка виджета

Если настроек не хватает, поисковый виджет можно доработать самим: поменять вёрстку, стили, поведение. Исходники мы даём по запросу. Вы собираете виджет со своими правками и размещаете файлы на своём сервере, а поиск, подсказки, настройки из кабинета и модули продолжают работать через SearchBooster.

Код SearchBooster на сайте не меняется. Он загружает main.js с настройками из кабинета, а main.js — ядро виджета init.js. Обычно init.js лежит на CDN SearchBooster. При своей сборке вы кладёте его на свой сервер и указываете адрес в кабинете.

Что Откуда загружается при своей сборке
main.js — код и настройки из кабинета CDN SearchBooster, как и раньше
init.js, стили, бандлы виджета ваш сервер
модули из кабинета (widgets-config.js: ИИ-консультант, кнопки «Похожие», «Свой код», обзор выдачи) CDN SearchBooster: https://cdn2.searchbooster.net
поиск, подсказки, рекомендации API SearchBooster

Напишите в поддержку из личного кабинета («Поддержка»), что хотите собирать виджет сами. Мы пришлём архив с исходниками текущей версии виджета. В архиве — код виджета, Dockerfile для сборки, README.md и LICENSE.

Исходники передаются по лицензионной оферте на исходный код виджета. Пользоваться ими можно только с SearchBooster, только на сайтах вашего проекта и только пока действует оплаченный тариф: в бесплатный период и после отключения сервиса — нельзя. Запрос исходников или начало работы с ними означает согласие с офертой.

Нужен Docker. Без Docker — Node.js 14.20 (как в .nvmrc) и Yarn 1: на более новых версиях Node сборка не проходит.

  1. Распакуйте архив и внесите правки. Код виджета — в src/: компоненты Vue в src/components/, темы в src/core/themes/, точка входа src/init/init.js.
  2. Соберите:
    Окно терминала
    docker build -t searchbooster-widget .
    docker run --rm -v "$PWD/dist:/app/dist" searchbooster-widget
    Без Docker:
    Окно терминала
    CYPRESS_INSTALL_BINARY=0 yarn install --frozen-lockfile
    yarn build:selfhost
  3. Результат — папка dist/selfhost/:
    • Директорияdist/selfhost/
      • init.js точка входа
      • Директория20261112-153012/ стили, бандлы и чанки этой сборки
        • searchbooster.min.js
        • base.css
        • …
    init.js загружает остальные файлы из папки версии рядом с собой. Имя папки — дата и время сборки.

Переменные сборки передаются через окружение (docker run -e ИМЯ=значение или перед yarn build:selfhost):

Переменная По умолчанию Зачем
SB_BUILD_VERSION дата и время сборки, 20261112-153012 Имя папки версии: латиница, цифры, ., -, _. Удобно подставить номер своего релиза или коммита, но имя должно быть новым при каждой сборке (см. «Размещение»).
SB_REMOTE_HOST https://cdn2.searchbooster.net Откуда брать модули из кабинета. Менять не нужно.

Скопируйте содержимое dist/selfhost/ в одну папку на сервере, например https://shop.ru/sb/. Должны открываться https://shop.ru/sb/init.js и файлы в https://shop.ru/sb/<версия>/.

Файлы Заголовок Cache-Control Почему
init.js no-cache или max-age=300 Меняется с каждой сборкой: после выкладки посетители должны получить новый.
<версия>/* public, max-age=31536000, immutable Не меняются: новая сборка ложится в новую папку.

Отдавайте .js с Content-Type: text/javascript, .css — с text/css. Если файлы лежат на другом домене или CDN, ничего дополнительно настраивать не нужно: виджет подключает их тегами <script> и <link>.

При выкладке новой версии сначала загрузите папку версии, потом замените init.js. Предыдущую папку не удаляйте хотя бы сутки: у посетителей с открытой страницей старый init.js ещё может догружать из неё файлы. Откатиться можно, вернув предыдущий init.js.

  1. В личном кабинете откройте Поисковый виджет → Дополнительные опции и впишите в поле Скрипт URL полный адрес своего init.js, например https://shop.ru/sb/init.js.
  2. Опубликуйте виджет. Новый main.js появится на сайте в течение нескольких минут.
  3. Проверьте: во вкладке Network браузера init.js и файлы папки версии загружаются с вашего сервера, widgets-config.js — с cdn2.searchbooster.net, все с кодом 200. В консоли window.searchbooster.version отвечает, а поиск открывается.

Чтобы вернуться на виджет SearchBooster, очистите поле Скрипт URL и опубликуйте виджет заново.

Обновления своей сборки вы делаете сами. Новую версию исходников мы присылаем по запросу тем же архивом. Перенести на неё свои правки проще, если исходники лежат в git:

  1. Первый архив закоммитьте отдельной веткой, например searchbooster, без своих правок. Свою работу ведите в другой ветке и время от времени вливайте в неё searchbooster.
  2. Получив новый архив, замените им содержимое ветки searchbooster и закоммитьте. Git покажет, что изменилось у нас.
  3. Влейте searchbooster в свою ветку, разрешите конфликты, соберите и проверьте на тестовом стенде.

Новые модули кабинета и настройки виджета могут требовать свежей версии init.js: если модуль включён в кабинете, но на сайте не появляется, обновите исходники.

API поиска, подсказок и рекомендаций, настройки из кабинета и модули работают со своей сборкой так же, как с нашей. За код, изменённый на вашей стороне, мы не отвечаем. Если что-то сломалось, сначала очистите поле Скрипт URL и проверьте на виджете SearchBooster: если там всё работает, причина в вашей сборке.