summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-05-19 13:26:47 +0200
committerSébastien Helleu <flashcode@flashtux.org>2024-05-19 13:26:47 +0200
commit54f2c7f2e00b8f9015e1d74aa7ccf70797c03310 (patch)
tree698806668fdab91f44ce50f7a15a25bfb6d13aa6
parent44ca4b41f393a14bff15b7adde7baa134325ff47 (diff)
downloadweechat-54f2c7f2e00b8f9015e1d74aa7ccf70797c03310.zip
doc/user: add relay "api" (issue #2066)
-rw-r--r--doc/de/weechat_user.de.adoc73
-rw-r--r--doc/en/weechat_user.en.adoc58
-rw-r--r--doc/fr/weechat_user.fr.adoc61
-rw-r--r--doc/it/weechat_user.it.adoc63
-rw-r--r--doc/ja/weechat_user.ja.adoc69
-rw-r--r--doc/pl/weechat_user.pl.adoc72
-rw-r--r--doc/sr/weechat_user.sr.adoc72
7 files changed, 402 insertions, 66 deletions
diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index fdc1ca1c7..5c71c2b4b 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -35,7 +35,8 @@ wesentliche Merkmale:
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^],
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] und
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]
-* IRC proxy und relay für remote Schnittstellen
+// TRANSLATION MISSING
+* IRC proxy and relay for WeeChat and remote interfaces
* Betriebssystemunabhängig (GNU/Linux, *BSD, macOS, Windows und weitere)
* 100% GPL, freie Software
@@ -132,8 +133,10 @@ Die folgende Tabelle zeigt eine Auflistung der Pakete, die zum Erstellen von Wee
Relay-Erweiterung: Untersützung von TLS Verbindungen.
| zlib1g-dev |
+// TRANSLATION MISSING
| Logger-Erweitertung: Kompression von rotierenden Protokolldateien (gzip). +
- Relay-Erweiterung: Kompression von Nachrichten (WeeChat -> client) with https://zlib.net/[zlib ^↗^^] (weechat protocol). +
+ Relay-Erweiterung: Kompression von Nachrichten (WeeChat -> client) with https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Script-Erweiterung: Lesen der Repository-Indexdatei (gzip).
|===
@@ -163,8 +166,10 @@ WeeChat optional sind:
| Relay-Erweiterung: Protokoll "api" (HTTP REST API).
| libzstd-dev | ≥ 0.8.1
+// TRANLSATION MISSING
| Logger-Erweiterung: Kompression von rotierenden Protokolldateien (zstandard). +
- Relay-Erweiterung: Kompression von Nachrichten (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol).
+ Relay-Erweiterung: Kompression von Nachrichten (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| Spell Erweiterung.
@@ -4606,8 +4611,16 @@ Die Relay-Erweiterung wird genutzt um Daten, mittels unterschiedlicher Protokoll
* _irc_: IRC Proxy: um mittels einem oder mehreren IRC-Clients eine Verbindung zu
IRC Servern zu unterhalten.
-* _weechat_: Protokoll, das von Remote-Schnittstellen zur Anzeige und Interaktion verwendet wird
- WeeChat, siehe https://weechat.org/about/interfaces/[this page ^↗^^].
+// TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
+// TRANSLATION MISSING
+* _weechat_: protocol used by remote interfaces to display and interact with
+ WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
[[relay_password]]
=== Passwort
@@ -4619,14 +4632,15 @@ Es wird dringend empfohlen, mit diesen Befehlen ein Passwort für das Relay fest
/set relay.network.password "${sec.data.relay}"
----
-Dieses Passwort wird sowohl für das _irc_ als auch für das _weechat_ Protokoll
-verwendet.
+// TRANSLATION MISSING
+This password is used with all protocols.
[[relay_totp]]
=== TOTP
-TOTP (Time-based One-Time Passwort) ist eine Zwei-Faktor-Authentifizierung
-für das _weechat_ Protokoll, als Ergänzung zum eigentlichen Passwort.
+// TRANSLATION MISSING
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _api_ and _weechat_ protocols, in addition to the password.
Diese Funktion is optional und erhöht den Sicherheitsgrad.
@@ -4723,6 +4737,40 @@ folgenden Befehlen einrichten:
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== WeeChat Protokoll
@@ -4763,7 +4811,10 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
----
Der Port (im Beispiel: 9000) ist der Port der in der Relay Erweiterung angegeben wurde.
-Die URI muss immer auf "/weechat" enden (_irc_ und _weechat_ Protokoll).
+
+// TRANSLATION MISSING
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
[[relay_unix_socket]]
=== UNIX Domain Sockets
@@ -4808,7 +4859,7 @@ Sektionen in Datei _relay.conf_:
| network | /set relay.network.* | Netzwerkoptionen.
| irc | /set relay.irc.* | für das IRC Protokoll spezifische Optionen (IRC Proxy).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Ports zur Nutzung der Relay-Erweiterung (IRC und weechat Protokolle) (Optionen können in Sektion hinzugefügt/entfernt werden).
+ /set relay.port.* | Ports zur Nutzung der Relay-Erweiterung (Optionen können in Sektion hinzugefügt/entfernt werden).
|===
Optionen:
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 42676946c..22aeee1b2 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -30,7 +30,7 @@ Main features are:
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^],
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] and
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]
-* IRC proxy and relay for remote interfaces
+* IRC proxy and relay for WeeChat and remote interfaces
* multi-platform (GNU/Linux, *BSD, macOS, Windows and other)
* 100% GPL, free software
@@ -128,7 +128,8 @@ WeeChat:
| zlib1g-dev |
| Logger plugin: compression of rotated log files (gzip). +
- Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^] (weechat protocol). +
+ Relay plugin: compression of messages with https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Script plugin: read of repository index file (gzip).
|===
@@ -159,7 +160,8 @@ WeeChat:
| libzstd-dev | ≥ 0.8.1
| Logger plugin: compression of rotated log files (zstandard). +
- Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol).
+ Relay plugin: compression of messages with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| Spell plugin.
@@ -4527,8 +4529,13 @@ The Relay plugin is used to relay data via network, using different protocols:
* _irc_: IRC proxy: used to share connections to IRC servers with one or many
other IRC clients
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
* _weechat_: protocol used by remote interfaces to display and interact with
- WeeChat, see https://weechat.org/about/interfaces/[this page ^↗^^].
+ WeeChat.
+
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
[[relay_password]]
=== Password
@@ -4540,13 +4547,13 @@ It is highly recommended to set a password for relay, with these commands:
/set relay.network.password "${sec.data.relay}"
----
-This password is used for _irc_ and _weechat_ protocols.
+This password is used with all protocols.
[[relay_totp]]
=== TOTP
TOTP (Time-based One-Time Password) can be used as secondary authentication
-factor for _weechat_ protocol, in addition to the password.
+factor for _api_ and _weechat_ protocols, in addition to the password.
This is optional and increases the security level.
@@ -4638,6 +4645,39 @@ commands:
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== WeeChat protocol
@@ -4677,7 +4717,9 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
----
The port (9000 in example) is the port defined in Relay plugin.
-The URI must always end with "/weechat" (for _irc_ and _weechat_ protocols).
+
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
[[relay_unix_socket]]
=== UNIX domain sockets
@@ -4720,7 +4762,7 @@ Sections in file _relay.conf_:
| network | /set relay.network.* | Network options.
| irc | /set relay.irc.* | Options specific to irc protocol (irc proxy).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Ports used for relay (irc and weechat protocols) (options can be added/removed in section).
+ /set relay.port.* | Ports used for relay (options can be added/removed in section).
|===
Options:
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index aa4500c9e..d25b6d506 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -32,7 +32,7 @@ Ses principales fonctionnalités sont les suivantes :
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^],
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] et
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]
-* proxy IRC et relai pour interfaces distantes
+* proxy IRC et relai pour WeeChat et interfaces distantes
* multi plates-formes (GNU/Linux, *BSD, macOS, Windows et d'autres systèmes)
* 100% GPL, logiciel libre
@@ -128,7 +128,8 @@ Le tableau suivant liste les paquets *requis* pour construire WeeChat :
| zlib1g-dev |
| Extension Logger : compression des fichiers de log qui tournent (gzip). +
- Extention Relay : compression des messages (WeeChat -> client) avec https://zlib.net/[zlib ^↗^^] (protocole weechat). +
+ Extention Relay : compression des messages (WeeChat -> client) avec https://zlib.net/[zlib ^↗^^]
+ (protocoles api et weechat). +
Extension Script : lecture du fichier d'index du dépôt (gzip).
|===
@@ -158,7 +159,8 @@ Le tableau suivant liste les paquets optionnels pour compiler WeeChat :
| libzstd-dev | ≥ 0.8.1
| Extension Logger : compression des fichiers de log qui tournent (zstandard). +
- Extension Relay : compression des messages (WeeChat -> client) avec https://facebook.github.io/zstd/[Zstandard ^↗^^] (protocole weechat).
+ Extension Relay : compression des messages (WeeChat -> client) avec https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (protocoles api et weechat).
| libaspell-dev / libenchant-dev |
| Extension spell.
@@ -4658,8 +4660,13 @@ utilisant divers protocoles :
* _irc_ : proxy IRC : utilisé pour partager la connexions aux serveurs IRC avec
un ou plusieurs autres clients IRC
+* _api_ : API REST HTTP, utilisée par WeeChat et les interfaces distantes pour
+ afficher et interagir avec WeeChat
* _weechat_ : protocole utilisé par les interfaces distantes pour afficher et
- interagir avec WeeChat, voir https://weechat.org/about/interfaces/[cette page ^↗^^].
+ interagir avec WeeChat.
+
+Pour les protocoles _api_ et _weechat_, voir la liste des interfaces distantes
+sur https://weechat.org/about/interfaces/[cette page ^↗^^].
[[relay_password]]
=== Mot de passe
@@ -4672,14 +4679,14 @@ commandes :
/set relay.network.password "${sec.data.relay}"
----
-Ce mot de passe sera utilisé pour les protocoles _irc_ et _weechat_.
+Ce mot de passe est utilisé avec tous les protocoles.
[[relay_totp]]
=== TOTP
TOTP (« Time-based One-Time Password » : mot de passe à usage unique basé sur le
-temps) peut être utilisé comme second facteur d'authentification pour le protocole
-_weechat_, en plus du mot de passe.
+temps) peut être utilisé comme second facteur d'authentification pour les
+protocoles _api_ et _weechat_, en plus du mot de passe.
Il est optionnel et augmente le niveau de sécurité.
@@ -4776,6 +4783,39 @@ avec ces commandes :
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+[[relay_api_protocol]]
+=== API protocol
+
+L'extension Relay peut envoyer les données à un autre WeeChat ou une interface
+distante avec un protocol HTTP de type API REST.
+
+Vous pouvez parcourir et tester l'API en ligne :
+https://weechat.org/api/[API Relay WeeChat ^↗^^].
+
+Vous pouvez vous connecter avec WeeChat ou une interface distante, voir
+https://weechat.org/about/interfaces/[cette page ^↗^^].
+
+Par exemple :
+
+----
+/relay add api 9000
+----
+
+Maintenant vous pouvez vous connecter sur le port 9000 avec une interface
+distante en utilisant le mot de passe "motdepasse".
+
+Pour vous connecter à un relai _api_ avec WeeChat :
+
+----
+/remote add weechat http://localhost:9000 -password=motdepasse
+/remote connect weechat
+----
+
+[NOTE]
+Le WeeChat distant doit exposer exactement la même version d'API que le WeeChat
+local, il est donc fortement recommandé d'utiliser exactement la même version
+de WeeChat de chaque côté.
+
[[relay_weechat_protocol]]
=== Protocole WeeChat
@@ -4819,8 +4859,9 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
----
Le port (9000 dans l'exemple) est le port défini dans l'extension Relay.
-L'URI doit toujours se terminer par "/weechat" (pour les protocoles _irc_ et
-_weechat_).
+
+L'URI doit se terminer par "/weechat" pour les protocoles _irc_ et _weechat_ et
+"/api" pour le protocole _api_.
[[relay_unix_socket]]
=== UNIX domain sockets
@@ -4865,7 +4906,7 @@ Sections dans le fichier _relay.conf_ :
| network | /set relay.network.* | Options réseau.
| irc | /set relay.irc.* | Options spécifiques au protocole irc (proxy irc).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Ports utilisés pour le relai (protocoles irc et weechat) (les options peuvent être ajoutées/supprimées dans la section).
+ /set relay.port.* | Ports utilisés pour le relai (les options peuvent être ajoutées/supprimées dans la section).
|===
Options :
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index fecb213e1..484119ca6 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -40,7 +40,7 @@ Le principali caratteristiche:
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] e
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]
// TRANSLATION MISSING
-* IRC proxy and relay for remote interfaces
+* IRC proxy and relay for WeeChat and remote interfaces
* multi-piattaforma (GNU/Linux, *BSD, macOS, Windows ed altre)
* 100% GPL, software libero
@@ -157,7 +157,8 @@ WeeChat:
// TRANSLATION MISSING
| zlib1g-dev |
| Logger plugin: compression of rotated log files (gzip). +
- Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^] (weechat protocol). +
+ Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Script plugin: read of repository index file (gzip).
|===
@@ -195,7 +196,8 @@ WeeChat:
// TRANSLATION MISSING
| libzstd-dev | ≥ 0.8.1
| Logger plugin: compression of rotated log files (zstandard). +
- Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol).
+ Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| Plugin spell.
@@ -4903,8 +4905,15 @@ protocolli differenti:
* _irc_: proxy IRC: usato per condividere le connessioni ai server IRC con uno
o più client IRC
// TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
+// TRANSLATION MISSING
* _weechat_: protocol used by remote interfaces to display and interact with
- WeeChat, see https://weechat.org/about/interfaces/[this page ^↗^^].
+ WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
// TRANSLATION MISSING
[[relay_password]]
@@ -4917,14 +4926,16 @@ It is highly recommended to set a password for relay, with these commands:
/set relay.network.password "${sec.data.relay}"
----
-This password is used for _irc_ and _weechat_ protocols.
+// TRANSLATION MISSING
+This password is used with all protocols.
// TRANSLATION MISSING
[[relay_totp]]
=== TOTP
+// TRANSLATION MISSING
TOTP (Time-based One-Time Password) can be used as secondary authentication
-factor for _weechat_ protocol, in addition to the password.
+factor for _api_ and _weechat_ protocols, in addition to the password.
This is optional and increases the security level.
@@ -5019,6 +5030,40 @@ commands:
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== Protocollo WeeChat
@@ -5062,7 +5107,9 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
----
The port (9000 in example) is the port defined in Relay plugin.
-The URI must always end with "/weechat" (for _irc_ and _weechat_ protocols).
+
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
// TRANSLATION MISSING
[[relay_unix_socket]]
@@ -5108,7 +5155,7 @@ Sections in file _relay.conf_:
| network | /set relay.network.* | Network options.
| irc | /set relay.irc.* | Options specific to irc protocol (irc proxy).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Ports used for relay (irc and weechat protocols) (options can be added/removed in section).
+ /set relay.port.* | Ports used for relay (options can be added/removed in section).
|===
// TRANSLATION MISSING
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index 3aa0dd183..4720037e6 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -36,7 +36,8 @@ WeeChat (Wee Enhanced Environment for Chat)
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^]、
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^]、
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]。
-* リモートインターフェース用の IRC プロキシとリレー
+// TRANSLATION MISSING
+* IRC proxy and relay for WeeChat and remote interfaces
* マルチプラットフォーム (GNU/Linux、*BSD、macOS、Windows 等)
* 完全な GPL、フリーソフトウェア
@@ -144,7 +145,8 @@ WeeChat:
// TRANSLATION MISSING
| zlib1g-dev |
| Logger plugin: compression of rotated log files (gzip). +
- Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^] (weechat protocol). +
+ Relay plugin: compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Script plugin: read of repository index file (gzip).
|===
@@ -180,7 +182,8 @@ WeeChat:
// TRANSLATION MISSING
| libzstd-dev | ≥ 0.8.1
| Logger plugin: compression of rotated log files (zstandard). +
- Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat protocol).
+ Relay plugin: compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| spell プラグイン
@@ -4752,8 +4755,15 @@ Relay プラグインはネットワークを介して異なるプロトコル
* _irc_: IRC プロキシ: IRC サーバに対する接続を、単一または複数の IRC
クライアントで共有するために用います。
// TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
+// TRANSLATION MISSING
* _weechat_: protocol used by remote interfaces to display and interact with
- WeeChat, see https://weechat.org/about/interfaces/[this page ^↗^^].
+ WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
[[relay_password]]
=== パスワード
@@ -4766,13 +4776,15 @@ secure set relay mypassword
/set relay.network.password "${sec.data.relay}"
----
-このパスワードは _irc_ と _weechat_ プロトコルで利用されます。
+// TRANSLATION MISSING
+This password is used with all protocols.
[[relay_totp]]
=== TOTP
-_weechat_ プロトコルでは、パスワードに加えて、二要素認証の
-TOTP (時間ベースのワンタイムパスワード) を使うことが可能です。
+// TRANSLATION MISSING
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _api_ and _weechat_ protocols, in addition to the password.
これは任意設定項目であり、セキュリティレベルを向上させます。
@@ -4869,6 +4881,40 @@ commands:
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== WeeChat プロトコル
@@ -4908,8 +4954,11 @@ HTML5 を使えばたった 1 行の JavaScript で WebSocket をオープンす
websocket = new WebSocket("ws://server.com:9000/weechat");
----
-ポート番号 (例では 9000 番) は Relay プラグインで定義したものです。URI
-の最後には必ず "/weechat" をつけます (_irc_ と _weechat_ プロトコルの場合)。
+ポート番号 (例では 9000 番) は Relay プラグインで定義したものです。
+
+// TRANSLATION MISSING
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
[[relay_unix_socket]]
=== UNIX ドメインソケット
@@ -4952,7 +5001,7 @@ _relay.conf_ ファイル内のセクション:
| network | /set relay.network.* | ネットワークオプション
| irc | /set relay.irc.* | 特定の irc プロトコルのオプション (irc プロキシ)
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | リレーに使うポート(irc や weechat プロトコル) (オプションをセクションに追加/削除出来ます)
+ /set relay.port.* | リレーに使うポート (オプションをセクションに追加/削除出来ます)
|===
オプション:
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index a65aaf22f..9913df267 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -35,7 +35,8 @@ Główne cechy to:
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^],
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] i
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^]
-* proxy IRC i pośrednik dla zdalnych interfejsów
+// TRANSLATION MISSING
+* IRC proxy and relay for WeeChat and remote interfaces
* wielo-platformowy (GNU/Linux, *BSD, macOS, Windows i inne)
* 100% GPL, darmowe oprogramowanie
@@ -131,8 +132,10 @@ WeeChat:
Wtyczka relay: wsparcie dla połączeń TLS.
| zlib1g-dev |
+// TRANSLATION MISSING
| Wtyczka logger: kompresja rotowanych plików z logami (gzip). +
- Wtyczka relay: kompresja wiadomości (WeeChat -> klient) za pomocą https://zlib.net/[zlib ^↗^^] (protokół weechat). +
+ Wtyczka relay: kompresja wiadomości (WeeChat -> klient) za pomocą https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Wtyczka script: odczyt repozytorium ze skryptami (gzip).
|===
@@ -162,8 +165,10 @@ WeeChat:
| Wtyczka relay: protokół "api" (HTTP REST API).
| libzstd-dev | ≥ 0.8.1
+// TRANSLATION MISSING
| Wtyczka logger: kompresja rotowanych plików z logami (zstandard). +
- Wtyczka relay: kompresja wiadomości (WeeChat -> klient) za pomocą https://facebook.github.io/zstd/[Zstandard ^↗^^] (protokół weechat).
+ Wtyczka relay: kompresja wiadomości (WeeChat -> klient) za pomocą https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| Wtyczka spell.
@@ -4561,8 +4566,16 @@ protokołów:
* _irc_: pośrednik IRC: używany do dzielenia połączeń z serwerami IRC z jednym
lub wieloma klientami IRC
-* _weechat_: protokół używany przez zdalne interfejsy do wyświetlania i interakcji
- z WeeChat, zobacz https://weechat.org/about/interfaces/[tą stronę ^↗^^].
+// TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
+// TRANSLATION MISSING
+* _weechat_: protocol used by remote interfaces to display and interact with
+ WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
[[relay_password]]
=== Hasło
@@ -4574,13 +4587,15 @@ Zaleca się ustawenia hasła dla pośrednika za pomocą poniższych komend:
/set relay.network.password "${sec.data.relay}"
----
-Hasło to używane jest przez protokoły _irc_ i _weechat_.
+// TRANSLATION MISSING
+This password is used with all protocols.
[[relay_totp]]
=== TOTP
-TOTP (Time-based One-Time Password) może zostać użyte jako drugi stopień uwierzytelnienia
-dla protokołu _weechat_, poza normalnym hasłem.
+// TRANSLATION MISSING
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _api_ and _weechat_ protocols, in addition to the password.
Jest to opcjomalne ale podnosi to poziom bezpieczeństwa.
This is optional and increases the security level.
@@ -4674,6 +4689,40 @@ za pomocą tych komend:
/set irc.server.relay.password "{sec.data.relay_libera}"
----
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== Protokół WeeChat
@@ -4714,7 +4763,10 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
----
Port (9000 w przykładzie) to port zdefiniowany we wtyczce relay.
-Adres URL musi się zawsze kończyć "/weechat" (dla protokołów _irc_ i _weechat_).
+
+// TRANSLATION MISSING
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
[[relay_unix_socket]]
=== Sockety UNIXowe
@@ -4757,7 +4809,7 @@ Sekcje w pliku _relay.conf_:
| network | /set relay.network.* | Opcje sieci.
| irc | /set relay.irc.* | Opcje specyficzne dla protokołu irc (pośrednik irc).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Porty używane do przekazywania (protokoły irc i weechat) (opcje w tej sekcji mogą być dodawane/usuwane).
+ /set relay.port.* | Porty używane do przekazywania (opcje w tej sekcji mogą być dodawane/usuwane).
|===
Opcje:
diff --git a/doc/sr/weechat_user.sr.adoc b/doc/sr/weechat_user.sr.adoc
index 45b506189..db3069ca6 100644
--- a/doc/sr/weechat_user.sr.adoc
+++ b/doc/sr/weechat_user.sr.adoc
@@ -34,7 +34,8 @@ WeeChat (Wee Enhanced Environment for Chat) је бесплатни чет кл
https://datatracker.ietf.org/doc/html/rfc2812[2812 ^↗^^],
https://datatracker.ietf.org/doc/html/rfc2813[2813 ^↗^^] и
https://datatracker.ietf.org/doc/html/rfc7194[7194 ^↗^^],
-* IRC прокси и релеј за удаљене интерфејсе
+// TRANSLATION MISSING
+* IRC proxy and relay for WeeChat and remote interfaces
* подржавање различитих платформи (GNU/Linux, *BSD, macOS, Windows и остале)
* 100% GPL, слободан софтвер
@@ -126,8 +127,10 @@ WeeChat мора да се изгради са CMake.
Relay додатак: подршка за TLS везе.
| zlib1g-dev |
+// TRANSLATION MISSING
| Logger додатак: компресија ротирајућих лог фајлова (gzip). +
- Relay додатак: компресија порука (WeeChat -> клијент) са https://zlib.net/[zlib ^↗^^] (weechat протокол). +
+ Relay додатак: компресија порука (WeeChat -> клијент) са https://zlib.net/[zlib ^↗^^]
+ (api and weechat protocols). +
Script додатак: читање индекс фајла репозиторијума (gzip).
|===
@@ -155,8 +158,10 @@ WeeChat мора да се изгради са CMake.
| Relay додатак: протокол „api” (HTTP REST API).
| libzstd-dev | ≥ 0.8.1
+// TRANSLATION MISSING
| Logger додатак: компресија ротирајућих лог фајлова (zstandard). +
- Relay додатак: компресија порука (WeeChat -> клијент) са https://facebook.github.io/zstd/[Zstandard ^↗^^] (weechat протокол).
+ Relay додатак: компресија порука (WeeChat -> клијент) са https://facebook.github.io/zstd/[Zstandard ^↗^^]
+ (api and weechat protocols).
| libaspell-dev / libenchant-dev |
| Spell додатак.
@@ -4304,8 +4309,16 @@ include::{autogendir}/autogen_user_options.sr.adoc[tag=typing_options]
Релеј додатак се користи за релеј података преко мреже, употребом различитих протокола:
* _irc_: IRC прокси: користи се за дељење веза са IRC серверима са једним или више других клијената
-* _weechat_: протокол који користе удаљени интерфејси да прикажу и омогуће интеракцију са програмом
- WeeChat, погледајте https://weechat.org/about/interfaces/[ову страницу ^↗^^].
+// TRANSLATION MISSING
+* _api_: HTTP REST API, used by WeeChat and remote interfaces to display and
+ interact with WeeChat
+// TRANSLATION MISSING
+* _weechat_: protocol used by remote interfaces to display and interact with
+ WeeChat.
+
+// TRANSLATION MISSING
+For _api_ and _weechat_ protocols, see the list of remote interfaces on
+https://weechat.org/about/interfaces/[this page ^↗^^].
[[relay_password]]
=== Лозинка
@@ -4317,12 +4330,15 @@ include::{autogendir}/autogen_user_options.sr.adoc[tag=typing_options]
/set relay.network.password "${sec.data.relay}"
----
-Ова лозинка се користи и за _irc_ и за _weechat_ протокол.
+// TRANSLATION MISSING
+This password is used with all protocols.
[[relay_totp]]
=== TOTP
-TOTP (Time-based One-Time Password) може уз лозинку да се користи као секундарни фактор аутентификације за _weechat_ протокол.
+// TRANSLATION MISSING
+TOTP (Time-based One-Time Password) can be used as secondary authentication
+factor for _api_ and _weechat_ protocols, in addition to the password.
Ово није обавезно, мада повећава ниво безбедности.
@@ -4402,6 +4418,40 @@ PASS сервер:лозинка
/set irc.server.relay.password "${sec.data.relay_libera}"
----
+// TRANSLATION MISSING
+[[relay_api_protocol]]
+=== API protocol
+
+The Relay plugin can send data to a remote WeeChat or interface using an
+HTTP REST API protocol.
+
+You can browse and test the API online:
+https://weechat.org/api/[WeeChat Relay API ^↗^^].
+
+You can connect with WeeChat or a remote interface, see
+https://weechat.org/about/interfaces/[this page ^↗^^].
+
+For example:
+
+----
+/relay add api 9000
+----
+
+Now you can connect on port 9000 with a WeeChat or a remote interface using
+password "mypassword".
+
+To connect to an _api_ relay with WeeChat:
+
+----
+/remote add weechat http://localhost:9000 -password=mypassword
+/remote connect weechat
+----
+
+[NOTE]
+The remote WeeChat must expose the same API version as the local WeeChat, so
+it's highly recommended to use exactly the same WeeChat version on remote
+and local client.
+
[[relay_weechat_protocol]]
=== WeeChat протокол
@@ -4436,7 +4486,11 @@ https://weechat.org/about/interfaces/[ову страницу ^↗^^].
websocket = new WebSocket("ws://server.com:9000/weechat");
----
-Порт (9000 у примеру) је порт који је дефинисан у Релеј додатку. URI увек мора да се завршава са „/weechat” (и за _irc_ и за _weechat_ протокол).
+Порт (9000 у примеру) је порт који је дефинисан у Релеј додатку.
+
+// TRANSLATION MISSING
+The URI must end with "/weechat" for _irc_ and _weechat_ protocols and "/api"
+for _api_ protocol.
[[relay_unix_socket]]
=== UNIX доменски сокети
@@ -4475,7 +4529,7 @@ include::{autogendir}/autogen_user_commands.sr.adoc[tag=relay_commands]
| network | /set relay.network.* | Мрежне опције.
| irc | /set relay.irc.* | Опције специфичне за irc протокол (irc прокси).
| port | <<command_relay_relay,/relay add>> +
- /set relay.port.* | Портови који се користе за релеј (irc и weechat протоколи) (у одељку је могуће додавање/уклањање опција).
+ /set relay.port.* | Портови који се користе за релеј (у одељку је могуће додавање/уклањање опција).
|===
Опције: