瀏覽代碼

Documentation for rss reader

Bob Mottram 9 年之前
父節點
當前提交
74d24aa298
共有 2 個文件被更改,包括 149 次插入70 次删除
  1. 28
    0
      doc/EN/usage.org
  2. 121
    70
      website/EN/usage.html

+ 28
- 0
doc/EN/usage.org 查看文件

@@ -25,6 +25,7 @@
25 25
 | [[Microblogging (GNU Social)]]                           |
26 26
 | [[Social Network]]                                       |
27 27
 | [[Chat Services]]                                        |
28
+| [[RSS Reader]]                                           |
28 29
 
29 30
 * Readme
30 31
 After the system has installed a README file will be generated which contains passwords and some brief advice on using the installed systems. You can read this with the following commands:
@@ -302,3 +303,30 @@ Freedombone also supports SIP phones The username and domain is the same as for
302 303
 Return to the <a href="index.html">home page</a>
303 304
 </center>
304 305
 #+END_HTML
306
+* RSS Reader
307
+If you check the readme file within your home directory then you will be able to find out the onion address for the RSS reader which exists on most variants of Freedombone. The address can also be found on the control panel About screen.
308
+
309
+#+BEGIN_SRC bash
310
+ssh username@domainname -p 2222
311
+emacs README
312
+exit
313
+#+END_SRC
314
+
315
+The RSS reader is accessible only via an onion address. This provides a reasonable degree of reading privacy, making it difficult for passive adversaries such as governments or corporations to create lists of sites which you are subscribed to.
316
+
317
+To set up the system open http://rss_reader_onion_address/ and enter:
318
+
319
+ * Database type: MySQL
320
+ * Username: root
321
+ * Password: [MariaDB database root password]
322
+ * Database name: ttrss
323
+ * Host name: localhost
324
+ * Port: 3306
325
+ * Tiny Tint RSS URL: http://rss_reader_onion_address/
326
+
327
+Click *Test configuration* and then *Initialize database*. You may need to click *Save configuration*.
328
+Initially log in with username *admin* and password *password*.
329
+
330
+Then go to *Preferences/Users*, click on the *admin* user and then change the password. You will immediately see what looks like an authorisation error, so log out and log back in with username "admin" and your new password.
331
+
332
+To access the RSS reader from a mobile device you can install a Tor compatible browser such as [[https://f-droid.org/wiki/page/info.guardianproject.orfox][OrFox]]. It will try to automatically change to the mobile version of the user interface, but if that doesn't work then navigate to http://rss_reader_onion_address/mobile.

+ 121
- 70
website/EN/usage.html 查看文件

@@ -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
-<!-- 2016-02-03 Wed 16:32 -->
6
+<!-- 2016-02-08 Mon 15:52 -->
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>
@@ -205,6 +205,10 @@ for the JavaScript code in this tag.
205 205
 <tr>
206 206
 <td class="org-left"><a href="#orgheadline8">Chat Services</a></td>
207 207
 </tr>
208
+
209
+<tr>
210
+<td class="org-left"><a href="#orgheadline9">RSS Reader</a></td>
211
+</tr>
208 212
 </tbody>
209 213
 </table>
210 214
 
@@ -322,9 +326,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ
322 326
 <div id="outline-container-orgheadline4" class="outline-2">
323 327
 <h2 id="orgheadline4">Syncing to the Cloud</h2>
324 328
 <div class="outline-text-2" id="text-orgheadline4">
325
-</div><div id="outline-container-orgheadline9" class="outline-3">
326
-<h3 id="orgheadline9">Initial install</h3>
327
-<div class="outline-text-3" id="text-orgheadline9">
329
+</div><div id="outline-container-orgheadline10" class="outline-3">
330
+<h3 id="orgheadline10">Initial install</h3>
331
+<div class="outline-text-3" id="text-orgheadline10">
328 332
 <p>
329 333
 Within a browser go to your owncloud domain, then create an administrator account. The username and password can be anything, and ideally should be generated from a password manager.
330 334
 </p>
@@ -368,9 +372,9 @@ Log out from the administrator account and then log back in as the user you just
368 372
 </p>
369 373
 </div>
370 374
 </div>
371
-<div id="outline-container-orgheadline10" class="outline-3">
372
-<h3 id="orgheadline10">On Android</h3>
373
-<div class="outline-text-3" id="text-orgheadline10">
375
+<div id="outline-container-orgheadline11" class="outline-3">
376
+<h3 id="orgheadline11">On Android</h3>
377
+<div class="outline-text-3" id="text-orgheadline11">
374 378
 <p>
375 379
 Within F-droid search for <b>owncloud</b> and install the client. Also install <b>CalDAV Sync Adapter</b>.
376 380
 </p>
@@ -394,9 +398,9 @@ You will also be prompted to enter login details. Your Android and Owncloud cale
394 398
 </p>
395 399
 </div>
396 400
 </div>
397
-<div id="outline-container-orgheadline11" class="outline-3">
398
-<h3 id="orgheadline11">On Linux</h3>
399
-<div class="outline-text-3" id="text-orgheadline11">
401
+<div id="outline-container-orgheadline12" class="outline-3">
402
+<h3 id="orgheadline12">On Linux</h3>
403
+<div class="outline-text-3" id="text-orgheadline12">
400 404
 <p>
401 405
 Open your software center and search for "owncloud client". Enter your owncloud domain name (with the https prefix) and login details.
402 406
 </p>
@@ -410,9 +414,9 @@ You can now drag files into the <b>~/owncloud</b> directory and they will automa
410 414
 <div id="outline-container-orgheadline5" class="outline-2">
411 415
 <h2 id="orgheadline5">Play Music</h2>
412 416
 <div class="outline-text-2" id="text-orgheadline5">
413
-</div><div id="outline-container-orgheadline12" class="outline-3">
414
-<h3 id="orgheadline12">With the DLNA service</h3>
415
-<div class="outline-text-3" id="text-orgheadline12">
417
+</div><div id="outline-container-orgheadline13" class="outline-3">
418
+<h3 id="orgheadline13">With the DLNA service</h3>
419
+<div class="outline-text-3" id="text-orgheadline13">
416 420
 <p>
417 421
 An easy way to play music on any mobile device in your home is to use the DLNA service. Copy your music into a directory called "<i>Music</i>" on a USB thumb drive and then insert it into from socket on the Beaglebone.
418 422
 </p>
@@ -452,9 +456,9 @@ The DLNA service will only work within your local home network, and isn't remote
452 456
 </div>
453 457
 </div>
454 458
 
455
-<div id="outline-container-orgheadline13" class="outline-3">
456
-<h3 id="orgheadline13">With Owncloud</h3>
457
-<div class="outline-text-3" id="text-orgheadline13">
459
+<div id="outline-container-orgheadline14" class="outline-3">
460
+<h3 id="orgheadline14">With Owncloud</h3>
461
+<div class="outline-text-3" id="text-orgheadline14">
458 462
 <p>
459 463
 The main advantage of playing music via Owncloud is that you can do that from anywhere - not only within your home network.
460 464
 </p>
@@ -469,9 +473,9 @@ By default a music player is installed into Owncloud, so all you need to do is t
469 473
 <div id="outline-container-orgheadline6" class="outline-2">
470 474
 <h2 id="orgheadline6">Microblogging (GNU Social)</h2>
471 475
 <div class="outline-text-2" id="text-orgheadline6">
472
-</div><div id="outline-container-orgheadline14" class="outline-3">
473
-<h3 id="orgheadline14">Initial configuration</h3>
474
-<div class="outline-text-3" id="text-orgheadline14">
476
+</div><div id="outline-container-orgheadline15" class="outline-3">
477
+<h3 id="orgheadline15">Initial configuration</h3>
478
+<div class="outline-text-3" id="text-orgheadline15">
475 479
 <p>
476 480
 To log into your GNU Social site first obtain your username and password from the "microblogging" section of the readme file.
477 481
 </p>
@@ -493,17 +497,17 @@ Navigate to your site and log in. You may then want to select <b>Admin</b> and c
493 497
 <div id="outline-container-orgheadline7" class="outline-2">
494 498
 <h2 id="orgheadline7">Social Network</h2>
495 499
 <div class="outline-text-2" id="text-orgheadline7">
496
-</div><div id="outline-container-orgheadline15" class="outline-3">
497
-<h3 id="orgheadline15">Domains</h3>
498
-<div class="outline-text-3" id="text-orgheadline15">
500
+</div><div id="outline-container-orgheadline16" class="outline-3">
501
+<h3 id="orgheadline16">Domains</h3>
502
+<div class="outline-text-3" id="text-orgheadline16">
499 503
 <p>
500 504
 Both Hubzilla and GNU Social try to obtain certificates automatically at the time of installation via Let's Encrypt. This will likely mean that in order for this to work you'll need to have obtained at least one "official" domain via a domain selling service, since Let's Encrypt mostly doesn't seem to work with free subdomains from sites such as freeDNS.
501 505
 </p>
502 506
 </div>
503 507
 </div>
504
-<div id="outline-container-orgheadline16" class="outline-3">
505
-<h3 id="orgheadline16">Initial install</h3>
506
-<div class="outline-text-3" id="text-orgheadline16">
508
+<div id="outline-container-orgheadline17" class="outline-3">
509
+<h3 id="orgheadline17">Initial install</h3>
510
+<div class="outline-text-3" id="text-orgheadline17">
507 511
 <p>
508 512
 Visit the URL of your Hubzilla site and you should be taken through the rest of the installation procedure.  Note that this may take a few minutes so don't be concerned if it looks as if it has crashed - just leave it running.
509 513
 </p>
@@ -517,16 +521,16 @@ When installation is complete you can register a new user.
517 521
 <div id="outline-container-orgheadline8" class="outline-2">
518 522
 <h2 id="orgheadline8">Chat Services</h2>
519 523
 <div class="outline-text-2" id="text-orgheadline8">
520
-</div><div id="outline-container-orgheadline17" class="outline-3">
521
-<h3 id="orgheadline17">IRC</h3>
522
-<div class="outline-text-3" id="text-orgheadline17">
524
+</div><div id="outline-container-orgheadline18" class="outline-3">
525
+<h3 id="orgheadline18">IRC</h3>
526
+<div class="outline-text-3" id="text-orgheadline18">
523 527
 <p>
524 528
 IRC is useful for multi-user chat. The classic use case is for software development where many engineers might need to coordinate their activities, but it's also useful for meetings, parties and general socialising.
525 529
 </p>
526 530
 </div>
527
-<div id="outline-container-orgheadline18" class="outline-4">
528
-<h4 id="orgheadline18">Irssi</h4>
529
-<div class="outline-text-4" id="text-orgheadline18">
531
+<div id="outline-container-orgheadline19" class="outline-4">
532
+<h4 id="orgheadline19">Irssi</h4>
533
+<div class="outline-text-4" id="text-orgheadline19">
530 534
 <p>
531 535
 If you are using the <a href="http://www.irssi.org/">irssi</a> IRC client then you can use the following commands to connect to your IRC server.
532 536
 </p>
@@ -540,9 +544,9 @@ If you are using the <a href="http://www.irssi.org/">irssi</a> IRC client then y
540 544
 </div>
541 545
 </div>
542 546
 </div>
543
-<div id="outline-container-orgheadline19" class="outline-4">
544
-<h4 id="orgheadline19">XChat</h4>
545
-<div class="outline-text-4" id="text-orgheadline19">
547
+<div id="outline-container-orgheadline20" class="outline-4">
548
+<h4 id="orgheadline20">XChat</h4>
549
+<div class="outline-text-4" id="text-orgheadline20">
546 550
 <p>
547 551
 If you are using the XChat client:
548 552
 </p>
@@ -578,12 +582,12 @@ Click <b>close</b> and then <b>connect</b>.
578 582
 </div>
579 583
 </div>
580 584
 
581
-<div id="outline-container-orgheadline25" class="outline-3">
582
-<h3 id="orgheadline25">XMPP/Jabber</h3>
583
-<div class="outline-text-3" id="text-orgheadline25">
584
-</div><div id="outline-container-orgheadline20" class="outline-4">
585
-<h4 id="orgheadline20">Managing users</h4>
586
-<div class="outline-text-4" id="text-orgheadline20">
585
+<div id="outline-container-orgheadline26" class="outline-3">
586
+<h3 id="orgheadline26">XMPP/Jabber</h3>
587
+<div class="outline-text-3" id="text-orgheadline26">
588
+</div><div id="outline-container-orgheadline21" class="outline-4">
589
+<h4 id="orgheadline21">Managing users</h4>
590
+<div class="outline-text-4" id="text-orgheadline21">
587 591
 <p>
588 592
 To add a user:
589 593
 </p>
@@ -642,9 +646,9 @@ prosodyctl status
642 646
 </div>
643 647
 </div>
644 648
 
645
-<div id="outline-container-orgheadline21" class="outline-4">
646
-<h4 id="orgheadline21">Using with Jitsi</h4>
647
-<div class="outline-text-4" id="text-orgheadline21">
649
+<div id="outline-container-orgheadline22" class="outline-4">
650
+<h4 id="orgheadline22">Using with Jitsi</h4>
651
+<div class="outline-text-4" id="text-orgheadline22">
648 652
 <p>
649 653
 Jitsi is the recommended communications client for desktop or laptop systems, since it includes the <i>off the record</i> (OTR) feature which provides some additional security beyond the usual SSL certificates.
650 654
 </p>
@@ -674,9 +678,9 @@ You can also <a href="https://www.youtube.com/watch?v=vgx7VSrDGjk">see this vide
674 678
 </p>
675 679
 </div>
676 680
 </div>
677
-<div id="outline-container-orgheadline22" class="outline-4">
678
-<h4 id="orgheadline22">Using with Ubuntu</h4>
679
-<div class="outline-text-4" id="text-orgheadline22">
681
+<div id="outline-container-orgheadline23" class="outline-4">
682
+<h4 id="orgheadline23">Using with Ubuntu</h4>
683
+<div class="outline-text-4" id="text-orgheadline23">
680 684
 <p>
681 685
 The default XMPP client in Ubuntu is Empathy.  Using Empathy isn't as secure as using Jitsi, since it doesn't include the <i>off the record</i> feature, but since it's the default it's what many users will have easy access to.
682 686
 </p>
@@ -694,17 +698,17 @@ Click on <b>Advanced</b> and make sure that <b>Encryption required</b> and <b>Ig
694 698
 </p>
695 699
 </div>
696 700
 </div>
697
-<div id="outline-container-orgheadline23" class="outline-4">
698
-<h4 id="orgheadline23">Using Tor Messenger</h4>
699
-<div class="outline-text-4" id="text-orgheadline23">
701
+<div id="outline-container-orgheadline24" class="outline-4">
702
+<h4 id="orgheadline24">Using Tor Messenger</h4>
703
+<div class="outline-text-4" id="text-orgheadline24">
700 704
 <p>
701 705
 Tor Messenger is a messaging client which supports XMPP, and its onion routing enables you to protect the metadata of chat interactions to some extent by making it difficult for an adversary to know which server is talking to which. You can download Tor Messenger from <a href="https://torproject.org/">torproject.org</a> and the setup is pretty simple.
702 706
 </p>
703 707
 </div>
704 708
 </div>
705
-<div id="outline-container-orgheadline24" class="outline-4">
706
-<h4 id="orgheadline24">Using with Android</h4>
707
-<div class="outline-text-4" id="text-orgheadline24">
709
+<div id="outline-container-orgheadline25" class="outline-4">
710
+<h4 id="orgheadline25">Using with Android</h4>
711
+<div class="outline-text-4" id="text-orgheadline25">
708 712
 <p>
709 713
 Install <a href="https://f-droid.org/">F-Droid</a>
710 714
 </p>
@@ -731,16 +735,16 @@ Go back to the initial screen and then using the menu you can add contacts and b
731 735
 </div>
732 736
 </div>
733 737
 </div>
734
-<div id="outline-container-orgheadline26" class="outline-3">
735
-<h3 id="orgheadline26">Tox</h3>
736
-<div class="outline-text-3" id="text-orgheadline26">
738
+<div id="outline-container-orgheadline27" class="outline-3">
739
+<h3 id="orgheadline27">Tox</h3>
740
+<div class="outline-text-3" id="text-orgheadline27">
737 741
 <p>
738 742
 Tox is an encrypted peer-to-peer messaging system and so should work without Freedombone. It uses a system of nodes which act as a sort of directory service allowing users to find and connect to each other. The Tox node ID on the Freedombone can be found within the README within your home directory. If you have other users connect to your node then you will be able to continue chatting even when no other nodes are available.
739 743
 </p>
740 744
 </div>
741
-<div id="outline-container-orgheadline27" class="outline-4">
742
-<h4 id="orgheadline27">Using the Toxic client</h4>
743
-<div class="outline-text-4" id="text-orgheadline27">
745
+<div id="outline-container-orgheadline28" class="outline-4">
746
+<h4 id="orgheadline28">Using the Toxic client</h4>
747
+<div class="outline-text-4" id="text-orgheadline28">
744 748
 <p>
745 749
 To connect to your node use the command:
746 750
 </p>
@@ -753,12 +757,12 @@ To connect to your node use the command:
753 757
 </div>
754 758
 </div>
755 759
 </div>
756
-<div id="outline-container-orgheadline30" class="outline-3">
757
-<h3 id="orgheadline30">VoIP (Voice chat)</h3>
758
-<div class="outline-text-3" id="text-orgheadline30">
759
-</div><div id="outline-container-orgheadline28" class="outline-4">
760
-<h4 id="orgheadline28">Using with Ubuntu</h4>
761
-<div class="outline-text-4" id="text-orgheadline28">
760
+<div id="outline-container-orgheadline31" class="outline-3">
761
+<h3 id="orgheadline31">VoIP (Voice chat)</h3>
762
+<div class="outline-text-3" id="text-orgheadline31">
763
+</div><div id="outline-container-orgheadline29" class="outline-4">
764
+<h4 id="orgheadline29">Using with Ubuntu</h4>
765
+<div class="outline-text-4" id="text-orgheadline29">
762 766
 <p>
763 767
 Within the software center search for "mumble" and install the client then run it. Skip through the audio setup wizard.
764 768
 </p>
@@ -772,9 +776,9 @@ Click on "add new" to add a new server and enter the default domain name for the
772 776
 </p>
773 777
 </div>
774 778
 </div>
775
-<div id="outline-container-orgheadline29" class="outline-4">
776
-<h4 id="orgheadline29">Using with Android</h4>
777
-<div class="outline-text-4" id="text-orgheadline29">
779
+<div id="outline-container-orgheadline30" class="outline-4">
780
+<h4 id="orgheadline30">Using with Android</h4>
781
+<div class="outline-text-4" id="text-orgheadline30">
778 782
 <p>
779 783
 Install <a href="https://f-droid.org/">F-Droid</a>
780 784
 </p>
@@ -801,9 +805,9 @@ Selecting the server by pressing on it then connects you to the server so that y
801 805
 </div>
802 806
 </div>
803 807
 </div>
804
-<div id="outline-container-orgheadline31" class="outline-3">
805
-<h3 id="orgheadline31">SIP phones</h3>
806
-<div class="outline-text-3" id="text-orgheadline31">
808
+<div id="outline-container-orgheadline32" class="outline-3">
809
+<h3 id="orgheadline32">SIP phones</h3>
810
+<div class="outline-text-3" id="text-orgheadline32">
807 811
 <p>
808 812
 Freedombone also supports SIP phones The username and domain is the same as for your email address, and the SIP password and extension number will appear within the README file in your home directory. Various SIP client options are available, such as CSipSimple on Android and Jitsi on desktop or laptop machines. Ideally use clients which support ZRTP, which will provide the best level of security.
809 813
 </p>
@@ -814,6 +818,53 @@ Return to the <a href="index.html">home page</a>
814 818
 </div>
815 819
 </div>
816 820
 </div>
821
+<div id="outline-container-orgheadline9" class="outline-2">
822
+<h2 id="orgheadline9">RSS Reader</h2>
823
+<div class="outline-text-2" id="text-orgheadline9">
824
+<p>
825
+If you check the readme file within your home directory then you will be able to find out the onion address for the RSS reader which exists on most variants of Freedombone. The address can also be found on the control panel About screen.
826
+</p>
827
+
828
+<div class="org-src-container">
829
+
830
+<pre class="src src-bash">ssh username@domainname -p 2222
831
+emacs README
832
+<span class="org-keyword">exit</span>
833
+</pre>
834
+</div>
835
+
836
+<p>
837
+The RSS reader is accessible only via an onion address. This provides a reasonable degree of reading privacy, making it difficult for passive adversaries such as governments or corporations to create lists of sites which you are subscribed to.
838
+</p>
839
+
840
+<p>
841
+To set up the system open <a href="http://rss_reader_onion_address/">http://rss_reader_onion_address/</a> and enter:
842
+</p>
843
+
844
+<ul class="org-ul">
845
+<li>Database type: MySQL</li>
846
+<li>Username: root</li>
847
+<li>Password: [MariaDB database root password]</li>
848
+<li>Database name: ttrss</li>
849
+<li>Host name: localhost</li>
850
+<li>Port: 3306</li>
851
+<li>Tiny Tint RSS URL: <a href="http://rss_reader_onion_address/">http://rss_reader_onion_address/</a></li>
852
+</ul>
853
+
854
+<p>
855
+Click <b>Test configuration</b> and then <b>Initialize database</b>. You may need to click <b>Save configuration</b>.
856
+Initially log in with username <b>admin</b> and password <b>password</b>.
857
+</p>
858
+
859
+<p>
860
+Then go to <b>Preferences/Users</b>, click on the <b>admin</b> user and then change the password. You will immediately see what looks like an authorisation error, so log out and log back in with username "admin" and your new password.
861
+</p>
862
+
863
+<p>
864
+To access the RSS reader from a mobile device you can install a Tor compatible browser such as <a href="https://f-droid.org/wiki/page/info.guardianproject.orfox">OrFox</a>. It will try to automatically change to the mobile version of the user interface, but if that doesn't work then navigate to <a href="http://rss_reader_onion_address/mobile">http://rss_reader_onion_address/mobile</a>.
865
+</p>
866
+</div>
867
+</div>
817 868
 </div>
818 869
 <div id="postamble" class="status">
819 870