Bladeren bron

Documentation for riot web

Bob Mottram 8 jaren geleden
bovenliggende
commit
f4e4a4b2de
4 gewijzigde bestanden met toevoegingen van 141 en 88 verwijderingen
  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 Bestand weergeven

@@ -0,0 +1,37 @@
1
+#+TITLE:
2
+#+AUTHOR: Bob Mottram
3
+#+EMAIL: bob@freedombone.net
4
+#+KEYWORDS: freedombone, riot
5
+#+DESCRIPTION: How to use Riot Web
6
+#+OPTIONS: ^:nil toc:nil
7
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
8
+
9
+#+BEGIN_CENTER
10
+[[file:images/logo.png]]
11
+#+END_CENTER
12
+
13
+#+BEGIN_EXPORT html
14
+<center>
15
+<h1>Riot Web</h1>
16
+</center>
17
+#+END_EXPORT
18
+
19
+#+BEGIN_CENTER
20
+[[file:images/riotweb.jpg]]
21
+#+END_CENTER
22
+
23
+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.
24
+
25
+* Installation
26
+Log into your system with:
27
+
28
+#+begin_src bash
29
+ssh myusername@mydomain -p 2222
30
+#+end_src
31
+
32
+Using cursor keys, space bar and Enter key select *Administrator controls* and type in your password.
33
+
34
+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.
35
+
36
+* Initial setup
37
+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 Bestand weergeven

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

BIN
img/riotweb.jpg Bestand weergeven


+ 100
- 88
website/EN/apps.html Bestand weergeven

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2017-05-08 Mon 23:42 -->
6
+<!-- 2017-05-10 Wed 20:12 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title></title>
@@ -264,9 +264,9 @@ The base install of the system just contains an email server and Mutt client, bu
264 264
 </div>
265 265
 </div>
266 266
 
267
-<div id="outline-container-org6db46a9" class="outline-2">
268
-<h2 id="org6db46a9">DLNA</h2>
269
-<div class="outline-text-2" id="text-org6db46a9">
267
+<div id="outline-container-org372bf3e" class="outline-2">
268
+<h2 id="org372bf3e">DLNA</h2>
269
+<div class="outline-text-2" id="text-org372bf3e">
270 270
 <p>
271 271
 Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.
272 272
 </p>
@@ -276,9 +276,9 @@ Enables you to use the system as a music server which any DLNA compatible device
276 276
 </p>
277 277
 </div>
278 278
 </div>
279
-<div id="outline-container-org25839d2" class="outline-2">
280
-<h2 id="org25839d2">Dokuwiki</h2>
281
-<div class="outline-text-2" id="text-org25839d2">
279
+<div id="outline-container-org8f40b27" class="outline-2">
280
+<h2 id="org8f40b27">Dokuwiki</h2>
281
+<div class="outline-text-2" id="text-org8f40b27">
282 282
 <p>
283 283
 A databaseless wiki system.
284 284
 </p>
@@ -288,9 +288,9 @@ A databaseless wiki system.
288 288
 </p>
289 289
 </div>
290 290
 </div>
291
-<div id="outline-container-orgdbbaf95" class="outline-2">
292
-<h2 id="orgdbbaf95">Emacs</h2>
293
-<div class="outline-text-2" id="text-orgdbbaf95">
291
+<div id="outline-container-org8451dac" class="outline-2">
292
+<h2 id="org8451dac">Emacs</h2>
293
+<div class="outline-text-2" id="text-org8451dac">
294 294
 <p>
295 295
 If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.
296 296
 </p>
@@ -300,9 +300,9 @@ If you use the Mutt client to read your email then this will set it up to use em
300 300
 </p>
301 301
 </div>
302 302
 </div>
303
-<div id="outline-container-org1b7b546" class="outline-2">
304
-<h2 id="org1b7b546">Etherpad</h2>
305
-<div class="outline-text-2" id="text-org1b7b546">
303
+<div id="outline-container-org9d3f7de" class="outline-2">
304
+<h2 id="org9d3f7de">Etherpad</h2>
305
+<div class="outline-text-2" id="text-org9d3f7de">
306 306
 <p>
