Settings

This section describes the plugin settings page.

Channel’s chat terms & conditions

You can configure a “terms & conditions” message that will be shown to users joining your chatrooms.

For more information on this feature, check the documentation for channel’s terms & conditions.

列出現有聊天室

When pressing the «List rooms» button, all existing chatrooms will be listed. You can then find them and moderated them.

Federation

Following settings concern the federation with other Peertube instances, and other fediverse softwares.

不顯示遠端聊天

透過檢查此設置，您的實例將永遠不會顯示來自遠端視訊的聊天。

不公開聊天資訊

透過檢查此設置，您的實例將不會在 fediverse 上發布聊天訊息。 遠端 Peertube 實例不會意識到它們是與您的視訊關聯的聊天室。 請注意：如果您已經進行過聊天，則該資訊可能已經發布。 您必須等待下一次視訊更新，訊息才會取消發布。 此外，如果您停用此設置，則必須等待視訊更新後才能顯示資訊。 再次發布。當現場活動恢復或停止時，會發生此更新。 請注意：此設定僅影響透過 ActivityPub 協定發布資訊。 它不會阻止遠端應用程式檢測聊天的存在並嘗試連接到它。

Authentication

Disable livechat tokens

In case you have any trouble with the long term authentication tokens, you can disable the feature here.

External Authentication

See the detailed documentation page:

External Authentication

Channel advanced configuration

Following settings concern the advanced channel options: users will be able to add some customization on their channels, activate the moderation bot, …

停用進階頻道設定和聊天機器人

If you encounter any issue with this feature, you can disable it.

Chat behaviour

聊天室類型

您可以在此處選擇為每個影片設定單獨的聊天室，或按頻道對它們進行分組。

自動開啟聊天

觀看影片時，聊天視窗會自動開啟。

顯示“在新視窗中開啟”按鈕

此按鈕可在新視窗中開啟網路聊天。

顯示「共享聊天連結」按鈕

This feature enables a «share chat link» modal. With this modal, you can generate URLs to join the chat. The chat can be customized (readonly mode, use the current theme, …).

You can for example generate a readonly URL and use it in OBS to integrate the chat in your live stream!

This setting allows you to choose who can access this modal.

使用者在直播時可啟用聊天

If checked, all live videos will have a checkbox in their properties for enabling the web chat.

The video owner will be able to activate web chats.

所有直播啟動聊天室

若勾選，則所有直播都啟用聊天室。

Activate chat for all non-lives

Activate chat for all non-lives

Activate chat for these videos

Activate chat for these videos

隱藏匿名使用者的聊天

若勾選，匿名 Peertube 用戶將看不到聊天資訊。 此功能仍處於實驗階段。 如果您啟用了它，強烈建議您也勾選「不發布聊天訊息」。 否則，某些第三方工具可能會嘗試開啟聊天，並出現不可預測的行為。

Note: for now this feature simply hide the chat. In a future release, the chat will be replaced by a message saying «please log in to […]». See v5.7.0 Release Notes for more information.

當用戶被禁止進入聊天室時，禁止匿名用戶的 IP

透過啟用此選項，每次匿名用戶被禁止進入聊天室時，其 IP 也將被聊天伺服器禁止。 警告：如果您的執行個體開放註冊，任何使用者都可以建立陷阱房間、邀請使用者加入，並自動禁止所有匿名使用者的 IP。 禁止的IP清單不會被存儲，它會在伺服器重新啟動或更改某些外掛的設定時被清除。 被禁止的IP會記錄在Prosody伺服器日誌檔案中，因此伺服器管理員最終可以使用一些外部工具（如fail2ban）來更廣泛地禁止IP。

Important note: If you enable this feature, and are using a custom reverse proxy on front of Peertube, please make sure that your setup is correctly configured to forward real user’s IPs to Peertube. Otherwise it could block all anonymous users at once.

Theming

Avatar set

You can choose from several different sets the default avatars that will be used for chat users.

棕褐色（Peertube 吉祥物）: David Revoy’s Peertube avatar generator, CC-By license

Cats: David Revoy’s cat avatar generator, CC-By license

Birds: David Revoy’s bird avatar generator, CC-By license

Fenecs (Mobilizon mascot): David Revoy’s fenec/mobilizon avatar generator, CC-By license

Abstract: David Revoy’s Abstract avatar generator, CC-By license

Legacy Sepia avatars (those included in previous plugin versions): Based on David Revoy' work, AGPL-v3 license

If you can’t see the change immediatly, it could be because of your browser cache. Just clear your browser session storage, or restart it.

ConverseJS 主題

You can choose which theme to use for ConverseJS:

• Peertube theme: this is a special theme, made especially for peertube’s integration.
• Default ConverseJS theme: this is the default ConverseJS theme.
• ConverseJS cyberpunk theme: this is a theme provided by ConverseJS.

自動色彩檢測

嘗試自動偵測使用者目前主題的顏色。 啟用此設定後，外掛程式會嘗試自動偵測顏色以套用至聊天主題。 如果這對於您的某些 Peertube 主題無法正常運作，您可以停用此選項。 您可以向官方報告該錯誤 問題追蹤器 。不要忘記指定哪個主題不起作用。

聊天 iframe 風格屬性

Additional styles to be added on the iframe style attribute.
Example: height:400px;

Chat server advanced settings

Use system Prosody

The plugin comes with an AppImage that is used to run the Prosody XMPP server. If this AppImage is not working, you can fallback to the Prosody that is packaged for your server. Just install the prosody package.

This setting should only be used if the plugin is broken, and waiting for a patch.

停用 Websocket

