Documentation translation (#199)
Documentation translation using weblate. * Use po4a to generate .po files from the english markdowns, then to generate translated files * Some pages can be marked as «english only» (for technical documentation for example) * New Hugo shortcode to use application strings in documentation (for example for settings names) * The code of conduct is no more translated, but there is a link to official Contributor Covenant translations * Adding all plugin's supported languages Related to https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117
This commit is contained in:
John Livingston
GitHub
159
support/documentation/content/en/documentation/admin/settings.md
Normal file
159
support/documentation/content/en/documentation/admin/settings.md
Normal file
@ -0,0 +1,159 @@
|
||||
---
|
||||
title: "Settings"
|
||||
description: "Plugin Peertube Livechat settings"
|
||||
weight: 10
|
||||
chapter: false
|
||||
---
|
||||
|
||||
This section describes the plugin settings page.
|
||||
|
||||
## {{% livechat_label "list_rooms_label" %}}
|
||||
|
||||
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.
|
||||
|
||||
### {{% livechat_label federation_no_remote_chat_label %}}
|
||||
|
||||
{{% livechat_label federation_no_remote_chat_description %}}
|
||||
|
||||
### {{% livechat_label federation_dont_publish_remotely_label %}}
|
||||
|
||||
{{% livechat_label federation_dont_publish_remotely_description %}}
|
||||
|
||||
## Chat behaviour
|
||||
|
||||
### {{% livechat_label room_type_label %}}
|
||||
|
||||
{{% livechat_label room_type_description %}}
|
||||
|
||||
### {{% livechat_label auto_display_label %}}
|
||||
|
||||
{{% livechat_label auto_display_description %}}
|
||||
|
||||
### {{% livechat_label open_blank_label %}}
|
||||
|
||||
{{% livechat_label open_blank_description %}}
|
||||
|
||||
### {{% livechat_label share_url_label %}}
|
||||
|
||||
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 settings allows you to choose who can access this modal.
|
||||
|
||||
### {{% livechat_label per_live_video_label %}}
|
||||
|
||||
{{% livechat_label per_live_video_description %}}
|
||||
|
||||
The video owner will be able to activate web chats.
|
||||
|
||||
### {{% livechat_label all_lives_label %}}
|
||||
|
||||
{{% livechat_label all_lives_description %}}
|
||||
|
||||
### {{% livechat_label all_non_lives_label %}}
|
||||
|
||||
{{% livechat_label all_non_lives_label %}}
|
||||
|
||||
### {{% livechat_label videos_list_label %}}
|
||||
|
||||
{{% livechat_label videos_list_label %}}
|
||||
|
||||
### {{% livechat_label no_anonymous_label %}}
|
||||
|
||||
{{% livechat_label no_anonymous_description %}}
|
||||
|
||||
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](https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/CHANGELOG.md#570) for more information.
|
||||
|
||||
## Theming
|
||||
|
||||
### {{% livechat_label converse_theme_label %}}
|
||||
|
||||
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 concord theme: this is a theme provided by ConverseJS.
|
||||
|
||||
### {{% livechat_label autocolors_label %}}
|
||||
|
||||
{{% livechat_label autocolors_description %}}
|
||||
|
||||
### {{% livechat_label chat_style_label %}}
|
||||
|
||||
{{% livechat_label chat_style_description %}}
|
||||
|
||||
## Chat server advanced settings
|
||||
|
||||
### {{% livechat_label system_prosody_label %}}
|
||||
|
||||
The plugin comes with an AppImage that is used to run the [Prosody XMPP server](https://prosody.im).
|
||||
If this AppImage is not working, you can fallback to the Prosody that is packaged for your server. Just install the `prosody` package.
|
||||
|
||||
This settings should only be used if the plugin is broken, and waiting for a patch.
|
||||
|
||||
### {{% livechat_label disable_websocket_label %}}
|
||||
|
||||
{{% livechat_label disable_websocket_description %}}
|
||||
|
||||
### {{% livechat_label prosody_port_label %}}
|
||||
|
||||
{{% livechat_label prosody_port_description %}}
|
||||
|
||||
### {{% livechat_label prosody_peertube_uri_label %}}
|
||||
|
||||
{{% livechat_label prosody_peertube_uri_description %}}
|
||||
|
||||
### {{% livechat_label prosody_muc_log_by_default_label %}}
|
||||
|
||||
{{% livechat_label prosody_muc_log_by_default_description %}}
|
||||
|
||||
### {{% livechat_label prosody_muc_expiration_label %}}
|
||||
|
||||
{{% livechat_label prosody_muc_expiration_description %}}
|
||||
|
||||
### {{% livechat_label prosody_room_allow_s2s_label %}}
|
||||
|
||||
{{% livechat_label prosody_room_allow_s2s_description %}}
|
||||
|
||||
### {{% livechat_label prosody_s2s_port_label %}}
|
||||
|
||||
{{% livechat_label prosody_s2s_port_description %}}
|
||||
|
||||
### {{% livechat_label prosody_s2s_interfaces_label %}}
|
||||
|
||||
{{% livechat_label prosody_s2s_interfaces_description %}}
|
||||
|
||||
### {{% livechat_label prosody_certificates_dir_label %}}
|
||||
|
||||
{{% livechat_label prosody_certificates_dir_description %}}
|
||||
|
||||
### {{% livechat_label prosody_c2s_label %}}
|
||||
|
||||
{{% livechat_label prosody_c2s_description %}}
|
||||
|
||||
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.
|
||||
|
||||
#### {{% livechat_label prosody_c2s_port_label %}}
|
||||
|
||||
{{% livechat_label prosody_c2s_port_description %}}
|
||||
|
||||
### {{% livechat_label prosody_components_label %}}
|
||||
|
||||
This settings enable XMPP external components to connect to the server.
|
||||
For now, this option **only allows connections from localhost components**.
|
||||
|
||||
This feature could be used to connect bridges or bots.
|
||||
|
||||
More informations on Prosody external components [here](https://prosody.im/doc/components).
|
||||
Reference in New Issue
Block a user