From: Camille Lafitte <cam.lafit@azerttyu.net>
To: ~nicoco/public-inbox@lists.sr.ht
Cc: Camille Lafitte <cam.lafit@azerttyu.net>
Subject: [PATCH slidge] Explain more http upload component configuration
Date: Fri, 16 Sep 2022 16:08:17 +0200
Message-Id: <20220916140817.839417-1-cam.lafit@azerttyu.net>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

* A xmmp server supporting XEP: is required
* Explain more how to configure a minimal component

Fixes: https://todo.sr.ht/~nicoco/slidge/50
---
 docs/source/admin/xmpp_server.rst | 40 ++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/source/admin/xmpp_server.rst b/docs/source/admin/xmpp_server.rst
index cb2a22a..bda6357 100644
--- a/docs/source/admin/xmpp_server.rst
+++ b/docs/source/admin/xmpp_server.rst
@@ -58,6 +58,18 @@ Then either restart the prosody server, or reload config. You might need to use
 `mod_reload_component <https://modules.prosody.im/mod_reload_components.html>`_
 for all changes to be taken into account (restarting prosody is the easiest way to go).
 
+Upload component
+****************
+
+
+Slidge to display information provided by any chat network use XEP-0363 (HTTP File Upload). To display qrcode or any other element to permit some action as device association. It's required to enable propsody http_file_share plugin
+
+.. code-block:: lua
+
+   Component "upload.example.org" "http_file_share"
+
+To get more informaton about component configuration : https://prosody.im/doc/modules/mod_http_file_share
+
 ejabberd
 --------
 
@@ -94,4 +106,30 @@ Roster management also requires roster versioning.
         message:
           outgoing: superduper.example.com
       mod_roster:
-        versioning: true
\ No newline at end of file
+        versioning: true
+
+Upload component
+****************
+
+Slidge to display information provided by any chat network use XEP-0363 (HTTP File Upload). 
+To display qrcode or any other element to permit some action as device association.
+
+.. code-block:: yaml
+
+    listen:
+      -
+        port: 5443
+        module: ejabberd_http
+        tls: true
+        request_handlers:
+          /upload: mod_http_upload
+
+.. code-block:: yaml
+
+    modules:
+      mod_http_upload:
+        docroot: /ejabberd/upload
+        put_url: "https://@HOST@:5443/upload"
+
+
+To get more informaton about component configuration : https://docs.ejabberd.im/admin/configuration/modules/#mod-http-upload
\ No newline at end of file
-- 
2.30.2