Browse Source

Update documentation for rss reader

Bob Mottram 9 years ago
parent
commit
9021c1e801
2 changed files with 17 additions and 39 deletions
  1. 7
    17
      doc/EN/usage.org
  2. 10
    22
      website/EN/usage.html

+ 7
- 17
doc/EN/usage.org View File

324
 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.
324
 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.
325
 
325
 
326
 * RSS Reader
326
 * RSS Reader
327
-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.
327
+The way that RSS reading is set up on Freedombone gives you strong reading privacy. Not only is there onion routing between you and the server but also between the server and the source of the RSS feed. The only down side is that many RSS feeds are still http only, and so could be vulnerable to injection attacks, but it's expected that more of this will go to https in the foreseeable future due to a combination of growing recognition of security issues and systems like Let's Encrypt which make obtaining certificates much easier.
328
+
329
+See the control panel for the RSS reader onion address.
328
 
330
 
329
 #+BEGIN_SRC bash
331
 #+BEGIN_SRC bash
330
 ssh username@domainname -p 2222
332
 ssh username@domainname -p 2222
331
-emacs README
332
-exit
333
+sudo control
333
 #+END_SRC
334
 #+END_SRC
334
 
335
 
335
-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.
336
+Then select the *About* screen.
336
 
337
 
337
-To set up the system open http://rss_reader_onion_address/ and enter:
338
-
339
- * Database type: MySQL
340
- * Username: root
341
- * Password: [MariaDB database root password]
342
- * Database name: ttrss
343
- * Host name: localhost
344
- * Port: 3306
345
- * Tiny Tint RSS URL: http://rss_reader_onion_address/
346
-
347
-Click *Test configuration* and then *Initialize database*. You may need to click *Save configuration*.
348
-Initially log in with username *admin* and password *password*.
338
+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.
349
 
339
 
350
-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.
340
+To set up the system open http://rss_reader_onion_address/. Initially log in with username *admin* and password *password*. 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.
351
 
341
 
352
 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.
342
 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.
353
 
343
 

+ 10
- 22
website/EN/usage.html View File

3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
 <head>
5
 <head>
6
-<!-- 2016-02-15 Mon 09:15 -->
6
+<!-- 2016-02-23 Tue 11:45 -->
7
 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
7
 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
 <meta  name="viewport" content="width=device-width, initial-scale=1" />
8
 <meta  name="viewport" content="width=device-width, initial-scale=1" />
9
 <title></title>
9
 <title></title>
858
 <h2 id="orgheadline9">RSS Reader</h2>
858
 <h2 id="orgheadline9">RSS Reader</h2>
859
 <div class="outline-text-2" id="text-orgheadline9">
859
 <div class="outline-text-2" id="text-orgheadline9">
860
 <p>
860
 <p>
861
-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.
861
+The way that RSS reading is set up on Freedombone gives you strong reading privacy. Not only is there onion routing between you and the server but also between the server and the source of the RSS feed. The only down side is that many RSS feeds are still http only, and so could be vulnerable to injection attacks, but it's expected that more of this will go to https in the foreseeable future due to a combination of growing recognition of security issues and systems like Let's Encrypt which make obtaining certificates much easier.
862
+</p>
863
+
864
+<p>
865
+See the control panel for the RSS reader onion address.
862
 </p>
866
 </p>
863
 
867
 
864
 <div class="org-src-container">
868
 <div class="org-src-container">
865
 
869
 
866
 <pre class="src src-bash">ssh username@domainname -p 2222
870
 <pre class="src src-bash">ssh username@domainname -p 2222
867
-emacs README
868
-<span class="org-keyword">exit</span>
871
+sudo control
869
 </pre>
872
 </pre>
870
 </div>
873
 </div>
871
 
874
 
872
 <p>
875
 <p>
873
-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.
876
+Then select the <b>About</b> screen.
874
 </p>
877
 </p>
875
 
878
 
876
 <p>
879
 <p>
877
-To set up the system open <a href="http://rss_reader_onion_address/">http://rss_reader_onion_address/</a> and enter:
878
-</p>
879
-
880
-<ul class="org-ul">
881
-<li>Database type: MySQL</li>
882
-<li>Username: root</li>
883
-<li>Password: [MariaDB database root password]</li>
884
-<li>Database name: ttrss</li>
885
-<li>Host name: localhost</li>
886
-<li>Port: 3306</li>
887
-<li>Tiny Tint RSS URL: <a href="http://rss_reader_onion_address/">http://rss_reader_onion_address/</a></li>
888
-</ul>
889
-
890
-<p>
891
-Click <b>Test configuration</b> and then <b>Initialize database</b>. You may need to click <b>Save configuration</b>.
892
-Initially log in with username <b>admin</b> and password <b>password</b>.
880
+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.
893
 </p>
881
 </p>
894
 
882
 
895
 <p>
883
 <p>
896
-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.
884
+To set up the system open <a href="http://rss_reader_onion_address/">http://rss_reader_onion_address/</a>. Initially log in with username <b>admin</b> and password <b>password</b>. 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.
897
 </p>
885
 </p>
898
 
886
 
899
 <p>
887
 <p>