當 Peertube >= 5.0.0 時，外掛嘗試使用 Websocket 連線進行聊天。 如果使用者的瀏覽器或連線不相容，瀏覽器將自動轉而使用 BOSH 協定。
但在極少數情況下，這可能會失敗。例如，如果您在 Peertube 前面有一個反向代理，但它不 允許外掛的 Websocket 連線。 在這種情況下，您可以檢查此設定以停用 Websocket 連線。

Prosody port

The port that will be used by the Prosody server.
Change it if this port is already in use on your server.
You can close this port on your firewall, it will not be accessed from the outer world.
Note: this might change in a near future, as it is planned to add a feature to activate external connections.

Peertube API呼叫網址

Please let this setting empty if you don’t know what you are doing.
In some rare cases, Prosody can’t call Peertube’s API from its public URI. You can use this field to customize Peertube’s URI for Prosody modules (for example, with «http://localhost:9000» or «http://127.0.0.1:9000»).

If this setting is left empty, and you are using Peertube >= 5.1 or later, the plugin will use values from your Peertube configuration file to guess on which interface and port request have to be done.

In last resort, it will use your Peertube public URI. So, any API Call will go throught your Nginx server. This could fail in some case: for example if you are in a Docker container, where the public hostname does not resolve to the correct IP. In such case, try changing the “Peertube API呼叫網址” settings, by setting http://127.0.0.1:9000 (assuming 9000 is the port on which Peertube listen, ask your instance administrators if you don’t know).

Log rooms content by default

If checked, room contents will be saved by default. Any user who joins a room will see what was written before they joins.
Please note that it is always possible to enable/disable the content archiving for a specific room, by editing its properties.

Room logs expiration

You can choose here how long the chatting room’s content is kept by the server. The value can be:

• 60: the content will be saved for 60 seconds. You can replace 60 by any integer value.
• 1d: the content will be saved for 1 day. You can replace 1 by any integer value.
• 1w: the content will be saved for 1 week. You can replace 1 by any integer value.
• 1m: the content will be saved for 1 month. You can replace 1 by any integer value.
• 1y: the content will be saved for 1 year. You can replace 1 by any integer value.
• never: the content will never expire, and will be kept forever.

Enable connection to room using external XMPP accounts

By enabling this option, it will be possible to connect to rooms using external XMPP accounts and XMPP clients.
Warning, enabling this option can request extra server and DNS configuration. Please refer to the documentation: Enable external XMPP account connections.

Prosody server to server port

The port that will be used for XMPP s2s (server to server) connections.
You should use the standard 5269 port. Otherwise you should setup a specific DNS record .

Server to server network interfaces

The network interfaces to listen on for server to server connections.
List of IP to listen on, coma separated (spaces will be stripped).
You can use «*» to listen on all IPv4 interfaces, and «::» for all IPv6.
Examples:

• *, ::
• *
• 127.0.0.1, ::1
• 172.18.0.42

Certificates folder

If this field is empty, the plugin will generate and use self-signed certificates.
If you want to use other certificates, just specify here the folder where Prosody can find them. Note: the “peertube” user must have read access to this folder.

Enable client to server connections

Enable XMPP clients to connect to the built-in Prosody server.
This option alone only allows connections from localhost clients.

This setting enable XMPP clients to connect to the built-in Prosody server. For now, this option only allows connections from localhost clients.

As example, this option can allow an instance of Matterbridge (once it could use anonymous login) on the same machine to bridge your chat with another services like a Matrix room.

Prosody client to server port

The port that will be used by the c2s module of the built-in Prosody server.
XMPP clients shall use this port to connect.
Change it if this port is already in use on your server.
You can keep this port closed on your firewall for now, it will not be accessed from the outer world.
Note: this might change in a near future, as it is planned to add a feature to activate external connections.

Client to server network interfaces

The network interfaces to listen on for client to server connections.
This setting is provided for advanced users. Don’t change this setting if you don’t fully understand what it means.
List of IP to listen on, coma separated (spaces will be stripped).
You can use «*» to listen on all IPv4 interfaces, and «::» for all IPv6.
Examples:

• *, ::
• *
• 127.0.0.1, ::1
• 127.0.0.1, ::1, 172.18.0.42

Enable custom Prosody external components

This setting enable XMPP external components to connect to the server. By default, this option only allows connections from localhost components. You have to change the “Prosody external components network interfaces” value to listen on other network interfaces.

This feature could be used to connect bridges or bots.

More informations on Prosody external components here.

Enable custom Prosody external components

Enable the use of external XMPP components.
This option alone only allows connections from localhost. You have to setup the listening interfaces and open the port on your firewall to make it available from remote servers.
This feature can, for example, be used to connect some bots to the chatting rooms.

Prosody external components port

The port that will be used by XMPP components to connect to the Prosody server.
Change it if this port is already in use on your server.
You can keep this port closed on your firewall if you don’t allow access on interfaces other than localhost.

Prosody external components network interfaces

The network interfaces to listen on for external components connections.
List of IP to listen on, coma separated (spaces will be stripped).
You can use «*» to listen on all IPv4 interfaces, and «::» for all IPv6.
Examples:

• *, ::
• *
• 127.0.0.1, ::1
• 172.18.0.42

External components

The external components to declare:

• One per line.
• Use the format «component_name:component_secret» (spaces will be trimmed).
• You can add comments: everything after the # character will be stripped off, and empty lines ignored.
• The name can only contain latin alphanumeric characters and dots.
• If the name contains only alphanumeric characters, it will be suffixed with the XMPP domain. For example, «bridge» will become «bridge.your_domain.tld». You can also specify a full domain name, but you have to make sure to configure your DNS correctly.
• Only use alphanumeric characters in the secret passphrase (use at least 15 characters).

Enable Prosody mod_firewall

You can enable mod_firewall on your Prosody server.

For more information, please check the documentation.