# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1720192717 -7200
# Node ID 6276242736c35b1be5e81ea76592b4c85321ca8f
# Parent  240d8b7ad906cc0b15bb2efb4c53f03daae563f9
doc (components): Documentation for the new `Conferences` component:

fix 445

diff -r 240d8b7ad906 -r 6276242736c3 doc/components.rst
--- a/doc/components.rst	Fri Jul 05 17:18:37 2024 +0200
+++ b/doc/components.rst	Fri Jul 05 17:18:37 2024 +0200
@@ -158,15 +158,6 @@
 
 **entry_point:** ``ap-gateway``
 
-.. note::
-
-  this component is currently in active development, and not yet fully functional. This
-  documentation will be updated during evolution of component.
-
-  You can follow the development by reading `Libervia Progress Notes`_.
-
-  .. _Libervia Progress Notes: https://www.goffi.org/tag/Libervia%20progress
-
 This gateway will provide a bidirectional gateway between XMPP and `ActivityPub`_ (or AP
 below). That means that user from XMPP will be able to follow actors or comments messages
 from any software compatible with ActivityPub protocol, and vice versa.
@@ -886,3 +877,46 @@
 
 Note the double escaping, one for the shell argument, and the other to specify JSON
 object.
+
+
+Audio/Video Conferences
+-----------------------
+
+**entry_point:** ``conferences``
+
+This component integrates a service to run multiparty audio/video conferences over XMPP.
+The service is called a "Selective Forwarding Unit" (SFU), and it's main role is to
+distribute participants' audio and video streams.
+
+The component currently integrates the `Galène project`_, as it is a complete, simple, and
+easy to install service. Other projects may be integrated in the future if the need
+arises.
+
+.. note::
+
+  This component is **work in progress** and under heavy development.
+
+Please ensure that Galène is already installed on your device.
+
+If the ``galene`` executable is not in your ``PATH`` environment variable, you can specify its
+location using the ``galene_path`` option (see below).
+
+Note that Galène will be automatically started and stopped by the component, you don't
+have to start it yourself.
+
+Configuration
+~~~~~~~~~~~~~
+
+All options are to be set in the ``[component conferences]`` section.
+
+``galene_path``
+  The path to the Galène executable, if it is not in the `PATH` environment variable.
+
+  **default**: Look for ``galene`` in the ``PATH``
+
+``http_port``
+  The port used by the Galène HTTP server.
+
+  **default**: 9443
+
+.. _Galène project: https://galene.org/