From 81148545e0de334f1d5115e59ac5df37a46377c0 Mon Sep 17 00:00:00 2001
From: Jeremy Mahieu
Date: Mon, 16 Dec 2019 12:32:34 +0100
Subject: [PATCH] Fleshed out the instructions for setting a custom path
---
css/glowingbear.css | 1 -
index.html | 37 ++++++++++++++++++++++++++++++++++---
2 files changed, 34 insertions(+), 4 deletions(-)
diff --git a/css/glowingbear.css b/css/glowingbear.css
index 6dc1524..ca71b9f 100644
--- a/css/glowingbear.css
+++ b/css/glowingbear.css
@@ -610,7 +610,6 @@ h2 span, h2 small {
.panel[data-state=active] .panel-collapse {
transition: max-height 0.5s;
- max-height: 60em;
height: auto;
display: block;
}
diff --git a/index.html b/index.html
index df97f76..3505dc3 100644
--- a/index.html
+++ b/index.html
@@ -207,10 +207,41 @@ chown -R username:username ~username
Helpful trigger to automatically repin a buffer (in this instance, irc.freenode.#weechat):
/trigger add autopin signal "buffer_opened" "${buffer[${tg_signal_data}].full_name} =~ irc.freenode.#weechat" "" "/command -buffer ${buffer[${tg_signal_data}].full_name} * /buffer set localvar_set_pinned true"
- Setting path
-
- The path is by default 'weechat'. In case a proxy is used the path can be changed by entering it in the host field. For example your.domain.com:8000/otherpath
.
+
Setting a custom path
+
+ To connect to the weechat relay service we connect using a URL. A typical URL consists of 4 parts. {scheme}://{host}:{port}/{path}
. The path can be changed by enterying the relay's full URL (except the scheme).
+
+
+ - scheme: The scheme must never be input. The scheme is "ws" if TLS isn't used and it is "wss" if TLS is used.
+ - host: Can be an IPv4, IPv6 or a FQDN. IPv6 addresses must be wrapped in square brackets.
+ - port: can be specified in the host field or the seperate port field. However if the path is specified in the host field the port must also be specified.
+ - path: by defautl this is "weechat". In case a proxy is used the path can be changed by entering it in the host field.
+
+
+ Examples of correct input for the host field are:
+
+ - 192.168.0.1
+ - 192.168.0.1:8000
+ - 192.168.0.1:8000/weechat2
+ - [2001:db8:85a3::8a2e:370:7334]
+ - [2001:db8:85a3::8a2e:370:7334]:8000
+ - [2001:db8:85a3::8a2e:370:7334]:8000/weechat2
+ - yourhost.yourdomain.com
+ - yourhost.yourdomain.com:8000
+ - yourhost.yourdomain.com:8000/weechat2
+
+
+ Incorrect input for the host field:
+
+
+ - ws://192.168.0.1 (do not specify the scheme)
+ - 192.168.0.1/weechat2 (must specify port when specifying path)
+ - [2001:db8:85a3::8a2e:370:7334]/weechat2 (must specify port when specifying path)
+ - yourhost.yourdomain.com/weechat2 (must specify port when specifying path)
+ - 2001:db8:85a3::8a2e:370:7334 (must wrap IPv6 address in square brackets)
+ - 2001:db8:85a3::8a2e:370:7334:8000 (must wrap IPv6 address in square brackets)
+