307 307
 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.
308 308
 </p>
@@ -312,9 +312,9 @@ Collaborate on creating documents in real time. Maybe you're planning a holiday
312 312
 </p>
313 313
 </div>
314 314
 </div>
315
-<div id="outline-container-orgfcbeddf" class="outline-2">
316
-<h2 id="orgfcbeddf">Friendica</h2>
317
-<div class="outline-text-2" id="text-orgfcbeddf">
315
+<div id="outline-container-org63b64da" class="outline-2">
316
+<h2 id="org63b64da">Friendica</h2>
317
+<div class="outline-text-2" id="text-org63b64da">
318 318
 <p>
319 319
 Federated social network system.
320 320
 </p>
@@ -324,9 +324,9 @@ Federated social network system.
324 324
 </p>
325 325
 </div>
326 326
 </div>
327
-<div id="outline-container-orge41b3a5" class="outline-2">
328
-<h2 id="orge41b3a5">Ghost</h2>
329
-<div class="outline-text-2" id="text-orge41b3a5">
327
+<div id="outline-container-orge6eb6c0" class="outline-2">
328
+<h2 id="orge6eb6c0">Ghost</h2>
329
+<div class="outline-text-2" id="text-orge6eb6c0">
330 330
 <p>
331 331
 Modern looking blogging system.
332 332
 </p>
@@ -336,9 +336,9 @@ Modern looking blogging system.
336 336
 </p>
337 337
 </div>
338 338
 </div>
339
-<div id="outline-container-orged8cfdf" class="outline-2">
340
-<h2 id="orged8cfdf">GNU Social</h2>
341
-<div class="outline-text-2" id="text-orged8cfdf">
339
+<div id="outline-container-org4a83bfb" class="outline-2">
340
+<h2 id="org4a83bfb">GNU Social</h2>
341
+<div class="outline-text-2" id="text-org4a83bfb">
342 342
 <p>
343 343
 Federated social network. You can "<i>remote follow</i>" other users within the GNU Social federation.
344 344
 </p>
@@ -348,9 +348,9 @@ Federated social network. You can "<i>remote follow</i>" other users within the
348 348
 </p>
349 349
 </div>
350 350
 </div>
351
-<div id="outline-container-org198389b" class="outline-2">
352
-<h2 id="org198389b">Gogs</h2>
353
-<div class="outline-text-2" id="text-org198389b">
351
+<div id="outline-container-orgeae0509" class="outline-2">
352
+<h2 id="orgeae0509">Gogs</h2>
353
+<div class="outline-text-2" id="text-orgeae0509">
354 354
 <p>
355 355
 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.
356 356
 </p>
@@ -360,9 +360,9 @@ Lightweight git project hosting system. You can mirror projects from Github, or
360 360
 </p>
361 361
 </div>
362 362
 </div>
363
-<div id="outline-container-org5a95d7d" class="outline-2">
364
-<h2 id="org5a95d7d">HTMLy</h2>
365
-<div class="outline-text-2" id="text-org5a95d7d">
363
+<div id="outline-container-org2429465" class="outline-2">
364
+<h2 id="org2429465">HTMLy</h2>
365
+<div class="outline-text-2" id="text-org2429465">
366 366
 <p>
367 367
 Databaseless blogging system. Quite simple and with a markdown-like format.
368 368
 </p>
@@ -372,9 +372,9 @@ Databaseless blogging system. Quite simple and with a markdown-like format.
372 372
 </p>
373 373
 </div>
374 374
 </div>
375
-<div id="outline-container-org9bde910" class="outline-2">
376
-<h2 id="org9bde910">Hubzilla</h2>
377
-<div class="outline-text-2" id="text-org9bde910">
375
+<div id="outline-container-orgb0d40a3" class="outline-2">
376
+<h2 id="orgb0d40a3">Hubzilla</h2>
377
+<div class="outline-text-2" id="text-orgb0d40a3">
378 378
 <p>
379 379
 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.
380 380
 </p>
@@ -384,9 +384,9 @@ Web publishing platform with social network like features and good privacy contr
384 384
 </p>
385 385
 </div>
386 386
 </div>
