Mercurial > libervia-backend

comparison doc/components.rst @ 4279:6276242736c3 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (components): Documentation for the new `Conferences` component: fix 445
author Goffi <goffi@goffi.org>
date Fri, 05 Jul 2024 17:18:37 +0200
parents 57ff857bf96e
children
comparison
equal deleted inserted replaced
4278:240d8b7ad906 4279:6276242736c3
155 155
156 ActivityPub Gateway 156 ActivityPub Gateway
157 ------------------- 157 -------------------
158 158
159 **entry_point:** ``ap-gateway`` 159 **entry_point:** ``ap-gateway``
160
161 .. note::
162
163 this component is currently in active development, and not yet fully functional. This
164 documentation will be updated during evolution of component.
165
166 You can follow the development by reading `Libervia Progress Notes`_.
167
168 .. _Libervia Progress Notes: https://www.goffi.org/tag/Libervia%20progress
169 160
170 This gateway will provide a bidirectional gateway between XMPP and `ActivityPub`_ (or AP 161 This gateway will provide a bidirectional gateway between XMPP and `ActivityPub`_ (or AP
171 below). That means that user from XMPP will be able to follow actors or comments messages 162 below). That means that user from XMPP will be able to follow actors or comments messages
172 from any software compatible with ActivityPub protocol, and vice versa. 163 from any software compatible with ActivityPub protocol, and vice versa.
173 164
884 875
885 $ li debug bridge method -c ap_send '"{\"node\": \"https://example.net/@pierre/106986412193109832\", \"content\": \"A lille hello from XMPP\"}","pierre\\40example.net@ap.example.org", "louise"' 876 $ li debug bridge method -c ap_send '"{\"node\": \"https://example.net/@pierre/106986412193109832\", \"content\": \"A lille hello from XMPP\"}","pierre\\40example.net@ap.example.org", "louise"'
886 877
887 Note the double escaping, one for the shell argument, and the other to specify JSON 878 Note the double escaping, one for the shell argument, and the other to specify JSON
888 object. 879 object.
880
881
882 Audio/Video Conferences
883 -----------------------
884
885 **entry_point:** ``conferences``
886
887 This component integrates a service to run multiparty audio/video conferences over XMPP.
888 The service is called a "Selective Forwarding Unit" (SFU), and it's main role is to
889 distribute participants' audio and video streams.
890
891 The component currently integrates the `Galène project`_, as it is a complete, simple, and
892 easy to install service. Other projects may be integrated in the future if the need
893 arises.
894
895 .. note::
896
897 This component is **work in progress** and under heavy development.
898
899 Please ensure that Galène is already installed on your device.
900
901 If the ``galene`` executable is not in your ``PATH`` environment variable, you can specify its
902 location using the ``galene_path`` option (see below).
903
904 Note that Galène will be automatically started and stopped by the component, you don't
905 have to start it yourself.
906
907 Configuration
908 ~~~~~~~~~~~~~
909
910 All options are to be set in the ``[component conferences]`` section.
911
912 ``galene_path``
913 The path to the Galène executable, if it is not in the `PATH` environment variable.
914
915 **default**: Look for ``galene`` in the ``PATH``
916
917 ``http_port``
918 The port used by the Galène HTTP server.
919
920 **default**: 9443
921
922 .. _Galène project: https://galene.org/