Сесії, паролі, пересилання й режими сервера

Одна спільна сесія поєднує джерела, доки, оверлеї, сповіщення й сторінки API. Прапорці маршрутизації також мають збігатися.

Модель підключення

  1. Джерело захоплює чат або подію й публікує їх у сесію Social Stream.
  2. Док, оверлей Featured, Multi Alerts, Event Flow та інші сторінки приєднуються до тієї самої сесії.
  3. Якщо пароль встановлено, кожна сторінка, що приєднується, повинна використовувати той самий пароль.
  4. Якщо серверну маршрутизацію ввімкнено, активні сторінки повинні використовувати нові згенеровані URL з відповідними параметрами маршрутизації.
Source → same session ID + password + routing mode → Dock / overlay / API consumer

ID сесії та пароль

Відкрити Global settings and tools → Session Options , щоб переглянути поточний ID сесії та встановити необов’язковий пароль.

Session Options Social Stream Ninja з полем ID сесії, необов’язковим паролем і Hide your links
Використовуйте заповнювач у документації та знімках екрана. Ніколи не публікуйте справжній пароль сесії або приватне згенероване посилання.
ЗначенняПравило
ID сесіїЗалишайте його незмінним, якщо не плануєте замінити всі URL джерел, доків, оверлеїв та інтеграцій, які його використовують.
ПарольНеобов’язковий, але після встановлення має збігатися всюди. Копіюйте нові згенеровані посилання після його додавання або зміни.
Згенероване посиланняВважайте все посилання приватним, якщо воно містить пароль або інші конфіденційні параметри.

Віддавайте перевагу копіюванню згенерованих URL. Вони вже містять поточну сесію, пароль, версію сторінки й підтримувані параметри маршрутизації. Вручну відредаговані посилання часто спричиняють порожні сторінки.

Увімкнення резервного сервера для читання й відповідей

Використовуйте це, коли док або об’єднаний чат підключається, але повідомлення не надходять, або коли відповіді не працюють через блокування чи ненадійність звичайного однорангового шляху.

Два резервні елементи керування працюють парою: Надсилати повідомлення чату на сервер API (для зовнішніх слухачів) передає вхідний чат серверним шляхом, тоді як Dock sends its commands to Extension via server повертає відповіді й команди дока.

Швидкий спосіб

  1. Відкрийте або перезавантажте згенероване посилання дока.
  2. Надішліть вигадане тестове повідомлення із Social Stream Ninja.
  3. Якщо Увімкнення резервного сервера з’явиться сповіщення, виберіть його й підтвердьте. Social Stream Ninja разом умикає серверні шляхи вхідного чату та команд відповідей.
  4. Скопіюйте щойно згенеровані посилання дока й оверлеїв. Повторно відкрийте звичайні вікна браузера та замініть усі збережені URL браузерних джерел OBS.

Ручний спосіб у настільному застосунку

  1. Відкрийте настільний застосунок Social Stream. У правій «Джерела й налаштування» панелі розгорніть Загальні налаштування та інструменти.
  2. Розгорніть Механіка — підключення та інтеграції.
  3. Увімкніть Надсилати повідомлення чату на сервер API (для зовнішніх слухачів). Це шлях вхідного чату/читання.
  4. Увімкніть Dock sends its commands to Extension via server. Це шлях відповідей/керування.
  5. Скопіюйте й повторно відкрийте щойно згенеровані посилання. Старі відкриті сторінки й збережені URL OBS не оновлюються самостійно.
Елементи керування Mechanics Social Stream Ninja з Send chat messages to API server і Dock commands via server
Для звичайного резервного читання й відповідей увімкніть параметр вхідного чату та параметр команд дока. Інші серверні елементи керування — окремі функції.

Не вмикайте всі серверні параметри. Увімкнути дистанційне керування API, Enable Dock to use and publish via API serverта тимчасовий параметр додаткової доставки не потрібні для звичайного резервного читання й відповідей. Додаткова доставка може дублювати повідомлення.

Стандартний режим, пересилання та режими сервера API

КеруванняЩо змінюєКоли це використовувати
Стандартні посилання Звичайний транспорт peer/session Social Stream без доданого прапорця сервера. Більшість налаштувань на одному комп’ютері та звичайних конфігурацій OBS.
Увімкнути дистанційне керування розширенням через API Умикає керування розширенням через HTTP/WebSocket і обробку вхідних вебхуків. Зовнішні застосунки, керування Stream Deck/API або підтримувані вхідні вебхуки донатів.
Enable Dock to use and publish via API server Додає параметр сторінки server маршрутизацію, де вона підтримується. Процесу Dock/Featured потрібне дистанційне керування через сервер API замість звичайного шляху.
Send chat messages to API server Спрямовує захоплений чат на шлях слухача сервера API та додає server2 до підтримуваних згенерованих посилань. Доку потрібен резервний сервер для вхідного чату, або Python, Node чи інший зовнішній слухач WebSocket має отримувати чат.
Також надсилати чат маршруту API звичайним способом Тимчасова додаткова доставка обома шляхами. Лише під час навмисного переходу зі змішаними режимами; може дублювати повідомлення.
Команди дока через сервер Додає server3 де підтримується, щоб команди дока поверталися серверним шляхом. Однорангові підключення заблоковані або ненадійні, а командам від дока до розширення потрібен сервер.
Глобальні елементи керування Mechanics Social Stream Ninja для дистанційного API, публікації дока через сервер API, зовнішніх слухачів чату, додаткової доставки й команд дока через сервер
Поточні елементи керування маршрутизацією. Зміна параметра згенерованого посилання не переписує вже відкриту сторінку чи збережене браузерне джерело OBS.

Про проєкт localserver

Деякі сторінки приймають localserver та використовують локальну кінцеву точку WebSocket на ws://127.0.0.1:3000. Додайте localserverport=PORT , щоб вибрати інший порт від 1024 до 65535. Неприпустимі або пропущені значення безпечно повертаються до порту 3000. Зауважте, що нові встановлення настільного застосунку Social Stream натомість запускають локальний сервер на порту 3003 і додають localserverport=3003 у згенеровані посилання — тому, якщо ви вручну пишете URL для нового встановлення, додайте цей параметр самі. Додавайте ці параметри лише коли локальний сервер справді працює та конкретна сторінка їх підтримує.

Знімки екрана й покрокове налаштування розміщеного WebSocket або розширеного Local Server див. у Режими розміщеного WebSocket і локального сервера.

Параметри маршрутизації залежать від сторінки. server, server2, server3, localserver, і localserverport не мають універсальної поведінки на всіх оверлеях. Використовуйте згенерований URL конкретної сторінки замість копіювання прапорців з іншого інструмента.

Після зміни сесії або перемикача маршрутизації

  1. Скопіюйте щойно згенерований URL дока або оверлею.
  2. Закрийте й повторно відкрийте активні сторінки браузера, які використовують старий URL.
  3. Замініть URL у збережених браузерних джерелах OBS і оновіть їхній кеш.
  4. Перезавантажте або повторно активуйте сторінки джерел, якщо ID сесії або пароль змінився.
  5. Надішліть одне вигадане тестове повідомлення й переконайтеся, що воно надходить у док, перш ніж перевіряти кінцевий оверлей.

Контрольний список для порожнього дока або оверлею

  1. Порівняйте повне session= значення в джерелі, доку й оверлеї.
  2. Перевірте, чи в одному з URL не бракує поточного password=.
  3. Перевірте, чи не бракує старому URL OBS поточних прапорців серверної маршрутизації.
  4. Приберіть вручну додані прапорці маршрутизації та скопіюйте свіжий згенерований URL, якщо режими незрозумілі.
  5. Спочатку перевірте док. Якщо він отримує повідомлення, далі перевіряйте фільтри подій і параметри URL оверлею.
  6. Дивіться Усунення несправностей OBS і Довідник команд і API для глибших перевірок.