Browse Source

Documentation for riot web

jessie
Bob Mottram 3 years ago
parent
commit
f4e4a4b2de
4 changed files with 141 additions and 88 deletions
  1. + 37
    - 0
      doc/EN/app_riot.org
  2. + 4
    - 0
      doc/EN/apps.org
  3. BIN
      img/riotweb.jpg
  4. + 100
    - 88
      website/EN/apps.html

+ 37
- 0
doc/EN/app_riot.org

@ -0,0 +1,37 @@
#+TITLE:
#+AUTHOR: Bob Mottram
#+EMAIL: bob@freedombone.net
#+KEYWORDS: freedombone, riot
#+DESCRIPTION: How to use Riot Web
#+OPTIONS: ^:nil toc:nil
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
#+BEGIN_CENTER
[[file:images/logo.png]]
#+END_CENTER
#+BEGIN_EXPORT html
<center>
<h1>Riot Web</h1>
</center>
#+END_EXPORT
#+BEGIN_CENTER
[[file:images/riotweb.jpg]]
#+END_CENTER
Riot Web is a browser based user interface for the [[./app_matrix.html][Matrix]] federated communications system. It allows you to do encrypted one-to-one or group chat, and has some fancy WebRTC features for voice and video conversations. The WebRTC stuff won't work in a Tor browser though. This type of system is fine for general public communications and collaboration on open source projects or gaming groups. For things which require real privacy though stick to XMPP with OMEMO.
* Installation
Log into your system with:
#+begin_src bash
ssh myusername@mydomain -p 2222
#+end_src
Using cursor keys, space bar and Enter key select *Administrator controls* and type in your password.
Select *Add/Remove Apps* then *riot* and also make sure that *matrix* is selected or was previously installed. You will then be asked for a domain name and if you are using FreeDNS also the code for the domain which can be found under *Dynamic DNS* on the FreeDNS site (the random string from "/quick cron example/" which appears after /update.php?/ and before />>/). For more details on obtaining a domain and making it accessible via dynamic DNS see the [[./faq.html][FAQ]]. Typically the domain name you use will be a subdomain, such as /riot.mydomainname.net/. It will need to be a domain which you have bought somewhere and own and not one of the FreeDNS subdomains, otherwise you won't be able to get a SSL/TLS certificate for it.
* Initial setup
Go to the *Administrator control panel* and select *Passwords* then *matrix*. This will give you the password to initially log in using the Riot Web user interface. Log in, and that's it. Happy chatting.

+ 4
- 0
doc/EN/apps.org

@ -107,6 +107,10 @@ An alternative federated social networking system compatible with GNU Social. It
Calendar system compatible with CalDAV and CardDAV. Synch your calendar events easily and securely across all your devices.
[[./app_radicale.html][How to use it]]
* Riot Web
A browser based user interface for the Matrix federated communications system, including WebRTC audio and video chat.
[[./app_riot.html][How to use it]]
* SearX
A metasearch engine for customised and private web searches.

BIN
img/riotweb.jpg

Before After
Width: 1268  |  Height: 874  |  Size: 63 KiB