387
-<div id="outline-container-org30916d8" class="outline-2">
388
-<h2 id="org30916d8">IRC Server (ngirc)</h2>
389
-<div class="outline-text-2" id="text-org30916d8">
387
+<div id="outline-container-org85b8a83" class="outline-2">
388
+<h2 id="org85b8a83">IRC Server (ngirc)</h2>
389
+<div class="outline-text-2" id="text-org85b8a83">
390 390
 <p>
391 391
 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.
392 392
 </p>
@@ -396,18 +396,18 @@ Run your own IRC chat channel which can be secured with a password and accessibl
396 396
 </p>
397 397
 </div>
398 398
 </div>
399
-<div id="outline-container-org607f35f" class="outline-2">
400
-<h2 id="org607f35f">Jitsi Meet</h2>
401
-<div class="outline-text-2" id="text-org607f35f">
399
+<div id="outline-container-org65ab5d3" class="outline-2">
400
+<h2 id="org65ab5d3">Jitsi Meet</h2>
401
+<div class="outline-text-2" id="text-org65ab5d3">
402 402
 <p>
403 403
 Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.
404 404
 </p>
405 405
 </div>
406 406
 </div>
407 407
 
408
-<div id="outline-container-orgb507e40" class="outline-2">
409
-<h2 id="orgb507e40">Lychee</h2>
410
-<div class="outline-text-2" id="text-orgb507e40">
408
+<div id="outline-container-org7ff4db3" class="outline-2">
409
+<h2 id="org7ff4db3">Lychee</h2>
410
+<div class="outline-text-2" id="text-org7ff4db3">
411 411
 <p>
412 412
 Make your photo albums available on the web.
413 413
 </p>
@@ -417,9 +417,9 @@ Make your photo albums available on the web.
417 417
 </p>
418 418
 </div>
419 419
 </div>
420
-<div id="outline-container-org189ec3b" class="outline-2">
421
-<h2 id="org189ec3b">Mailpile</h2>
422
-<div class="outline-text-2" id="text-org189ec3b">
420
+<div id="outline-container-org0b2516a" class="outline-2">
421
+<h2 id="org0b2516a">Mailpile</h2>
422
+<div class="outline-text-2" id="text-org0b2516a">
423 423
 <p>
424 424
 Modern email client which supports GPG encryption.
425 425
 </p>
@@ -429,9 +429,9 @@ Modern email client which supports GPG encryption.
429 429
 </p>
430 430
 </div>
431 431
 </div>
432
-<div id="outline-container-org10c7089" class="outline-2">
433
-<h2 id="org10c7089">Matrix</h2>
434
-<div class="outline-text-2" id="text-org10c7089">
432
+<div id="outline-container-org464b4b7" class="outline-2">
433
+<h2 id="org464b4b7">Matrix</h2>
434
+<div class="outline-text-2" id="text-org464b4b7">
435 435
 <p>
436 436
 Multi-user chat with some security and moderation controls.
437 437
 </p>
@@ -441,9 +441,9 @@ Multi-user chat with some security and moderation controls.
441 441
 </p>
442 442
 </div>
443 443
 </div>
444
-<div id="outline-container-org3df846e" class="outline-2">
445
-<h2 id="org3df846e">Mediagoblin</h2>
446
-<div class="outline-text-2" id="text-org3df846e">
444
+<div id="outline-container-org3da94ed" class="outline-2">
445
+<h2 id="org3da94ed">Mediagoblin</h2>
446
+<div class="outline-text-2" id="text-org3da94ed">
447 447
 <p>
448 448
 Publicly host video and audio files so that you don't need to use YouTube/Vimeo/etc.
449 449
 </p>
@@ -453,9 +453,9 @@ Publicly host video and audio files so that you don't need to use YouTube/Vimeo/
453 453
 </p>
454 454
 </div>
455 455
 </div>
456
-<div id="outline-container-org83fee89" class="outline-2">
457
-<h2 id="org83fee89">Mumble</h2>
458
-<div class="outline-text-2" id="text-org83fee89">
456
+<div id="outline-container-orgc8b5bd6" class="outline-2">
457
+<h2 id="orgc8b5bd6">Mumble</h2>
458
+<div class="outline-text-2" id="text-orgc8b5bd6">
459 459
 <p>
460 460
 The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.
461 461
 </p>
@@ -465,9 +465,9 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co
465 465
 </p>
466 466
 </div>
467 467
 </div>
468
-<div id="outline-container-orgde509db" class="outline-2">
469
-<h2 id="orgde509db">NextCloud</h2>
470
-<div class="outline-text-2" id="text-orgde509db">
468
+<div id="outline-container-orge2e9cd1" class="outline-2">
469
+<h2 id="orge2e9cd1">NextCloud</h2>
470
+<div class="outline-text-2" id="text-orge2e9cd1">
471 471
 <p>
472 472
 Store files on your server and sync them with laptops or mobile devices. Includes many plugins including videoconferencing and collaborative document editing.
473 473
 </p>
@@ -477,9 +477,9 @@ Store files on your server and sync them with laptops or mobile devices. Include
477 477
 </p>
478 478
 </div>
479 479
 </div>
480
-<div id="outline-container-org932521c" class="outline-2">
481
-<h2 id="org932521c">PI-Hole</h2>
482
-<div class="outline-text-2" id="text-org932521c">
480
+<div id="outline-container-org03a928d" class="outline-2">
481
+<h2 id="org03a928d">PI-Hole</h2>
482
+<div class="outline-text-2" id="text-org03a928d">
483 483
 <p>
484 484
 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.
485 485
 </p>
@@ -489,9 +489,9 @@ The black hole for web adverts. Block adverts at the domain name level within yo
489 489
 </p>
490 490
 </div>
491 491
 </div>
492
-<div id="outline-container-org2e61ebd" class="outline-2">
493
-<h2 id="org2e61ebd">PostActiv</h2>
494
-<div class="outline-text-2" id="text-org2e61ebd">
492
+<div id="outline-container-org47912c7" class="outline-2">
493
+<h2 id="org47912c7">PostActiv</h2>
494
+<div class="outline-text-2" id="text-org47912c7">
495 495
 <p>
496 496
 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.
497 497
 </p>
@@ -501,9 +501,9 @@ An alternative federated social networking system compatible with GNU Social. It
501 501
 </p>
502 502
 </div>
503 503
 </div>
504
-<div id="outline-container-org5d6ca5c" class="outline-2">
505
-<h2 id="org5d6ca5c">Radicale</h2>
506
-<div class="outline-text-2" id="text-org5d6ca5c">
504
+<div id="outline-container-orgf28761f" class="outline-2">
505
+<h2 id="orgf28761f">Radicale</h2>
506
+<div class="outline-text-2" id="text-orgf28761f">
507 507
 <p>
508 508
 Calendar system compatible with CalDAV and CardDAV. Synch your calendar events easily and securely across all your devices.
509 509
 </p>
@@ -513,9 +513,21 @@ Calendar system compatible with CalDAV and CardDAV. Synch your calendar events e
513 513
 </p>
514 514
 </div>
515 515
 </div>
516
-<div id="outline-container-orge2883dd" class="outline-2">
517
-<h2 id="orge2883dd">SearX</h2>
518
-<div class="outline-text-2" id="text-orge2883dd">
516
+<div id="outline-container-org17a8973" class="outline-2">
517
+<h2 id="org17a8973">Riot Web</h2>
518
+<div class="outline-text-2" id="text-org17a8973">
519
+<p>
520
+A browser based user interface for the Matrix federated communications system, including WebRTC audio and video chat.
521
+</p>
522
+
523
+<p>
524
+<a href="./app_riot.html">How to use it</a>
525
+</p>
526
+</div>
527
+</div>
528
+<div id="outline-container-org8827212" class="outline-2">
529
+<h2 id="org8827212">SearX</h2>
530
+<div class="outline-text-2" id="text-org8827212">
519 531
 <p>
520 532
 A metasearch engine for customised and private web searches.
521 533
 </p>
@@ -525,9 +537,9 @@ A metasearch engine for customised and private web searches.
525 537
 </p>
526 538
 </div>
527 539
 </div>
528
-<div id="outline-container-org543ba26" class="outline-2">
529
-<h2 id="org543ba26">tt-rss</h2>
530
-<div class="outline-text-2" id="text-org543ba26">
540
+<div id="outline-container-org4f37358" class="outline-2">
541
+<h2 id="org4f37358">tt-rss</h2>
542
+<div class="outline-text-2" id="text-org4f37358">
531 543
 <p>
532 544
 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.
533 545
 </p>
@@ -537,9 +549,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a
537 549
 </p>
538 550
 </div>
539 551
 </div>
540
-<div id="outline-container-org2057517" class="outline-2">
541
-<h2 id="org2057517">Syncthing</h2>
542
-<div class="outline-text-2" id="text-org2057517">
552
+<div id="outline-container-org8f9c43d" class="outline-2">
553
+<h2 id="org8f9c43d">Syncthing</h2>
554
+<div class="outline-text-2" id="text-org8f9c43d">
543 555
 <p>
544 556
 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.
545 557
 </p>
@@ -549,9 +561,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h
549 561
 </p>
550 562
 </div>
551 563
 </div>
552
-<div id="outline-container-orgea5c12c" class="outline-2">
553
-<h2 id="orgea5c12c">Tahoe-LAFS</h2>
554
-<div class="outline-text-2" id="text-orgea5c12c">
564
+<div id="outline-container-orgd0043d9" class="outline-2">
565
+<h2 id="orgd0043d9">Tahoe-LAFS</h2>
566
+<div class="outline-text-2" id="text-orgd0043d9">
555 567
 <p>
556 568
 Robust and encrypted storage of files on one or more server.
557 569
 </p>
@@ -561,9 +573,9 @@ Robust and encrypted storage of files on one or more server.
561 573
 </p>
562 574
 </div>
563 575
 </div>
564
-<div id="outline-container-orgf085c9d" class="outline-2">
565
-<h2 id="orgf085c9d">Tox</h2>
566
-<div class="outline-text-2" id="text-orgf085c9d">
576
+<div id="outline-container-org7820aeb" class="outline-2">
577
+<h2 id="org7820aeb">Tox</h2>
578
+<div class="outline-text-2" id="text-org7820aeb">
567 579
 <p>
568 580
 Client and bootstrap node for the Tox chat/VoIP system.
569 581
 </p>
@@ -573,9 +585,9 @@ Client and bootstrap node for the Tox chat/VoIP system.
573 585
 </p>
574 586
 </div>
575 587
 </div>
576
-<div id="outline-container-org1cd1017" class="outline-2">
577
-<h2 id="org1cd1017">Turtl</h2>
578
-<div class="outline-text-2" id="text-org1cd1017">
588
+<div id="outline-container-orgfd1cd79" class="outline-2">
589
+<h2 id="orgfd1cd79">Turtl</h2>
590
+<div class="outline-text-2" id="text-orgfd1cd79">
579 591
 <p>
580 592
 A system for privately creating and sharing notes and images, similar to Evernote but without the spying.
581 593
 </p>
@@ -585,18 +597,18 @@ A system for privately creating and sharing notes and images, similar to Evernot
585 597
 </p>
586 598
 </div>
587 599
 </div>
588
-<div id="outline-container-org5d18482" class="outline-2">
589
-<h2 id="org5d18482">Vim</h2>
590
-<div class="outline-text-2" id="text-org5d18482">
600
+<div id="outline-container-org2264fcd" class="outline-2">
601
+<h2 id="org2264fcd">Vim</h2>
602
+<div class="outline-text-2" id="text-org2264fcd">
591 603
 <p>
592 604
 If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.
593 605
 </p>
594 606
 </div>
595 607
 </div>
596 608
 
597
-<div id="outline-container-orgd0f17c6" class="outline-2">
598
-<h2 id="orgd0f17c6">XMPP</h2>
599
-<div class="outline-text-2" id="text-orgd0f17c6">
609
+<div id="outline-container-orgc47a593" class="outline-2">
610
+<h2 id="orgc47a593">XMPP</h2>
611
+<div class="outline-text-2" id="text-orgc47a593">
600 612
 <p>
601 613
 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.
602 614
 </p>