mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
4064d6e231
Closes #930 - Make targets to download wiki pages of each service - Add post-processor script for DocBook file processing Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
236 lines
11 KiB
XML
236 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
|
|
<article>
|
|
<articleinfo>
|
|
<title>FreedomBox/Manual/MatrixSynapse</title>
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>6</revnumber>
|
|
<date>2018-03-02 12:06:08</date>
|
|
<authorinitials>JosephNuthalapati</authorinitials>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>5</revnumber>
|
|
<date>2018-03-02 10:44:12</date>
|
|
<authorinitials>JosephNuthalapati</authorinitials>
|
|
<revremark>Naming was inconsistent</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>4</revnumber>
|
|
<date>2017-06-27 05:13:41</date>
|
|
<authorinitials>JosephNuthalapati</authorinitials>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>3</revnumber>
|
|
<date>2017-03-24 06:42:49</date>
|
|
<authorinitials>SunilMohanAdapa</authorinitials>
|
|
<revremark>Update for explaining more features etc.</revremark>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>2</revnumber>
|
|
<date>2017-03-23 06:36:05</date>
|
|
<authorinitials>rahulde</authorinitials>
|
|
</revision>
|
|
<revision>
|
|
<revnumber>1</revnumber>
|
|
<date>2017-03-23 06:33:43</date>
|
|
<authorinitials>rahulde</authorinitials>
|
|
</revision>
|
|
</revhistory>
|
|
</articleinfo>
|
|
<section>
|
|
<title>Chat Server (Matrix Synapse)</title>
|
|
<section>
|
|
<title>What is the Matrix?</title>
|
|
<para><ulink url="https://matrix.org/">Matrix</ulink> is an open standard for interoperable, decentralized, real-time communication over IP. Synapse is the reference implementation of a Matrix server. It can be used to setup instant messaging on <ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox#">FreedomBox</ulink> to host large chat rooms, end to end encrypted communication and audio/video calls. Each instance of a Matrix server federates with other instances such that all your contacts need not hold accounts on your server. <ulink url="https://matrix.org/docs/guides/faq.html">See</ulink> more detailed info about Matrix. </para>
|
|
<para><emphasis role="strong">Note:</emphasis> The Matrix Synapse is available in FreedomBox starting with Plinth version 0.14. </para>
|
|
</section>
|
|
<section>
|
|
<title>How to access the Matrix?</title>
|
|
<para>We recommend the <ulink url="https://riot.im">Riot</ulink> client to access the Matrix server. You can <ulink url="https://riot.im/desktop.html">download</ulink> Riot for desktops. Mobile applications for Android and iOS are available from app stores. </para>
|
|
</section>
|
|
<section>
|
|
<title>Setting up your FreedomBox for Matrix</title>
|
|
<para>To enable Matrix, first navigate to the Chat Server (Matrix Synapse) page and install it. Matrix needs a valid domain name to be configured. After installation, you will be asked to configure it. You will be able to select a domain from a drop down menu of available domains. Domains are configured using System -> Configure page. After configuring a domain, you will see that the service is running. The service will be accessible on the configured <ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox#">FreedomBox</ulink> domain. All the registered users will have their Matrix IDs as <code>@username:domain</code>. Currently, you will not be able to change the domain once is it configured. </para>
|
|
</section>
|
|
<section>
|
|
<title>Federating with other Matrix instances</title>
|
|
<para>You will be able to interact with any other person running another Matrix instance. This is done by simply starting a conversation with them using their matrix ID which is of the format <code>@their-username:their-domain</code>. You can also join rooms which are in another server and have audio/video calls with contacts on other server. </para>
|
|
<!--rule (<hr>) is not applicable to DocBook-->
|
|
<informaltable>
|
|
<tgroup cols="8">
|
|
<colspec colname="col_0"/>
|
|
<colspec colname="col_1"/>
|
|
<colspec colname="col_2"/>
|
|
<colspec colname="col_3"/>
|
|
<colspec colname="col_4"/>
|
|
<colspec colname="col_5"/>
|
|
<colspec colname="col_6"/>
|
|
<colspec colname="col_7"/>
|
|
<tbody>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Information</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Support</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Work Space</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Reports</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Promote</emphasis>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Introduction#">Overview</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Hardware#">Hardware</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Support#">Live Help</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contribute#">Where To Start</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Translate#">Translate</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/ProgressCalls#">Calls</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/TalksAndPresentations#">Talks</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Features#">Features</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Vision#">Vision</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/QuestionsAndAnswers#">Q&A</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Design#">Design</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/TODO#">To Do</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Metrics#">Metrics</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Press#">Press</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Download#">Download</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Manual#">Manual</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/UserExperience#">Use cases</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contribute/Code#">Code</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contributors#">Contributors</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/ReleaseNotes#">Releases</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Blog#">Blog</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
<!--rule (<hr>) is not applicable to DocBook-->
|
|
<para>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</article>
|