diff --git a/README.md b/README.md index d9cbc18..716908e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Glowing Bear connects to the WeeChat instance you're already running (version 0. Now point your browser to the [Glowing Bear](https://www.glowing-bear.org)! If you're having trouble connecting, check that the host and port of your WeeChat host are entered correctly, and that your server's firewall permits incoming connections on the relay port (9001 in this example). -**Please note that the above instructions set up an unencrypted relay, and all your data will be transmitted in clear.** You should not use this over the internet. We strongly recommend that you set up encryption if you want to keep using Glowing Bear. There's a guide on setting it up with Let's Encrypt on the landing page of the [next version of Glowing Bear](https://latest.glowing-bear.org), under "Getting Started". Ask us in `#glowing-bear` on freenode if something is unclear. +**Please note that the above instructions set up an unencrypted relay, and all your data will be transmitted in clear.** You should not use this over the internet. We strongly recommend that you set up encryption if you want to keep using Glowing Bear. There's a guide on setting it up with Let's Encrypt on the landing page of the [next version of Glowing Bear](https://latest.glowing-bear.org), under "Getting Started". Ask us in `#glowing-bear` on [libera](https://libera.chat) if something is unclear. You can run Glowing Bear in many ways: @@ -61,7 +61,7 @@ Once this is done, you will need to retrieve the necessary packages for testing ## Contributing -Whether you are interested in contributing or simply want to talk about the project, join us at **#glowing-bear** on **freenode**! +Whether you are interested in contributing or simply want to talk about the project, join us at **#glowing-bear** on [libera](https://libera.chat)! We appreciate all forms of contributions -- whether you're a coder, designer, or user, we are always curious what you have to say. Whether you have suggestions or already implemented a solution, let us know and we'll try to help. We're also very keen to hear which devices and platforms Glowing Bear works on (or doesn't), as we're a small team and don't have access to the resources we would need to test it everywhere. @@ -69,6 +69,6 @@ If you wish to submit code, we try to make the contribution process as simple as `$ ./run_tests.sh` - We'd also like to ask you to join our IRC channel, #glowing-bear on freenode, so we can discuss your ideas and changes. + We'd also like to ask you to join our IRC channel, #glowing-bear on libera, so we can discuss your ideas and changes. If you're curious about the projects we're using, here's a list: [AngularJS](https://angularjs.org/), [Bootstrap](http://getbootstrap.com/), [Underscore](http://underscorejs.org/), [favico.js](http://lab.ejci.net/favico.js/), Emoji provided free by [Emoji One](http://emojione.com/), and [zlib.js](https://github.com/imaya/zlib.js). Technology-wise, [WebSockets](https://en.wikipedia.org/wiki/WebSocket) are the most important part, but we also use [local storage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#localStorage), the [Notification Web API](https://developer.mozilla.org/en/docs/Web/API/notification), and last (but not least) [Apache Cordova](https://cordova.apache.org/) for our mobile app (currently unmaintained and unavailable). diff --git a/src/index.html b/src/index.html index d6f2f5c..2a78f59 100644 --- a/src/index.html +++ b/src/index.html @@ -173,7 +173,7 @@ chown -R username:username ~username/secure set relay_totp_secret xxxxx /set relay.network.totp_secret "${sec.data.relay_totp_secret}"

Open an authenticator app and create an entry with the same secret. In Glowing Bear check the checkbox for "use Time-based One-Time Password" and fill in the one time password as you see it in the authenticator app.

- +

Compatibility with WeeChat 2.8 and older

Required for WeeChat <= 2.8

With WeeChat 2.9—scheduled for release in July 2020—relay client authentication was made more secure and resistant to brute forcing. Glowing Bear uses the most secure authentication method by default. However, to support older versions of WeeChat, this option allows Glowing Bear to still use the old authentication method, sending your password to WeeChat (in plain text if you are not using encryption!). Only enable this if you are using a WeeChat version before 2.9!

@@ -211,28 +211,28 @@ chown -R username:username ~username

Pinning buffers

- The option "Only show buffers with unread messages" is useful when you have a lot of buffers and can't meaningfully look at all of them at the same time. However, often you have a select few buffers that you use more frequently and would like to have displayed permanently. + The option "Only show buffers with unread messages" is useful when you have a lot of buffers and can't meaningfully look at all of them at the same time. However, often you have a select few buffers that you use more frequently and would like to have displayed permanently.

To pin a buffer, type /buffer set localvar_set_pinned true. Note: Local variables on buffers are not persisted across WeeChat restarts, so either use script buffer_autoset.py to automatically apply that upon buffer creation or use a trigger if you want automatic repinning when buffers get recreated. To unpin, you can use the same command and set anything other than true.

- 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"
+ Helpful trigger to automatically repin a buffer (in this instance, irc.libera.#weechat): 
/trigger add autopin signal "buffer_opened" "${buffer[${tg_signal_data}].full_name} =~ irc.libera.#weechat" "" "/command -buffer ${buffer[${tg_signal_data}].full_name} * /buffer set localvar_set_pinned true"

Setting a custom path

-

- The hostname field can be used to set a custom path. Or a URL parameter can be used see section 'URL Parameters'. +

+ The hostname field can be used to set a custom path. Or a URL parameter can be used see section 'URL Parameters'.

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 entering the relay's full URL (except the scheme). -

+

-

+

Examples of correct input for the host field are: