erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (components): Documentation for the new Conferences component:

Browse source 
fix 445
This commit is contained in:
Goffi 2024-07-05 17:18:37 +02:00
commit 6f347a3fb1
1 changed files with 43 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

52
doc/components.rst
View file

@ -158,15 +158,6 @@ ActivityPub Gateway
**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 @@ Louise can use the following command::
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/