From e7b27f39f0e97f6081ce06050260a46d76f35405 Mon Sep 17 00:00:00 2001 From: eta Date: Fri, 28 May 2021 17:03:19 +0100 Subject: [PATCH] update README --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5c731ab..e3709f3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # whatsxmpp [![XMPP chatroom: whatsxmpp@conf.theta.eu.org](https://inverse.chat/badge.svg?room=whatsxmpp@conf.theta.eu.org)](xmpp:whatsxmpp@conf.theta.eu.org?join) -![Maintenance](https://img.shields.io/maintenance/yes/2020.svg) - -![Lisp warning](http://www.lisperati.com/lisplogo_warning_256.png) +![Maintenance](https://img.shields.io/maintenance/yes/2021.svg) A WhatsApp Web transport for the [Extensible Messaging and Presence Protocol (XMPP)](https://xmpp.org/), otherwise known as Jabber. (alpha!) @@ -15,9 +13,9 @@ This is a multi-user transport for WhatsApp, using the [whatscl](https://git.the library for Common Lisp. By scanning a QR code generated by the bridge with the WhatsApp app on your phone, you can send and receive messages and media with your Jabber ID. -**Note:** You currently need an XMPP server of your own to try this. It's only been tested -with [prosody 0.11](https://prosody.im/) as of the time of writing - and there are some -additional caveats: take a look at the requirements list. +**Note:** You currently need an XMPP server of your own to try this. Setup instructions assume [prosody](https://prosody.im); the bridge +also works on [ejabberd](https://www.ejabberd.im/), but is not officially supported (though swing by the support MUC and we might +be able to provide some pointers, who knows). ## What works? @@ -44,11 +42,10 @@ additional caveats: take a look at the requirements list. - An XMPP server (we recommend [prosody](https://prosody.im/), but it might also work with ejabberd; let us know!) - You need to set up a new *external component* for the bridge ([see prosody doc](https://prosody.im/doc/components)). - In addition, you **must** configure an [XEP-0363 (HTTP File Upload)](https://xmpp.org/extensions/xep-0363.html) component. ([see prosody doc](https://modules.prosody.im/mod_http_upload.html)) - - **WARNING:** Prosody's `mod_http_upload` does not allow the bridge to use it, as of the time of writing (2020-05-28). You will need to replace `mod_http_upload.lua` in your community modules directory with `doc/mod_http_upload.lua` from this repository for it to work. - An installation of [Docker](https://www.docker.com/) - You *can* try and run the bridge without Docker. However, we really don't recommend it, especially if you aren't familiar with Common Lisp. - Ask in the support MUC (link at the top of this file) if you want to do this. -- [SQLite](https://www.sqlite.org/) installed (specifically the `sqlite3` command). +- [SQLite](https://www.sqlite.org/) installed (specifically the `sqlite3` command**. ## Instructions @@ -56,9 +53,14 @@ additional caveats: take a look at the requirements list. Make sure you've followed the links above to set up XEP-0363 and an external component for the bridge. With prosody, your config might look something like: +**IMPORTANT**: The bridge MUST be allowed to upload things to the XEP-0363 server. For prosody's `mod_http_upload`, you should configure the +[`http_upload_access`](https://modules.prosody.im/mod_http_upload.html#access) option, as shown below. For ejabberd, you'll need to do something +with ACLs that I don't quite understand. + ``` Component "upload.capulet.lit" "http_upload" http_upload_file_size_limit = 104857600 + http_upload_access = {"whatsapp.capulet.lit"} Component "whatsapp.capulet.lit" component_secret = "juliet"