UCS - коллекция мануалов

Практика - критерий истины...

Инструменты пользователя

Инструменты сайта


web:cjs:config

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Следующая версия
Предыдущая версия
web:cjs:config [2026/03/06 20:02] – создано Luciferusweb:cjs:config [2026/03/06 22:16] (текущий) – Luciferus
Строка 1: Строка 1:
-====== ConverseJS configuration =====+====== Конфигурирование ConverseJS =====
  
-The included minified JavaScript and CSS files can be used for demoing or testing, but you’ll want to configure Converse to suit your needs before you deploy it on your website.+Включенные минифицированные файлы JavaScript и CSS можно использовать для демонстрации или тестирования, но перед развертыванием на вашем веб-сайте вам потребуется настроить Converse в соответствии с вашими потребностями. Converse получает свои параметры конфигурации при вызове метода <wrap hi>initialize</wrap>. Скорее всего, вам потребуется настроить вызов метода <wrap hi>initialize</wrap> на вашей **HTML-странице**. Пример того, как это делается, смотрите внизу страницы ./index.html.
  
-Converse is passed its configuration settings when you call its initialize method.+Информацию обо всех доступных параметрах конфигурации см. в разделе «Параметры конфигурации» ниже. 
  
-You’ll most likely want to call the initialize method in your HTML page. For an example of how this is done, please see the bottom of the ./index.html page.+===== Параметры конфигурации ===== 
 +==== Источники медиа: ====
  
-Please refer to the Configuration settings section below for info on all the available configuration settings. +**<color #ffc90e>allowed_audio_domains</color>** - По умолчанию: <wrap hi>null</wrap>. \\ 
-Configuration settings +Если значение равно <wrap hi>false</wrap>, разрешены все домены. Укажите массив, чтобы задать белый список разрешенных доменов. Например: 
-allowed_audio_domains+    allowed_audio_domains: ['spotify.link', 'zaicev.net']
  
-    Default: null+**<color #ffc90e>allowed_image_domains</color>** - По умолчанию: <wrap hi>null</wrap> \\ 
 +Если значение равно <wrap hi>false</wrap>, разрешены все домены. Укажите массив, чтобы задать белый список разрешенных доменов. Например: 
 +    allowed_image_domains: ['imgur.com', 'imgbb.com']
  
-If falsy, all domains are allowed. Set it to an array to specify a whitelist of allowed domains. +**<color #ffc90e>allowed_video_domains</color>** - По умолчанию: <wrap hi>null</wrap> \\ 
-allowed_image_domains+Если значение равно <wrap hi>false</wrap>, разрешены все домены. Укажите массив, чтобы задать белый список разрешенных доменов. Например:  
 +    allowed_video_domains: ['imgur.com', 'youtube.com'] \\
  
-    Default: null+**<color #ff7f27>Примечание:</color>** если вы разрешаете все домены, то вышеперечисленные параметры можно не указывать в скрипте инициализации.
  
-If falsy, all domains are allowed. Set it to an array to specify a whitelist of allowed domains.+==== Аутентификация: ====
  
-E.g. ['imgur.com', 'imgbb.com'] +**<color #fff200>authentication</color>** - По умолчанию: <wrap hi>login</wrap>, доступные значения: <wrap hi>login</wrap>, <wrap hi>external</wrap>, <wrap hi>anonymous</wrap>, <wrap hi>prebind</wrap>. Например: 
-allowed_video_domains+<code> 
 +authentication: 'login' 
 +</code> 
 +Этот параметр определяет способ аутентификации, который будет использовать Converse: \\ 
 +**<color #ffc90e>login</color>** - по умолчанию используется вход в систему, что означает, что пользователь либо входит вручную, используя свое имя пользователя и пароль, либо автоматически, если используется параметр <wrap hi>auto_login</wrap> со значением <wrap hi>true</wrap>, а также значения **jid** и **password**. \\
  
-    Default: null+**<color #ffc90e>external</color>** - при таких настройках форма входа и кнопка отправки по-прежнему будут отображаться, но форма будет содержать только поле для ввода JID пользователя, а не пароля. Это связано с тем, что данная настройка предназначена для использования при применении SASL-EXTERNAL в качестве механизма аутентификации, в этом случае пароль обычно не требуется. Сертификат SASL-EXTERNAL обычно используется вместе с клиентскими сертификатами x509 для обеспечения входа в систему без пароля или двухфакторной аутентификации. Для получения более подробной информации по этому вопросу прочтите [[https://opkode.com/blog/strophe_converse_sasl_external/|эту запись в блоге]]. \\
  
