summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2013-02-10 20:22:13 +0100
committerSebastien Helleu <flashcode@flashtux.org>2013-02-10 20:22:13 +0100
commitc2aeb69c46a8f0222aed935afc46e0b27cbc94a0 (patch)
treed217e5bfc2dbfe7e0d50dbcd7a0b24b032681441 /doc
parenteb11921f1633db940df4b0c02a43df1360d39b96 (diff)
downloadweechat-c2aeb69c46a8f0222aed935afc46e0b27cbc94a0.zip
relay: add experimental websocket server support (RFC 6455) for irc and weechat protocols, new option relay.network.websocket_allowed_origins
It is a partial implementation of RFC 6455: fragmentation and control frames are not yet supported. Text and binary frames are supported.
Diffstat (limited to 'doc')
-rw-r--r--doc/de/autogen/user/relay_options.txt5
-rw-r--r--doc/de/weechat_user.de.txt23
-rw-r--r--doc/en/autogen/user/relay_options.txt5
-rw-r--r--doc/en/weechat_dev.en.txt1
-rw-r--r--doc/en/weechat_user.en.txt22
-rw-r--r--doc/fr/autogen/user/relay_options.txt5
-rw-r--r--doc/fr/weechat_user.fr.txt24
-rw-r--r--doc/it/autogen/user/relay_options.txt5
-rw-r--r--doc/it/weechat_user.it.txt23
-rw-r--r--doc/ja/autogen/user/relay_options.txt5
-rw-r--r--doc/ja/weechat_user.ja.txt23
11 files changed, 141 insertions, 0 deletions
diff --git a/doc/de/autogen/user/relay_options.txt b/doc/de/autogen/user/relay_options.txt
index 16c463408..1dc1c6ff5 100644
--- a/doc/de/autogen/user/relay_options.txt
+++ b/doc/de/autogen/user/relay_options.txt
@@ -113,3 +113,8 @@
** Typ: Zeichenkette
** Werte: beliebige Zeichenkette (Standardwert: `"%h/ssl/relay.pem"`)
+* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
+** Beschreibung: `regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
+** Typ: Zeichenkette
+** Werte: beliebige Zeichenkette (Standardwert: `""`)
+
diff --git a/doc/de/weechat_user.de.txt b/doc/de/weechat_user.de.txt
index 9ed7dd7cd..42d830e64 100644
--- a/doc/de/weechat_user.de.txt
+++ b/doc/de/weechat_user.de.txt
@@ -2403,6 +2403,29 @@ um dann die Relay-Verbindung, mit SSL Verschlüsselung, anzulegen:
/relay add ssl.weechat 9001
----------------------------------------
+// TRANSLATION MISSING
+[[relay_websocket]]
+Websocket
+^^^^^^^^^
+
+WebSocket protocol (http://tools.ietf.org/html/rfc6455[RFC 6455]) is supported
+in Relay plugin for all protocols.
+
+The WebSocket handshake is automatically detected and socket becomes ready for
+WebSocket if required headers are found in handshake and if origin is allowed
+(see option
+<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).
+
+A WebSocket can be opened in a HTML5 with a single line of JavaScript:
+
+[source,js]
+----------------------------------------
+websocket = new WebSocket("ws://server.com:5000/weechat");
+----------------------------------------
+
+The port (5000 in example) is the port defined in Relay plugin.
+The URI must always ends with "/weechat" (for both IRC and WeeChat protocols).
+
[[rmodifier_plugin]]
Rmodifier Erweiterung
~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/en/autogen/user/relay_options.txt b/doc/en/autogen/user/relay_options.txt
index 1e58aa784..8e0253657 100644
--- a/doc/en/autogen/user/relay_options.txt
+++ b/doc/en/autogen/user/relay_options.txt
@@ -113,3 +113,8 @@
** type: string
** values: any string (default value: `"%h/ssl/relay.pem"`)
+* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
+** description: `regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
+** type: string
+** values: any string (default value: `""`)
+
diff --git a/doc/en/weechat_dev.en.txt b/doc/en/weechat_dev.en.txt
index 7b3c9a414..2f8391bc7 100644
--- a/doc/en/weechat_dev.en.txt
+++ b/doc/en/weechat_dev.en.txt
@@ -246,6 +246,7 @@ Plugins
| relay-raw.c | Relay raw buffer
| relay-server.c | Relay server
| relay-upgrade.c | Save/restore relay data when upgrading WeeChat
+| relay-websocket.c | Websocket server functions for relay (RFC 6455)
| irc/ | IRC proxy
| relay-irc.c | Main IRC proxy functions
| weechat/ | Relay for remote interface
diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt
index fed6d0d2a..a87df0a10 100644
--- a/doc/en/weechat_user.en.txt
+++ b/doc/en/weechat_user.en.txt
@@ -2354,6 +2354,28 @@ And then add relay with SSL, for example:
/relay add ssl.weechat 9001
----------------------------------------
+[[relay_websocket]]
+Websocket
+^^^^^^^^^
+
+WebSocket protocol (http://tools.ietf.org/html/rfc6455[RFC 6455]) is supported
+in Relay plugin for all protocols.
+
+The WebSocket handshake is automatically detected and socket becomes ready for
+WebSocket if required headers are found in handshake and if origin is allowed
+(see option
+<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).
+
+A WebSocket can be opened in a HTML5 with a single line of JavaScript:
+
+[source,js]
+----------------------------------------
+websocket = new WebSocket("ws://server.com:5000/weechat");
+----------------------------------------
+
+The port (5000 in example) is the port defined in Relay plugin.
+The URI must always ends with "/weechat" (for both IRC and WeeChat protocols).
+
[[rmodifier_plugin]]
Rmodifier plugin
~~~~~~~~~~~~~~~~
diff --git a/doc/fr/autogen/user/relay_options.txt b/doc/fr/autogen/user/relay_options.txt
index 052bcd92e..aa6eca9ef 100644
--- a/doc/fr/autogen/user/relay_options.txt
+++ b/doc/fr/autogen/user/relay_options.txt
@@ -113,3 +113,8 @@
** type: chaîne
** valeurs: toute chaîne (valeur par défaut: `"%h/ssl/relay.pem"`)
+* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
+** description: `expression régulière avec les origines autorisées dans les websockets (insensible à la casse, utilisez "(?-i)" en début de chaîne pour la rendre insensible à la casse), exemple: "^http://(www\.)?example\.(com|org)"`
+** type: chaîne
+** valeurs: toute chaîne (valeur par défaut: `""`)
+
diff --git a/doc/fr/weechat_user.fr.txt b/doc/fr/weechat_user.fr.txt
index 7afa2f737..dec97b923 100644
--- a/doc/fr/weechat_user.fr.txt
+++ b/doc/fr/weechat_user.fr.txt
@@ -2428,6 +2428,30 @@ Et ajoutez le relai avec SSL, par exemple :
/relay add ssl.weechat 9001
----------------------------------------
+[[relay_websocket]]
+Websocket
+^^^^^^^^^
+
+Le protocole WebSocket (http://tools.ietf.org/html/rfc6455[RFC 6455]) est
+supporté dans l'extension Relay pour tous les protocoles.
+
+La poignée de main ("handshake") WebSocket est automatiquement détectée et le
+socket devient prêt pour WebSocket si les en-tête requis sont trouvés dans la
+poignée de main et si l'origine est autorisée (voir l'option
+<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).
+
+Un WebSocket peut être ouvert dans une page HTML5 avec une seule ligne de
+JavaScript :
+
+[source,js]
+----------------------------------------
+websocket = new WebSocket("ws://server.com:5000/weechat");
+----------------------------------------
+
+Le port (5000 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).
+
[[rmodifier_plugin]]
Extension Rmodifier
~~~~~~~~~~~~~~~~~~~
diff --git a/doc/it/autogen/user/relay_options.txt b/doc/it/autogen/user/relay_options.txt
index 6445f4d8e..fdd5d0437 100644
--- a/doc/it/autogen/user/relay_options.txt
+++ b/doc/it/autogen/user/relay_options.txt
@@ -113,3 +113,8 @@
** tipo: stringa
** valori: qualsiasi stringa (valore predefinito: `"%h/ssl/relay.pem"`)
+* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
+** descrizione: `regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
+** tipo: stringa
+** valori: qualsiasi stringa (valore predefinito: `""`)
+
diff --git a/doc/it/weechat_user.it.txt b/doc/it/weechat_user.it.txt
index 7d4721c7c..5ef4a8873 100644
--- a/doc/it/weechat_user.it.txt
+++ b/doc/it/weechat_user.it.txt
@@ -2416,6 +2416,29 @@ E poi aggiungere il relay con SSL, ad esempio:
/relay add ssl.weechat 9001
----------------------------------------
+// TRANSLATION MISSING
+[[relay_websocket]]
+Websocket
+^^^^^^^^^
+
+WebSocket protocol (http://tools.ietf.org/html/rfc6455[RFC 6455]) is supported
+in Relay plugin for all protocols.
+
+The WebSocket handshake is automatically detected and socket becomes ready for
+WebSocket if required headers are found in handshake and if origin is allowed
+(see option
+<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).
+
+A WebSocket can be opened in a HTML5 with a single line of JavaScript:
+
+[source,js]
+----------------------------------------
+websocket = new WebSocket("ws://server.com:5000/weechat");
+----------------------------------------
+
+The port (5000 in example) is the port defined in Relay plugin.
+The URI must always ends with "/weechat" (for both IRC and WeeChat protocols).
+
[[rmodifier_plugin]]
Plugin Rmodifier
~~~~~~~~~~~~~~~~
diff --git a/doc/ja/autogen/user/relay_options.txt b/doc/ja/autogen/user/relay_options.txt
index 62c2be65e..5a78ed5b4 100644
--- a/doc/ja/autogen/user/relay_options.txt
+++ b/doc/ja/autogen/user/relay_options.txt
@@ -113,3 +113,8 @@
** タイプ: 文字列
** 値: 未制約文字列 (デフォルト値: `"%h/ssl/relay.pem"`)
+* [[option_relay.network.websocket_allowed_origins]] *relay.network.websocket_allowed_origins*
+** 説明: `regular expression with origins allowed in websockets (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^http://(www\.)?example\.(com|org)"`
+** タイプ: 文字列
+** 値: 未制約文字列 (デフォルト値: `""`)
+
diff --git a/doc/ja/weechat_user.ja.txt b/doc/ja/weechat_user.ja.txt
index 214d2ac27..dc862bdc4 100644
--- a/doc/ja/weechat_user.ja.txt
+++ b/doc/ja/weechat_user.ja.txt
@@ -2270,6 +2270,29 @@ WeeChat が既に起動している場合、
/relay add ssl.weechat 9001
----------------------------------------
+// TRANSLATION MISSING
+[[relay_websocket]]
+Websocket
+^^^^^^^^^
+
+WebSocket protocol (http://tools.ietf.org/html/rfc6455[RFC 6455]) is supported
+in Relay plugin for all protocols.
+
+The WebSocket handshake is automatically detected and socket becomes ready for
+WebSocket if required headers are found in handshake and if origin is allowed
+(see option
+<<option_relay.network.websocket_allowed_origins,relay.network.websocket_allowed_origins>>).
+
+A WebSocket can be opened in a HTML5 with a single line of JavaScript:
+
+[source,js]
+----------------------------------------
+websocket = new WebSocket("ws://server.com:5000/weechat");
+----------------------------------------
+
+The port (5000 in example) is the port defined in Relay plugin.
+The URI must always ends with "/weechat" (for both IRC and WeeChat protocols).
+
[[rmodifier_plugin]]
=== Rmodifier プラグイン ===