+ 100
- 88
website/EN/apps.html

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2017-05-08 Mon 23:42 -->
<!-- 2017-05-10 Wed 20:12 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
@ -264,9 +264,9 @@ The base install of the system just contains an email server and Mutt client, bu
</div>
</div>
<div id="outline-container-org6db46a9" class="outline-2">
<h2 id="org6db46a9">DLNA</h2>
<div class="outline-text-2" id="text-org6db46a9">
<div id="outline-container-org372bf3e" class="outline-2">
<h2 id="org372bf3e">DLNA</h2>
<div class="outline-text-2" id="text-org372bf3e">
<p>
Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.
</p>
@ -276,9 +276,9 @@ Enables you to use the system as a music server which any DLNA compatible device
</p>
</div>
</div>
<div id="outline-container-org25839d2" class="outline-2">
<h2 id="org25839d2">Dokuwiki</h2>
<div class="outline-text-2" id="text-org25839d2">
<div id="outline-container-org8f40b27" class="outline-2">
<h2 id="org8f40b27">Dokuwiki</h2>
<div class="outline-text-2" id="text-org8f40b27">
<p>
A databaseless wiki system.
</p>
@ -288,9 +288,9 @@ A databaseless wiki system.
</p>
</div>
</div>
<div id="outline-container-orgdbbaf95" class="outline-2">
<h2 id="orgdbbaf95">Emacs</h2>
<div class="outline-text-2" id="text-orgdbbaf95">
<div id="outline-container-org8451dac" class="outline-2">
<h2 id="org8451dac">Emacs</h2>
<div class="outline-text-2" id="text-org8451dac">
<p>
If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.
</p>
@ -300,9 +300,9 @@ If you use the Mutt client to read your email then this will set it up to use em
</p>
</div>
</div>
<div id="outline-container-org1b7b546" class="outline-2">
<h2 id="org1b7b546">Etherpad</h2>
<div class="outline-text-2" id="text-org1b7b546">
<div id="outline-container-org9d3f7de" class="outline-2">
<h2 id="org9d3f7de">Etherpad</h2>
<div class="outline-text-2" id="text-org9d3f7de">
<p>
Collaborate on creating documents in real time. Maybe you're planning a holiday with other family members or creating documentation for a Free Software project along with other volunteers. Etherpad is hard to beat for simplicity and speed. Only users of the system will be able to access it.
</p>
@ -312,9 +312,9 @@ Collaborate on creating documents in real time. Maybe you're planning a holiday
</p>
</div>
</div>
<div id="outline-container-orgfcbeddf" class="outline-2">
<h2 id="orgfcbeddf">Friendica</h2>
<div class="outline-text-2" id="text-orgfcbeddf">
<div id="outline-container-org63b64da" class="outline-2">
<h2 id="org63b64da">Friendica</h2>
<div class="outline-text-2" id="text-org63b64da">
<p>
Federated social network system.
</p>
@ -324,9 +324,9 @@ Federated social network system.
</p>
</div>
</div>
<div id="outline-container-orge41b3a5" class="outline-2">
<h2 id="orge41b3a5">Ghost</h2>
<div class="outline-text-2" id="text-orge41b3a5">
<div id="outline-container-orge6eb6c0" class="outline-2">
<h2 id="orge6eb6c0">Ghost</h2>
<div class="outline-text-2" id="text-orge6eb6c0">
<p>
Modern looking blogging system.
</p>
@ -336,9 +336,9 @@ Modern looking blogging system.
</p>
</div>
</div>
<div id="outline-container-orged8cfdf" class="outline-2">
<h2 id="orged8cfdf">GNU Social</h2>
<div class="outline-text-2" id="text-orged8cfdf">
<div id="outline-container-org4a83bfb" class="outline-2">
<h2 id="org4a83bfb">GNU Social</h2>
<div class="outline-text-2" id="text-org4a83bfb">
<p>
Federated social network. You can "<i>remote follow</i>" other users within the GNU Social federation.
</p>
@ -348,9 +348,9 @@ Federated social network. You can "remote follow" other users within the
</p>
</div>
</div>
<div id="outline-container-org198389b" class="outline-2">
<h2 id="org198389b">Gogs</h2>
<div class="outline-text-2" id="text-org198389b">
<div id="outline-container-orgeae0509" class="outline-2">
<h2 id="orgeae0509">Gogs</h2>
<div class="outline-text-2" id="text-orgeae0509">
<p>
Lightweight git project hosting system. You can mirror projects from Github, or if Github turns evil then just host your own projects while retaining the familiar <i>fork-and-pull</i> workflow. If you can use Github then you can also use Gogs.
</p>
@ -360,9 +360,9 @@ Lightweight git project hosting system. You can mirror projects from Github, or
</p>
</div>
</div>
<div id="outline-container-org5a95d7d" class="outline-2">
<h2 id="org5a95d7d">HTMLy</h2>
<div class="outline-text-2" id="text-org5a95d7d">
<div id="outline-container-org2429465" class="outline-2">
<h2 id="org2429465">HTMLy</h2>
<div class="outline-text-2" id="text-org2429465">
<p>
Databaseless blogging system. Quite simple and with a markdown-like format.
</p>
@ -372,9 +372,9 @@ Databaseless blogging system. Quite simple and with a markdown-like format.
</p>
</div>
</div>
<div id="outline-container-org9bde910" class="outline-2">
<h2 id="org9bde910">Hubzilla</h2>
<div class="outline-text-2" id="text-org9bde910">
<div id="outline-container-orgb0d40a3" class="outline-2">
<h2 id="orgb0d40a3">Hubzilla</h2>
<div class="outline-text-2" id="text-orgb0d40a3">
<p>
Web publishing platform with social network like features and good privacy controls so that it's possible to specify who can see which content. Includes photo albums, calendar, wiki and file storage.
</p>
@ -384,9 +384,9 @@ Web publishing platform with social network like features and good privacy contr
</p>
</div>
</div>
<div id="outline-container-org30916d8" class="outline-2">
<h2 id="org30916d8">IRC Server (ngirc)</h2>
<div class="outline-text-2" id="text-org30916d8">
<div id="outline-container-org85b8a83" class="outline-2">
<h2 id="org85b8a83">IRC Server (ngirc)</h2>
<div class="outline-text-2" id="text-org85b8a83">
<p>
Run your own IRC chat channel which can be secured with a password and accessible via an onion address. A bouncer is included so that you can receive messages sent while you were offline. Works with Hexchat and other popular clients.
</p>
@ -396,18 +396,18 @@ Run your own IRC chat channel which can be secured with a password and accessibl
</p>
</div>
</div>
<div id="outline-container-org607f35f" class="outline-2">
<h2 id="org607f35f">Jitsi Meet</h2>
<div class="outline-text-2" id="text-org607f35f">
<div id="outline-container-org65ab5d3" class="outline-2">
<h2 id="org65ab5d3">Jitsi Meet</h2>
<div class="outline-text-2" id="text-org65ab5d3">
<p>
Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.
</p>
</div>
</div>
<div id="outline-container-orgb507e40" class="outline-2">
<h2 id="orgb507e40">Lychee</h2>
<div class="outline-text-2" id="text-orgb507e40">
<div id="outline-container-org7ff4db3" class="outline-2">
<h2 id="org7ff4db3">Lychee</h2>
<div class="outline-text-2" id="text-org7ff4db3">
<p>
Make your photo albums available on the web.
</p>
@ -417,9 +417,9 @@ Make your photo albums available on the web.
</p>
</div>
</div>
<div id="outline-container-org189ec3b" class="outline-2">
<h2 id="org189ec3b">Mailpile</h2>
<div class="outline-text-2" id="text-org189ec3b">
<div id="outline-container-org0b2516a" class="outline-2">
<h2 id="org0b2516a">Mailpile</h2>
<div class="outline-text-2" id="text-org0b2516a">
<p>
Modern email client which supports GPG encryption.
</p>
@ -429,9 +429,9 @@ Modern email client which supports GPG encryption.
</p>
</div>
</div>
<div id="outline-container-org10c7089" class="outline-2">
<h2 id="org10c7089">Matrix</h2>
<div class="outline-text-2" id="text-org10c7089">
<div id="outline-container-org464b4b7" class="outline-2">
<h2 id="org464b4b7">Matrix</h2>
<div class="outline-text-2" id="text-org464b4b7">
<p>
Multi-user chat with some security and moderation controls.
</p>
@ -441,9 +441,9 @@ Multi-user chat with some security and moderation controls.
</p>
</div>
</div>
<div id="outline-container-org3df846e" class="outline-2">
<h2 id="org3df846e">Mediagoblin</h2>
<div class="outline-text-2" id="text-org3df846e">
<div id="outline-container-org3da94ed" class="outline-2">
<h2 id="org3da94ed">Mediagoblin</h2>
<div class="outline-text-2" id="text-org3da94ed">
<p>
Publicly host video and audio files so that you don't need to use YouTube/Vimeo/etc.
</p>
@ -453,9 +453,9 @@ Publicly host video and audio files so that you don't need to use YouTube/Vimeo/
</p>
</div>
</div>
<div id="outline-container-org83fee89" class="outline-2">
<h2 id="org83fee89">Mumble</h2>
<div class="outline-text-2" id="text-org83fee89">
<div id="outline-container-orgc8b5bd6" class="outline-2">
<h2 id="orgc8b5bd6">Mumble</h2>
<div class="outline-text-2" id="text-orgc8b5bd6">
<p>
The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.
</p>
@ -465,9 +465,9 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co
</p>
</div>
</div>
<div id="outline-container-orgde509db" class="outline-2">
<h2 id="orgde509db">NextCloud</h2>
<div class="outline-text-2" id="text-orgde509db">
<div id="outline-container-orge2e9cd1" class="outline-2">
<h2 id="orge2e9cd1">NextCloud</h2>
<div class="outline-text-2" id="text-orge2e9cd1">
<p>
Store files on your server and sync them with laptops or mobile devices. Includes many plugins including videoconferencing and collaborative document editing.
</p>
@ -477,9 +477,9 @@ Store files on your server and sync them with laptops or mobile devices. Include
</p>
</div>
</div>
<div id="outline-container-org932521c" class="outline-2">
<h2 id="org932521c">PI-Hole</h2>
<div class="outline-text-2" id="text-org932521c">
<div id="outline-container-org03a928d" class="outline-2">
<h2 id="org03a928d">PI-Hole</h2>
<div class="outline-text-2" id="text-org03a928d">
<p>
The black hole for web adverts. Block adverts at the domain name level within your local network. It can significantly reduce bandwidth, speed up page load times and protect your systems from being tracked by spyware.
</p>
@ -489,9 +489,9 @@ The black hole for web adverts. Block adverts at the domain name level within yo
</p>
</div>
</div>
<div id="outline-container-org2e61ebd" class="outline-2">
<h2 id="org2e61ebd">PostActiv</h2>
<div class="outline-text-2" id="text-org2e61ebd">
<div id="outline-container-org47912c7" class="outline-2">
<h2 id="org47912c7">PostActiv</h2>
<div class="outline-text-2" id="text-org47912c7">
<p>
An alternative federated social networking system compatible with GNU Social. It includes some optimisations and fixes currently not available within the main GNU Social project.
</p>
@ -501,9 +501,9 @@ An alternative federated social networking system compatible with GNU Social. It
</p>
</div>
</div>
<div id="outline-container-org5d6ca5c" class="outline-2">
<h2 id="org5d6ca5c">Radicale</h2>
<div class="outline-text-2" id="text-org5d6ca5c">
<div id="outline-container-orgf28761f" class="outline-2">
<h2 id="orgf28761f">Radicale</h2>
<div class="outline-text-2" id="text-orgf28761f">
<p>
Calendar system compatible with CalDAV and CardDAV. Synch your calendar events easily and securely across all your devices.
</p>
@ -513,9 +513,21 @@ Calendar system compatible with CalDAV and CardDAV. Synch your calendar events e
</p>
</div>
</div>
<div id="outline-container-orge2883dd" class="outline-2">
<h2 id="orge2883dd">SearX</h2>
<div class="outline-text-2" id="text-orge2883dd">
<div id="outline-container-org17a8973" class="outline-2">
<h2 id="org17a8973">Riot Web</h2>
<div class="outline-text-2" id="text-org17a8973">
<p>
A browser based user interface for the Matrix federated communications system, including WebRTC audio and video chat.
</p>
<p>
<a href="./app_riot.html">How to use it</a>
</p>
</div>
</div>
<div id="outline-container-org8827212" class="outline-2">
<h2 id="org8827212">SearX</h2>
<div class="outline-text-2" id="text-org8827212">
<p>
A metasearch engine for customised and private web searches.
</p>
@ -525,9 +537,9 @@ A metasearch engine for customised and private web searches.
</p>
</div>
</div>
<div id="outline-container-org543ba26" class="outline-2">
<h2 id="org543ba26">tt-rss</h2>
<div class="outline-text-2" id="text-org543ba26">
<div id="outline-container-org4f37358" class="outline-2">
<h2 id="org4f37358">tt-rss</h2>
<div class="outline-text-2" id="text-org4f37358">
<p>
Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via an onion address. Have "<i>the right to read</i>" without the Surveillance State knowing what you're reading. Also available with a user interface suitable for viewing on mobile devices via a browser such as OrFox.
</p>
@ -537,9 +549,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a
</p>
</div>
</div>
<div id="outline-container-org2057517" class="outline-2">
<h2 id="org2057517">Syncthing</h2>
<div class="outline-text-2" id="text-org2057517">
<div id="outline-container-org8f9c43d" class="outline-2">
<h2 id="org8f9c43d">Syncthing</h2>
<div class="outline-text-2" id="text-org8f9c43d">
<p>
Possibly the best way to synchronise files across all of your devices. Once it has been set up it "just works" with no user intervention needed.
</p>
@ -549,9 +561,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h
</p>
</div>
</div>
<div id="outline-container-orgea5c12c" class="outline-2">
<h2 id="orgea5c12c">Tahoe-LAFS</h2>
<div class="outline-text-2" id="text-orgea5c12c">
<div id="outline-container-orgd0043d9" class="outline-2">
<h2 id="orgd0043d9">Tahoe-LAFS</h2>
<div class="outline-text-2" id="text-orgd0043d9">
<p>
Robust and encrypted storage of files on one or more server.
</p>
@ -561,9 +573,9 @@ Robust and encrypted storage of files on one or more server.
</p>
</div>
</div>
<div id="outline-container-orgf085c9d" class="outline-2">
<h2 id="orgf085c9d">Tox</h2>
<div class="outline-text-2" id="text-orgf085c9d">
<div id="outline-container-org7820aeb" class="outline-2">
<h2 id="org7820aeb">Tox</h2>
<div class="outline-text-2" id="text-org7820aeb">
<p>
Client and bootstrap node for the Tox chat/VoIP system.
</p>
@ -573,9 +585,9 @@ Client and bootstrap node for the Tox chat/VoIP system.
</p>
</div>
</div>
<div id="outline-container-org1cd1017" class="outline-2">
<h2 id="org1cd1017">Turtl</h2>
<div class="outline-text-2" id="text-org1cd1017">
<div id="outline-container-orgfd1cd79" class="outline-2">
<h2 id="orgfd1cd79">Turtl</h2>
<div class="outline-text-2" id="text-orgfd1cd79">
<p>
A system for privately creating and sharing notes and images, similar to Evernote but without the spying.
</p>
@ -585,18 +597,18 @@ A system for privately creating and sharing notes and images, similar to Evernot
</p>
</div>
</div>
<div id="outline-container-org5d18482" class="outline-2">
<h2 id="org5d18482">Vim</h2>
<div class="outline-text-2" id="text-org5d18482">
<div id="outline-container-org2264fcd" class="outline-2">
<h2 id="org2264fcd">Vim</h2>
<div class="outline-text-2" id="text-org2264fcd">
<p>
If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.
</p>
</div>
</div>
<div id="outline-container-orgd0f17c6" class="outline-2">
<h2 id="orgd0f17c6">XMPP</h2>
<div class="outline-text-2" id="text-orgd0f17c6">
<div id="outline-container-orgc47a593" class="outline-2">
<h2 id="orgc47a593">XMPP</h2>
<div class="outline-text-2" id="text-orgc47a593">
<p>
Chat server which can be used together with client such as Gajim or Conversations to provide end-to-end content security and also onion routed metadata security. Includes advanced features such as <i>client state notification</i> to save battery power on your mobile devices, support for seamless roaming between networks and <i>message carbons</i> so that you can receive the same messages while being simultaneously logged in to your account on more than one device.
</p>

Loading…
Cancel
Save