-If falsy, all domains are allowed. Set it to an array to specify a whitelist of allowed domains. +**<color #ffc90e>anonymous</color>** - это позволяет использовать анонимный вход в систему, если XMPP-сервер его поддерживает. Этот параметр можно использовать вместе с auto_login для автоматического и анонимного входа пользователя в систему сразу после загрузки страницы. Домен сервера передается через параметр JID. \\
- +
-E.g. ['imgur.com'] +
-authentication +
- +
-    Default: login +
- +
-    Allowed values: login, external, anonymous, prebind +
- +
-This option states the way Converse will authenticate. +
-login +
- +
-The default means is login, which means that the user either logs in manually with their username and password, or automatically if used together with auto_login set to true and jid and password values. +
-external +
- +
-This setting will still show a login form and submit button, but the form will only contain an input for the user’s JID, not for the password. +
- +
-That’s because this setting is intended to be used when you are using SASL-EXTERNAL as authentication mechanism, in which case a password is usually not required. +
- +
-SASL-EXTERNAL is generally used together with x509 client certificates to enable passwordless login or 2-factor authentication. +
- +
-For more details on this, read this blog post. +
-anonymous +
- +
-This enables anonymous login if the XMPP server supports it. This option can be used together with auto_login to automatically and anonymously log a user in as soon as the page loads. +
- +
-The server’s domain is passed in via the jid setting. +
-prebind +
- +
-See also: Shared Sessions +
- +
-Use this option when you want to attach to an existing XMPP BOSH session. +
- +
-Usually a BOSH session is set up server-side in your web app. +
- +
-Attaching to an existing BOSH session that was set up server-side is useful when you want to maintain a persistent single session for your users instead of requiring them to log in manually. +
- +
-When a BOSH session is initially created, you’ll receive three tokens. A JID (jabber ID), SID (session ID) and RID (Request ID). +
- +
-Converse needs these tokens in order to attach to that same session. +
- +
-In addition to setting authentication to prebind, you’ll also need to set the prebind_url and bosh-service-url. +
- +
-Here’s an example of Converse being initialized with these options:+
  
 +**<color #ffc90e>prebind</color>** - смотрите также: [[https://conversejs.org/docs/html/session.html#session-support|Совместные сессии]] \\
 +Используйте эту опцию, если хотите подключиться к существующей сессии XMPP **BOSH**. Обычно сессия **BOSH** устанавливается на стороне сервера в вашем веб-приложении. Подключение к существующей сессии **BOSH**, созданной на стороне сервера, полезно, если вы хотите поддерживать единую постоянную сессию для ваших пользователей, вместо того чтобы требовать от них ручного входа в систему. 
 +При первоначальном создании сессии **BOSH** вы получите три токена: **JID** (идентификатор Jabber), **SID** (идентификатор сессии) и **RID** (идентификатор запроса). Для подключения к той же сессии Converse необходимы эти токены. Помимо установки аутентификации в режим **prebind**, вам также потребуется задать параметры **prebind_url** и **bosh-service-url**. \\
 +Вот пример инициализации Converse с этими параметрами:
 +<code>
 converse.initialize({ converse.initialize({
     bosh_service_url: 'https://bind.example.com',     bosh_service_url: 'https://bind.example.com',
Строка 78: Строка 48:
     allow_logout: false     allow_logout: false
 }); });
 +</code>
  
-allow_adhoc_commands +==== Cпециальные команды ====
- +
-    Default: true +
- +
-Allows privileged users to run XEP-0050 Ad-Hoc commands via the settings modal. +
-allow_bookmarks +
- +
-    Default: true +
- +
-Enables/disables chatroom bookmarks functionality. This setting is only applicable if the converse-bookmarks plugin is loaded. +
- +
-See also: allow_public_bookmarks +
-allow_contact_removal +
- +
-    Default: true+
  
-Allow the user to remove roster contacts by clicking on the delete icon (i.e. trashcan) next to a contact’s name in the roster. +**<color #ffc90e>allow_adhoc_commands</color>** - по умолчанию: <wrap hi>true</wrap>. Позволяет пользователям с привилегиями использовать команды XEP-0050 **Ad-Hoc** через модальное окно настроек. \\
-allow_contact_requests+
  
-    Default: true+**<color #ffc90e>allow_bookmarks</color>** - по умолчанию: <wrap hi>true</wrap>. Включает/отключает функцию закладок в чатах. Этот параметр применим только в том случае, если загружен плагин **converse-bookmarks**. Смотрите также: allow_public_bookmarks \\
  
-Allow users to add one another as contacts. If this is set to false, the Add a contact widget, Contact Requests and Pending Contacts roster sections will all not appear. Additionally, all incoming contact requests will be ignored. +**<color #ffc90e>allow_contact_removal</color>** - по умолчанию: <wrap hi>true</wrap>. Предоставление пользователю возможности удаления контактов из списка нажатием на значок удаления (например, корзину) рядом с именем контакта в списке. \\
-allow_dragresize+
  
-    Default: true+**<color #ffc90e>allow_contact_requests</color>** - по умолчанию: <wrap hi>true</wrap>. Разрешить пользователям добавлять друг друга в качестве контактов. Если этот параметр установлен в значение <wrap hi>false</wrap>, разделы «Добавить контакт», «Запросы на добавление контакта» и «Ожидающий список контактов» не будут отображаться. Кроме того, все входящие запросы на добавление контакта будут игнорироваться. \\
  
-Allow users to resize chats by dragging the edges. The min-height and min-width CSS properties set on a chatboxes (specifically on the .chatbox > .box-flyout element) will be honored, IF they are set in pixels. +**<color #ffc90e>allow_dragresize</color>** - по умолчанию: <wrap hi>true</wrap>. Предоставьте пользователям возможность изменять размер чатов, перетаскивая их края. Свойства CSS min-height и min-width, заданные для блоков чата (в частности, для элемента <wrap hi>.chatbox</wrap> **>** <wrap hi>.box-flyout</wrap>), будут учитываться, **ЕСЛИ** они заданы в пикселях. \\
-allow_logout+
  
-    Default: true+**<color #ffc90e>allow_logout</color>** - по умолчанию: <wrap hi>true</wrap>. Определяет, разрешено ли пользователю выходить из системы. Если установлено значение <wrap hi>false</wrap>, кнопка выхода отображаться не будет.
  
-Determines whether the user is allowed to log out. If set to false, there will be no logout button. 
 allow_message_corrections allow_message_corrections
  
web/cjs/config.1772827336.txt.gz · Последнее изменение: — Luciferus