diff --git a/docs/admin/20_syncing.rst b/docs/admin/20_syncing.rst new file mode 100644 index 0000000000000000000000000000000000000000..edca88fcb6b335d12e7eca60723d598b111c6689 --- /dev/null +++ b/docs/admin/20_syncing.rst @@ -0,0 +1,14 @@ +Synchronizing with Matrix +========================= + +To initially start the synchronization of groups in AlekSIS to rooms, +and optionally spaces, to Matrix, go to ``Matrix → Groups and Rooms``. + +Select the groups to be synchronized and click ``Execute``. +This process can take some time. +All group members that have a Matrix profile in AlekSIS, that may be automatically +created when a ``Name of Matrix homeserver user for auto-generating Matrix IDs`` is set, +get invited to the respective rooms. + +After this initial synchronization, every change in a ``Group``, ``Matrix room`` or +``Matrix profile`` will be refleceted in Matrix.