...
 
Commits (4)
......@@ -11,3 +11,11 @@ If you only want to see the output as a PDF file, you can find it [here](https:/
## License information
Available under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
## Contribution
If you like my work, you can contribute to the future development of the manual the following ways:
- Create an issue and describe how the manual can be improved. Alternatively, you can send me a message through email (szakacs dot zsolt at zoho dot com) or Matrix (maxigaz colon matrix dot org).
- If you feel generous, check out my [portfolio](https://it.movim.eu/?blog/maxigaz%40movim.eu/b53f0f78-2a78-4b5f-ab07-697c9715d227).
- If you feel *especially* generous, donate. Any amount is appreciated. At the moment, you can donate via PayPal to zsolt dot szakacs at bestressfreefast dot com.
No preview for this file type
......@@ -37,6 +37,12 @@
\maketitle
\subsection*{Preface}
I like the philosophy behind Riot and Matrix (which includes software openness, decentralisation, and interoperability), and I have been using them for a while for communication with my family, friends, business clients as well as finding like--minded people around the world—and I have been using it with great satisfaction.
So, I have decided to start a manual for end--users, which hopefully helps widen the adoption of this wonderful piece of software. I hope you'll enjoy it.
\tableofcontents
\section{Licence information}
......@@ -45,9 +51,7 @@ This document is licenced under a \href{http://creativecommons.org/licenses/by/4
\section{The goal of this document}
\label{sec:goal} I have been using Riot for a while for communication with my family, friends, business clients as well as finding like-minded people around the world—and I have been using it with great satisfaction.
This user's manual has been written for general users, to familiarise them with what Riot can do to make their communications as pleasant as possible and help them get the most out of Riot.
\label{sec:goal} This user's manual has been written for general users, to familiarise them with what Riot can do to make their communications as pleasant as possible and help them get the most out of Riot.
\section{What is Riot?}
......@@ -57,12 +61,12 @@ Riot is a free and open source client for the Matrix ecosystem. Some of its main
\item The ability to create an unlimited number of chatrooms,
\item the chatrooms can be private or public,
\item excellent options for moderation (e.g.\ banning users or deleting messages),
\item 1-to-1 audio and video calls and conference calls,
\item 1--to--1 audio and video calls and conference calls,
\item file sharing,
\item end-to-end encryption\footnote{When active, nobody except the participants can find out the content of your communications.} for messages, file attachments, and calls,
\item end--to--end encryption\footnote{When active, nobody except the participants can find out the content of your communications.} for messages, file attachments, and calls,
\item showing preview for hyperlinks, if possible,
\item can be connected with other platforms through bridges (e.g.\ IRC, Slack, Gitter, Telegram, Twitter),
\item cross-platform: available for GNU/Linux, Windows, OS X, Android and iOS.
\item cross--platform: available for GNU/Linux, Windows, OS X, Android and iOS.
\end{itemize}
\section{Registration}
......@@ -220,10 +224,10 @@ You can see all the available slash commands in Table \ref{tab:slashcommands}. S
\end{tabular}
\end{table}
\section{End-to-end encryption}
\section{End--to--end encryption}
\label{sec:e2ee}
End-to-end encryption (E2EE) makes sure your messages, file attachments, and calls are encrypted in a way that nobody except the participants can know its content (i.e. even those who have direct access to the server are unable to decipher what is really stored on the it).
End--to--end encryption (E2EE) makes sure your messages, file attachments, and calls are encrypted in a way that nobody except the participants can know its content (i.e. even those who have direct access to the server are unable to decipher what is really stored on the it).
Starting from Riot V0.9.1, this feature is available to everyone using Riot. If you're interested in using it, please, read this whole section first to learn about what important things to look out for.
......@@ -248,9 +252,9 @@ To enable E2EE, open the settings of the room and click on \textsc{Enable encryp
If you've enabled E2EE for the first time, you have probably noticed that there's a yellow warning sign in front of the message somebody has sent you. This sign means you haven't verified the other person's device yet, which is highly recommended before moving on because this way, you make sure it is really the person you want to communicate with on the other side, and also that there's nobody listening in.
Either click on this yellow sign or click on the user's name in the member list and then on the button \textsc{Verify\dots} below the device you want to verify. Then, a new pop-up message should appear.
Either click on this yellow sign or click on the user's name in the member list and then on the button \textsc{Verify\dots} below the device you want to verify. Then, a new pop--up message should appear.
In the pop-up message, look at the device name, ID, and key. Ask the other person to open the account settings (if you need help finding it, see No.\ \ref{itm:layout-bottom-left-buttons} in Section \ref{sec:layout}), scroll down, and read out these pieces of information---\emph{especially the device key} under the section \textsc{Cryptography}. (For extra security, let them read it out by other means of communication, such as talking in person or on the phone.) If what they say and what you can see on your side match, click on \textsc{I verify that the keys match}. Otherwise, you may want to immediately hang up (if there's an ongoing call), look for the device on in the right sidebar (after clicking on the name of the user), and \textsc{Blacklist} it.
In the pop--up message, look at the device name, ID, and key. Ask the other person to open the account settings (if you need help finding it, see No.\ \ref{itm:layout-bottom-left-buttons} in Section \ref{sec:layout}), scroll down, and read out these pieces of information---\emph{especially the device key} under the section \textsc{Cryptography}. (For extra security, let them read it out by other means of communication, such as talking in person or on the phone.) If what they say and what you can see on your side match, click on \textsc{I verify that the keys match}. Otherwise, you may want to immediately hang up (if there's an ongoing call), look for the device on in the right sidebar (after clicking on the name of the user), and \textsc{Blacklist} it.
\subsection{Device management}\label{sub:device-management}
......@@ -275,7 +279,6 @@ After you configured a few, the section of integration management of the options
\label{fig:integrations}
\end{figure}
\subsection{Example: joining an IRC channel}
Riot, while using an account registered on \url{matrix.org}, supports joining IRC channels out of the box! The current requirement, however, is that the channels need to be hosted on Freenode, Snoonet, OFTC, Mozilla or W3.
......@@ -285,6 +288,7 @@ You can join an IRC channel by either opening \textsc{Integration management} me
/join #_<irchost>_#<channelname>:matrix.org
\end{lstlisting}
which will create an empty Matrix room and bridge it together with the channel you want to join.
\section{Further information and support}
Do you have a question you haven't found your answer to? Feel free to visit one of the following Matrix rooms and ask away: \href{https://matrix.to/#/#riot:matrix.org}{Riot}, \href{https://matrix.to/#/#android:matrix.org}{Riot for Android}, \href{https://matrix.to/#/#ios:matrix.org}{Riot for iOS}.
......