nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-02-04 08:13:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: Link to manual from each service

Browse Source 
Closes #930

- Make targets to download wiki pages of each service

- Add post-processor script for DocBook file processing

Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Joseph Nuthalapati 2018-03-01 11:32:09 +05:30 committed by James Valleroy
parent c6bccaaac0
commit 4064d6e231
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
128 changed files with 14994 additions and 1539 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

231
doc/Configure.raw.xml Normal file
View File

@ -0,0 +1,231 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Configure</title>
<revhistory>
<revision>
<revnumber>3</revnumber>
<date>2016-12-31 04:11:43</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>mention how domain name is used</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-12-31 04:07:26</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>fix outline</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 16:35:55</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Configure</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Configure</title>
<para>Configure covers a couple of general topics: </para>
<orderedlist numeration="arabic">
<listitem>
<para>Hostname </para>
<itemizedlist>
<listitem override="none">
<para>Hostname is the local name by which other devices on the local network can reach your FreedomBox. Default is <emphasis>freedombox</emphasis>. </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Domain Name </para>
<itemizedlist>
<listitem override="none">
<para>Domain name is the global name by which other devices on the Internet can reach your FreedomBox. The value set here is used by the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Manual/XMPP#">Chat Server (XMPP)</ulink>, <ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Manual/LetsEncrypt#">Certificates (Let's Encrypt)</ulink>, and <ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Manual/Monkeysphere#">Monkeysphere</ulink>. </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Language </para>
<itemizedlist>
<listitem override="none">
<para>Language for the web administration interface Plinth </para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Configure/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

261
doc/Coquelicot.raw.xml Normal file
View File

@ -0,0 +1,261 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Coquelicot</title>
<revhistory>
<revision>
<revnumber>5</revnumber>
<date>2018-03-05 09:15:01</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>coquelicot: Fix broken links</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2018-02-26 17:14:51</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>included in 0.24</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2018-02-12 23:48:10</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>bump version</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2018-02-12 23:47:14</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>replace fancy quote characters with plain quote characters</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2018-02-10 03:14:55</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Create new page for Coquelicot</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>File Sharing (Coquelicot)</title>
<section>
<title>About Coquelicot</title>
<para>Coquelicot is a "one-click" file sharing web application with a focus on protecting users' privacy. </para>
<para>Read more about Coquelicot at <ulink url="https://coquelicot.potager.org/README">the Coquelicot README</ulink> </para>
<para><emphasis role="strong">Available since:</emphasis> version 0.24.0 </para>
</section>
<section>
<title>When to use Coquelicot</title>
<para>Coquelicot is best used to quickly share a single file. If you want to share a folder, </para>
<orderedlist numeration="arabic">
<listitem>
<para>for a single use, compress the folder and share it over Coquelicot </para>
</listitem>
<listitem>
<para>which must be kept synchronized between computers, use <ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Manual/Syncthing#">Syncthing</ulink> instead </para>
</listitem>
</orderedlist>
<para>Coquelicot can only provide a reasonable degree of privacy. If anonymity is required, you should consider using the desktop application <ulink url="https://onionshare.org/">Onionshare</ulink> instead. </para>
<para>Since Coquelicot fully uploads the file to the server, your FreedomBox will incur both upload and download bandwidth costs. For very large files, consider sharing them using BitTorrent by creating a private torrent file. If anonymity is required, use Onionshare. It is P2P and doesn't require a server. </para>
</section>
<section>
<title>Coquelicot on FreedomBox</title>
<para>With Coquelicot installed, you can upload files to your FreedomBox server and privately share them. </para>
<para>Post installation, the Coquelicot page offers two settings. </para>
<orderedlist numeration="arabic">
<listitem>
<para><emphasis role="strong">Upload Password</emphasis>: Coquelicot on FreedomBox is currently configured to use simple password authentication for ease of use. Remember that it's one global password for this Coquelicot instance and not your user password for FreedomBox. You need not remember this password. You can set a new one from the Plinth interface anytime. </para>
</listitem>
<listitem>
<para><emphasis role="strong">Maximum File Size</emphasis>: You can alter the maximum size of the file that can be transferred through Coquelicot using this setting. The size is in <ulink url="https://en.wikipedia.org/wiki/Mebibyte">Mebibytes</ulink>. The maximum file size is only limited by the disk size of your FreedomBox. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Privacy</title>
<para>Someone monitoring your network traffic might find out that some file is being transferred through your FreedomBox and also possibly its size, but will not know the file name. Coquelicot encrypts files on the server and also fills the file contents with 0s when deleting them. This eliminates the risk of file contents being revealed in the event of your FreedomBox being confiscated or stolen. The real risk to mitigate here is a third-party also downloading your file along with the intended recipient. </para>
<section>
<title>Sharing over instant messengers</title>
<para>Some instant messengers which have previews for websites might download your file in order to show a preview in the conversation. If you set the option of one-time download on a file, you might notice that the one download will be used up by the instant messenger. If sharing over such messengers, please use a download password in combination with a one-time download option. </para>
</section>
<section>
<title>Sharing download links privately</title>
<para>It is recommended to share your file download links and download passwords over encrypted channels. You can simply avoid all the above problems with instant messenger previews by using instant messengers that support encrypted conversations like Riot with <ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Manual/MatrixSynapse#">Matrix Synapse</ulink> or <ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Manual/ejabberd#">XMPP</ulink> (ejabberd server on FreedomBox) with clients that support end-to-end encryption. Send the download link and the download password in two separate messages (helps if your messenger supports perfect forward secrecy like XMPP with OTR). You can also share your links over PGP-encrypted email using <ulink url="https://securityinabox.org/en/guide/thunderbird/linux/">Thunderbird</ulink>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Coquelicot/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</section>
</article>

210
doc/DateTime.raw.xml Normal file
View File

@ -0,0 +1,210 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/DateTime</title>
<revhistory>
<revision>
<revnumber>2</revnumber>
<date>2017-03-31 20:20:57</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screenshot DateTime</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 09:26:45</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Date &amp; Time</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Date &amp; Time</title>
<para>This network time server is a program that maintains the system time in synchronization with servers on the Internet. </para>
<para>You can select your time zone by picking a big city nearby (they are sorted by <emphasis>Continent/City</emphasis>) or select directly the zone with respect to GMT (Greenwich Mean Time). </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/DateTime?action=AttachFile&amp;do=get&amp;target=DateTime.png"/>
</imageobject>
<textobject>
<phrase>DateTime.png</phrase>
</textobject>
</inlinemediaobject>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DateTime/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

308
doc/Deluge.raw.xml Normal file
View File

@ -0,0 +1,308 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Deluge</title>
<revhistory>
<revision>
<revnumber>11</revnumber>
<date>2016-12-31 01:32:15</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add initial setup directions</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2016-12-30 19:20:00</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>reword</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-12-30 19:14:16</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add intro paragraph</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-12-30 19:00:50</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>no space in "BitTorrent"</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-12-26 18:07:46</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add screenshot</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-09-01 19:05:24</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-04-10 07:26:48</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-12-15 20:41:02</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-12-15 20:40:16</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 18:16:28</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Deluge definition</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 16:59:01</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Created new Deluge page for manual</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>BitTorrent (Deluge)</title>
<section>
<title>What is Deluge?</title>
<para>BitTorrent is a communications protocol using peer-to-peer (P2P) file sharing. It is not anonymous; you should assume that others can see what files you are sharing. There are two BitTorrent web clients available in FreedomBox: <ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Manual/Transmission#">Transmission</ulink> and Deluge. They have similar features, but you may prefer one over the other. </para>
<para>Deluge is a lightweight BitTorrent client that is highly configurable. Additional functionality can be added by installing plugins. </para>
</section>
<section>
<title>Screenshot</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Deluge?action=AttachFile&amp;do=get&amp;target=deluge.png" width="800"/>
</imageobject>
<textobject>
<phrase>Deluge Web UI</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Initial Setup</title>
<para>After installing Deluge, it can be accessed by pointing your browser to <code>https://&lt;your freedombox&gt;/deluge</code>. You will need to enter a password to login: </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Deluge?action=AttachFile&amp;do=get&amp;target=deluge_login.png"/>
</imageobject>
<textobject>
<phrase>Deluge Login</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>The initial password is "deluge". The first time that you login, Deluge will ask if you wish to change the password. You should change it to something that is harder to guess. </para>
<para>Next you will be shown the connection manager. Click on the first entry (Offline - 127.0.0.1:58846). Then click "Start Daemon" to start the Deluge service that will run in the background. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Deluge?action=AttachFile&amp;do=get&amp;target=deluge_connection_manager.png"/>
</imageobject>
<textobject>
<phrase>Deluge Connection Manager (Offline)</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>Now it should say "Online". Click "Connect" to complete the setup. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Deluge?action=AttachFile&amp;do=get&amp;target=deluge_connection_manager_2.png"/>
</imageobject>
<textobject>
<phrase>Deluge Connection Manager (Online)</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>At this point, you are ready to begin using Deluge. You can make further changes in the Preferences, or add a torrent file or URL. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Deluge/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

194
doc/Diagnostics.raw.xml Normal file
View File

@ -0,0 +1,194 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Diagnostics</title>
<revhistory>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 09:43:52</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Diagnostics</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Diagnostics</title>
<para>The system diagnostic test will run a number of checks on your system to confirm that applications and services are working as expected. </para>
<para>Just click <emphasis>Run Diagnostics</emphasis>. This may take some minutes. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Diagnostics/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

398
doc/DynamicDNS.raw.xml Normal file
View File

@ -0,0 +1,398 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/DynamicDNS</title>
<revhistory>
<revision>
<revnumber>14</revnumber>
<date>2018-03-11 03:11:04</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized image</revremark>
</revision>
<revision>
<revnumber>13</revnumber>
<date>2017-03-31 20:35:42</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>updated screenshot</revremark>
</revision>
<revision>
<revnumber>12</revnumber>
<date>2016-09-09 15:40:08</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor indentation fix with screenshot</revremark>
</revision>
<revision>
<revnumber>11</revnumber>
<date>2016-09-01 19:18:48</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2016-08-15 18:46:51</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screenshot GNU-DIP</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-04-14 14:22:41</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added accurate How to create a DNS name with GnuDIP</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-04-10 07:15:47</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-01-11 06:28:36</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2015-12-15 18:48:25</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added definition title to Dynamic DNS page</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2015-09-13 15:02:37</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Demote headings one level for inclusion into manual</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-09-13 13:14:41</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Move DynamicDNS page to manual</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-08-13 13:03:13</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add more introduction and re-organize.</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-08-09 21:38:52</date>
<authorinitials>DanielSteglich</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-08-09 21:23:48</date>
<authorinitials>DanielSteglich</authorinitials>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Dynamic DNS Client</title>
<section>
<title>What is Dynamic DNS?</title>
<para>In order to reach a server on the Internet, the server needs to have permanent address also know as the static IP address. Many Internet service providers don't provide home users with a static IP address or they charge more providing a static IP address. Instead they provide the home user with an IP address that changes every time the user connects to the Internet. Clients wishing to contact the server will have difficulty reaching the server. </para>
<para>Dynamic DNS service providers assist in working around a problem. First they provide you with a domain name, such as 'myhost.example.org'. Then they associate your IP address, whenever it changes, with this domain name. Then anyone intending to reach the server will be to contact the server using the domain name 'myhost.example.org' which always points to the latest IP address of the server. </para>
<para>For this to work, every time you connect to the Internet, you will have to tell your Dynamic DNS provider what your current IP address is. Hence you need special software on your server to perform this operation. The Dynamic DNS function in FreedomBox will allow users without a static public IP address to push the current public IP address to a Dynamic DNS Server. This allows you to expose services on FreedomBox, such as ownCloud, to the Internet. </para>
</section>
<section>
<title>GnuDIP vs. Update URL</title>
<para>There are two main mechanism to notify the Dynamic DNS server of your new IP address; using the <emphasis>GnuDIP</emphasis> protocol and using the <emphasis>Update URL</emphasis> mechanism. </para>
<para>If a service provided using update URL is not properly secured using HTTPS, your credentials may be visible to an adversary. Once an adversary gains your credentials, they will be able to replay your request your server and hijack your domain. </para>
<para>On the other hand, the GnuDIP protocol will only transport a salted MD5 value of your password, in a way that is secure against replay attacks. </para>
</section>
<section>
<title>Using the GnuDIP protocol</title>
<orderedlist numeration="arabic">
<listitem>
<para>Register an account with any Dynamic DNS service provider. A free service provided by the FreedomBox community is available at <ulink url="https://gnudip.datasystems24.net"/> . </para>
</listitem>
<listitem>
<para>In FreedomBox UI, enable the Dynamic DNS Service. </para>
</listitem>
<listitem>
<para>Select <emphasis>GnuDIP</emphasis> as <emphasis>Service type</emphasis>, enter your Dynamic DNS service provider address (for example, gnudip.datasystems24.net) into <emphasis>GnuDIP Server Address</emphasis> field. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS?action=AttachFile&amp;do=get&amp;target=DynamicDNS-Settings.png" width="800"/>
</imageobject>
<textobject>
<phrase>Dynamic DNS Settings</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>Fill <emphasis>Domain Name</emphasis>, <emphasis>Username</emphasis>, <emphasis>Password</emphasis> information given by your provider into the corresponding fields. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Using an Update URL</title>
<para>This feature is implemented because the most popular Dynamic DNS providers are using Update URLs mechanism. </para>
<orderedlist numeration="arabic">
<listitem>
<para>Register an account with a Dynamic DNS service provider providing their service using Update URL mechanism. Some example providers are listed in the configuration page itself. </para>
</listitem>
<listitem>
<para>In FreedomBox UI, enable the Dynamic DNS service. </para>
</listitem>
<listitem>
<para>Select <emphasis>other Update URL</emphasis> as <emphasis>Service type</emphasis>, enter the update URL given by your provider into <emphasis>Update URL</emphasis> field. </para>
</listitem>
<listitem>
<para>If you browse the update URL with your Internet browser and a warning message about untrusted certificate appears, then enable <emphasis>accept all SSL certificates</emphasis>. WARNING: your credentials may be readable here because man-in-the-middle attacks are possible! Consider choosing a better service provider instead. </para>
</listitem>
<listitem>
<para>If you browse the update URL with your Internet browser and the username/password box appears, enable <emphasis>use HTTP basic authentication</emphasis> checkbox and provide the <emphasis>Username</emphasis> and <emphasis>Password</emphasis>. </para>
</listitem>
<listitem>
<para>If the update URL contains your current IP address, replace the IP address with the string <emphasis>&lt;Ip&gt;</emphasis>. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Checking If It Works</title>
<orderedlist numeration="arabic">
<listitem>
<para>Make sure that external services you have enabled such as /jwchat, /roundcube and /ikiwiki are available on your domain address. </para>
</listitem>
<listitem>
<para>Go to the <emphasis>Status</emphasis> page, make sure that the NAT type is detected correctly. If your FreedomBox is behind a NAT device, this should be detected over there (Text: <emphasis>Behind NAT</emphasis>). If your FreedomBox has a public IP address assigned, the text should be "Direct connection to the Internet". </para>
</listitem>
<listitem>
<para>Check that the last update status is not <emphasis>failed</emphasis>. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Recap: How to create a DNS name with GnuDIP</title>
<para>
<remark>to delete or to replace the old text</remark>
</para>
<orderedlist numeration="arabic">
<listitem>
<para>Access to <ulink url="https://gnudip.datasystems24.net">GnuIP login page</ulink> (answer Yes to all pop ups) </para>
</listitem>
<listitem>
<para>Click on "Self Register" </para>
</listitem>
<listitem>
<para>Fill the registration form (Username and domain will form the public IP address [username.domain]) </para>
</listitem>
<listitem>
<para>Take note of the username/hostname and password that will be used on the FreedomBox app. </para>
</listitem>
<listitem>
<para>Save and return to the GnuDIP login page to verify your username, domain and password (enter the datas, click login). </para>
</listitem>
<listitem>
<para>Login output should display your new domain name along with your current public IP address (this is a unique address provided by your router for all your local devices). </para>
</listitem>
<listitem>
<para>Leave the GnuDIP interface and open the Dynamic DNS Client app page in your FreedomBox. </para>
</listitem>
<listitem>
<para>Click on "Set Up" in the top menu. </para>
</listitem>
<listitem>
<para>Activate Dynamic DNS </para>
</listitem>
<listitem>
<para>Choose GnuDIP service. </para>
</listitem>
<listitem>
<para>Add server address (gnudip.datasystems24.net) </para>
</listitem>
<listitem>
<para>Add your fresh domain name (username.domain, ie [username].freedombox.rocks) </para>
</listitem>
<listitem>
<para>Add your fresh username (the one used in your new IP address) and password </para>
</listitem>
<listitem>
<para>Add your GnuDIP password </para>
</listitem>
<listitem>
<para>Fill the option with <ulink url="http://myip.datasystems24.de"/> (try this url in your browser, you will figure out immediatly) </para>
</listitem>
</orderedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/DynamicDNS/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

2208
doc/Firewall.raw.xml Normal file
View File

File diff suppressed because it is too large Load Diff

324
doc/Ikiwiki.raw.xml Normal file
View File

@ -0,0 +1,324 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Ikiwiki</title>
<revhistory>
<revision>
<revnumber>9</revnumber>
<date>2016-12-26 19:18:01</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add screenshots</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-09-01 19:15:54</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-05-26 17:19:45</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>new section on adding users as wiki admins</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-04-13 01:10:28</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added blog to quick start entry in Ikiwiki Manual</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-04-13 01:00:22</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added a "Quick Start" entry in Ikiwiki manual</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-04-10 07:21:53</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-12-15 19:54:35</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Ikiwiki definition</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-11-29 19:13:55</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>added ## BEGIN_INCLUDE</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-13 17:06:14</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add ikiwiki page for manual</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Wiki and Blog (Ikiwiki)</title>
<section>
<title>What is Ikiwiki?</title>
<para>Ikiwiki converts wiki pages into HTML pages suitable for publishing on a website. It provides particularly blogging, podcasting, calendars and a large selection of plugins. </para>
</section>
<section>
<title>Quick Start</title>
<para>After the app installation on your box administration interface: </para>
<itemizedlist>
<listitem>
<para>Go to "Create" section and create a wiki or a blog </para>
</listitem>
<listitem>
<para>Go back to "Configure" section and click on /ikiwiki link </para>
</listitem>
<listitem>
<para>Click on your new wiki or blog name under "Parent directory" </para>
</listitem>
<listitem>
<para>Enjoy your new publication page. </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Creating a wiki or blog</title>
<para>You can create a wiki or blog to be hosted on your FreedomBox through the Wiki &amp; Blog (Ikiwiki) page in Plinth. The first time you visit this page, it will ask to install packages required by Ikiwiki. </para>
<para>After the package install has completed, select the Create tab. You can select the type to be Wiki or Blog. Also type in a name for the wiki or blog, and the username and password for the wiki's/blog's admin account. Then click Update setup and you will see the wiki/blog added to your list. Note that each wiki/blog has its own admin account. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki?action=AttachFile&amp;do=get&amp;target=ikiwiki_create.png" width="800"/>
</imageobject>
<textobject>
<phrase>ikiwiki: Create</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Accessing your wiki or blog</title>
<para>From the Wiki &amp; Blog (Ikiwiki) page, select the Manage tab and you will see a list of your wikis and blogs. Click a name to navigate to that wiki or blog. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki?action=AttachFile&amp;do=get&amp;target=ikiwiki_manage.png" width="800"/>
</imageobject>
<textobject>
<phrase>ikiwiki: Manage</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>From here, if you click Edit or Preferences, you will be taken to a login page. To log in with the admin account that you created before, select the Other tab, enter the username and password, and click Login. </para>
</section>
<section>
<title>User login through SSO</title>
<para>Besides the wiki/blog admin, other FreedomBox users can be given access to login and edit wikis and blogs. However, they will not have all the same permissions as the wiki admin. They can add or edit pages, but cannot change the wiki's configuration. </para>
<para>To add a wiki user, go to the Users and Groups page in Plinth (under System configuration, the gear icon at the top right corner of the page). Create or modify a user, and add them to the wiki group. (Users in the admin group will also have wiki access.) </para>
<para>To login as a FreedomBox user, go to the wiki/blog's login page and select the Other tab. Then click the "Login with HTTP auth" button. The browser will show a popup dialog where you can enter the username and password of the FreedomBox user. </para>
</section>
<section>
<title>Adding FreedomBox users as wiki admins</title>
<orderedlist numeration="arabic">
<listitem>
<para>Login to the wiki, using the admin account that was specified when the wiki was created. </para>
</listitem>
<listitem>
<para>Click "Preferences", then "Setup". </para>
</listitem>
<listitem>
<para>Under "main", in the "users who are wiki admins", add the name of a user on the FreedomBox. </para>
</listitem>
<listitem>
<para>(Optional) Under "auth plugin: passwordauth", uncheck the "enable passwordauth?" option. (Note: This will disable the old admin account login. Only SSO login using HTTP auth will be possible.) </para>
</listitem>
<listitem>
<para>Click "Save Setup". </para>
</listitem>
<listitem>
<para>Click "Preferences", then "Logout". </para>
</listitem>
<listitem>
<para>Login as the new admin user using "Login with HTTP auth". </para>
</listitem>
</orderedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Ikiwiki/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

321
doc/LetsEncrypt.raw.xml Normal file
View File

@ -0,0 +1,321 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/LetsEncrypt</title>
<revhistory>
<revision>
<revnumber>8</revnumber>
<date>2018-03-11 03:16:47</date>
<authorinitials>JosephNuthalapati</authorinitials>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2017-01-19 00:18:41</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>replace quote character</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2017-01-07 19:48:45</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add port forwarding info</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2017-01-07 18:21:14</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>clarify step</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-08-21 19:00:07</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-08-21 18:59:20</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screencast of the setting up</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-08-21 17:57:07</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>screenshots</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 17:43:20</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Let's Encypt</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Certificates (Let's Encrypt)</title>
<para>A digital certficate allows users of a web service to verify the identity of the service and to securely communicate with it. FreedomBox can automatically obtain and setup digital certificates for each available domain. It does so by proving itself to be the owner of a domain to Let's Encrypt, a certificate authority (CA). </para>
<para>Let's Encrypt is a free, automated, and open certificate authority, run for the public's benefit by the Internet Security Research Group (ISRG). Please read and agree with the Let's Encrypt Subscriber Agreement before using this service. </para>
<section>
<title>Why using Certificates</title>
<para>The communication with your FreedomBox can be secured so that it is not possible to intercept the content of the web pages viewed and about the content exchanged. </para>
</section>
<section>
<title>How to setup</title>
<orderedlist numeration="arabic">
<listitem>
<para>If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports: </para>
<itemizedlist>
<listitem>
<para>TCP 80 (http) </para>
</listitem>
<listitem>
<para>TCP 443 (https) </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Make the domain name known: </para>
<itemizedlist>
<listitem>
<para>In <ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Manual/Configure#">Configure</ulink> insert your <emphasis>domain name</emphasis>, e.g. <emphasis><code>MyWebName.com</code></emphasis> <inlinemediaobject><imageobject><imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt?action=AttachFile&amp;do=get&amp;target=LetsEncrypt-Configure.png" width="800"/></imageobject><textobject><phrase>Let's Encrypt</phrase></textobject></inlinemediaobject> </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Verify the domain name was accepted </para>
<itemizedlist>
<listitem>
<para>Check that it is enabled in <ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Manual/NameServices#">Name Services</ulink> </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt?action=AttachFile&amp;do=get&amp;target=LetsEncrypt-NameServices.png" width="800"/>
</imageobject>
<textobject>
<phrase>Let's Encrypt Name Services</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Go to the Certificates (Let's Encrypt) page, and complete the module install if needed. Then click the "Obtain" button for your domain name. </para>
<itemizedlist>
<listitem>
<para>After some minutes a valid certificate is available </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt?action=AttachFile&amp;do=get&amp;target=LetsEncrypt.png" width="800"/>
</imageobject>
<textobject>
<phrase>Let's Encrypt</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Verify in your browser by checking <emphasis><code>https://MyWebName.com</code></emphasis> </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt?action=AttachFile&amp;do=get&amp;target=LetsEncrypt-Certificate.png" width="800"/>
</imageobject>
<textobject>
<phrase>Let's Encrypt Certificate</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
<para><emphasis role="strong">Screencast</emphasis>: <ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Manual/LetsEncrypt?action=AttachFile&amp;do=get&amp;target=Let%27s+Encrypt.webm">Let's Encrypt</ulink></para>
</section>
<section>
<title>Using</title>
<para>The certificate is valid for 3 months. It is renewed automatically and can also be re-obtained or revoked manually. </para>
<para>With running <emphasis>diagnostics</emphasis> the certificate can also be verified. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/LetsEncrypt/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

24
doc/Makefile
View File

@ -15,10 +15,9 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
MANUAL_URL="https://wiki.debian.org/FreedomBox/Manual?action=show&mimetype=text%2Fdocbook"
OUTPUTS=freedombox-manual.pdf freedombox-manual.html freedombox-manual.part.html plinth.1
OUTPUTS=freedombox-manual.pdf plinth.1 manual-pages
# In order to debug various problems with the documents especially
# intermediate LaTeX state, run make as follows:
@ -51,28 +50,39 @@ all: $(OUTPUTS)
fetch:
wget --quiet -O - $(MANUAL_URL) | \
xmllint --format --output freedombox-manual.raw.xml -
xsltproc --output freedombox-manual.xml fixes.xslt freedombox-manual.raw.xml
xsltproc fetch-images.xslt freedombox-manual.raw.xml | sort -u | \
awk '{print "wget --quiet -O images/" $$1 " " $$2}' | sh
rm -f freedombox-manual.raw.xml
./fetch-manual-pages
.PHONY: manual-pages
manual-pages-list:=$(shell cat manual-pages.list) freedombox-manual
manual-pages-part-html:=$(patsubst %, %.part.html, $(manual-pages-list))
manual-pages-html:=$(patsubst %, %.html, $(manual-pages-list))
manual-pages-xml:=$(patsubst %, %.xml, $(manual-pages-list))
manual-pages: $(manual-pages-part-html)
%.pdf: %.xml
xmlto $(XMLTO_DEBUG_FLAGS) --with-dblatex pdf $<
%.part.html: %.html
perl -pe 'BEGIN {undef $$/} s/.*<body[^>]*>(.*)<\/body\s*>.*/$$1/si' $< > $@
freedombox-manual.xml: freedombox-manual.raw.xml fixes.xslt
xsltproc --output $@ fixes.xslt $<
%.xml: %.raw.xml manual-page-fixes.xslt
xsltproc --output $@ manual-page-fixes.xslt $<
./post-processor remove-footer $@
./post-processor fix-wiki-urls $@
%.html: %.xml
docbook2html --nochunks $<
%.1: %.xml
xmlto man $<
.PHONY: clean
clean:
rm -f $(manual-pages-html) $(manual-pages-part-html) $(manual-pages-xml)
rm -f $(OUTPUTS)

235
doc/MatrixSynapse.raw.xml Normal file
View File

@ -0,0 +1,235 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/MatrixSynapse</title>
<revhistory>
<revision>
<revnumber>6</revnumber>
<date>2018-03-02 12:06:08</date>
<authorinitials>JosephNuthalapati</authorinitials>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2018-03-02 10:44:12</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Naming was inconsistent</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2017-06-27 05:13:41</date>
<authorinitials>JosephNuthalapati</authorinitials>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2017-03-24 06:42:49</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Update for explaining more features etc.</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2017-03-23 06:36:05</date>
<authorinitials>rahulde</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2017-03-23 06:33:43</date>
<authorinitials>rahulde</authorinitials>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Chat Server (Matrix Synapse)</title>
<section>
<title>What is the Matrix?</title>
<para><ulink url="https://matrix.org/">Matrix</ulink> is an open standard for interoperable, decentralized, real-time communication over IP. Synapse is the reference implementation of a Matrix server. It can be used to setup instant messaging on <ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox#">FreedomBox</ulink> to host large chat rooms, end to end encrypted communication and audio/video calls. Each instance of a Matrix server federates with other instances such that all your contacts need not hold accounts on your server. <ulink url="https://matrix.org/docs/guides/faq.html">See</ulink> more detailed info about Matrix. </para>
<para><emphasis role="strong">Note:</emphasis> The Matrix Synapse is available in FreedomBox starting with Plinth version 0.14. </para>
</section>
<section>
<title>How to access the Matrix?</title>
<para>We recommend the <ulink url="https://riot.im">Riot</ulink> client to access the Matrix server. You can <ulink url="https://riot.im/desktop.html">download</ulink> Riot for desktops. Mobile applications for Android and iOS are available from app stores. </para>
</section>
<section>
<title>Setting up your FreedomBox for Matrix</title>
<para>To enable Matrix, first navigate to the Chat Server (Matrix Synapse) page and install it. Matrix needs a valid domain name to be configured. After installation, you will be asked to configure it. You will be able to select a domain from a drop down menu of available domains. Domains are configured using System -&gt; Configure page. After configuring a domain, you will see that the service is running. The service will be accessible on the configured <ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox#">FreedomBox</ulink> domain. All the registered users will have their Matrix IDs as <code>@username:domain</code>. Currently, you will not be able to change the domain once is it configured. </para>
</section>
<section>
<title>Federating with other Matrix instances</title>
<para>You will be able to interact with any other person running another Matrix instance. This is done by simply starting a conversation with them using their matrix ID which is of the format <code>@their-username:their-domain</code>. You can also join rooms which are in another server and have audio/video calls with contacts on other server. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MatrixSynapse/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

251
doc/MediaWiki.raw.xml Normal file
View File

@ -0,0 +1,251 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/MediaWiki</title>
<revhistory>
<revision>
<revnumber>3</revnumber>
<date>2018-01-31 06:02:30</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add footer and category</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2018-01-17 10:26:45</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix headings</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2018-01-13 04:01:22</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>New wiki entry for MediaWiki on FreedomBox</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Wiki (MediaWiki)</title>
<section>
<title>About MediaWiki</title>
<para><ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/MediaWiki#">MediaWiki</ulink> is the software that powers the Wikimedia suite of wikis. </para>
<para>Read more about MediaWiki on <ulink url="https://en.wikipedia.org/wiki/MediaWiki">Wikipedia</ulink> </para>
<para><emphasis role="strong">Available since:</emphasis> version 0.20.0 </para>
</section>
<section>
<title>MediaWiki on FreedomBox</title>
<para>MediaWiki on FreedomBox is configured to be publicly readable and privately editable. Only logged in users can make edits to the wiki. This configuration prevents spam and vandalism on the wiki. </para>
<section>
<title>User management</title>
<para>Users can be created by the MediaWiki administrator (user "admin") only. The "admin" user can also be used to reset passwords of MediaWiki users. The administrator password, if forgotten can be reset anytime from the <ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/MediaWiki#">MediaWiki</ulink> page in the Plinth UI. </para>
</section>
<section>
<title>Use cases</title>
<para><ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/MediaWiki#">MediaWiki</ulink> is quite versatile and can be put to many creative uses. It also comes with a lot of plugins and themes and is highly customizable. </para>
<section>
<title>Personal Knowledge Repository</title>
<itemizedlist>
<listitem override="none">
<para>MediaWiki on FreedomBox can be your own personal knowledge repository. Since MediaWiki has good multimedia support, you can write notes, store images, create checklists, store references and bookmarks etc. in an organized manner. You can store the knowledge of a lifetime in your MediaWiki instance. </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Community Wiki</title>
<itemizedlist>
<listitem override="none">
<para>A community of users can use MediaWiki as their common repository of knowledge and reference material. It can used as a college notice board, documentation server for a small company, common notebook for study groups or as a fan wiki like wikia. </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Personal Wiki-based Website</title>
<itemizedlist>
<listitem override="none">
<para><ulink url="https://www.mediawiki.org/wiki/Sites_using_MediaWiki/en">Several websites</ulink> on the internet are simply MediaWiki instances. MediaWiki on FreedomBox is read-only to visitors. Hence, it can be adapted to serve as your personal website and/or blog. MediaWiki content is easy to export and can be later moved to use another blog engine. </para>
</listitem>
</itemizedlist>
</section>
</section>
<section>
<title>Editing Wiki Content</title>
<para>MediWiki's new Visual Editor gives a WYSIWYG user interface to creating wiki pages. Unfortunately, it is not yet available in the current version of MediaWiki on Debian. </para>
<para>You don't have to necessarily learn the MediaWiki formatting language. You can write in your favorite format (Markdown, Org-mode, LaTeX etc.) and convert it to the MediaWiki format using <ulink url="https://pandoc.org/try/">Pandoc</ulink>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/MediaWiki/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</section>
</article>

214
doc/Minetest.raw.xml Normal file
View File

@ -0,0 +1,214 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Minetest</title>
<revhistory>
<revision>
<revnumber>3</revnumber>
<date>2017-01-02 13:29:19</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>fix list</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2017-01-02 13:26:03</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add port forwarding info</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-09-04 10:20:44</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>stub created</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Block Sandbox (Minetest)</title>
<para>Minetest is a multiplayer infinite-world block sandbox. This module enables the Minetest server to be run on this FreedomBox, on the default port (30000). To connect to the server, a <ulink url="http://www.minetest.net/downloads/">Minetest client</ulink> is needed. </para>
<section>
<title>Port Forwarding</title>
<para>If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for Minetest: </para>
<itemizedlist>
<listitem>
<para>UDP 30000 </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Minetest/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

194
doc/Monkeysphere.raw.xml Normal file
View File

@ -0,0 +1,194 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Monkeysphere</title>
<revhistory>
<revision>
<revnumber>1</revnumber>
<date>2016-09-04 10:12:10</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>stub created</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Monkeysphere</title>
<para>With Monkeysphere, an OpenPGP key can be generated for each configured domain serving SSH. The OpenPGP public key can then be uploaded to the OpenPGP keyservers. Users connecting to this machine through SSH can verify that they are connecting to the correct host. For users to trust the key, at least one person (usually the machine owner) must sign the key using the regular OpenPGP key signing process. See the <ulink url="http://web.monkeysphere.info/getting-started-ssh/">Monkeysphere SSH documentation</ulink> for more details. </para>
<para>Monkeysphere can also generate an OpenPGP key for each Secure Web Server (HTTPS) certificate installed on this machine. The OpenPGP public key can then be uploaded to the OpenPGP keyservers. Users accessing the web server through HTTPS can verify that they are connecting to the correct host. To validate the certificate, the user will need to install some software that is available on the <ulink url="https://web.monkeysphere.info/download/">Monkeysphere website</ulink>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Monkeysphere/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

241
doc/Mumble.raw.xml Normal file
View File

@ -0,0 +1,241 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Mumble</title>
<revhistory>
<revision>
<revnumber>6</revnumber>
<date>2017-01-02 13:28:53</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add port forwarding info</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-12-31 04:04:56</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add basic usage info</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-09-01 19:14:55</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-04-10 07:20:42</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 20:51:58</date>
<authorinitials>PhilippeBaret</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 20:06:18</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Mumble page and definition.</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Voice Chat (Mumble)</title>
<section>
<title>What is Mumble?</title>
<para>Mumble is a voice chat software. Primarily intended for use while gaming, it is suitable for simple talking with high audio quality, noise suppression, encrypted communication, public/private-key authentication by default, and "wizards" to configure your microphone for instance. A user can be marked as a "priority speaker" within a channel. </para>
</section>
<section>
<title>Using Mumble</title>
<para>FreedomBox includes the Mumble server. <ulink url="https://wiki.mumble.info/wiki/Main_Page">Clients</ulink> are available for desktop and mobile platforms. Users can download one of these clients and connect to the server. </para>
</section>
<section>
<title>Port Forwarding</title>
<para>If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for Mumble: </para>
<itemizedlist>
<listitem>
<para>TCP 64738 </para>
</listitem>
<listitem>
<para>UDP 64738 </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Mumble/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

204
doc/NameServices.raw.xml Normal file
View File

@ -0,0 +1,204 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/NameServices</title>
<revhistory>
<revision>
<revnumber>3</revnumber>
<date>2016-12-31 04:18:51</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>reword</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-08-21 17:16:56</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 17:16:41</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created NameServices</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Name Services</title>
<para>Name Services provides an overview of ways the box can be reached from the public Internet: domain name, Tor hidden service, and Pagekite. For each type of name, it is shown whether the HTTP, HTTPS, and SSH services are enabled or disabled for incoming connections through the given name. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/NameServices/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

611
doc/Networks.raw.xml Normal file
View File

@ -0,0 +1,611 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Networks</title>
<revhistory>
<revision>
<revnumber>8</revnumber>
<date>2017-03-31 20:04:48</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screenshot Network Single</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2017-03-02 16:26:27</date>
<authorinitials>AaronFerrucci</authorinitials>
<revremark>Corrected a few typos</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-09-02 05:31:28</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add information about configuring BATMAN-Adv Mesh network</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-03-06 20:43:34</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Text correction</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-09-13 15:04:43</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Demote headings one level for inclusion into manual</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-09-12 11:23:58</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Update link to renamed Firewall page</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-09-12 10:04:19</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add information about Internet connection sharing</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-12 09:24:59</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>New page for FreedomBox manual on networking</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Networks</title>
<para>This section describes how networking is setup by default in FreedomBox and how you can customize it. See also the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Manual/Firewall#">Firewall</ulink> section for more information on how firewall works. </para>
<section>
<title>Default setup</title>
<para>In a fresh image of FreedomBox, network is not configured at all. When the image is written to an SD card and the device boots, configuration is done. During first boot, FreedomBox setup package detects the networks interfaces and tries to automatically configure them so that FreedomBox is available for further configuration via the web interface from another machine without the need to connect a monitor. Automatic configuration also tries to make FreedomBox useful, out of the box, for the most important scenarios FreedomBox is used for. </para>
<para>There are two scenarios it handles: when is a single ethernet interface and when there are multiple ethernet interfaces. </para>
<section>
<title>Single ethernet interface</title>
<para>When there is only single ethernet interface available on the hardware device, there is not much scope for it to play the role of a router. In this case, the device is assumed to be just another machine in the network. Accordingly, the only available interface is configured to be an <code>internal</code> interface in <code>automatic</code> configuration mode. This means that it connects to the Internet using the configuration provided by a router in the network and also makes all (internal and external) of its services available to all the clients on this network. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Networks?action=AttachFile&amp;do=get&amp;target=network_single.png"/>
</imageobject>
<textobject>
<phrase>network_single.png</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Multiple ethernet interface</title>
<para>When there are multiple ethernet interfaces available on the hardware device, the device can act as a router. The interfaces are then configured to perform this function. </para>
<para>The first network interface is configured to be an WAN or <code>external</code> interface in automatic configuration mode. This means that it connects to the Internet using network configuration provided by the Internet Service Provider (ISP). Only services that are meant to be provided across the entire Internet (external services) will be exposed on this interface. You must plug your Internet connection into the port of this ethernet interface. If you wish to continue to have your existing router manage the Internet connection for you, then plug a connection from your router to the port on this interface. </para>
<para>The remaining network interfaces are configured for the clients of a router. They are configured as LAN or <code>internal</code> interfaces in <code>shared</code> configuration mode. This means that all the services (both external and internal) services are provided to who ever connects on this interface. Further, the <code>shared</code> mode means that clients will be able to receive details of automatic network connection on this interface. Specifically, DHCP configuration and DNS servers are provided on this interface. The Internet connection available to the device using the first network interface will be <code>shared</code> with clients using this interface. This all means that you can connect your computers to this network interface and they will get automatically configured and will be able to access the Internet via the FreedomBox. </para>
<para>Currently, it is not very clear which interface will be come the WAN interface (and the remaining being LAN interfaces) although the assignment process is deterministic. So, it take a bit of trail and error to figure out which one is which. In future, for each device, this will be well documented. </para>
</section>
<section>
<title>Wi-Fi configuration</title>
<para>All Wi-Fi interfaces are configured to be LAN or <code>internal</code> interfaces in <code>shared</code> configuration mode. They are also configured to become Wi-Fi access points with following details. </para>
<itemizedlist>
<listitem>
<para>Name of the access point will be <code>FreedomBox</code> plus the name of the interface (to handle the case where there are multiple of them). </para>
</listitem>
<listitem>
<para>Password for connecting to the interface will be <code>freedombox123</code>. </para>
</listitem>
</itemizedlist>
</section>
</section>
<section>
<title>Internet Connection Sharing</title>
<para>Although the primary duty of FreedomBox is to provide decentralized services, it can also act like a home router. Hence, in most cases, FreedomBox connects to the Internet and provides other machines in the network the ability to use that Internet connection. FreedomBox can do this in two ways: using a <code>shared</code> mode connection or using an <code>internal</code> connection. </para>
<para>When an interface is set in <code>shared</code> mode, you may connect your machine directly to it. This is either by plugging in an ethernet cable from this interface to your machine or by connecting to a Wi-Fi access point. This case is the simplest to use, as FreedomBox automatically provides your machine with the necessary network configuration. Your machine will automatically connect to FreedomBox provided network and will be able to connect to the Internet given that FreedomBox can itself connect to the Internet. </para>
<para>Sometimes the above setup may not be possible because the hardware device may have only one network interface or for other reasons. Even in this case, your machine can still connect to the Internet via FreedomBox. For this to work, make sure that the network interface that your machine is connecting to is in <code>internal</code> mode. Then, connect your machine to network in which FreedomBox is present. After this, in your machine's network configuration, set FreedomBox's IP address as the gateway. FreedomBox will then accept your network traffic from your machine and send it over to the Internet. This works because network interfaces in <code>internal</code> mode are configured to <code>masquerade</code> packets from local machines to the Internet and receive packets from Internet and forward them back to local machines. </para>
</section>
<section>
<title>Customization</title>
<para>The above default configuration may not be fit for your setup. You can customize the configuration to suit your needs from the <code>Networks</code> area in the 'setup' section of the FreedomBox web interface. </para>
<section>
<title>PPPoE connections</title>
<para>If your ISP does not provide automatic network configuration via DHCP and requires you to connection via PPPoE. To configure PPPoE, remove any network connection existing on an interface and add a PPPoE connection. Here, optionally, provide the account username and password given by your ISP and activate the connection. </para>
</section>
<section>
<title>Connect to Internet via Wi-Fi</title>
<para>By default Wi-Fi devices attached during first boot will be configured as access points. They can be configured as regular Wi-Fi devices instead to connection to a local network or an existing Wi-Fi router. To do this, click on the Wi-Fi connection to edit it. Change the mode to <code>Infrastructure</code> instead of <code>Access Point</code> mode and <code>IPv4 Addressing Method</code> to <code>Automatic (DHCP)</code> instead of <code>Shared</code> mode. Then the SSID provided will mean the Wi-Fi network name you wish to connect to and passphrase will be the used to while making the connection. </para>
</section>
<section>
<title>Adding a new network device</title>
<para>When a new network device is added, network manager will automatically configure it. In most cases this will not work to your liking. Delete the automatic configuration created on the interface and create a new network connection. Select your newly added network interface in the add connection page. </para>
<itemizedlist>
<listitem>
<para>Then set firewall zone to <code>internal</code> and <code>external</code> appropriately. </para>
</listitem>
<listitem>
<para>You can configure the interface to connect to a network or provide network configuration to whatever machine connects to it. </para>
</listitem>
<listitem>
<para>Similarly, if it is a Wi-Fi interface, you can configure it to become a Wi-FI access point or to connect to an existing access points in the network. </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Configuring a mesh network</title>
<para>FreedomBox has rudimentary support for participating in BATMAN-Adv based mesh networks. It is possible to either join an existing network in your area or create a new mesh network and share your Internet connection with the rest of the nodes that join the network. Currently, two connections have to be created and activated manually to join or create a mesh network. </para>
<section>
<title>Joining a mesh network</title>
<para>To join an existing mesh network in your area, first consult the organizers and get information about the mesh network. </para>
<orderedlist numeration="arabic">
<listitem>
<para>Create a new connection, then select the connection type as <emphasis>Wi-Fi</emphasis>. In the following dialog, provide the following values: </para>
<informaltable>
<tgroup cols="3">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Field Name</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Example Value</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Explanation</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Connection Name</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Mesh Join - BATMAN </para>
</entry>
<entry colsep="1" rowsep="1">
<para> The name must end with 'BATMAN' (uppercase) </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Physical Interface</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> wlan0 </para>
</entry>
<entry colsep="1" rowsep="1">
<para> The Wi-Fi device you wish to use for joining the mesh network </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Firewall Zone</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> External </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Since you don't wish that participants in mesh network to use internal services of FreedomBox </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>SSID</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> ch1.freifunk.net </para>
</entry>
<entry colsep="1" rowsep="1">
<para> As provided to you by the operators of the mesh network. You should see this as a network in <emphasis>Nearby Wi-Fi Networks</emphasis> </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Mode</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Ad-hoc </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Because this is a peer-to-peer network </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Frequency Band</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> 2.4Ghz </para>
</entry>
<entry colsep="1" rowsep="1">
<para> As provided to you by the operators of the mesh network </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Channel</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> 1 </para>
</entry>
<entry colsep="1" rowsep="1">
<para> As provided to you by the operators of the mesh network </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>BSSID</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> 12:CA:FF:EE:BA:BE </para>
</entry>
<entry colsep="1" rowsep="1">
<para> As provided to you by the operators of the mesh network </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Authentication</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Open </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Leave this as open, unless you know your mesh network needs it be otherwise </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Passphrase</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para> Leave empty unless you know your mesh network requires one </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>IPv4 Addressing Method</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Disabled </para>
</entry>
<entry colsep="1" rowsep="1">
<para> We don't want to request IP configuration information yet </para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Save the connection. Join the mesh network by activating this newly created connection. </para>
</listitem>
<listitem>
<para>Create a second new connection, then select the connection type as <emphasis>Generic</emphasis>. In the following dialog, provide this following values: </para>
<informaltable>
<tgroup cols="3">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Field Name</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Example Value</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Explanation</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Connection Name</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Mesh Connect </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Any name to identify this connection </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Physical Interface</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> bat0 </para>
</entry>
<entry colsep="1" rowsep="1">
<para> This interface will only show up after you successfully activate the connection in first step </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>Firewall Zone</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> External </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Since you don't wish that participants in mesh network to use internal services of FreedomBox </para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis>IPv4 Addressing Method</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para> Auto </para>
</entry>
<entry colsep="1" rowsep="1">
<para> Mesh networks usually have a DHCP server somewhere that provide your machine with IP configuration. If not, consult the operator and configure IP address setting accordingly with <emphasis>Manual</emphasis> method </para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Save the connection. Configure your machine for participation in the network by activating this connection. Currently, this connection has to be manually activated every time you need to join the network. In future, FreedomBox will do this automatically. You will now be able reach other nodes in the network. You will also be able to connect to the Internet via the mesh network if there is an Internet connection point somewhere in mesh as setup by the operators. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Creating a mesh network</title>
<para>To create your own mesh network and share your Internet connection with the rest of the nodes in the network: </para>
<orderedlist numeration="arabic">
<listitem>
<para>Follow the instructions as provided above in step 1 of <emphasis>Joining a mesh network</emphasis> but choose and fix upon your own valid values for <emphasis>SSID</emphasis> (a name for you mesh network), <emphasis>Frequency Band</emphasis> (usually 2.4Ghz), <emphasis>Channel</emphasis> (1 to 11 in 2.4Ghz band) and <emphasis>BSSID</emphasis> (a hex value like 12:CA:DE:AD:BE:EF). Create this connection and activate it. </para>
</listitem>
<listitem>
<para>Follow the instructions as provided above in step 2 of <emphasis>Joining a mesh network</emphasis> but select <emphasis>IPv4 Addressing Method</emphasis> as <emphasis>Shared</emphasis>. This will provide automatic IP configuration to other nodes in the network as well as share the Internet connection on your machine (achieved using a second Wi-Fi interface, using Ethernet, etc.) with other nodes in the mesh network. </para>
</listitem>
</orderedlist>
<para>Spread the word about your mesh network to your neighbors and let them know the parameters you have provided when creating the network. When other nodes connect to this mesh network, they have to follow steps in <emphasis>Joining a mesh network</emphasis> but use the values for <emphasis>SSID</emphasis>, <emphasis>Frequency Band</emphasis> and <emphasis>Channel</emphasis> that you have chosen when you created the mesh network. </para>
</section>
</section>
</section>
<section>
<title>Manual Network Operation</title>
<para>FreedomBox automatically configures networks by default and provides a simplified interface to customize the configuration to specific needs. In most cases, manual operation is not necessary. The following steps describe how to manually operate network configuration in the event that a user finds FreedomBox interface to insufficient for task at hand or to diagnose a problem that FreedomBox does not identify. </para>
<para>On the command line interface: </para>
<para>For text based user interface for configuring network connections: </para>
<screen><![CDATA[nmtui]]></screen>
<para>To see the list of available network devices: </para>
<screen><![CDATA[nmcli device]]></screen>
<para>To see the list of configured connections: </para>
<screen><![CDATA[nmcli connection]]></screen>
<para>To see the current status of a connection: </para>
<screen><![CDATA[nmcli connection show '<connection_name>']]></screen>
<para>To see the current firewall zone assigned to a network interface: </para>
<screen><![CDATA[nmcli connection show '<connection_name>' | grep zone]]></screen>
<para>or </para>
<screen><![CDATA[firewall-cmd --zone=internal --list-all
firewall-cmd --zone=external --list-all]]></screen>
<para>To create a new network connection: </para>
<screen><![CDATA[nmcli con add con-name "<connection_name>" ifname "<interface>" type ethernet
nmcli con modify "<connection_name>" connection.autoconnect TRUE
nmcli con modify "<connection_name>" connection.zone internal]]></screen>
<para>To change the firewall zone for a connection: </para>
<screen><![CDATA[nmcli con modify "<connection_name>" connection.zone "<internal|external>"]]></screen>
<para>For more information on how to use <code>nmcli</code> command, see its man page. Also for a full list of configuration settings and type of connections accepted by Network Manager see: </para>
<para>
<ulink url="https://developer.gnome.org/NetworkManager/stable/ref-settings.html"/>
</para>
<para>To see the current status of the firewall and manually operate it, see the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Manual/Firewall#">Firewall</ulink> section. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Networks/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

291
doc/OpenVPN.raw.xml Normal file
View File

@ -0,0 +1,291 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/OpenVPN</title>
<revhistory>
<revision>
<revnumber>8</revnumber>
<date>2016-12-31 04:01:13</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>clarify install vs setup</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-09-09 15:37:55</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor indentation fix with screenshot</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-09-01 19:14:03</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-08-14 19:39:09</date>
<authorinitials>JanCostermans</authorinitials>
<revremark>added screenshot and setting up sections</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-04-10 07:16:50</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-12-16 00:32:58</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Text finishing</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-16 00:28:34</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added definition for OpenVPN</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 23:58:42</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added first content [OpenVPN page to Apps manual]</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Virtual Private Network (OpenVPN)</title>
<section>
<title>What is OpenVPN?</title>
<para>OpenVPN provides to your FreedomBox a virtual private network service. You can use this software for remote access, site-to-site VPNs and Wi-Fi security. OpenVPN includes support for dynamic IP addresses and NAT. </para>
</section>
<section>
<title>Setting up</title>
<orderedlist numeration="arabic">
<listitem>
<para>In Plinth apps menu, select <emphasis>Virtual Private Network (OpenVPN)</emphasis> and click Install. </para>
</listitem>
<listitem>
<para>After the module is installed, there is an additional setup step that may take a long time to complete. Click "Start setup" to begin. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/OpenVPN?action=AttachFile&amp;do=get&amp;target=plinth_openvpn.png"/>
</imageobject>
<textobject>
<phrase>plinth_openvpn.png</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>Wait for the setup to finish. This could take a while. </para>
</listitem>
<listitem>
<para>Once the setup of the OpenVPN server is complete, you can download your profile. This will download a file called &lt;USER&gt;.ovpn, where &lt;USER&gt; is the name of a FreedomBox user. Each FreedomBox user will be able to download a different profile. </para>
</listitem>
<listitem>
<para>The ovpn file contains all the information a vpn client needs to connect to the server. </para>
</listitem>
<listitem>
<para>If you are behind a modem, you may have to change the ip address (if not, you can skip this step). Open the ovpn file in any text editor. The second line shows the IP address or hostname the client will try to connect to. This should be your WAN IP address or your hostname. This line also contains the port number, 1194 being the default. You may have to open this port on your modem and enable port forwarding. </para>
</listitem>
</orderedlist>
<screen><![CDATA[client
remote mybox.sds-ip.de 1194
proto udp]]></screen>
<orderedlist numeration="arabic">
<listitem>
<para>Install an OpenVPN client for your system </para>
</listitem>
<listitem>
<para>Open the ovpn file with the OpenVPN client. </para>
</listitem>
<listitem>
<para>Try to ping the FreedomBox or other devices on the local network. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>External Links</title>
<para>
<ulink url="https://openvpn.net/index.php/open-source/overview.html"/>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/OpenVPN/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

290
doc/PageKite.raw.xml Normal file
View File

@ -0,0 +1,290 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/PageKite</title>
<revhistory>
<revision>
<revnumber>12</revnumber>
<date>2017-01-07 20:37:22</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add info on getting certificate</revremark>
</revision>
<revision>
<revnumber>11</revnumber>
<date>2017-01-07 20:21:47</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add instructions</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2017-01-07 20:14:44</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>clarify how pagekite works</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-09-01 19:19:45</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-04-10 07:13:20</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added navigation link</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2015-12-15 20:50:09</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2015-12-15 19:28:57</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added more definition</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2015-12-15 19:19:27</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added pagekite extended definition</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-09-13 14:58:24</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add headings for inclusion into manual</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-09-13 13:18:15</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Move PageKite page to manual</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-02-13 05:01:10</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Include FreedomBox portal in footer</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2012-09-14 07:37:02</date>
<authorinitials>planetlarg</authorinitials>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Public Visibility (PageKite)</title>
<section>
<title>What is PageKite?</title>
<para>PageKite makes local websites and services publicly accessible immediately without creating yourself a public IP address. It does this by tunneling protocols such as HTTPS or SSH through firewalls and NAT. Using PageKite requires an account on a PageKite relay service. One such service is <ulink url="https://pagekite.net"/>. </para>
<para>A PageKite relay service will allow you to create kites. Kites are similar to domain names, but with different advantages and drawbacks. A kite can have a number of configured services. PageKite is known to work with HTTP, HTTPS, and SSH, and may work with some other services, but not all. </para>
</section>
<section>
<title>Using PageKite</title>
<orderedlist numeration="arabic">
<listitem>
<para>Create an account on a PageKite relay service. </para>
</listitem>
<listitem>
<para>Add a kite to your account. Note your kite name and kite secret. </para>
</listitem>
<listitem>
<para>In Plinth, go to the "Configure PageKite" tab on the Public Visibility (PageKite) page. </para>
</listitem>
<listitem>
<para>Check the "Enable PageKite" box, then enter your kite name and kite secret. Click "Save settings". </para>
</listitem>
<listitem>
<para>On the "Standard Services" tab, you can enable HTTP and HTTPS (recommended) and SSH (optional). </para>
<itemizedlist>
<listitem>
<para>HTTP is needed to obtain the Let's Encrypt certificate. You can disable it later. </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>On the <ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Manual/LetsEncrypt#">Certificates (Let's Encrypt)</ulink> page, you can obtain a Let's Encrypt certificate for your kite name. </para>
</listitem>
</orderedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/PageKite/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

199
doc/Power.raw.xml Normal file
View File

@ -0,0 +1,199 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Power</title>
<revhistory>
<revision>
<revnumber>2</revnumber>
<date>2017-01-07 20:38:36</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>note confirmation</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 09:29:59</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Power</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Power</title>
<para>Power provides an easy way to restart or shut down FreedomBox. After you select "Restart" or "Shut Down", you will be asked to confirm. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Power/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

317
doc/Privoxy.raw.xml Normal file
View File

@ -0,0 +1,317 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Privoxy</title>
<revhistory>
<revision>
<revnumber>10</revnumber>
<date>2018-03-11 03:09:16</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized images</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-09-09 15:39:20</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor indentation fix with screenshots</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-09-09 15:31:16</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Promote the visibility of the screencast</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-08-09 19:09:55</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>configuration for advanced users</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-08-06 20:02:42</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screencast of the setting up</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-08-06 17:57:33</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>screenshots</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-08-01 19:38:35</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Very basic restructuring as preparation for more work to be done.</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-04-10 07:24:20</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 20:54:14</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added link to Privoxy FAQ</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 20:22:00</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Privoxy page and definition</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Web Proxy (Privoxy)</title>
<para>A web proxy acts as a filter for incoming and outgoing internet traffic. Thus, you can instruct any computer in your network to pass internet traffic through the proxy to remove unwanted ads and tracking mechanisms. </para>
<para>Privoxy is a software for security, privacy, and accurate control over the web. It provides a much more powerful web proxy (and anonymity on the web) than what your browser can offer. Privoxy "is a proxy that is primarily focused on privacy enhancement, ad and junk elimination and freeing the user from restrictions placed on his activities" (source: <ulink url="http://www.privoxy.org/faq/index.html">Privoxy FAQ</ulink>). </para>
<section>
<title>Screencast</title>
<para>Watch the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Manual/Privoxy?action=AttachFile&amp;do=get&amp;target=Privoxy_Installation.webm">screencast</ulink> on how to setup and use Privoxy in FreedomBox. </para>
</section>
<section>
<title>Setting up</title>
<orderedlist numeration="arabic">
<listitem>
<para>In Plinth install <emphasis>Web Proxy (Privoxy)</emphasis> </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Privoxy?action=AttachFile&amp;do=get&amp;target=Privoxy-Installation.png" width="800"/>
</imageobject>
<textobject>
<phrase>Privoxy Installation</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>Adapt your browser proxy settings to your FreedomBox hostname (or IP address) with port 8118. Please note that Privoxy can only proxy HTTP and HTTPS traffic. It will not work with FTP or other protocols. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Privoxy?action=AttachFile&amp;do=get&amp;target=Privoxy-BrowserSettings.png" width="800"/>
</imageobject>
<textobject>
<phrase>Privoxy Browser Settings</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>Go to page <ulink url="http://config.privoxy.org/"/> or <ulink url="http://p.p"/>. If Privoxy is installed properly, you will be able to configure it in detail; if not you will see an error message. </para>
</listitem>
<listitem>
<para>If you are using a laptop that occasionally has to connect through other routers than yours with the FreedomBox and Privoxy, you may want to install a proxy switch add-on that allows you to easily turn the proxy on or off. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Advanced Users</title>
<orderedlist numeration="arabic">
<listitem>
<para>The default installation should provide a reasonable starting point for most. There will undoubtedly be occasions where you will want to adjust the configuration, that can be dealt with as the need arises. </para>
</listitem>
<listitem>
<para>While using Privoxy, you can see its configuration details and documentation at <ulink url="http://config.privoxy.org/"/> or <ulink url="http://p.p"/>. </para>
</listitem>
<listitem>
<para>To enable changing these configurations, you first have to change the value of <code>enable-edit-actions</code> in <code>/etc/privoxy/config</code> to <code>1</code>. Before doing so, read carefully the manual, especially: </para>
<itemizedlist>
<listitem override="none">
<para>
<emphasis>Access to the editor can not be controlled separately by "ACLs" or HTTP authentication, so that everybody who can access Privoxy can modify its configuration for all users. This option is not recommended for environments with untrusted users. Note that malicious client side code (e.g Java) is also capable of using the actions editor and you shouldn't enable this options unless you understand the consequences and are sure your browser is configured correctly.</emphasis>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Now you find an <code>EDIT</code> button on the configuration screen in <code>http://config.privoxy.org/</code>. </para>
</listitem>
<listitem>
<para>The <ulink url="http://www.privoxy.org/user-manual/quickstart.html">Quickstart</ulink> is a good starting point to read on how to define own blocking and filtering rules. </para>
</listitem>
</orderedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Privoxy/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

313
doc/Quassel.raw.xml Normal file
View File

@ -0,0 +1,313 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Quassel</title>
<revhistory>
<revision>
<revnumber>3</revnumber>
<date>2018-03-11 03:00:04</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized image</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-08-18 17:30:28</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>wording, screen-shots</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-17 20:09:38</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>page creation; not sure about the configuration of quassel-client (too long ago); screenshots to follow</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>IRC Client (Quassel)</title>
<para><emphasis>Quassel</emphasis> is an IRC application that is split into two parts, a "core" and a "client". This allows the core to remain connected to IRC servers, and to continue receiving messages, even when the client is disconnected. FreedomBox can run the Quassel core service keeping you always online and one or more Quassel clients from a desktop or a mobile device can be used to connect and disconnect from it. </para>
<section>
<title>Why running Quassel?</title>
<para>Many discussions about FreedomBox are being done on the IRC-Channel <code>irc://irc.debian.org/freedombox</code>. If your FreedomBox is running <emphasis>Quassel</emphasis>, it will collect all discussions while you are away, such as responses to your questions. Remember, the FreedomBox project is a worldwide project with people from nearly every time zone. You use your <emphasis>client</emphasis> to connect to the <emphasis>Quassel</emphasis> core to read and respond whenever you have time and are available. </para>
</section>
<section>
<title>How to setup Quassel?</title>
<itemizedlist>
<listitem>
<para>Within Plinth </para>
<orderedlist numeration="arabic">
<listitem>
<para>select <emphasis>Applications</emphasis> </para>
</listitem>
<listitem>
<para>go to <emphasis>IRC Client (Quassel)</emphasis> and </para>
</listitem>
<listitem>
<para>install the application and make sure it is enabled </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=Quassel_Installation.png" width="800"/>
</imageobject>
<textobject>
<phrase>Quassel Installation</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>now your Quassel core is running </para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Configure in your router port forwarding for port <code>4242</code> </para>
<itemizedlist>
<listitem>
<para>on my device, this setting can be found in the section <emphasis>Network &gt; NAT &amp; Port rules &gt; Port Forwarding</emphasis> </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=Quassel_PortForwarding.png"/>
</imageobject>
<textobject>
<phrase>Quassel_PortForwarding.png</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section>
<title>Clients</title>
<para>Clients to connect to Quassel from your <ulink url="http://quassel-irc.org/downloads">desktop</ulink> and <ulink url="http://quasseldroid.iskrembilen.com/">mobile</ulink> devices are available. </para>
<para>In a Debian system, you can e.g. use <ulink url="https://packages.debian.org/search?keywords=quassel-client">quassel-client</ulink> </para>
<orderedlist numeration="arabic">
<listitem>
<para>With the first start you create a user-ID you want to use in your IRC channel </para>
</listitem>
<listitem>
<para>Configure the network connection, e.g. server <code>irc.debian.org/freedombox</code> </para>
</listitem>
<listitem>
<para>Communication takes place in a channel, e.g. <code>freedombox</code> </para>
</listitem>
<listitem>
<para>Add a core </para>
<orderedlist numeration="arabic">
<listitem>
<para>Chose an account name </para>
</listitem>
<listitem>
<para>Computer name is the DNS name to access your FreedomBox </para>
</listitem>
<listitem>
<para>Port: 4242 </para>
</listitem>
<listitem>
<para>User and password </para>
</listitem>
</orderedlist>
</listitem>
</orderedlist>
<para>For Android devices you may use e.g. <emphasis>Quasseldroid</emphasis> from <ulink url="https://f-droid.org/repository/browse/?fdfilter=quassel&amp;fdid=com.iskrembilen.quasseldroid">F-Droid</ulink> </para>
<itemizedlist>
<listitem>
<para>enter core, username etc. as above </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=Quasseldroid.png"/>
</imageobject>
<textobject>
<phrase>Quasseldroid.png</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>By the way, the German verb <emphasis>quasseln</emphasis> means <emphasis>talking a lot</emphasis>, to <emphasis>jabber</emphasis>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Quassel/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

559
doc/Radicale.raw.xml Normal file
View File

@ -0,0 +1,559 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Radicale</title>
<revhistory>
<revision>
<revnumber>31</revnumber>
<date>2018-01-03 08:54:14</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Update broken link - radicale clients</revremark>
</revision>
<revision>
<revnumber>30</revnumber>
<date>2017-08-06 23:06:11</date>
<authorinitials>JohannesKeyser</authorinitials>
<revremark>updated dead link to radicale client page, and added warning about misleading URL info</revremark>
</revision>
<revision>
<revnumber>29</revnumber>
<date>2016-12-31 02:28:01</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>style changes</revremark>
</revision>
<revision>
<revnumber>28</revnumber>
<date>2016-09-09 15:36:28</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor indentation fix with screenshot</revremark>
</revision>
<revision>
<revnumber>27</revnumber>
<date>2016-09-09 14:43:07</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor fix to adjust screenshot</revremark>
</revision>
<revision>
<revnumber>26</revnumber>
<date>2016-09-01 19:11:38</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>25</revnumber>
<date>2016-08-31 17:26:23</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>updated screenshot</revremark>
</revision>
<revision>
<revnumber>24</revnumber>
<date>2016-08-31 17:24:42</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Access rights</revremark>
</revision>
<revision>
<revnumber>23</revnumber>
<date>2016-08-01 16:32:28</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>22</revnumber>
<date>2016-08-01 16:28:29</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>screenshots</revremark>
</revision>
<revision>
<revnumber>21</revnumber>
<date>2016-08-01 16:18:30</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Evolution tutorial to use Calendar instead of Contacts (just happen to have that screenshot)</revremark>
</revision>
<revision>
<revnumber>20</revnumber>
<date>2016-07-31 18:21:39</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Android, advanced user, screenshots still to follow</revremark>
</revision>
<revision>
<revnumber>19</revnumber>
<date>2016-07-31 16:54:46</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>18</revnumber>
<date>2016-05-18 12:40:51</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Reduce item nesting to &lt; 4 due to problems in generating FreedomBox Manual</revremark>
</revision>
<revision>
<revnumber>17</revnumber>
<date>2016-04-27 03:35:17</date>
<authorinitials>StacyCockrum</authorinitials>
<revremark>formatting</revremark>
</revision>
<revision>
<revnumber>16</revnumber>
<date>2016-04-27 03:24:18</date>
<authorinitials>StacyCockrum</authorinitials>
<revremark>Editing and added instructions for Evolution Calendar.</revremark>
</revision>
<revision>
<revnumber>15</revnumber>
<date>2016-04-26 06:11:34</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Editing</revremark>
</revision>
<revision>
<revnumber>14</revnumber>
<date>2016-04-25 11:43:17</date>
<authorinitials>StacyCockrum</authorinitials>
</revision>
<revision>
<revnumber>13</revnumber>
<date>2016-04-25 11:36:30</date>
<authorinitials>StacyCockrum</authorinitials>
<revremark>I'm not sure if this is the right place to put this kind of information. I thought it would be helpful for a person to know some specifics around the settings. Pls advise if it should go somewhere e</revremark>
</revision>
<revision>
<revnumber>12</revnumber>
<date>2016-04-16 01:38:12</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Why Radical app content</revremark>
</revision>
<revision>
<revnumber>11</revnumber>
<date>2016-04-16 01:36:07</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2016-04-15 14:58:18</date>
<authorinitials>StacyCockrum</authorinitials>
<revremark>2nd bullet under "How to setup...?" Is it true that a new calendar/address book is created for each client or perhaps the clients need to be configured to access the calendar/address books?</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-04-15 14:53:50</date>
<authorinitials>StacyCockrum</authorinitials>
<revremark>Struggled with the last sentence of the first bullet under "How to setup Radicale?". When the Radicale server is launched does CalDAV become a function of the server or is a CalDAV server?</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-04-11 09:04:25</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-04-11 09:02:38</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction proper terms: CalDAV and CardDAV</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-04-11 09:01:11</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Why running Radicale section</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-04-11 08:53:27</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Correction</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-04-11 08:48:16</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added how to setup Radical server and clients in FreedomBox Manual</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-04-10 07:12:39</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added manual link</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-04-10 07:09:27</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Radicale definition on FreedomBox manual</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-04-10 06:40:28</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added first content to Radicale manual page</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Calendar and Addressbook (Radicale)</title>
<para>With Radicale, you can synchronize your personal calendars, ToDo lists, and addressbooks with your various computers, tablets, and smartphones, and share them with friends, without letting third parties know your personal schedule or contacts. </para>
<section>
<title>Why should I run Radicale?</title>
<para>Using Radicale, you can get rid of centralized services like Google Calendar or Apple Calendar (iCloud) data mining your events and social connections. </para>
</section>
<section>
<title>How to setup Radicale?</title>
<para>First, the Radicale server needs to be activated on your box. </para>
<itemizedlist>
<listitem>
<para>Within Plinth </para>
<orderedlist numeration="arabic">
<listitem>
<para>select <emphasis>Applications</emphasis> </para>
</listitem>
<listitem>
<para>go to <emphasis>Calendar and Addressbook (Radicale)</emphasis> and </para>
</listitem>
<listitem>
<para>install the application. After the installation is complete, make sure the application is marked "enabled" in the FreedomBox interface. Enabling the application launches the Radicale CalDAV/CardDAV server. </para>
</listitem>
<listitem>
<para>define the access rights: </para>
<itemizedlist>
<listitem>
<para>Only the owner of a calendar/addressbook can view or make changes </para>
</listitem>
<listitem>
<para>Any user can view any calendar/addressbook, but only the owner can make changes </para>
</listitem>
<listitem>
<para>Any user can view or make changes to any calendar/addressbook </para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</listitem>
</itemizedlist>
<para>Note, that only users with a FreedomBox login can access Radicale. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Radicale?action=AttachFile&amp;do=get&amp;target=Radicale-Plinth.png"/>
</imageobject>
<textobject>
<phrase>Radicale-Plinth.png</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>If you want to share a calendar with only some users, the simplest approach is to create an additional user-name for these users and to share that user-name and password with them. </para>
<para>Radicale does not have a user interface. An external <ulink url="http://radicale.org/clients/">supported client application</ulink> is needed. </para>
<para>Now open your client application to create new calendar and address books that will use your FreedomBox and Radicale server. The Radicale website provides <ulink url="http://radicale.org/clients/">an overview of supported clients</ulink>, but do <emphasis>not</emphasis> use the URLs described there; FreedomBox uses another setup, follow this manual. Below are the steps for two examples: </para>
<itemizedlist>
<listitem>
<para>Example of setup with Evolution client: </para>
<itemizedlist>
<listitem>
<para>Calendar </para>
<orderedlist numeration="arabic">
<listitem>
<para>Create a new calendar </para>
</listitem>
<listitem>
<para>For "Type," select "CalDAV" </para>
</listitem>
<listitem>
<para>When "CalDAV" is selected, additional options will appear in the dialogue window. </para>
</listitem>
<listitem>
<para>URL: <code>https://</code><emphasis>IP-address-or-domain-for-your-server</emphasis><code>/radicale/</code><emphasis>user</emphasis><code>/</code><emphasis>contact-file-name</emphasis><code>.ics/</code>. Items in <emphasis>italics</emphasis> need to be changed to match your settings. </para>
<itemizedlist>
<listitem>
<para>note the trailing <code>/</code> in the path, it is important. </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Enable "Use a secure connection." </para>
</listitem>
<listitem>
<para>Name the calendar </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Radicale?action=AttachFile&amp;do=get&amp;target=Radicale-Evolution-Docu.png"/>
</imageobject>
<textobject>
<phrase>Radicale-Evolution-Docu.png</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>TODO/Tasks list: Adding a TODO/Tasks list is basically the same as a calendar. </para>
</listitem>
<listitem>
<para>Contacts </para>
<itemizedlist>
<listitem>
<para>Follow the same steps described above and replace CalDAV with WebDAV. The extension of the address book will be .vcf. </para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Android </para>
<itemizedlist>
<listitem>
<para>There are various Apps that allow the integration of the *radicale* server. This example uses DAVdroid, which is available e.g. on <ulink url="https://f-droid.org/repository/browse/?fdid=at.bitfire.davdroid">F-Droid</ulink>. </para>
</listitem>
<listitem>
<para>If you intend to use ToDo-Lists as well, the compatible app <ulink url="https://f-droid.org/repository/browse/?fdid=org.dmfs.tasks">OpenTasks</ulink> has to be installed first. </para>
</listitem>
<listitem>
<para>Install DAVdroid </para>
</listitem>
<listitem>
<para>Create an account in DAVdroid with the same settings as described for Evolution </para>
</listitem>
<listitem>
<para>Click the newly created account and synchronize. </para>
</listitem>
<listitem>
<para>The settings, such as periodicity of synchronization, can be adjusted. </para>
</listitem>
<listitem>
<para>A contact or calendar file, that was created before appears. </para>
</listitem>
<listitem>
<para>Enable it. </para>
</listitem>
<listitem>
<para>It may take some minutes before e.g. the calendar is visible in your calendar app. </para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section>
<title>Advanced Users</title>
<section>
<title>Sharing resources</title>
<para>Above was shown an easy way to create a resource for a group of people by creating a dedicated account for all. Here will be described an alternative method where two users <code>User1</code> and <code>User2</code> are granted access to a calendar. This requires SSH-access to the FreedomBox. </para>
<orderedlist numeration="arabic">
<listitem>
<para>create a file <code>/etc/radicale/rights</code> </para>
<itemizedlist>
<listitem override="none">
<screen><![CDATA[[friends_calendar]
user: ^(User1|User2)$
collection: ^.*/calendar_of_my_friends.ics$
permission: rw
# Give write access to owners
[owner-write]
user: .+
collection: ^%(login)s/.+$
permission: rw]]></screen>
</listitem>
<listitem>
<para><code>[friends_calendar]</code> is just an identifier, can be any name. </para>
</listitem>
<listitem>
<para>The <code>[owner-write]</code> section makes sure that owners have access to their own files </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>edit file <code>/etc/radicale/config</code> and make the following changes in section <code>[rights)</code> </para>
<itemizedlist>
<listitem override="none">
<screen><![CDATA[[rights]
type = from_file
file = /etc/radicale/rights]]></screen>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Restart the radicale server or the FreedbomBox </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Importing files</title>
<para>If you are using a contacts file exported from another service or application, it should be copied to: /var/lib/radicale/collections/<emphasis>user</emphasis>/<emphasis>contact file name</emphasis>.vcf. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Radicale/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</section>
</article>

283
doc/Repro.raw.xml Normal file
View File

@ -0,0 +1,283 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Repro</title>
<revhistory>
<revision>
<revnumber>6</revnumber>
<date>2017-01-02 13:43:51</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add port forwarding info</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-12-31 03:57:09</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add basic info</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-12-26 18:56:31</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add screenshots</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-05-27 17:24:23</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add footer</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-05-27 17:21:48</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>Renamed from 'FreedomBox/Manual/repro'.</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-05-15 19:03:02</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>start page</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>SIP Server (repro)</title>
<para>repro is a server for SIP, a standard that enables Voice-over-IP calls. A desktop or mobile SIP client is required to use repro. </para>
<section>
<title>How to set up the SIP server</title>
<orderedlist numeration="arabic">
<listitem>
<para>Configure the domain at /repro/domains.html on the FreedomBox. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Repro?action=AttachFile&amp;do=get&amp;target=repro_domains.png" width="800"/>
</imageobject>
<textobject>
<phrase>Repro Domains</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Add users at /repro/addUser.html. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Repro?action=AttachFile&amp;do=get&amp;target=repro_users.png" width="800"/>
</imageobject>
<textobject>
<phrase>Repro Users</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Disable and re-enable the repro application in Plinth. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Port Forwarding</title>
<para>If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for repro: </para>
<itemizedlist>
<listitem>
<para>TCP 5060 </para>
</listitem>
<listitem>
<para>TCP 5061 </para>
</listitem>
<listitem>
<para>UDP 5060 </para>
</listitem>
<listitem>
<para>UDP 5061 </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Repro/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

230
doc/Roundcube.raw.xml Normal file
View File

@ -0,0 +1,230 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Roundcube</title>
<revhistory>
<revision>
<revnumber>6</revnumber>
<date>2016-12-31 03:41:20</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add link</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-09-01 19:12:35</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-04-10 07:25:23</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-12-15 19:04:22</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Text finishing</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 19:03:29</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added ## END_INCLUDE</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 19:02:17</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Rouncube page with definition</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Email Client (Roundcube)</title>
<section>
<title>What is Roundcube?</title>
<para>Roundcube is a browser-based multilingual email client with an application-like user interface. Roundcube is using the Internet Message Access Protocol (IMAP) to access e-mail on a remote mail server. It supports MIME to send files, and provides particularly address book, folder management, message searching and spell checking. </para>
</section>
<section>
<title>Using Roundcube</title>
<para>After Roundcube is installed, it can be accessed at <code>https://&lt;your freedombox&gt;/roundcube</code>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Roundcube/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

276
doc/Searx.raw.xml Normal file
View File

@ -0,0 +1,276 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Searx</title>
<revhistory>
<revision>
<revnumber>6</revnumber>
<date>2018-03-08 15:08:44</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Add screenshot. Remove last 20 seconds from screencast to reduce size.</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2018-03-08 14:23:24</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Add query param to make the video play within the browser</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2018-03-07 20:43:27</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2018-03-07 20:37:05</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screencast of the installation and first steps</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2018-02-26 17:15:26</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>included in 0.24</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2018-02-22 12:12:50</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>searx: Initial draft</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Web Search (Searx)</title>
<section>
<title>About Searx</title>
<para>Searx is a <ulink url="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</ulink>. A metasearch engine aggregates the results from various search engines and presents them in a unified interface. </para>
<para>Read more about Searx on their <ulink url="https://asciimoo.github.io/searx/">official website</ulink>. </para>
<para><emphasis role="strong">Available since:</emphasis> version 0.24.0 </para>
</section>
<section>
<title>Screenshot</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Searx?action=AttachFile&amp;do=get&amp;target=searx-screenshot.png" width="800"/>
</imageobject>
<textobject>
<phrase>Searx Screenshot</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Screencast</title>
<para><ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Manual/Searx?action=AttachFile&amp;do=get&amp;target=Searx.webm">Searx installation and first steps</ulink> (14 MB) </para>
</section>
<section>
<title>Why use Searx?</title>
<section>
<title>Personalization and Filter Bubbles</title>
<para>Search engines have the ability to profile users and serve results most relevant to them, putting people into <ulink url="https://en.wikipedia.org/wiki/Filter_bubble">filter bubbles</ulink>, thus distorting people's view of the world. Search engines have a financial incentive to serve interesting advertisements to their users, increasing their chances of clicking on the advertisements. </para>
<para>A metasearch engine is a possible solution to this problem, as it aggregates results from multiple search engines thus bypassing personalization attempts by search engines. </para>
<para>Searx avoids storing cookies from search engines as a means of preventing tracking and profiling by search engines. </para>
</section>
<section>
<title>Advertisement filtering</title>
<para>Searx filters out advertisements from the search results before serving the results, thus increasing relevance the of your search results and saving you from distractions. </para>
</section>
<section>
<title>Privacy</title>
<para>Searx uses HTTP POST instead of GET by default to send your search queries to the <ulink url="https://en.wikipedia.org/wiki/Web_search_engine">search engines</ulink>, so that anyone snooping your traffic wouldn't be able to read your queries. The search queries wouldn't stored in browser history either. </para>
<para><emphasis role="strong">Note:</emphasis> Searx used from Chrome browser's omnibar would make GET requests instead of POST. </para>
</section>
</section>
<section>
<title>Searx on FreedomBox</title>
<itemizedlist>
<listitem>
<para>Searx on FreedomBox uses Single Sign On. This means that you should be logged in into your FreedomBox in the browser that you're using Searx. </para>
</listitem>
<listitem>
<para>Searx can be added as a search engine to the Firefox browser's search bar. See <ulink url="https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox">Firefox Help</ulink> on this topic. Once Searx is added, you can also set it as your default search engine. </para>
</listitem>
<listitem>
<para>Searx also offers search results in csv, json and rss formats, which can be used with scripts to automate some tasks. </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Searx/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

322
doc/SecureShell.raw.xml Normal file
View File

@ -0,0 +1,322 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/SecureShell</title>
<revhistory>
<revision>
<revnumber>11</revnumber>
<date>2018-01-30 07:55:33</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Update GitHub links with Salsa</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2017-03-06 23:17:08</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add note</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-10-13 21:49:06</date>
<authorinitials>David Jones</authorinitials>
<revremark>Added infromation about connecting to the FBX using ssh over Tor</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-10-13 21:09:31</date>
<authorinitials>David Jones</authorinitials>
<revremark>Added information about admin account for first log in to Plinth</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-09-05 09:42:36</date>
<authorinitials>ElVirolo</authorinitials>
<revremark>Removing my previous contribution, as info already present in original version.</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-09-05 09:39:05</date>
<authorinitials>ElVirolo</authorinitials>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-09-05 09:26:15</date>
<authorinitials>ElVirolo</authorinitials>
<revremark>Added "Users created via Plinth" paragraph</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-12-21 19:42:10</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>update default account</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-12-21 19:33:56</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>fix outline level</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 19:31:18</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added definition title</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-16 16:22:37</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>New manual page for secure shell access</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Secure Shell</title>
<section>
<title>What is Secure Shell?</title>
<para>FreedomBox runs <code>openssh-server</code> server by default allowing remote logins from all interfaces. If your hardware device is connected to a monitor and a keyboard, you may login directly as well. Regular operation of FreedomBox does not require you to use the shell. However, some tasks or identifying a problem may require you to login to a shell. </para>
</section>
<section>
<title>Setting Up A User Account</title>
<section>
<title>Plinth First Log In: Admin Account</title>
<para>When creating an account in Plinth for the first time, this user will automatically have administrator capabilities. <code>Admin</code> users are able to log in using ssh (see Logging In below) and have superuser privileges via sudo. </para>
</section>
<section>
<title>Default User Account</title>
<itemizedlist>
<listitem>
<para>Note: If you can access Plinth, then you don't need to do this. You can use the user account created in Plinth to connect to SSH. </para>
</listitem>
</itemizedlist>
<para>The pre-built FreedomBox images have a default user account called "fbx". However the password is not set for this account, so it will not be possible to log in with this account by default. </para>
<para>There is a script included in the freedom-maker program, that will allow you to set the password for this account, if it is needed. To set a password for the "fbx" user: </para>
<para>1. Decompress the image file. </para>
<para>2. Get a copy of freedom-maker from <ulink url="https://salsa.debian.org/freedombox-team/freedom-maker/"/>. </para>
<para>3. Run <code>sudo ./bin/passwd-in-image &lt;image-file&gt; fbx</code>. </para>
<para>4. Copy the image file to SD card and boot device as normal. </para>
<para>The "fbx" user also has superuser privileges via sudo. </para>
</section>
</section>
<section>
<title>Logging In</title>
<section>
<title>Local</title>
<para>To login via SSH, to your FreedomBox: </para>
<screen><![CDATA[$ ssh fbx@freedombox]]></screen>
<para>Replace <code>fbx</code> with the name of the user you wish to login as. <code>freedombox</code> should be replaced with the hostname or IP address of you FreedomBox device as found in the <ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Manual/QuickStart#">Quick Start</ulink> process. </para>
<para><code>fbx</code> is the default user present on FreedomBox with superuser privileges. Any other user created using Plinth and belonging to the group <code>admin</code> will be able to login. The <code>root</code> account has no password set and will not be able to login. Access will be denied to all other users. </para>
<para><code>fbx</code> and users in <code>admin</code> group will also be able to login on the terminal directly. Other users will be denied access. </para>
<para>If you repeatedly try to login as a user and fail, you will be blocked from logging in for some time. This is due to <code>libpam-abl</code> package that FreedomBox installs by default. To control this behavior consult <code>libpam-abl</code> documentation. </para>
</section>
<section>
<title>SSH over Tor</title>
<para>If in Plinth you have enabled hidden services via Tor, you can access your <ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox#">FreedomBox</ulink> using ssh over Tor. On a GNU/Linux computer, install netcat-openbsd. </para>
<screen><![CDATA[$ sudo apt-get install netcat-openbsd]]></screen>
<para>Edit ~/.ssh/config to enable connections over Tor. </para>
<screen><![CDATA[$ nano ~/.ssh/config]]></screen>
<para>Add the following: </para>
<screen><![CDATA[Host *.onion
user USERNAME
port 22
ProxyCommand nc -X 5 -x 127.0.0.1:9050 %h %p]]></screen>
<para>Replace USERNAME with, e.g., an <code>admin</code> username (see above). </para>
<para>Note that in some cases you may need to replace 9050 with 9150. </para>
<para>Now to connect to the <ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox#">FreedomBox</ulink>, open a terminal and type: </para>
<screen><![CDATA[$ ssh USERNAME@ADDRESS.onion]]></screen>
<para>Replace USERNAME with, e.g., an <code>admin</code> username, and ADDRESS with the hidden service address for your <ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox#">FreedomBox</ulink>. </para>
</section>
</section>
<section>
<title>Becoming Superuser</title>
<para>After logging in, if you want to become the superuser for performing administrative activities: </para>
<screen><![CDATA[$ sudo su]]></screen>
<para>Make a habit of logging in as root <emphasis>only when you need to</emphasis>. If you aren't logged in as root, you can't accidentally break everything. </para>
<para>
<anchor id="changingpassword"/>
</para>
</section>
<section>
<title>Changing Password</title>
<para>To change the password of a user managed by Plinth, use the change password page. However, the <code>fbx</code> default user is not managed by Plinth and its password cannot be changed in the web interface. </para>
<para>To change password on the terminal, log in to your FreedomBox as the user whose password you want to change. Then, run the following command: </para>
<screen><![CDATA[$ passwd]]></screen>
<para>This will ask you for your current password before giving you the opportunity to set a new one. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/SecureShell/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

210
doc/Security.raw.xml Normal file
View File

@ -0,0 +1,210 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Security</title>
<revhistory>
<revision>
<revnumber>2</revnumber>
<date>2016-08-31 17:40:56</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screenshot</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-31 17:37:33</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>creation</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Security</title>
<para>When this option is enabled, only users in the "admin" group will be able to log in to console or via SSH. Console users may be able to access some services without further authorization. </para>
<para>You can define the group of the users in the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Manual/Users#">Users</ulink> section. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Security?action=AttachFile&amp;do=get&amp;target=Security.png"/>
</imageobject>
<textobject>
<phrase>Security.png</phrase>
</textobject>
</inlinemediaobject>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Security/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

201
doc/ServiceDiscovery.raw.xml Normal file
View File

@ -0,0 +1,201 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/ServiceDiscovery</title>
<revhistory>
<revision>
<revnumber>2</revnumber>
<date>2017-01-02 13:17:40</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>mention .local address</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 09:48:13</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Service Discovery</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Service Discovery</title>
<para>Service discovery allows other devices on the network to discover your FreedomBox and services running on it. If a client on the local network supports mDNS, it can find your FreedomBox at &lt;hostname&gt;.local (for example: freedombox.local). </para>
<para>It also allows FreedomBox to discover other devices and services running on your local network. </para>
<para>Service discovery is not essential and works only on internal networks. It may be disabled to improve security especially when connecting to a hostile local network. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ServiceDiscovery/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

218
doc/Shadowsocks.raw.xml Normal file
View File

@ -0,0 +1,218 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Shadowsocks</title>
<revhistory>
<revision>
<revnumber>1</revnumber>
<date>2018-01-04 19:59:57</date>
<authorinitials>David Jones</authorinitials>
</revision>
</revhistory>
</articleinfo>
<section>
<title>SOCKS5 proxy (Shadowsocks)</title>
<section>
<title>What is Shadowsocks?</title>
<para><ulink url="https://shadowsocks.org/en/index.html">Shadowsocks</ulink> is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server. </para>
<para><emphasis role="strong">Note:</emphasis> Shadowsocks is available in FreedomBox starting with Plinth version 0.18. </para>
</section>
<section>
<title>Using the Shadowsocks client?</title>
<para>The current implementation of Shadowsocks in <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> only supports configuring <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> as a Shadowsocks client. The current use case for Shadowsocks is as follows: </para>
<itemizedlist>
<listitem>
<para>Shadowsocks client (<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink>) is in a region where some parts of the Internet are blocked or censored. </para>
</listitem>
<listitem>
<para>Shadowsocks server is in a different region, which doesn't have these blocks. </para>
</listitem>
<listitem>
<para>The <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> provides SOCKS proxy service on the local network for other devices to make use of its Shadowsocks connection. </para>
</listitem>
</itemizedlist>
<para>At a future date it will be possible to configure <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> as Shadowsocks server. </para>
</section>
<section>
<title>Configuring your FreedomBox for the Shadowsocks client</title>
<para>To enable Shadowsocks, first navigate to the Socks5 Proxy (Shadowsocks) page and install it. </para>
<para>Server: the Shadowsocks server is not the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> IP or URL; rather, it will be another server or VPS that has been configured as a Shadowsocks server. There are also some public Shadowsocks servers listed on the web, but be aware that whoever operates the server can see where requests are going, and any non-encrypted data will be visible to them. </para>
<para>To use Shadowsocks after setup, set the SOCKS5 proxy URL in your device, browser or application to <ulink url="http://freedombox_address:1080/"/> </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

214
doc/Snapshots.raw.xml Normal file
View File

@ -0,0 +1,214 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Snapshots</title>
<revhistory>
<revision>
<revnumber>2</revnumber>
<date>2018-03-10 15:11:41</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized image</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2017-11-14 02:24:01</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>new page for snapshots module</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Snapshots</title>
<para><emphasis>Snapshots</emphasis> allows you to create filesystem snapshots, and rollback the system to a previous snapshot. </para>
<itemizedlist>
<listitem>
<para>Note: This feature requires a Btrfs filesystem. All of the FreedomBox stable disk images use Btrfs. </para>
</listitem>
</itemizedlist>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Snapshots?action=AttachFile&amp;do=get&amp;target=snapshots.png" width="800"/>
</imageobject>
<textobject>
<phrase>Snapshots</phrase>
</textobject>
</inlinemediaobject>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Snapshots/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

240
doc/Storage.raw.xml Normal file
View File

@ -0,0 +1,240 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Storage</title>
<revhistory>
<revision>
<revnumber>7</revnumber>
<date>2018-03-05 12:17:19</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Renamed from 'FreedomBox/Manual/Disks'.</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2018-03-05 12:16:41</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Renaming Disks to Storage</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2017-04-09 13:45:57</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>update note about issue</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2017-03-31 20:16:25</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>update screenshot with "expand partition"</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2017-02-10 22:33:01</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add warning about non-functional feature</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-08-31 17:10:11</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>screenshot</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-31 17:09:10</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Disks creation</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Storage</title>
<para><emphasis>Storage</emphasis> shows free space of mounted partitions. </para>
<para>If there is some free space left after the root partition, the option to expand the root partition is also available. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Storage?action=AttachFile&amp;do=get&amp;target=Disks.png"/>
</imageobject>
<textobject>
<phrase>Disks.png</phrase>
</textobject>
</inlinemediaobject>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Storage/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

261
doc/Syncthing.raw.xml Normal file
View File

@ -0,0 +1,261 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Syncthing</title>
<revhistory>
<revision>
<revnumber>10</revnumber>
<date>2018-03-10 04:32:57</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized image</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2017-10-22 14:57:58</date>
<authorinitials>Drahtseil</authorinitials>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2017-10-22 14:57:09</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Syncthing GUI image</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2017-10-22 14:54:54</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Some rewording etc.</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2017-10-21 14:59:53</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Titel same as in Plinth GUI; standard footer; some basic restructuring before I will update the docu more in detail</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2017-04-04 10:39:36</date>
<authorinitials>JosephNuthalapati</authorinitials>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2017-03-23 10:54:49</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Rewrote the section on Syncthing's role in FreedomBox</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2017-03-23 05:12:13</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor formatting</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2017-03-23 05:11:43</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add note about availability of Syncthing</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2017-03-23 02:11:00</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Created wiki page for Syncthing</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>File Synchronization (Syncthing)</title>
<para>With <emphasis>Syncthing</emphasis> installed on your FreedomBox, you can synchronize content from other devices to your FreedomBox and vice-versa. For example, you can keep the photos taken on your mobile phone synchronized to your FreedomBox. </para>
<para><emphasis role="strong">Note:</emphasis> Syncthing is available in FreedomBox starting with Plinth version 0.14. </para>
<para>Users should keep in mind that Syncthing is a peer-to-peer synchronization solution, not a client-server one. This means that the FreedomBox isn't really the server and your other devices clients. They're all devices from Syncthing's perspective. You can use Syncthing to synchronize your files between any of your devices. The advantage that FreedomBox provides is that it is a server that's always running. Suppose you want your photos on your phone to be synchronized to your laptop, if you simply sync the photos to the FreedomBox, the laptop can get them from the FreedomBox whenever it comes online the next time. You don't have to be worried about your other devices being online for synchronization. If your FreedomBox is one of the devices set up with your Syncthing shared folder, you can rest assured that your other devices will eventually get the latest files once they come online. </para>
<para>After installation follow the instructions in the <ulink url="https://docs.syncthing.net/intro/getting-started.html">getting started of the Syncthing project</ulink>. Syncthing allows individual folders to be selectively shared with other devices. Devices must be paired up before sharing by scanning QR codes or entering the device ids manually. Syncthing has a discovery service for easily identifying the other devices on the same network having Syncthing installed. </para>
<para>In order to access to the web client of the Syncthing instance running on your FreedomBox, use the path <emphasis>/syncthing</emphasis>. This web client is currently only accessible to the users of the FreedomBox that have administrator privileges, though it might be accessible to all FreedomBox users in a future release. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Syncthing?action=AttachFile&amp;do=get&amp;target=Syncthing_GUI.png" width="800"/>
</imageobject>
<textobject>
<phrase>Syncthing web interface</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>Syncthing has android apps available on the <ulink url="https://f-droid.org/repository/browse/?fdid=com.nutomic.syncthingandroid">F-Droid</ulink> and <ulink url="https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid">Google Play</ulink> app stores. Cross-platform desktop apps are also available. </para>
<para>To learn more about Syncthing, please visit their <ulink url="https://syncthing.net">official website</ulink> and <ulink url="https://docs.syncthing.net">documentation</ulink>. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Syncthing/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</article>

398
doc/TinyTinyRSS.raw.xml Normal file
View File

@ -0,0 +1,398 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/TinyTinyRSS</title>
<revhistory>
<revision>
<revnumber>10</revnumber>
<date>2018-03-11 03:05:29</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Fix oversized images</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2017-10-18 13:51:27</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Remove link to source code as this wiki seems to have banned anything that starts with git.tt</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2017-10-18 13:47:46</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Add importing OPML feeds and link to source code of TT-RSS Android App</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2017-10-18 12:58:46</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Add documentation for automatic detection of RSS feeds and the Unsubscribe option</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2017-10-18 12:37:03</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Add screenshots for subscribing to a new RSS feed</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2017-10-16 12:11:52</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Minor styling</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2017-10-16 12:08:36</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add information about mobile application</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-12-31 03:49:54</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add screenshot</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-12-31 03:44:56</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add user info</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-09-04 10:18:59</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>stub created</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>News Feed Reader (Tiny Tiny RSS)</title>
<para>Tiny Tiny RSS is a news feed (RSS/Atom) reader and aggregator, designed to allow reading news from any location, while feeling as close to a real desktop application as possible. </para>
<para>Any user created through FreedomBox web interface will be able to login and use this app. Each user has their own feeds, state and preferences. </para>
<section>
<title>Using the Web Interface</title>
<para>When enabled, Tiny Tiny RSS will be available from <emphasis>/tt-rss</emphasis> path on the web server. Any user created through Plinth will be able to login and use this app. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrss.png" width="800"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
</para>
<section>
<title>Adding a new feed</title>
<para>1. Go to the website you want the RSS feed for and copy the RSS/Atom feed link from it. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=Select-RSS-feed.png" width="800"/>
</imageobject>
<textobject>
<phrase>Selecting feeds</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>2. Select "Subscribe to feed.." from the Actions dropdown. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=Subscribe-to-feed.png"/>
</imageobject>
<textobject>
<phrase>Subscribe to feed</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>3. In the dialog box that appears, paste the URL for copied in step 1 and click the <emphasis role="strong">Subscribe</emphasis> button. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=Subscribe-dialog.png" width="800"/>
</imageobject>
<textobject>
<phrase>Subscription dialog box</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>Give the application a minute to fetch the feeds after clicking Subscribe. </para>
<para>In some websites, the RSS feeds button isn't clearly visible. In that case, you can simply paste the website URL into the Subscribe dialog (step 3) and let TT-RSS automatically detect the RSS feeds on the page. </para>
<para>You can try this now with the homepage of <ulink url="https://en.wikinews.org/wiki/Main_Page">WikiNews</ulink> </para>
<para>As you can see in the image below, TT-RSS detected and added the Atom feed of WikiNews to our list of feeds. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=WikiNews-feed.png"/>
</imageobject>
<textobject>
<phrase>WikiNews feed added</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>If you don't want to keep this feed, right click on the feed shown in the above image, select <emphasis role="strong">Edit feed</emphasis> and click <emphasis role="strong">Unsubscribe</emphasis> in the dialog box that appears. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=Unsubscribe.png" width="800"/>
</imageobject>
<textobject>
<phrase>Unsubscribe from a feed</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Importing your feeds from another feed reader</title>
<para>In your existing feed reader, find an option to <emphasis>Export</emphasis> your feeds to a file. Prefer the OPML file format if you have to choose between multiple formats. Let's say your exported feeds file is called Subscriptions.opml </para>
<para>Click on the <emphasis>Actions</emphasis> menu at the top left corner and select <emphasis>Preferences</emphasis>. You will be taken to another page. </para>
<para>Select the second tab called <emphasis>Feeds</emphasis> in the top header. Feeds has several sections. The second one is called <emphasis>OPML</emphasis>. Select it. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=OPML.png" width="960"/>
</imageobject>
<textobject>
<phrase>OPML feeds page</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>To import your Subscriptions.opml file into TT-RSS, </para>
<orderedlist numeration="arabic">
<listitem>
<para>Click <emphasis>Browse</emphasis> and select the file from your file system </para>
</listitem>
<listitem>
<para>Click <emphasis>Import my OPML</emphasis> </para>
</listitem>
</orderedlist>
<para>After importing, you'll be taken to the <emphasis role="strong">Feeds</emphasis> section that's above the OPML section in the page. You can see that the feeds from your earlier feed reader are now imported into Tiny Tiny RSS. You can now start using Tiny Tiny RSS as your primary feed reader. </para>
<para>In the next section, we will discuss setting up the mobile app, which can let you read your feeds on the go. </para>
</section>
</section>
<section>
<title>Using the Mobile App</title>
<para>The official Android app from the Tiny Tiny RSS project works with FreedomBox's Tiny Tiny RSS Server. The older TTRSS-Reader application is known <emphasis role="strong">not</emphasis> to work. </para>
<para>The official Android app is unfortunately only available on the Google Play Store and not on F-Droid. You can still obtain the source code and build the apk file yourself. </para>
<para>To configure, first install the application, then in the setting page, set URL as <emphasis><ulink url="https://&lt;your.freedombox.address&gt;/tt-rss-app/"/></emphasis>. Set your user name and password in the Login details as well as HTTP Authentication details. If your FreedomBox does not have a valid HTTPS certificate, then in settings request allowing any SSL certificate and any host. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrssapp1.png" width="288"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrssapp2.png" width="288"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrssapp3.png" width="288"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrssapp4.png" width="288"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS?action=AttachFile&amp;do=get&amp;target=ttrssapp5.png" width="288"/>
</imageobject>
<textobject>
<phrase>Tiny Tiny RSS</phrase>
</textobject>
</inlinemediaobject>
</para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/TinyTinyRSS/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

297
doc/Tor.raw.xml Normal file
View File

@ -0,0 +1,297 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Tor</title>
<revhistory>
<revision>
<revnumber>13</revnumber>
<date>2017-01-07 16:00:24</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add image</revremark>
</revision>
<revision>
<revnumber>12</revnumber>
<date>2017-01-07 15:21:27</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>plural</revremark>
</revision>
<revision>
<revnumber>11</revnumber>
<date>2016-12-31 02:19:46</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>mention ssh</revremark>
</revision>
<revision>
<revnumber>10</revnumber>
<date>2016-12-31 02:19:03</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add relay info</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2016-12-23 18:31:29</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>undo outline level change</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-12-23 18:30:06</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>move down outline level</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-04-10 07:14:17</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2015-12-15 16:54:58</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Text finishing</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2015-12-15 16:40:11</date>
<authorinitials>PhilippeBaret</authorinitials>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2015-12-15 16:34:38</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Tor definition</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2015-09-13 14:54:59</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Demote headings one level for inclusion into manual</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-09-13 14:53:54</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add FreedomBox category and portal</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-12 15:55:05</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>create tor page</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Anonymity Network (Tor)</title>
<section>
<title>What is Tor?</title>
<para>Tor is a network of servers operated by volunteers. It allows users of these servers to improve their privacy and security while surfing on the Internet. You and your friends are able to access to your FreedomBox via Tor network without revealing its IP address. Activating Tor application on your FreedomBox, you will be able to offer remote services (chat, wiki, file sharing, etc...) without showing your location. This application will give you a better protection than a public web server because you will be less exposed to intrusive people on the web. </para>
</section>
<section>
<title>Using Tor to browse anonymously</title>
<para>Tor Browser is the recommended way to browse the web using Tor. You can download the Tor Browser from <ulink url="https://www.torproject.org/projects/torbrowser.html"/> and follow the instructions on that site to install and run it. </para>
</section>
<section>
<title>Using Tor Hidden Service to access your FreedomBox</title>
<para>Tor Hidden Service provides a way to access your FreedomBox, even if it's behind a router or firewall. </para>
<para>To enable Tor Hidden Service, first navigate to the Anonymity Network (Tor) page. (If you don't see it, click on the FreedomBox logo at the top-left of the page, to go to the main Apps page.) On the Anonymity Network (Tor) page, under Configuration, check "Enable Tor Hidden Service", then press the Update setup button. Tor will be reconfigured and restarted. </para>
<para>After a while, the page will refresh and under Status, you will see a table listing the Hidden Service .onion address. Copy the entire address (ending in .onion) and paste it into the Tor Browser's address field, and you should be able to access your FreedomBox. (You may see a certificate warning because FreedomBox has a self-signed certificate.) </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Tor?action=AttachFile&amp;do=get&amp;target=tor_browser_plinth.png" width="800"/>
</imageobject>
<textobject>
<phrase>Tor Browser - Plinth</phrase>
</textobject>
</inlinemediaobject>
</para>
<para>Currently only HTTP (port 80), HTTPS (port 443), and SSH (port 22) are accessible through the Tor Hidden Service configured on the FreedomBox. </para>
</section>
<section>
<title>Running a Tor relay</title>
<para>When Tor is installed, it is configured by default to run as a bridge relay. The relay or bridge option can be disabled through the Tor configuration page in Plinth. </para>
<para>At the bottom of the Tor page in Plinth, there is a list of ports used by the Tor relay. If your FreedomBox is behind a router, you will need to configure port forwarding on your router so that these ports can be reached from the public Internet. </para>
</section>
<section>
<title>Using Tor SOCKS port (advanced)</title>
<para>FreedomBox provides a Tor SOCKS port that other applications can connect to, in order to route their traffic over the Tor network. This port is accessible on any interfaces configured in the internal firewall zone. To configure the application, set SOCKS Host to the internal network connection's IP address, and set the SOCKS Port to 9050. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Tor/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

269
doc/Transmission.raw.xml Normal file
View File

@ -0,0 +1,269 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Transmission</title>
<revhistory>
<revision>
<revnumber>9</revnumber>
<date>2016-12-31 02:07:57</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add login info</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2016-12-30 19:20:51</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>reword</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-12-30 19:13:09</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add intro paragraph</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-12-30 18:59:46</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>no space in "BitTorrent"</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-12-26 18:00:44</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add screenshot</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-09-01 19:04:35</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-04-10 07:27:22</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 20:42:02</date>
<authorinitials>PhilippeBaret</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-12-15 18:23:33</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added Transmission page and definition</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>BitTorrent (Transmission)</title>
<section>
<title>What is Transmission ?</title>
<para>BitTorrent is a communications protocol using peer-to-peer (P2P) file sharing. It is not anonymous; you should assume that others can see what files you are sharing. There are two BitTorrent web clients available in FreedomBox: Transmission and <ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Manual/Deluge#">Deluge</ulink>. They have similar features, but you may prefer one over the other. </para>
<para>Transmission is a lightweight BitTorrent client that is well known for its simplicity and a default configuration that "Just Works". </para>
</section>
<section>
<title>Screenshot</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Transmission?action=AttachFile&amp;do=get&amp;target=transmission.png" width="800"/>
</imageobject>
<textobject>
<phrase>Transmission Web Interface</phrase>
</textobject>
</inlinemediaobject>
</para>
</section>
<section>
<title>Using Transmission</title>
<para>After installing Transmission, it can be accessed at <code>https://&lt;your freedombox&gt;/transmission</code>. When you try to access this page, you will be required to login with a username and password. The default for both is "transmission". You can change the username and password using the configuration form in Plinth. </para>
</section>
<section>
<title>Known Issues</title>
<itemizedlist>
<listitem>
<para>The initial password is shown in the Plinth configuration form in a hashed format. This prevents it from being read or copied. However, after the password is changed, it is shown directly, without hashing. </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Transmission/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

238
doc/Upgrades.raw.xml Normal file
View File

@ -0,0 +1,238 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Upgrades</title>
<revhistory>
<revision>
<revnumber>5</revnumber>
<date>2017-03-31 20:11:01</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Screenshot automatic upgrades</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-09-01 19:20:27</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-01-16 07:41:43</date>
<authorinitials>StacyCockrum</authorinitials>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-01-16 07:35:56</date>
<authorinitials>StacyCockrum</authorinitials>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-16 15:01:05</date>
<authorinitials>SunilMohanAdapa</authorinitials>
<revremark>Add upgrades manual page</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Software Upgrades</title>
<para>FreedomBox can automatically install security upgrades. On the <emphasis>Upgrades</emphasis> page of the <emphasis>Settings</emphasis> section in Plinth you can turn on automatic upgrades. For FreedomBox versions above 0.5, this feature is enabled by default and there is no manual action necessary. It is strongly recommended that you have this option enabled to keep your FreedomBox secure. </para>
<para>Upgrades are performed every day at night. If you wish to shutdown FreedomBox every day after use, keep it running at night once a week or so to let the automatic upgrades happen. Alternatively, you can perform manual upgrades as described below. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Upgrades?action=AttachFile&amp;do=get&amp;target=upgrades.png"/>
</imageobject>
<textobject>
<phrase>upgrades.png</phrase>
</textobject>
</inlinemediaobject>
</para>
<section>
<title>Manual Upgrades</title>
<para>In the Plinth web interface, you can initiate a manual upgrade process from <emphasis>Upgrades</emphasis> page of the <emphasis>Settings</emphasis> section. Note that once the upgrades start, it may take a long time to complete and Plinth may seem to wait for the page to load. </para>
<para>Under some circumstances, automatic upgrades may fail and require you perform a manual upgrade action. Even upgrades initiated from Plinth may not finish properly. This may be because the upgrade process requires you to make a decision. In these cases, manual upgrade on the terminal may be the only option. </para>
<para>In addition, while the upgrade task is running any application installations will wait until the upgrade task is finished. Depending on the hardware, the upgrade task may take a little time, therefore, giving the impression that the application installation stalled. </para>
<para>To perform manual upgrades on the terminal, login into FreedomBox on a terminal or using a remote secure shell (see <ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Manual/SecureShell#">Secure Shell</ulink> section). Then run the following commands: </para>
<screen><![CDATA[$ sudo su -
Password:
# apt-get update
# apt-get dist-upgrade]]></screen>
<para>This will ask you if it is alright to install/upgrade (or remove) some packages and use (or release) some disk space. Say <emphasis>yes</emphasis> after review. In some cases, during the upgrades process you will be asked questions about modified configuration files, answering with a default <emphasis>Keep current configuration</emphasis> is usually safe. </para>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Upgrades/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

233
doc/Users.raw.xml Normal file
View File

@ -0,0 +1,233 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/Users</title>
<revhistory>
<revision>
<revnumber>4</revnumber>
<date>2017-01-14 20:13:01</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add known issue</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-12-31 04:15:09</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>reword</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2016-09-01 19:21:25</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>adapted title to Plinth wording</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2016-08-21 16:48:45</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>Created Users</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Users and Groups</title>
<para>You can grant access to your FreedomBox for other users. Provide the Username with a password and assign a group to it. Currently the groups </para>
<itemizedlist>
<listitem>
<para>admin </para>
</listitem>
<listitem>
<para>wiki </para>
</listitem>
</itemizedlist>
<para>are supported. </para>
<para>The user will be able to log in to services that support single sign-on through LDAP, if they are in the appropriate group. </para>
<para>Users in the admin group will be able to log in to all services. They can also log in to the system through SSH and have administrative privileges (sudo). </para>
<para>These characteristics can also be changed later-on. </para>
<para>It is also possible to set an SSH public key which will allow this user to securely log in to the system without using a password. You may enter multiple keys, one on each line. Blank lines and lines starting with # will be ignored. </para>
<para>A user's account can be deactivated, which will temporarily disable the account. </para>
<section>
<title>Known Issues</title>
<itemizedlist>
<listitem>
<para>Currently, Plinth does not distinguish between users and administrators. Every user added through Plinth will have full access to the Plinth interface. </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Users/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

294
doc/ejabberd.raw.xml Normal file
View File

@ -0,0 +1,294 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
<articleinfo>
<title>FreedomBox/Manual/ejabberd</title>
<revhistory>
<revision>
<revnumber>10</revnumber>
<date>2018-03-02 13:01:38</date>
<authorinitials>JosephNuthalapati</authorinitials>
<revremark>Consistent naming conventions</revremark>
</revision>
<revision>
<revnumber>9</revnumber>
<date>2017-01-07 17:42:27</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add note about service restart</revremark>
</revision>
<revision>
<revnumber>8</revnumber>
<date>2017-01-02 13:48:30</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add port forwarding info</revremark>
</revision>
<revision>
<revnumber>7</revnumber>
<date>2016-12-31 03:11:19</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>clarify</revremark>
</revision>
<revision>
<revnumber>6</revnumber>
<date>2016-12-31 03:10:19</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>mention web client</revremark>
</revision>
<revision>
<revnumber>5</revnumber>
<date>2016-12-31 02:35:52</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add security info</revremark>
</revision>
<revision>
<revnumber>4</revnumber>
<date>2016-09-04 10:31:37</date>
<authorinitials>Drahtseil</authorinitials>
<revremark>added links</revremark>
</revision>
<revision>
<revnumber>3</revnumber>
<date>2016-04-10 07:18:35</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added bottom navigation link</revremark>
</revision>
<revision>
<revnumber>2</revnumber>
<date>2015-12-15 18:37:29</date>
<authorinitials>PhilippeBaret</authorinitials>
<revremark>Added definition to Chat server page</revremark>
</revision>
<revision>
<revnumber>1</revnumber>
<date>2015-09-20 23:52:11</date>
<authorinitials>JamesValleroy</authorinitials>
<revremark>add xmpp page</revremark>
</revision>
</revhistory>
</articleinfo>
<section>
<title>Chat Server (XMPP)</title>
<section>
<title>What is XMPP?</title>
<para>XMPP is a federated protocol for Instant Messaging. This means that users who have accounts on one server, can talk to users that are on another server. XMPP can also be used for voice and video calls, if supported by the clients. </para>
<para>With XMPP, there are two ways that conversations can be secured: </para>
<orderedlist numeration="arabic">
<listitem>
<para>TLS: This secures the connection between the client and server, or between two servers. This should be supported by all clients and is highly recommended. </para>
</listitem>
<listitem>
<para>End-to-end: This secures the messages sent from one client to another, so that even the server cannot see the contents. The latest and most convenient protocol is called OMEMO, but it is only supported by a few clients. There is another protocol called OTR that may be supported by some clients that lack OMEMO support. Both clients must support the same protocol for it to work. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Setting the Domain Name</title>
<para>For XMPP to work, your FreedomBox needs to have a Domain Name that can be accessed over the public Internet. You can read more about obtaining a Domain Name in the <ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Manual/DynamicDNS#">Dynamic DNS section of this manual</ulink>. </para>
<para>Once you have a Domain Name, you can tell your FreedomBox to use it by setting the Domain Name in the System <ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Manual/Configure#">Configuration</ulink>. </para>
<itemizedlist>
<listitem>
<para>Note: After changing your Domain Name, the Chat Server (XMPP) page may show that the service is not running. After a minute or so, it should be up and running again. </para>
</listitem>
</itemizedlist>
<para>Please note that <ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/Pagekite#">Pagekite</ulink> does not support the XMPP protocol at this time. </para>
</section>
<section>
<title>Registering XMPP users through SSO</title>
<para>Currently, all users created through Plinth will be able to login to the XMPP server. You can add new users through the System Users and Groups module. It does not matter which Groups are selected for the new user. </para>
</section>
<section>
<title>Using the web client</title>
<para>After the XMPP module install completes, the JSXC web client for XMPP can be accessed at <code>https://&lt;your freedombox&gt;/plinth/apps/xmpp/jsxc/</code>. It will automatically check the BOSH server connection to the configured domain name. </para>
</section>
<section>
<title>Using a desktop or mobile client</title>
<para><ulink url="https://xmpp.org/software/clients.html">XMPP clients</ulink> are available for various desktop and mobile platforms. </para>
</section>
<section>
<title>Port Forwarding</title>
<para>If your FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for XMPP: </para>
<itemizedlist>
<listitem>
<para>TCP 5222 (client-to-server) </para>
</listitem>
<listitem>
<para>TCP 5269 (server-to-server) </para>
</listitem>
</itemizedlist>
<!--rule (<hr>) is not applicable to DocBook-->
<informaltable>
<tgroup cols="8">
<colspec colname="col_0"/>
<colspec colname="col_1"/>
<colspec colname="col_2"/>
<colspec colname="col_3"/>
<colspec colname="col_4"/>
<colspec colname="col_5"/>
<colspec colname="col_6"/>
<colspec colname="col_7"/>
<tbody>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Information</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Support</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Work Space</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Reports</emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong">Promote</emphasis>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Introduction#">Overview</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Hardware#">Hardware</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Support#">Live Help</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Contribute#">Where To Start</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Translate#">Translate</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/ProgressCalls#">Calls</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/TalksAndPresentations#">Talks</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Features#">Features</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Vision#">Vision</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/QuestionsAndAnswers#">Q&amp;A</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Design#">Design</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/TODO#">To Do</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Metrics#">Metrics</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Press#">Press</ulink>
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Download#">Download</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Manual#">Manual</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<emphasis role="strong"> </emphasis>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/UserExperience#">Use cases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Contribute/Code#">Code</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Contributors#">Contributors</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/ReleaseNotes#">Releases</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Manual/ejabberd/FreedomBox/Blog#">Blog</ulink>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!--rule (<hr>) is not applicable to DocBook-->
<para>
</para>
</section>
</section>
</article>

65
doc/fetch-manual-pages Executable file
View File

@ -0,0 +1,65 @@
#!/usr/bin/python3
#
# This file is part of FreedomBox.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import re
import urllib.request
from subprocess import PIPE, Popen
MANUAL_PAGE_URL = "https://wiki.debian.org/FreedomBox/Manual/{}?action=show&mimetype=text%2Fdocbook"
MANUAL_INDEX_RAW_URL = "https://wiki.debian.org/FreedomBox/Manual?action=raw"
manual_pages = []
to_remove = ['QuickStart', 'GettingHelp', 'Developer']
def write_manual_pages():
pattern = 'FreedomBox/Manual/\w+'
lst = list(urllib.request.urlopen(MANUAL_INDEX_RAW_URL))
global manual_pages
manual_pages = list(l[0].split('/')[-1] for l in filter(
None, map(lambda x: re.findall(pattern, x.decode()), lst)))
for entry in to_remove:
if entry in manual_pages:
manual_pages.remove(entry)
with open('manual-pages.list', 'w') as lst_file:
lst_file.write('\n'.join(manual_pages))
def fetch_manual_pages_in_docbook_format():
for page in manual_pages:
url = MANUAL_PAGE_URL.format(page)
p1 = Popen(['wget', '--quiet', '-O', '-', url], stdout=PIPE)
p2 = Popen(['xmllint', '--format', '-'], stdin=p1.stdout, stdout=PIPE)
p1.stdout.close()
with open('{}.raw.xml'.format(page), 'w') as docbook:
p3 = Popen(
['egrep', '-v', 'linkend|Category|Commons|HELP|Back to'],
stdin=p2.stdout, stdout=docbook)
p2.stdout.close()
p3.communicate()
def main():
write_manual_pages()
fetch_manual_pages_in_docbook_format()
if __name__ == '__main__':
main()

1636
doc/freedombox-manual.xml → doc/freedombox-manual.raw.xml
View File

File diff suppressed because it is too large Load Diff

99
doc/manual-page-fixes.xslt Normal file
View File

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#
# This file is part of FreedomBox.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
-->
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!-- Set output format to Docbook -->
<xsl:output
method="xml"
encoding="utf-8"
indent="yes"
doctype-public="-//OASIS//DTD DocBook XML V4.4//EN"
doctype-system="http://www.docbook.org/xml/4.4/docbookx.dtd"/>
<!-- Copy all nodes and attributes by default -->
<xsl:template match="@*|node()">
<xsl:copy>
<xsl:apply-templates select="@*|node()"/>
</xsl:copy>
</xsl:template>
<!-- Split and get the last word in the title -->
<xsl:template match="articleinfo/title/text()">
<xsl:call-template name="clean-title">
<xsl:with-param name="title" select="."/>
</xsl:call-template>
</xsl:template>
<xsl:template name="clean-title">
<xsl:param name="title"/>
<xsl:choose>
<xsl:when test="contains($title, '/')">
<xsl:text></xsl:text>
<xsl:call-template name="clean-title">
<xsl:with-param name="title" select="substring-after($title, '/')"/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$title"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- Remove revision history -->
<xsl:template match="revhistory"/>
<!-- Convert all image dimensions from pixels to points -->
<xsl:template match="@width[parent::imagedata]|@depth[parent::imagedata]">
<xsl:attribute name="{name()}">
<xsl:value-of select=". div 2"/>
<xsl:text>pt</xsl:text>
</xsl:attribute>
</xsl:template>
<!-- Convert all image source URLs to relative paths -->
<xsl:template match="@fileref[parent::imagedata]">
<xsl:attribute name="fileref">
<xsl:text>images/</xsl:text>
<xsl:call-template name="filename">
<xsl:with-param name="path" select="."/>
</xsl:call-template>
</xsl:attribute>
</xsl:template>
<!-- Output just the filename from a URL -->
<xsl:template name="filename">
<xsl:param name="path"/>
<xsl:choose>
<xsl:when test="contains($path, 'target=')">
<xsl:value-of select="substring-after($path, 'target=')"/>
</xsl:when>
<xsl:when test="not(contains($path, '/'))">
<xsl:value-of select="$path"/>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="filename">
<xsl:with-param name="path" select="substring-after($path, '/')"/>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>

38
doc/manual-pages.list Normal file
View File

@ -0,0 +1,38 @@
Tor
Transmission
Deluge
Minetest
Radicale
ejabberd
MatrixSynapse
Roundcube
Coquelicot
Syncthing
Quassel
TinyTinyRSS
Repro
Shadowsocks
OpenVPN
Mumble
Privoxy
Searx
MediaWiki
Ikiwiki
Configure
DateTime
Diagnostics
DynamicDNS
Firewall
LetsEncrypt
Monkeysphere
NameServices
Networks
Power
PageKite
SecureShell
Security
ServiceDiscovery
Snapshots
Storage
Upgrades
Users

93
doc/post-processor Executable file
View File

@ -0,0 +1,93 @@
#!/usr/bin/python3
#
# This file is part of FreedomBox.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import argparse
import xml.etree.ElementTree as etree
def parse_arguments():
"""Return parsed command line arguments as dictionary."""
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')
subparser = subparsers.add_parser(
'remove-footer', help='Remove footer from the XML document')
subparser.add_argument('filename', help='Name of the XML file')
subparser = subparsers.add_parser('fix-wiki-urls',
help='Fix wrongly formatted wiki urls')
subparser.add_argument('filename', help='Name of the XML file')
subparsers.required = True
return parser.parse_args()
def subcommand_fix_wiki_urls(arguments):
file_name = arguments.filename
page_name = file_name.split('.')[0]
with open(file_name, 'r') as xml_file:
lines = xml_file.readlines()
pattern = 'FreedomBox/Manual/{0}/FreedomBox'.format(page_name)
lines = list(map(lambda s: s.replace(pattern, 'FreedomBox'), lines))
with open(file_name, 'w') as xml_file:
xml_file.writelines(lines)
def subcommand_remove_footer(arguments):
filename = arguments.filename
tree = etree.parse(filename)
root = tree.getroot()
informaltables = []
def recurse(elem):
for child in elem:
if child.tag == 'informaltable':
informaltables.append((elem, child))
else:
recurse(child)
recurse(root)
if informaltables:
parent, child = informaltables[-1]
parent.remove(child)
processed_xml = etree.tostring(root, encoding='utf-8').decode()
with open(filename, 'r') as xml_file:
header = xml_file.readlines()[:2]
with open(filename, 'w') as xml_file:
xml_file.writelines(header)
xml_file.write(processed_xml)
def main():
"""Parse arguments and perform all duties."""
arguments = parse_arguments()
subcommand = arguments.subcommand.replace('-', '_')
subcommand_method = globals()['subcommand_' + subcommand]
subcommand_method(arguments)
if __name__ == '__main__':
main()

10
plinth/modules/avahi/__init__.py
View File

@ -20,9 +20,8 @@ FreedomBox app for service discovery.
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import cfg
from plinth import service as service_module
from plinth import actions, cfg
from plinth.menu import main_menu
from plinth.utils import format_lazy
from plinth.views import ServiceView
@ -52,6 +51,8 @@ description = [
service = None
manual_page = 'ServiceDiscovery'
def init():
"""Intialize the service discovery module."""
@ -59,8 +60,8 @@ def init():
menu.add_urlname(name, 'glyphicon-lamp', 'avahi:index')
global service # pylint: disable=W0603
service = service_module.Service(
managed_services[0], name, ports=['mdns'], is_external=False)
service = service_module.Service(managed_services[0], name, ports=['mdns'],
is_external=False)
def setup(helper, old_version=False):
@ -76,3 +77,4 @@ def setup(helper, old_version=False):
class AvahiServiceView(ServiceView):
service_id = managed_services[0]
description = description
manual_page = manual_page

2
plinth/modules/config/__init__.py
View File

@ -34,6 +34,8 @@ is_essential = True
depends = ['firewall', 'names']
manual_page = 'Configure'
def get_domainname():
"""Return the domainname"""

13
plinth/modules/config/templates/config.html
View File

@ -20,9 +20,22 @@
{% load bootstrap %}
{% load i18n %}
{% load static %}
{% block content %}
{% block pagetitle %}
<h2>{{ title }}</h2>
{% endblock %}
{% if manual_page %}
<p class="manual-page">
<a href="{% url 'help:manual-page' manual_page %}">
{% trans 'Learn more...' %}
</a>
</p>
{% endif %}
<form class="form" method="post">
{% csrf_token %}

11
plinth/modules/config/views.py
View File

@ -22,7 +22,6 @@ import logging
from django.contrib import messages
from django.template.response import TemplateResponse
from django.utils import translation
from django.utils.translation import ugettext as _
from plinth import actions
@ -51,10 +50,12 @@ def index(request):
else:
form = ConfigurationForm(initial=status, prefix='configuration')
return TemplateResponse(request, 'config.html', {
'title': _('General Configuration'),
'form': form
})
return TemplateResponse(
request, 'config.html', {
'title': _('General Configuration'),
'form': form,
'manual_page': config.manual_page
})
def get_status(request):

2
plinth/modules/coquelicot/__init__.py
View File

@ -50,6 +50,8 @@ description = [
service = None
manual_page = 'Coquelicot'
def init():
"""Intialize the module."""

3
plinth/modules/coquelicot/views.py
View File

@ -24,7 +24,7 @@ from django.utils.translation import ugettext as _
from plinth import actions, views
from plinth.errors import ActionError
from plinth.modules.coquelicot import (clients, description,
get_current_max_file_size)
get_current_max_file_size, manual_page)
from .forms import CoquelicotForm
@ -37,6 +37,7 @@ class CoquelicotServiceView(views.ServiceView):
service_id = 'coquelicot'
form_class = CoquelicotForm
show_status_block = True
manual_page = manual_page
def get_initial(self):
"""Return the status of the service to fill in the form."""

14
plinth/modules/datetime/__init__.py
View File

@ -18,13 +18,13 @@
FreedomBox app to configure system date and time.
"""
from django.utils.translation import ugettext_lazy as _
import subprocess
from django.utils.translation import ugettext_lazy as _
from plinth import service as service_module
from plinth.menu import main_menu
version = 1
is_essential = True
@ -40,6 +40,8 @@ description = [
'in synchronization with servers on the Internet.')
]
manual_page = 'DateTime'
service = None
@ -51,8 +53,8 @@ def init():
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0], name, ports=['ntp'], is_external=False)
service = service_module.Service(managed_services[0], name,
ports=['ntp'], is_external=False)
def setup(helper, old_version=None):
@ -60,8 +62,8 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
managed_services[0], name, ports=['ntp'], is_external=False)
service = service_module.Service(managed_services[0], name,
ports=['ntp'], is_external=False)
helper.call('post', service.notify_enabled, None, True)

27
plinth/modules/datetime/views.py
View File

@ -18,15 +18,17 @@
FreedomBox app for configuring date and time.
"""
from django.contrib import messages
from django.utils.translation import ugettext as _
import logging
from .forms import DateTimeForm
from django.contrib import messages
from django.utils.translation import ugettext as _
from plinth import actions
from plinth.modules import datetime
from plinth.views import ServiceView
from .forms import DateTimeForm
logger = logging.getLogger(__name__)
@ -35,11 +37,14 @@ class DateTimeServiceView(ServiceView):
form_class = DateTimeForm
service_id = datetime.managed_services[0]
diagnostics_module_name = "datetime"
manual_page = datetime.manual_page
def get_initial(self):
return {'is_enabled': self.service.is_enabled(),
'is_running': self.service.is_running(),
'time_zone': self.get_current_time_zone()}
return {
'is_enabled': self.service.is_enabled(),
'is_running': self.service.is_running(),
'time_zone': self.get_current_time_zone()
}
def get_current_time_zone(self):
"""Get current time zone."""
@ -53,12 +58,12 @@ class DateTimeServiceView(ServiceView):
if old_status['time_zone'] != new_status['time_zone'] and \
new_status['time_zone'] != 'none':
try:
actions.superuser_run(
'timezone-change', [new_status['time_zone']])
actions.superuser_run('timezone-change',
[new_status['time_zone']])
except Exception as exception:
messages.error(
self.request, _('Error setting time zone: {exception}')
.format(exception=exception))
messages.error(self.request,
_('Error setting time zone: {exception}')
.format(exception=exception))
else:
messages.success(self.request, _('Time zone set'))

38
plinth/modules/deluge/__init__.py
View File

@ -20,14 +20,12 @@ FreedomBox app to configure a Deluge web client.
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, frontpage
from plinth.menu import main_menu
from plinth.modules.users import register_group
from .manifest import clients
from .manifest import clients
version = 2
@ -43,7 +41,6 @@ short_description = _('BitTorrent Web Client')
description = [
_('Deluge is a BitTorrent client that features a Web UI.'),
_('When enabled, the Deluge web client will be available from '
'<a href="/deluge">/deluge</a> path on the web server. The '
'default password is \'deluge\', but you should log in and change '
@ -56,21 +53,23 @@ reserved_usernames = ['debian-deluged']
clients = clients
manual_page = 'Deluge'
def init():
"""Initialize the Deluge module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-magnet',
'deluge:index', short_description)
menu.add_urlname(name, 'glyphicon-magnet', 'deluge:index',
short_description)
register_group(group)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0], name, ports=['http', 'https'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
if is_enabled():
add_shortcut()
@ -82,10 +81,10 @@ def setup(helper, old_version=None):
helper.call('post', actions.superuser_run, 'deluge', ['enable'])
global service
if service is None:
service = service_module.Service(
managed_services[0], name, ports=['http', 'https'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
@ -97,8 +96,8 @@ def add_shortcut():
def is_enabled():
"""Return whether the module is enabled."""
return (action_utils.webserver_is_enabled('deluge-plinth') and
action_utils.service_is_enabled('deluge-web'))
return (action_utils.webserver_is_enabled('deluge-plinth')
and action_utils.service_is_enabled('deluge-web'))
def enable():
@ -119,7 +118,8 @@ def diagnose():
results.append(action_utils.diagnose_port_listening(8112, 'tcp4'))
results.append(action_utils.diagnose_port_listening(8112, 'tcp6'))
results.extend(action_utils.diagnose_url_on_all(
'https://{host}/deluge', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/deluge',
check_certificate=False))
return results

8
plinth/modules/deluge/urls.py
View File

@ -26,9 +26,7 @@ from plinth.views import ServiceView
urlpatterns = [
url(r'^apps/deluge/$',
ServiceView.as_view(
description=deluge.description,
diagnostics_module_name="deluge",
clients=deluge.clients,
service_id=deluge.managed_services[0]),
name='index'),
description=deluge.description, diagnostics_module_name="deluge",
clients=deluge.clients, service_id=deluge.managed_services[0],
manual_page=deluge.manual_page), name='index'),
]

8
plinth/modules/diagnostics/__init__.py
View File

@ -23,7 +23,6 @@ from django.utils.translation import ugettext_lazy as _
from plinth import action_utils
from plinth.menu import main_menu
version = 1
is_essential = True
@ -36,6 +35,8 @@ description = [
'expected.')
]
manual_page = 'Diagnostics'
def init():
"""Initialize the module"""
@ -48,7 +49,8 @@ def diagnose():
results = []
results.append(action_utils.diagnose_port_listening(8000, 'tcp4'))
results.append(action_utils.diagnose_port_listening(8000, 'tcp6'))
results.extend(action_utils.diagnose_url_on_all(
'http://{host}/plinth/', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('http://{host}/plinth/',
check_certificate=False))
return results

41
plinth/modules/diagnostics/diagnostics.py
View File

@ -19,17 +19,17 @@ FreedomBox app for running diagnostics.
"""
import collections
from django.http import Http404
from django.template.response import TemplateResponse
from django.views.decorators.http import require_POST
from django.utils.translation import ugettext_lazy as _
import logging
import threading
from django.http import Http404
from django.template.response import TemplateResponse
from django.utils.translation import ugettext_lazy as _
from django.views.decorators.http import require_POST
from plinth import module_loader
from plinth.modules import diagnostics
logger = logging.Logger(__name__)
current_results = {}
@ -42,11 +42,14 @@ def index(request):
if request.method == 'POST' and not _running_task:
_start_task()
return TemplateResponse(request, 'diagnostics.html',
{'title': diagnostics.name,
'description': diagnostics.description,
'is_running': _running_task is not None,
'results': current_results})
return TemplateResponse(
request, 'diagnostics.html', {
'title': diagnostics.name,
'description': diagnostics.description,
'is_running': _running_task is not None,
'manual_page': diagnostics.manual_page,
'results': current_results
})
@require_POST
@ -61,10 +64,12 @@ def module(request, module_name):
if hasattr(module, 'diagnose'):
results = module.diagnose()
return TemplateResponse(request, 'diagnostics_module.html',
{'title': _('Diagnostic Test'),
'module_name': module_name,
'results': results})
return TemplateResponse(
request, 'diagnostics_module.html', {
'title': _('Diagnostic Test'),
'module_name': module_name,
'results': results
})
def _start_task():
@ -92,9 +97,11 @@ def _run_on_all_modules_wrapper():
def run_on_all_modules():
"""Run diagnostics on all modules and store the result."""
global current_results
current_results = {'modules': [],
'results': collections.OrderedDict(),
'progress_percentage': 0}
current_results = {
'modules': [],
'results': collections.OrderedDict(),
'progress_percentage': 0
}
modules = []
for module_name, module in module_loader.loaded_modules.items():

13
plinth/modules/dynamicdns/__init__.py
View File

@ -38,9 +38,7 @@ description = [
_('If your Internet provider changes your IP address periodically '
'(i.e. every 24h), it may be hard for others to find you on the '
'Internet. This will prevent others from finding services which are '
'provided by this {box_name}.'),
box_name=_(cfg.box_name)),
'provided by this {box_name}.'), box_name=_(cfg.box_name)),
_('The solution is to assign a DNS name to your IP address and '
'update the DNS name every time your IP is changed by your '
'Internet provider. Dynamic DNS allows you to push your current '
@ -53,18 +51,21 @@ description = [
reserved_usernames = ['ez-ipupd']
manual_page = 'DynamicDNS'
def init():
"""Initialize the module."""
menu = main_menu.get('system')
menu.add_urlname(name, 'glyphicon-refresh', 'dynamicdns:index')
current_status = dynamicdns.get_status()
if current_status['enabled']:
services = dynamicdns.get_enabled_services(current_status['dynamicdns_domain'])
services = dynamicdns.get_enabled_services(
current_status['dynamicdns_domain'])
domain_added.send_robust(
sender='dynamicdns', domain_type='dynamicdnsservice',
name=current_status['dynamicdns_domain'],
description=_('Dynamic DNS Service'),
services=services)
description=_('Dynamic DNS Service'), services=services)
def setup(helper, old_version=None):

141
plinth/modules/dynamicdns/dynamicdns.py
View File

@ -14,7 +14,6 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Forms and views for the dynamicsdns module.
"""
@ -24,14 +23,13 @@ import logging
from django import forms
from django.contrib import messages
from django.core import validators
from django.urls import reverse_lazy
from django.utils.translation import ugettext as _, ugettext_lazy
from django.template.response import TemplateResponse
from django.urls import reverse_lazy
from django.utils.translation import ugettext as _
from django.utils.translation import ugettext_lazy
from plinth import actions
from plinth import cfg
from plinth.modules import dynamicdns
from plinth.modules import firewall
from plinth import actions, cfg
from plinth.modules import dynamicdns, firewall
from plinth.modules.names import SERVICES
from plinth.signals import domain_added, domain_removed
from plinth.utils import format_lazy
@ -39,24 +37,32 @@ from plinth.utils import format_lazy
logger = logging.getLogger(__name__)
EMPTYSTRING = 'none'
subsubmenu = [{'url': reverse_lazy('dynamicdns:index'),
'text': ugettext_lazy('About')},
{'url': reverse_lazy('dynamicdns:configure'),
'text': ugettext_lazy('Configure')},
{'url': reverse_lazy('dynamicdns:statuspage'),
'text': ugettext_lazy('Status')}]
subsubmenu = [{
'url': reverse_lazy('dynamicdns:index'),
'text': ugettext_lazy('About')
}, {
'url': reverse_lazy('dynamicdns:configure'),
'text': ugettext_lazy('Configure')
}, {
'url': reverse_lazy('dynamicdns:statuspage'),
'text': ugettext_lazy('Status')
}]
def index(request):
"""Serve Dynamic DNS page."""
return TemplateResponse(request, 'dynamicdns.html',
{'title': dynamicdns.name,
'description': dynamicdns.description,
'subsubmenu': subsubmenu})
return TemplateResponse(
request, 'dynamicdns.html', {
'title': dynamicdns.name,
'description': dynamicdns.description,
'manual_page': dynamicdns.manual_page,
'subsubmenu': subsubmenu
})
class TrimmedCharField(forms.CharField):
"""Trim the contents of a CharField."""
def clean(self, value):
"""Clean and validate the field value"""
if value:
@ -103,29 +109,25 @@ class ConfigureForm(forms.Form):
help_user = \
ugettext_lazy('The username that was used when the account was '
'created.')
"""ToDo: sync this list with the html template file"""
provider_choices = (
('GnuDIP', 'GnuDIP'),
('noip', 'noip.com'),
('selfhost', 'selfhost.bz'),
('freedns', 'freedns.afraid.org'),
('other', 'other update URL'))
provider_choices = (('GnuDIP', 'GnuDIP'), ('noip', 'noip.com'),
('selfhost', 'selfhost.bz'), ('freedns',
'freedns.afraid.org'),
('other', 'other update URL'))
enabled = forms.BooleanField(label=ugettext_lazy('Enable Dynamic DNS'),
required=False)
enabled = forms.BooleanField(
label=ugettext_lazy('Enable Dynamic DNS'), required=False)
service_type = forms.ChoiceField(label=ugettext_lazy('Service Type'),
help_text=help_services,
choices=provider_choices)
service_type = forms.ChoiceField(
label=ugettext_lazy('Service Type'), help_text=help_services,
choices=provider_choices)
dynamicdns_server = TrimmedCharField(
label=ugettext_lazy('GnuDIP Server Address'),
required=False,
help_text=help_server,
validators=[
label=ugettext_lazy('GnuDIP Server Address'), required=False,
help_text=help_server, validators=[
validators.RegexValidator(r'^[\w-]{1,63}(\.[\w-]{1,63})*$',
ugettext_lazy('Invalid server name'))])
ugettext_lazy('Invalid server name'))
])
dynamicdns_update_url = TrimmedCharField(
label=ugettext_lazy('Update URL'), required=False,
@ -140,12 +142,11 @@ class ConfigureForm(forms.Form):
help_text=help_http_auth, required=False)
dynamicdns_domain = TrimmedCharField(
label=ugettext_lazy('Domain Name'),
help_text=help_domain,
required=False,
validators=[
label=ugettext_lazy('Domain Name'), help_text=help_domain,
required=False, validators=[
validators.RegexValidator(r'^[\w-]{1,63}(\.[\w-]{1,63})*$',
ugettext_lazy('Invalid domain name'))])
ugettext_lazy('Invalid domain name'))
])
dynamicdns_user = TrimmedCharField(
label=ugettext_lazy('Username'), required=False, help_text=help_user)
@ -154,15 +155,13 @@ class ConfigureForm(forms.Form):
label=ugettext_lazy('Password'), widget=forms.PasswordInput(),
required=False, help_text=help_secret)
showpw = forms.BooleanField(label=ugettext_lazy('Show password'),
required=False)
showpw = forms.BooleanField(
label=ugettext_lazy('Show password'), required=False)
dynamicdns_ipurl = TrimmedCharField(
label=ugettext_lazy('URL to look up public IP'),
required=False,
label=ugettext_lazy('URL to look up public IP'), required=False,
help_text=help_ip_url,
validators=[
validators.URLValidator(schemes=['http', 'https', 'ftp'])])
validators=[validators.URLValidator(schemes=['http', 'https', 'ftp'])])
def clean(self):
cleaned_data = super(ConfigureForm, self).clean()
@ -215,10 +214,12 @@ def configure(request):
else:
form = ConfigureForm(initial=status)
return TemplateResponse(request, 'dynamicdns_configure.html',
{'title': _('Configure Dynamic DNS'),
'form': form,
'subsubmenu': subsubmenu})
return TemplateResponse(
request, 'dynamicdns_configure.html', {
'title': _('Configure Dynamic DNS'),
'form': form,
'subsubmenu': subsubmenu
})
def statuspage(request):
@ -236,13 +237,15 @@ def statuspage(request):
if nat_unchecked:
logger.info('Did not check if behind a NAT')
return TemplateResponse(request, 'dynamicdns_status.html',
{'title': _('Dynamic DNS Status'),
'no_nat': no_nat,
'nat_unchecked': nat_unchecked,
'timer': timer,
'last_update': last_update,
'subsubmenu': subsubmenu})
return TemplateResponse(
request, 'dynamicdns_status.html', {
'title': _('Dynamic DNS Status'),
'no_nat': no_nat,
'nat_unchecked': nat_unchecked,
'timer': timer,
'last_update': last_update,
'subsubmenu': subsubmenu
})
def get_status():
@ -353,20 +356,19 @@ def _apply_changes(request, old_status, new_status):
if new_status['use_http_basic_auth']:
use_http_basic_auth = "enabled"
_run(['configure', '-s', new_status['dynamicdns_server'],
'-d', new_status['dynamicdns_domain'],
'-u', new_status['dynamicdns_user'],
'-p',
'-I', new_status['dynamicdns_ipurl'],
'-U', new_status['dynamicdns_update_url'],
'-c', disable_ssl_check,
'-b', use_http_basic_auth],
input=new_status['dynamicdns_secret'].encode())
_run([
'configure', '-s', new_status['dynamicdns_server'], '-d',
new_status['dynamicdns_domain'], '-u',
new_status['dynamicdns_user'], '-p', '-I',
new_status['dynamicdns_ipurl'], '-U',
new_status['dynamicdns_update_url'], '-c', disable_ssl_check, '-b',
use_http_basic_auth
], input=new_status['dynamicdns_secret'].encode())
if old_status['enabled']:
domain_removed.send_robust(
sender='dynamicdns', domain_type='dynamicdnsservice',
name=old_status['dynamicdns_domain'])
domain_removed.send_robust(sender='dynamicdns',
domain_type='dynamicdnsservice',
name=old_status['dynamicdns_domain'])
_run(['stop'])
if new_status['enabled']:
@ -374,8 +376,7 @@ def _apply_changes(request, old_status, new_status):
domain_added.send_robust(
sender='dynamicdns', domain_type='dynamicdnsservice',
name=new_status['dynamicdns_domain'],
description=_('Dynamic DNS Service'),
services=services)
description=_('Dynamic DNS Service'), services=services)
_run(['start'])
messages.success(request, _('Configuration updated'))

12
plinth/modules/dynamicdns/templates/dynamicdns.html
View File

@ -21,12 +21,22 @@
{% load i18n %}
{% block content %}
<h2>{{ title }}</h2>
{% block pagetitle %}
<h2>{{ title }}</h2>
{% endblock %}
{% for paragraph in description %}
<p>{{ paragraph|safe }}</p>
{% endfor %}
{% if manual_page %}
<p class="manual-page">
<a href="{% url 'help:manual-page' manual_page %}">
{% trans 'Learn more...' %}
</a>
</p>
{% endif %}
<p>
{% blocktrans trimmed %}
If you are looking for a free dynamic DNS account, you may find

87
plinth/modules/ejabberd/__init__.py
View File

@ -18,23 +18,20 @@
FreedomBox app to configure ejabberd server.
"""
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth.utils import format_lazy
import logging
import socket
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth.menu import main_menu
from plinth.signals import pre_hostname_change, post_hostname_change
from plinth.signals import domainname_change
from .manifest import clients
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.signals import (domainname_change, post_hostname_change,
pre_hostname_change)
from plinth.utils import format_lazy
from .manifest import clients
version = 1
@ -49,14 +46,13 @@ short_description = _('Chat Server')
description = [
_('XMPP is an open and standardized communication protocol. Here '
'you can run and configure your XMPP server, called ejabberd.'),
format_lazy(
_('To actually communicate, you can use the <a href="/plinth/apps/'
'jsxc">web client</a> or any other <a href=\'https://xmpp.org/'
'software/clients\' target=\'_blank\'>XMPP client</a>. '
'When enabled, ejabberd can be accessed by any <a href="/plinth/sys'
'/users">user with a {box_name} login</a>.'),
box_name=_(cfg.box_name))
'/users">user with a {box_name} login</a>.'), box_name=_(
cfg.box_name))
]
clients = clients
@ -65,22 +61,24 @@ reserved_usernames = ['ejabberd']
service = None
manual_page = 'ejabberd'
logger = logging.getLogger(__name__)
def init():
"""Initialize the ejabberd module"""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-comment', 'ejabberd:index', short_description)
menu.add_urlname(name, 'glyphicon-comment', 'ejabberd:index',
short_description)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
'ejabberd', name,
ports=['xmpp-client', 'xmpp-server', 'xmpp-bosh'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service('ejabberd', name, ports=[
'xmpp-client', 'xmpp-server', 'xmpp-bosh'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
if is_enabled():
add_shortcut()
pre_hostname_change.connect(on_pre_hostname_change)
@ -99,21 +97,19 @@ def setup(helper, old_version=None):
helper.call('post', actions.superuser_run, 'ejabberd', ['setup'])
global service
if service is None:
service = service_module.Service(
'ejabberd', name,
ports=['xmpp-client', 'xmpp-server', 'xmpp-bosh'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service('ejabberd', name, ports=[
'xmpp-client', 'xmpp-server', 'xmpp-bosh'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut('ejabberd', name=name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('ejabberd:index'),
login_required=True)
frontpage.add_shortcut(
'ejabberd', name=name, short_description=short_description,
details=description, configure_url=reverse_lazy('ejabberd:index'),
login_required=True)
def is_enabled():
@ -146,10 +142,10 @@ def on_pre_hostname_change(sender, old_hostname, new_hostname, **kwargs):
del sender # Unused
del kwargs # Unused
actions.superuser_run('ejabberd',
['pre-change-hostname',
'--old-hostname', old_hostname,
'--new-hostname', new_hostname])
actions.superuser_run('ejabberd', [
'pre-change-hostname', '--old-hostname', old_hostname,
'--new-hostname', new_hostname
])
def on_post_hostname_change(sender, old_hostname, new_hostname, **kwargs):
@ -157,11 +153,10 @@ def on_post_hostname_change(sender, old_hostname, new_hostname, **kwargs):
del sender # Unused
del kwargs # Unused
actions.superuser_run('ejabberd',
['change-hostname',
'--old-hostname', old_hostname,
'--new-hostname', new_hostname],
run_in_background=True)
actions.superuser_run('ejabberd', [
'change-hostname', '--old-hostname', old_hostname, '--new-hostname',
new_hostname
], run_in_background=True)
def on_domainname_change(sender, old_domainname, new_domainname, **kwargs):
@ -170,10 +165,9 @@ def on_domainname_change(sender, old_domainname, new_domainname, **kwargs):
del old_domainname # Unused
del kwargs # Unused
actions.superuser_run('ejabberd',
['change-domainname',
'--domainname', new_domainname],
run_in_background=True)
actions.superuser_run(
'ejabberd', ['change-domainname', '--domainname', new_domainname],
run_in_background=True)
def diagnose():
@ -186,7 +180,6 @@ def diagnose():
results.append(action_utils.diagnose_port_listening(5269, 'tcp6'))
results.append(action_utils.diagnose_port_listening(5280, 'tcp4'))
results.append(action_utils.diagnose_port_listening(5280, 'tcp6'))
results.extend(
action_utils.diagnose_url_on_all('http://{host}/bosh/'))
results.extend(action_utils.diagnose_url_on_all('http://{host}/bosh/'))
return results

11
plinth/modules/ejabberd/views.py
View File

@ -18,13 +18,15 @@
Views for the Ejabberd module
"""
from plinth.modules import ejabberd
from plinth.views import ServiceView
from .forms import EjabberdForm
from plinth import actions
from django.contrib import messages
from django.utils.translation import ugettext as _
from plinth import actions
from plinth.modules import ejabberd
from plinth.views import ServiceView
from .forms import EjabberdForm
class EjabberdServiceView(ServiceView):
"""Show ejabberd as a service."""
@ -33,6 +35,7 @@ class EjabberdServiceView(ServiceView):
description = ejabberd.description
diagnostics_module_name = 'ejabberd'
form_class = EjabberdForm
manual_page = ejabberd.manual_page
def get_initial(self):
initdict = super().get_initial()

23
plinth/modules/firewall/__init__.py
View File

@ -18,17 +18,16 @@
FreedomBox app to configure a firewall.
"""
from django.utils.translation import ugettext_lazy as _
import logging
from plinth import actions
from plinth import cfg
from django.utils.translation import ugettext_lazy as _
import plinth.service as service_module
from plinth import actions, cfg
from plinth.menu import main_menu
from plinth.signals import service_enabled
import plinth.service as service_module
from plinth.utils import format_lazy
version = 1
is_essential = True
@ -45,6 +44,8 @@ description = [
'security threat from the Internet.'), box_name=cfg.box_name)
]
manual_page = 'Firewall'
LOGGER = logging.getLogger(__name__)
@ -105,8 +106,7 @@ def on_service_enabled(sender, service_id, enabled, **kwargs):
if port not in internal_enabled_services:
add_service(port, zone='internal')
if (service.is_external and
port not in external_enabled_services):
if (service.is_external and port not in external_enabled_services):
add_service(port, zone='external')
else:
# service already configured.
@ -116,8 +116,9 @@ def on_service_enabled(sender, service_id, enabled, **kwargs):
enabled_services_on_port = [
service_.is_enabled()
for service_ in service_module.services.values()
if port in service_.ports and
service_id != service_.service_id]
if port in service_.ports
and service_id != service_.service_id
]
if not any(enabled_services_on_port):
remove_service(port, zone='internal')
@ -126,8 +127,8 @@ def on_service_enabled(sender, service_id, enabled, **kwargs):
service_.is_enabled()
for service_ in service_module.services.values()
if port in service_.ports and
service_id != service_.service_id and
service_.is_external]
service_id != service_.service_id and service_.is_external
]
if not any(enabled_services_on_port):
remove_service(port, zone='external')

26
plinth/modules/firewall/views.py
View File

@ -20,25 +20,29 @@ FreedomBox app to configure a firewall.
from django.template.response import TemplateResponse
from plinth.modules import firewall
import plinth.service as service_module
from plinth.modules import firewall
def index(request):
"""Serve introduction page"""
if not firewall.get_enabled_status():
return TemplateResponse(request, 'firewall.html',
{'title': firewall.name,
'description': firewall.description,
'firewall_status': 'not_running'})
return TemplateResponse(
request, 'firewall.html', {
'title': firewall.name,
'description': firewall.description,
'firewall_status': 'not_running'
})
internal_enabled_services = firewall.get_enabled_services(zone='internal')
external_enabled_services = firewall.get_enabled_services(zone='external')
return TemplateResponse(
request, 'firewall.html',
{'title': firewall.name,
'description': firewall.description,
'services': list(service_module.services.values()),
'internal_enabled_services': internal_enabled_services,
'external_enabled_services': external_enabled_services})
request, 'firewall.html', {
'title': firewall.name,
'description': firewall.description,
'services': list(service_module.services.values()),
'manual_page': firewall.manual_page,
'internal_enabled_services': internal_enabled_services,
'external_enabled_services': external_enabled_services
})

23
plinth/modules/help/help.py
View File

@ -51,8 +51,9 @@ def init():
def index(request):
"""Serve the index page"""
return TemplateResponse(request, 'help_index.html',
{'title': _('Documentation and FAQ')})
return TemplateResponse(request, 'help_index.html', {
'title': _('Documentation and FAQ')
})
def about(request):
@ -68,20 +69,22 @@ def about(request):
return TemplateResponse(request, 'help_about.html', context)
def manual(request):
def manual(request, page='freedombox-manual.part.html'):
"""Serve the manual page from the 'doc' directory"""
try:
with open(
os.path.join(cfg.doc_dir, 'freedombox-manual.part.html'), 'r',
encoding='utf-8') as input_file:
page = '{}.part.html'.format(
page) if not page.endswith('html') else page
with open(os.path.join(cfg.doc_dir, page), 'r',
encoding='utf-8') as input_file:
content = input_file.read()
except IOError:
raise Http404
return TemplateResponse(request, 'help_manual.html', {
'title': _('{box_name} Manual').format(box_name=_(cfg.box_name)),
'content': content
})
return TemplateResponse(
request, 'help_manual.html', {
'title': _('{box_name} Manual').format(box_name=_(cfg.box_name)),
'content': content
})
def download_manual(request):

10
plinth/modules/help/urls.py
View File

@ -32,8 +32,10 @@ urlpatterns = [
url(r'^help/index/$', non_admin_view(views.index), name='index-explicit'),
url(r'^help/about/$', non_admin_view(views.about), name='about'),
url(r'^help/manual/$', non_admin_view(views.manual), name='manual'),
url(r'^help/manual/download/$',
non_admin_view(views.download_manual), name='download-manual'),
url(r'^help/status-log/$',
non_admin_view(views.status_log), name='status-log'),
url(r'^help/manual/download/$', non_admin_view(views.download_manual),
name='download-manual'),
url(r'^help/manual/(?P<page>[\w-]+)?/?$', non_admin_view(views.manual),
name='manual-page'),
url(r'^help/status-log/$', non_admin_view(views.status_log),
name='status-log'),
]

33
plinth/modules/ikiwiki/__init__.py
View File

@ -19,23 +19,21 @@ FreedomBox app to configure ikiwiki.
"""
from django.utils.translation import ugettext_lazy as _
from plinth.utils import format_lazy
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.modules.users import register_group
from .manifest import clients
from plinth.utils import format_lazy
from .manifest import clients
version = 1
managed_packages = ['ikiwiki', 'libdigest-sha-perl', 'libxml-writer-perl',
'xapian-omega', 'libsearch-xapian-perl',
'libimage-magick-perl']
managed_packages = [
'ikiwiki', 'libdigest-sha-perl', 'libxml-writer-perl', 'xapian-omega',
'libsearch-xapian-perl', 'libimage-magick-perl'
]
service = None
@ -49,7 +47,6 @@ description = [
'common blogging functionality such as comments and RSS feeds. '
'When enabled, the blogs and wikis will be available '
'at <a href="/ikiwiki">/ikiwiki</a> (once created).'),
format_lazy(
_('Only {box_name} users in the <b>admin</b> group can <i>create</i> '
'and <i>manage</i> blogs and wikis, but any user in the <b>wiki</b> '
@ -60,14 +57,16 @@ description = [
clients = clients
group = ('wiki', _('View and edit wiki applications'))
manual_page = 'Ikiwiki'
def init():
"""Initialize the ikiwiki module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-edit', 'ikiwiki:index', short_description)
menu.add_urlname(name, 'glyphicon-edit', 'ikiwiki:index',
short_description)
register_group(group)
global service
@ -98,9 +97,8 @@ def add_shortcuts():
sites = actions.run('ikiwiki', ['get-sites']).split('\n')
sites = [name for name in sites if name != '']
for site in sites:
frontpage.add_shortcut(
'ikiwiki_' + site, site, url='/ikiwiki/' + site,
login_required=False, icon='ikiwiki')
frontpage.add_shortcut('ikiwiki_' + site, site, url='/ikiwiki/' + site,
login_required=False, icon='ikiwiki')
def is_enabled():
@ -124,7 +122,8 @@ def diagnose():
"""Run diagnostics and return the results."""
results = []
results.extend(action_utils.diagnose_url_on_all(
'https://{host}/ikiwiki', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/ikiwiki',
check_certificate=False))
return results

47
plinth/modules/ikiwiki/views.py
View File

@ -22,11 +22,10 @@ from django.contrib import messages
from django.shortcuts import redirect
from django.template.response import TemplateResponse
from django.urls import reverse_lazy
from django.utils.translation import ugettext as _, ugettext_lazy
from django.utils.translation import ugettext as _
from django.utils.translation import ugettext_lazy
from plinth import actions
from plinth import frontpage
from plinth import views
from plinth import actions, frontpage, views
from plinth.modules import ikiwiki
from .forms import IkiwikiCreateForm
@ -63,11 +62,12 @@ def manage(request):
sites = actions.run('ikiwiki', ['get-sites']).split('\n')
sites = [name for name in sites if name != '']
return TemplateResponse(request, 'ikiwiki_manage.html', {
'title': _('Manage Wikis and Blogs'),
'subsubmenu': subsubmenu,
'sites': sites
})
return TemplateResponse(
request, 'ikiwiki_manage.html', {
'title': _('Manage Wikis and Blogs'),
'subsubmenu': subsubmenu,
'sites': sites
})
def create(request):
@ -87,22 +87,21 @@ def create(request):
form.cleaned_data['admin_password'])
site = form.cleaned_data['name'].replace(' ', '')
frontpage.add_shortcut(
'ikiwiki_' + site,
site,
url='/ikiwiki/' + site,
login_required=False,
icon='ikiwiki')
frontpage.add_shortcut('ikiwiki_' + site, site,
url='/ikiwiki/' + site,
login_required=False, icon='ikiwiki')
return redirect(reverse_lazy('ikiwiki:manage'))
else:
form = IkiwikiCreateForm(prefix='ikiwiki')
return TemplateResponse(request, 'ikiwiki_create.html', {
'title': _('Create Wiki or Blog'),
'form': form,
'subsubmenu': subsubmenu
})
return TemplateResponse(
request, 'ikiwiki_create.html', {
'title': _('Create Wiki or Blog'),
'form': form,
'subsubmenu': subsubmenu,
'manual_page': ikiwiki.manual_page,
})
def _create_wiki(request, name, admin_name, admin_password):
@ -114,8 +113,8 @@ def _create_wiki(request, name, admin_name, admin_password):
input=admin_password.encode())
messages.success(request, _('Created wiki {name}.').format(name=name))
except actions.ActionError as error:
messages.error(
request, _('Could not create wiki: {error}').format(error=error))
messages.error(request,
_('Could not create wiki: {error}').format(error=error))
def _create_blog(request, name, admin_name, admin_password):
@ -127,8 +126,8 @@ def _create_blog(request, name, admin_name, admin_password):
input=admin_password.encode())
messages.success(request, _('Created blog {name}.').format(name=name))
except actions.ActionError as error:
messages.error(
request, _('Could not create blog: {error}').format(error=error))
messages.error(request,
_('Could not create blog: {error}').format(error=error))
def delete(request, name):

51
plinth/modules/letsencrypt/__init__.py
View File

@ -23,16 +23,12 @@ import logging
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import action_utils, actions, cfg, module_loader
from plinth.errors import ActionError
from plinth.menu import main_menu
from plinth.modules import names
from plinth.modules import config
from plinth.modules import config, names
from plinth.signals import domain_added, domain_removed, domainname_change
from plinth.utils import format_lazy
from plinth import module_loader
from plinth.signals import domainname_change, domain_added, domain_removed
version = 1
@ -53,8 +49,7 @@ description = [
'{box_name} can automatically obtain and setup digital '
'certificates for each available domain. It does so by proving '
'itself to be the owner of a domain to Let\'s Encrypt, a '
'certificate authority (CA).'),
box_name=_(cfg.box_name)),
'certificate authority (CA).'), box_name=_(cfg.box_name)),
_('Let\'s Encrypt is a free, automated, and open certificate '
'authority, run for the public\'s benefit by the Internet Security '
'Research Group (ISRG). Please read and agree with the '
@ -64,6 +59,8 @@ description = [
service = None
manual_page = 'LetsEncrypt'
MODULES_WITH_HOOKS = ['ejabberd']
LIVE_DIRECTORY = '/etc/letsencrypt/live/'
logger = logging.getLogger(__name__)
@ -72,8 +69,8 @@ logger = logging.getLogger(__name__)
def init():
"""Intialize the module."""
menu = main_menu.get('system')
menu.add_urlname(name,
'glyphicon-lock', 'letsencrypt:index', short_description)
menu.add_urlname(name, 'glyphicon-lock', 'letsencrypt:index',
short_description)
domainname_change.connect(on_domainname_change)
domain_added.connect(on_domain_added)
domain_removed.connect(on_domain_removed)
@ -112,8 +109,8 @@ def enable_renewal_management(domain):
except ActionError as exception:
logger.error(
_('Failed to enable certificate renewal management for '
'{domain}: {error}').format(
domain=domain, error=exception.args[2]))
'{domain}: {error}').format(domain=domain,
error=exception.args[2]))
def on_domainname_change(sender, old_domainname, new_domainname, **kwargs):
@ -124,11 +121,11 @@ def on_domainname_change(sender, old_domainname, new_domainname, **kwargs):
for module in MODULES_WITH_HOOKS:
actions.superuser_run(
module, ['letsencrypt', 'drop', '--domain',
old_domainname], run_in_background=True)
module, ['letsencrypt', 'drop', '--domain', old_domainname],
run_in_background=True)
actions.superuser_run(
'letsencrypt', ['manage_hooks', 'disable', '--domain',
old_domainname], run_in_background=True)
'letsencrypt', ['manage_hooks', 'disable', '--domain', old_domainname],
run_in_background=True)
def get_manage_hooks_status():
@ -143,10 +140,12 @@ def get_manage_hooks_status():
def get_installed_modules():
installed_modules = [module_name for module_name, module in
module_loader.loaded_modules.items()
if module_name in MODULES_WITH_HOOKS
and module.setup_helper.get_state() == 'up-to-date']
installed_modules = [
module_name
for module_name, module in module_loader.loaded_modules.items()
if module_name in MODULES_WITH_HOOKS
and module.setup_helper.get_state() == 'up-to-date'
]
return installed_modules
@ -196,10 +195,12 @@ def get_status():
status = json.loads(status)
curr_dom = config.get_domainname()
current_domain = {
'name': curr_dom,
'has_cert': (curr_dom in status['domains'] and
status['domains'][curr_dom]['certificate_available']),
'manage_hooks_status': get_manage_hooks_status()
'name':
curr_dom,
'has_cert': (curr_dom in status['domains']
and status['domains'][curr_dom]['certificate_available']),
'manage_hooks_status':
get_manage_hooks_status()
}
status['current_domain'] = current_domain

46
plinth/modules/letsencrypt/views.py
View File

@ -29,8 +29,7 @@ from django.views.decorators.http import require_POST
from plinth import actions
from plinth.errors import ActionError
from plinth.modules import config
from plinth.modules import letsencrypt
from plinth.modules import config, letsencrypt
logger = logging.getLogger(__name__)
@ -38,12 +37,14 @@ logger = logging.getLogger(__name__)
def index(request):
"""Serve configuration page."""
status = letsencrypt.get_status()
return TemplateResponse(request, 'letsencrypt.html',
{'title': letsencrypt.name,
'description': letsencrypt.description,
'status': status,
'installed_modules':
letsencrypt.get_installed_modules()})
return TemplateResponse(
request, 'letsencrypt.html', {
'title': letsencrypt.name,
'description': letsencrypt.description,
'status': status,
'manual_page': letsencrypt.manual_page,
'installed_modules': letsencrypt.get_installed_modules()
})
@require_POST
@ -95,8 +96,8 @@ def enable_renewal_management(request, domain):
messages.error(
request,
_('Failed to enable certificate renewal management for '
'{domain}: {error}').format(
domain=domain, error=exception.args[2]))
'{domain}: {error}').format(domain=domain,
error=exception.args[2]))
@require_POST
@ -111,9 +112,10 @@ def toggle_hooks(request, domain):
try:
if subcommand == 'disable':
enabled_modules = [module for module in
letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status]
enabled_modules = [
module for module in letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status
]
for module in enabled_modules:
actions.superuser_run(module, ['letsencrypt', 'drop'],
run_in_background=True)
@ -138,8 +140,10 @@ def toggle_hooks(request, domain):
def toggle_module(request, domain, module):
"""Toggle usage of LE cert for a module name, for the current domain."""
manage_hooks_status = letsencrypt.get_manage_hooks_status()
enabled_modules = [module for module in letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status]
enabled_modules = [
module for module in letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status
]
if module in enabled_modules:
mod_le_arg = 'drop'
@ -157,9 +161,9 @@ def toggle_module(request, domain, module):
try:
actions.superuser_run(module, module_args)
actions.superuser_run('letsencrypt', le_arguments)
messages.success(
request, _('Switched use of certificate for app {module}')
.format(module=module))
messages.success(request,
_('Switched use of certificate for app {module}')
.format(module=module))
except ActionError as exception:
messages.error(
request,
@ -173,8 +177,10 @@ def toggle_module(request, domain, module):
def delete(request, domain):
"""Delete a certificate for a given domain, and cleanup renewal config."""
manage_hooks_status = letsencrypt.get_manage_hooks_status()
enabled_modules = [module for module in letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status]
enabled_modules = [
module for module in letsencrypt.MODULES_WITH_HOOKS
if module in manage_hooks_status
]
try:
for module in enabled_modules:

31
plinth/modules/matrixsynapse/__init__.py
View File

@ -25,11 +25,10 @@ from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from ruamel.yaml.util import load_yaml_guess_indent
from plinth import action_utils
from plinth import actions
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, frontpage
from plinth.menu import main_menu
from .manifest import clients
version = 2
@ -50,7 +49,6 @@ description = [
'synchronization and does not require phone numbers to work. Users on a '
'given Matrix server can converse with users on all other Matrix '
'servers via federation.'),
_('To communicate, you can use the '
'<a href="https://matrix.org/docs/projects/">available clients</a> '
'for mobile, desktop and the web. <a href="https://riot.im/">Riot</a> '
@ -61,6 +59,8 @@ clients = clients
service = None
manual_page = 'MatrixSynapse'
logger = logging.getLogger(__name__)
SERVER_NAME_PATH = "/etc/matrix-synapse/conf.d/server_name.yaml"
@ -76,11 +76,10 @@ def init():
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
'matrix-synapse', name,
ports=['matrix-synapse-plinth'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service('matrix-synapse', name, ports=[
'matrix-synapse-plinth'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
if is_enabled():
add_shortcut()
@ -90,11 +89,10 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
'matrix-synapse', name,
ports=['matrix-synapse-plinth'],
is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
service = service_module.Service('matrix-synapse', name, ports=[
'matrix-synapse-plinth'
], is_external=True, is_enabled=is_enabled, enable=enable,
disable=disable)
helper.call('post', actions.superuser_run, 'matrixsynapse',
['post-install'])
@ -138,8 +136,9 @@ def diagnose():
results.append(action_utils.diagnose_port_listening(8008, 'tcp4'))
results.append(action_utils.diagnose_port_listening(8448, 'tcp4'))
results.extend(action_utils.diagnose_url_on_all(
'https://{host}/_matrix', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/_matrix',
check_certificate=False))
return results

1
plinth/modules/matrixsynapse/views.py
View File

@ -79,6 +79,7 @@ class MatrixSynapseServiceView(ServiceView):
context = super().get_context_data(*args, **kwargs)
context['domain_name'] = matrixsynapse.get_configured_domain_name()
context['clients'] = matrixsynapse.clients
context['manual_page'] = matrixsynapse.manual_page
return context
def get_initial(self):

2
plinth/modules/mediawiki/__init__.py
View File

@ -51,6 +51,8 @@ description = [
service = None
manual_page = 'MediaWiki'
clients = clients

1
plinth/modules/mediawiki/views.py
View File

@ -38,6 +38,7 @@ class MediaWikiServiceView(views.ServiceView):
diagnostics_module_name = 'mediawiki'
service_id = 'mediawiki'
form_class = MediaWikiForm
manual_page = mediawiki.manual_page
show_status_block = False
def form_valid(self, form):

52
plinth/modules/minetest/__init__.py
View File

@ -19,19 +19,15 @@ FreedomBox app for Minetest server.
"""
import augeas
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
from .manifest import clients
from .manifest import clients
version = 2
@ -39,11 +35,13 @@ service = None
managed_services = ['minetest-server']
managed_packages = ['minetest-server', 'minetest-mod-advspawning',
'minetest-mod-animalmaterials', 'minetest-mod-animals',
'minetest-mod-mesecons', 'minetest-mod-mobf-core',
'minetest-mod-mobf-trap', 'minetest-mod-moreblocks',
'minetest-mod-nether', 'minetest-mod-torches']
managed_packages = [
'minetest-server', 'minetest-mod-advspawning',
'minetest-mod-animalmaterials', 'minetest-mod-animals',
'minetest-mod-mesecons', 'minetest-mod-mobf-core',
'minetest-mod-mobf-trap', 'minetest-mod-moreblocks', 'minetest-mod-nether',
'minetest-mod-torches'
]
name = _('Minetest')
@ -60,6 +58,8 @@ description = [
clients = clients
manual_page = 'Minetest'
reserved_usernames = ['Debian-minetest']
CONFIG_FILE = '/etc/minetest/minetest.conf'
@ -69,15 +69,15 @@ AUG_PATH = '/files' + CONFIG_FILE + '/.anon'
def init():
"""Initialize the module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-th-large', 'minetest:index', short_description)
menu.add_urlname(name, 'glyphicon-th-large', 'minetest:index',
short_description)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0], name,
ports=['minetest-plinth'], is_external=True, enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'minetest-plinth'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -88,20 +88,18 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
managed_services[0], name,
ports=['minetest-plinth'], is_external=True, enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'minetest-plinth'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut('minetest', name, url=None,
short_description=short_description,
details=description,
configure_url=reverse_lazy('minetest:index'),
login_required=False)
frontpage.add_shortcut(
'minetest', name, url=None, short_description=short_description,
details=description, configure_url=reverse_lazy('minetest:index'),
login_required=False)
def enable():
@ -127,8 +125,8 @@ def diagnose():
def load_augeas():
"""Initialize Augeas."""
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
augeas.Augeas.NO_MODL_AUTOLOAD)
aug = augeas.Augeas(
flags=augeas.Augeas.NO_LOAD + augeas.Augeas.NO_MODL_AUTOLOAD)
aug.set('/augeas/load/Php/lens', 'Php.lns')
aug.set('/augeas/load/Php/incl[last() + 1]', CONFIG_FILE)
aug.load()

20
plinth/modules/minetest/views.py
View File

@ -22,12 +22,11 @@ from django.contrib import messages
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth.modules import minetest
from plinth.modules import minetest, names
from plinth.views import ServiceView
from . import description, managed_services, get_configuration
from . import description, get_configuration, managed_services
from .forms import MinetestForm
from plinth.modules import names
class MinetestServiceView(ServiceView): # pylint: disable=too-many-ancestors
@ -39,6 +38,7 @@ class MinetestServiceView(ServiceView): # pylint: disable=too-many-ancestors
template_name = 'minetest.html'
form_class = MinetestForm
clients = minetest.clients
manual_page = minetest.manual_page
def get_initial(self):
"""Return the values to fill in the form."""
@ -49,9 +49,9 @@ class MinetestServiceView(ServiceView): # pylint: disable=too-many-ancestors
def get_context_data(self, *args, **kwargs):
"""Add service to the context data."""
context = super().get_context_data(*args, **kwargs)
domains = [domain
for domains in names.domains.values()
for domain in domains]
domains = [
domain for domains in names.domains.values() for domain in domains
]
context['domains'] = domains
return context
@ -62,10 +62,10 @@ class MinetestServiceView(ServiceView): # pylint: disable=too-many-ancestors
if old_config['max_players'] != data['max_players'] \
and data['max_players'] != None:
actions.superuser_run('minetest', [
'configure', '--max_players',
str(data['max_players'])
])
actions.superuser_run(
'minetest',
['configure', '--max_players',
str(data['max_players'])])
messages.success(self.request,
_('Maximum players configuration updated'))

8
plinth/modules/monkeysphere/__init__.py
View File

@ -22,7 +22,6 @@ from django.utils.translation import ugettext_lazy as _
from plinth.menu import main_menu
version = 1
managed_packages = ['monkeysphere']
@ -38,7 +37,6 @@ description = [
'sign the key using the regular OpenPGP key signing process. See the '
'<a href="http://web.monkeysphere.info/getting-started-ssh/"> '
'Monkeysphere SSH documentation</a> for more details.'),
_('Monkeysphere can also generate an OpenPGP key for each Secure Web '
'Server (HTTPS) certificate installed on this machine. The OpenPGP '
'public key can then be uploaded to the OpenPGP keyservers. Users '
@ -49,14 +47,16 @@ description = [
'website</a>.')
]
manual_page = "Monkeysphere"
reserved_usernames = ['monkeysphere']
def init():
"""Initialize the monkeysphere module."""
menu = main_menu.get('system')
menu.add_urlname(_('Monkeysphere'), 'glyphicon-certificate',
'monkeysphere:index')
menu.add_urlname(
_('Monkeysphere'), 'glyphicon-certificate', 'monkeysphere:index')
def setup(helper, old_version=None):

50
plinth/modules/monkeysphere/views.py
View File

@ -14,22 +14,21 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
Views for the monkeysphere module.
"""
import json
from django.contrib import messages
from django.shortcuts import redirect
from django.template.response import TemplateResponse
from django.urls import reverse_lazy
from django.utils.translation import ugettext as _
from django.views.decorators.http import require_POST
import json
from plinth import actions
from plinth.modules import monkeysphere
from plinth.modules import names
from plinth.modules import monkeysphere, names
publish_process = None
@ -39,23 +38,25 @@ def index(request):
_collect_publish_result(request)
status = get_status()
return TemplateResponse(
request, 'monkeysphere.html',
{'title': monkeysphere.name,
'description': monkeysphere.description,
'status': status,
'running': bool(publish_process)})
request, 'monkeysphere.html', {
'title': monkeysphere.name,
'description': monkeysphere.description,
'status': status,
'manual_page': monkeysphere.manual_page,
'running': bool(publish_process)
})
@require_POST
def import_key(request, ssh_fingerprint):
"""Import a key into monkeysphere."""
available_domains = [domain
for domains in names.domains.values()
for domain in domains]
available_domains = [
domain for domains in names.domains.values() for domain in domains
]
try:
actions.superuser_run(
'monkeysphere', ['host-import-key', ssh_fingerprint] +
available_domains)
'monkeysphere',
['host-import-key', ssh_fingerprint] + available_domains)
messages.success(request, _('Imported key.'))
except actions.ActionError as exception:
messages.error(request, str(exception))
@ -65,9 +66,10 @@ def import_key(request, ssh_fingerprint):
def details(request, fingerprint):
"""Get details for an OpenPGP key."""
return TemplateResponse(request, 'monkeysphere_details.html',
{'title': monkeysphere.name,
'key': get_key(fingerprint)})
return TemplateResponse(request, 'monkeysphere_details.html', {
'title': monkeysphere.name,
'key': get_key(fingerprint)
})
@require_POST
@ -88,7 +90,8 @@ def cancel(request):
global publish_process
if publish_process:
actions.superuser_run(
'monkeysphere', ['host-cancel-publish', str(publish_process.pid)])
'monkeysphere', ['host-cancel-publish',
str(publish_process.pid)])
publish_process = None
messages.info(request, _('Cancelled key publishing.'))
@ -107,17 +110,18 @@ def get_keys(fingerprint=None):
['host-show-keys'] + fingerprint)
keys = json.loads(output)['keys']
domains = [domain
for domains_of_a_type in names.domains.values()
for domain in domains_of_a_type]
domains = [
domain for domains_of_a_type in names.domains.values()
for domain in domains_of_a_type
]
for key in keys.values():
key['imported_domains'] = set(key.get('imported_domains', []))
key['available_domains'] = set(key.get('available_domains', []))
if '*' in key['available_domains']:
key['available_domains'] = set(domains)
key['all_domains'] = sorted(
key['available_domains'].union(key['imported_domains']))
key['all_domains'] = sorted(key['available_domains'].union(
key['imported_domains']))
key['importable_domains'] = key['available_domains'] \
.difference(key['imported_domains'])

39
plinth/modules/mumble/__init__.py
View File

@ -21,12 +21,11 @@ FreedomBox app to configure Mumble server.
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, frontpage
from plinth.menu import main_menu
from plinth.views import ServiceView
from .manifest import clients
version = 1
@ -53,6 +52,8 @@ clients = clients
reserved_usernames = ['mumble-server']
manual_page = 'Mumble'
def init():
"""Intialize the Mumble module."""
@ -63,13 +64,9 @@ def init():
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0],
name,
ports=['mumble-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'mumble-plinth'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -80,6 +77,7 @@ class MumbleServiceView(ServiceView):
diagnostics_module_name = "mumble"
description = description
clients = clients
manual_page = manual_page
def setup(helper, old_version=None):
@ -87,25 +85,18 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
managed_services[0],
name,
ports=['mumble-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'mumble-plinth'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut(
'mumble',
name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('mumble:index'),
login_required=False)
frontpage.add_shortcut('mumble', name, short_description=short_description,
details=description,
configure_url=reverse_lazy('mumble:index'),
login_required=False)
def enable():

10
plinth/modules/names/__init__.py
View File

@ -18,13 +18,13 @@
FreedomBox app to configure name services.
"""
from django.utils.translation import ugettext_lazy as _
import logging
from django.utils.translation import ugettext_lazy as _
from plinth.menu import main_menu
from plinth.signals import domain_added, domain_removed
SERVICES = (
('http', _('HTTP'), 80),
('https', _('HTTPS'), 443),
@ -42,6 +42,8 @@ domains = {}
logger = logging.getLogger(__name__)
manual_page = 'NameServices'
def init():
"""Initialize the names module."""
@ -69,8 +71,8 @@ def on_domain_added(sender, domain_type, name='', description='',
# new domain_type
domains[domain_type] = {}
domains[domain_type][name] = services
logger.info('Added domain %s of type %s with services %s',
name, domain_type, str(services))
logger.info('Added domain %s of type %s with services %s', name,
domain_type, str(services))
def on_domain_removed(sender, domain_type, name='', **kwargs):

13
plinth/modules/names/views.py
View File

@ -21,18 +21,21 @@ FreedomBox app for name services.
from django.template.response import TemplateResponse
from django.utils.translation import ugettext as _
from . import SERVICES, get_domain_types, get_description
from . import get_domain, get_services_status
from plinth.modules import names
from . import (SERVICES, get_description, get_domain, get_domain_types,
get_services_status)
def index(request):
"""Serve name services page."""
status = get_status()
return TemplateResponse(request, 'names.html',
{'title': names.name,
'status': status})
return TemplateResponse(request, 'names.html', {
'title': names.name,
'manual_page': names.manual_page,
'status': status
})
def get_status():

19
plinth/modules/networks/__init__.py
View File

@ -18,16 +18,14 @@
FreedomBox app to interface with network-manager.
"""
from django.utils.translation import ugettext_lazy as _
from logging import Logger
import subprocess
from logging import Logger
from plinth import actions
from plinth import action_utils
from plinth import network
from django.utils.translation import ugettext_lazy as _
from plinth import action_utils, actions, network
from plinth.menu import main_menu
version = 1
is_essential = True
@ -38,6 +36,8 @@ name = _('Networks')
logger = Logger(__name__)
manual_page = 'Networks'
def init():
"""Initialize the Networks module."""
@ -113,9 +113,10 @@ def _diagnose_dnssec(kind='4'):
result = 'failed'
try:
output = subprocess.check_output(
['dig', kind_option, '+time=2', '+tries=1',
'test.dnssec-or-not.net', 'TXT'])
output = subprocess.check_output([
'dig', kind_option, '+time=2', '+tries=1',
'test.dnssec-or-not.net', 'TXT'
])
if 'Yes, you are using DNSSEC' in output.decode():
result = 'passed'

207
plinth/modules/networks/networks.py
View File

@ -15,37 +15,47 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from logging import Logger
from django.contrib import messages
from django.shortcuts import redirect
from django.template.response import TemplateResponse
from django.urls import reverse_lazy
from django.utils.translation import ugettext as _, ugettext_lazy
from django.utils.translation import ugettext as _
from django.utils.translation import ugettext_lazy
from django.views.decorators.http import require_POST
from logging import Logger
from plinth import network
from plinth.modules import networks
from .forms import (ConnectionTypeSelectForm, EthernetForm, GenericForm,
PPPoEForm, WifiForm)
from plinth import network
logger = Logger(__name__)
subsubmenu = [{'url': reverse_lazy('networks:index'),
'text': ugettext_lazy('Network Connections')},
{'url': reverse_lazy('networks:scan'),
'text': ugettext_lazy('Nearby Wi-Fi Networks')},
{'url': reverse_lazy('networks:add'),
'text': ugettext_lazy('Add Connection')}]
subsubmenu = [{
'url': reverse_lazy('networks:index'),
'text': ugettext_lazy('Network Connections')
}, {
'url': reverse_lazy('networks:scan'),
'text': ugettext_lazy('Nearby Wi-Fi Networks')
}, {
'url': reverse_lazy('networks:add'),
'text': ugettext_lazy('Add Connection')
}]
def index(request):
"""Show connection list."""
connections = network.get_connection_list()
return TemplateResponse(request, 'connections_list.html',
{'title': _('Network Connections'),
'subsubmenu': subsubmenu,
'connections': connections})
return TemplateResponse(
request, 'connections_list.html', {
'title': _('Network Connections'),
'manual_page': networks.manual_page,
'subsubmenu': subsubmenu,
'connections': connections
})
def show(request, uuid):
@ -53,8 +63,9 @@ def show(request, uuid):
try:
connection = network.get_connection(uuid)
except network.ConnectionNotFound:
messages.error(request, _('Cannot show connection: '
'Connection not found.'))
messages.error(request,
_('Cannot show connection: '
'Connection not found.'))
return redirect(reverse_lazy('networks:index'))
# Connection status
@ -86,13 +97,15 @@ def show(request, uuid):
access_point_status = network.get_status_from_wifi_access_point(
device, connection_status['wireless']['ssid'])
return TemplateResponse(request, 'connection_show.html',
{'title': _('Connection Information'),
'subsubmenu': subsubmenu,
'connection': connection_status,
'active_connection': active_connection_status,
'device': device_status,
'access_point': access_point_status})
return TemplateResponse(
request, 'connection_show.html', {
'title': _('Connection Information'),
'subsubmenu': subsubmenu,
'connection': connection_status,
'active_connection': active_connection_status,
'device': device_status,
'access_point': access_point_status
})
def edit(request, uuid):
@ -100,8 +113,9 @@ def edit(request, uuid):
try:
connection = network.get_connection(uuid)
except network.ConnectionNotFound:
messages.error(request, _('Cannot edit connection: '
'Connection not found.'))
messages.error(request,
_('Cannot edit connection: '
'Connection not found.'))
return redirect(reverse_lazy('networks:index'))
if connection.get_connection_type() not in network.CONNECTION_TYPE_NAMES:
@ -127,10 +141,12 @@ def edit(request, uuid):
return redirect(reverse_lazy('networks:index'))
else:
return TemplateResponse(request, 'connections_edit.html',
{'title': _('Edit Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(
request, 'connections_edit.html', {
'title': _('Edit Connection'),
'subsubmenu': subsubmenu,
'form': form
})
else:
settings_connection = connection.get_setting_connection()
form_data['interface'] = connection.get_interface_name()
@ -211,10 +227,11 @@ def edit(request, uuid):
form_data['password'] = secrets['pppoe']['password']
form = PPPoEForm(form_data)
return TemplateResponse(request, 'connections_edit.html',
{'title': _('Edit Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(request, 'connections_edit.html', {
'title': _('Edit Connection'),
'subsubmenu': subsubmenu,
'form': form
})
@require_POST
@ -223,16 +240,17 @@ def activate(request, uuid):
try:
connection = network.activate_connection(uuid)
name = connection.get_id()
messages.success(request, _('Activated connection {name}.')
.format(name=name))
messages.success(request,
_('Activated connection {name}.').format(name=name))
except network.ConnectionNotFound:
messages.error(request, _('Failed to activate connection: '
'Connection not found.'))
messages.error(request,
_('Failed to activate connection: '
'Connection not found.'))
except network.DeviceNotFound as exception:
name = exception.args[0].get_id()
messages.error(request, _('Failed to activate connection {name}: '
'No suitable device is available.')
.format(name=name))
messages.error(request,
_('Failed to activate connection {name}: '
'No suitable device is available.').format(name=name))
return redirect(reverse_lazy('networks:index'))
@ -243,11 +261,12 @@ def deactivate(request, uuid):
try:
active_connection = network.deactivate_connection(uuid)
name = active_connection.get_id()
messages.success(request, _('Deactivated connection {name}.')
.format(name=name))
messages.success(request,
_('Deactivated connection {name}.').format(name=name))
except network.ConnectionNotFound:
messages.error(request, _('Failed to de-activate connection: '
'Connection not found.'))
messages.error(request,
_('Failed to de-activate connection: '
'Connection not found.'))
return redirect(reverse_lazy('networks:index'))
@ -255,10 +274,12 @@ def deactivate(request, uuid):
def scan(request):
"""Show a list of nearby visible Wi-Fi access points."""
access_points = network.wifi_scan()
return TemplateResponse(request, 'wifi_scan.html',
{'title': _('Nearby Wi-Fi Networks'),
'subsubmenu': subsubmenu,
'access_points': access_points})
return TemplateResponse(
request, 'wifi_scan.html', {
'title': _('Nearby Wi-Fi Networks'),
'subsubmenu': subsubmenu,
'access_points': access_points
})
def add(request):
@ -279,10 +300,11 @@ def add(request):
return redirect(reverse_lazy('networks:add_pppoe'))
else:
form = ConnectionTypeSelectForm()
return TemplateResponse(request, 'connections_type_select.html',
{'title': _('Add Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(request, 'connections_type_select.html', {
'title': _('Add Connection'),
'subsubmenu': subsubmenu,
'form': form
})
def add_generic(request):
@ -297,10 +319,12 @@ def add_generic(request):
else:
form = GenericForm()
return TemplateResponse(request, 'connections_create.html',
{'title': _('Adding New Generic Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(
request, 'connections_create.html', {
'title': _('Adding New Generic Connection'),
'subsubmenu': subsubmenu,
'form': form
})
def add_ethernet(request):
@ -315,10 +339,12 @@ def add_ethernet(request):
else:
form = EthernetForm()
return TemplateResponse(request, 'connections_create.html',
{'title': _('Adding New Ethernet Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(
request, 'connections_create.html', {
'title': _('Adding New Ethernet Connection'),
'subsubmenu': subsubmenu,
'form': form
})
def add_pppoe(request):
@ -333,10 +359,12 @@ def add_pppoe(request):
else:
form = PPPoEForm()
return TemplateResponse(request, 'connections_create.html',
{'title': _('Adding New PPPoE Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(
request, 'connections_create.html', {
'title': _('Adding New PPPoE Connection'),
'subsubmenu': subsubmenu,
'form': form
})
def add_wifi(request, ssid=None, interface_name=None):
@ -346,14 +374,16 @@ def add_wifi(request, ssid=None, interface_name=None):
if ssid:
device = network.get_device_by_interface_name(interface_name)
form_data = {'name': ssid,
'interface': interface_name if device else None,
'zone': 'external',
'ssid': ssid,
'mode': 'infrastructure',
'band': 'auto',
'auth_mode': 'wpa',
'ipv4_method': 'auto'}
form_data = {
'name': ssid,
'interface': interface_name if device else None,
'zone': 'external',
'ssid': ssid,
'mode': 'infrastructure',
'band': 'auto',
'auth_mode': 'wpa',
'ipv4_method': 'auto'
}
if request.method == 'POST':
form = WifiForm(request.POST)
@ -366,10 +396,12 @@ def add_wifi(request, ssid=None, interface_name=None):
else:
form = WifiForm()
return TemplateResponse(request, 'connections_create.html',
{'title': _('Adding New Wi-Fi Connection'),
'subsubmenu': subsubmenu,
'form': form})
return TemplateResponse(
request, 'connections_create.html', {
'title': _('Adding New Wi-Fi Connection'),
'subsubmenu': subsubmenu,
'form': form
})
def delete(request, uuid):
@ -381,11 +413,12 @@ def delete(request, uuid):
if request.method == 'POST':
try:
name = network.delete_connection(uuid)
messages.success(request, _('Connection {name} deleted.')
.format(name=name))
messages.success(request,
_('Connection {name} deleted.').format(name=name))
except network.ConnectionNotFound:
messages.error(request, _('Failed to delete connection: '
'Connection not found.'))
messages.error(request,
_('Failed to delete connection: '
'Connection not found.'))
return redirect(reverse_lazy('networks:index'))
@ -393,11 +426,13 @@ def delete(request, uuid):
connection = network.get_connection(uuid)
name = connection.get_id()
except network.ConnectionNotFound:
messages.error(request, _('Failed to delete connection: '
'Connection not found.'))
messages.error(request,
_('Failed to delete connection: '
'Connection not found.'))
return redirect(reverse_lazy('networks:index'))
return TemplateResponse(request, 'connections_delete.html',
{'title': _('Delete Connection'),
'subsubmenu': subsubmenu,
'name': name})
return TemplateResponse(request, 'connections_delete.html', {
'title': _('Delete Connection'),
'subsubmenu': subsubmenu,
'name': name
})

7
plinth/modules/openvpn/__init__.py
View File

@ -21,11 +21,8 @@ FreedomBox app to configure OpenVPN server.
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
@ -52,6 +49,8 @@ description = [
'for added security and anonymity.'), box_name=_(cfg.box_name))
]
manual_page = 'OpenVPN'
def init():
"""Initialize the OpenVPN module."""

22
plinth/modules/openvpn/views.py
View File

@ -18,18 +18,19 @@
FreedomBox app for configuring OpenVPN server.
"""
import logging
from django.contrib import messages
from django.http import HttpResponse
from django.shortcuts import redirect
from django.template.response import TemplateResponse
from django.utils.translation import ugettext as _
from django.views.decorators.http import require_POST
import logging
from plinth import actions
from plinth.modules import config, openvpn
from .forms import OpenVpnForm
from plinth import actions
from plinth.modules import openvpn
from plinth.modules import config
logger = logging.getLogger(__name__)
@ -55,11 +56,14 @@ def index(request):
else:
form = OpenVpnForm(initial=status, prefix='openvpn')
return TemplateResponse(request, 'openvpn.html',
{'title': openvpn.name,
'description': openvpn.description,
'status': status,
'form': form})
return TemplateResponse(
request, 'openvpn.html', {
'title': openvpn.name,
'description': openvpn.description,
'manual_page': openvpn.manual_page,
'status': status,
'form': form
})
@require_POST

4
plinth/modules/pagekite/__init__.py
View File

@ -60,7 +60,7 @@ description = [
_('Your ISP does not provide you an external IP address and '
'instead provides Internet connection through NAT.'),
_('Your ISP does not provide you a static IP address and your IP '
'address changes evertime you connect to Internet.'),
'address changes every time you connect to Internet.'),
_('Your ISP limits incoming connections.'),
format_lazy(
_('PageKite works around NAT, firewalls and IP-address limitations '
@ -71,6 +71,8 @@ description = [
box_name=_(cfg.box_name))
]
manual_page = 'PageKite'
def init():
"""Intialize the PageKite module"""

16
plinth/modules/pagekite/templates/pagekite_introduction.html
View File

@ -19,15 +19,27 @@
{% endcomment %}
{% load i18n %}
{% load static %}
{% block content %}
<h2>{{ title }}</h2>
{% block pagetitle %}
<h2>{{ title }}</h2>
{% endblock %}
{% for paragraph in description %}
<p>{{ paragraph|safe }}</p>
{% endfor %}
<p>
{% if manual_page %}
<p class="manual-page">
<a href="{% url 'help:manual-page' manual_page %}">
{% trans 'Learn more...' %}
</a>
</p>
{% endif %}
<p>
<a class="btn btn-primary btn-md" href="{% url 'pagekite:configure' %}">
{% trans "Configure PageKite" %}</a>
</p>

12
plinth/modules/pagekite/views.py
View File

@ -49,11 +49,13 @@ subsubmenu = [{
def index(request):
"""Serve introduction page"""
return TemplateResponse(request, 'pagekite_introduction.html', {
'title': pagekite.name,
'description': pagekite.description,
'subsubmenu': subsubmenu
})
return TemplateResponse(
request, 'pagekite_introduction.html', {
'title': pagekite.name,
'description': pagekite.description,
'manual_page': pagekite.manual_page,
'subsubmenu': subsubmenu
})
class ContextMixin(object):

6
plinth/modules/power/__init__.py
View File

@ -26,9 +26,9 @@ is_essential = True
name = _('Power')
description = [
_('Restart or shut down the system.')
]
description = [_('Restart or shut down the system.')]
manual_page = 'Power'
def init():

11
plinth/modules/power/templates/power_restart.html
View File

@ -20,10 +20,19 @@
{% load bootstrap %}
{% load i18n %}
{% load static %}
{% block content %}
<h2>{{ title }}</h2>
{% block pagetitle %}
<h2>{{ title }}
{% if manual_page %}
<a href="{% url 'help:manual-page' manual_page %}">
<img class="manual-page" src="{% static 'theme/icons/manual.png' %}" alt="Manual" />
</a>
{% endif %}
</h2>
{% endblock %}
<p>
{% blocktrans trimmed %}

11
plinth/modules/power/templates/power_shutdown.html
View File

@ -20,10 +20,19 @@
{% load bootstrap %}
{% load i18n %}
{% load static %}
{% block content %}
<h2>{{ title }}</h2>
{% block pagetitle %}
<h2>{{ title }}
{% if manual_page %}
<a href="{% url 'help:manual-page' manual_page %}">
<img class="manual-page" src="{% static 'theme/icons/manual.png' %}" alt="Manual" />
</a>
{% endif %}
</h2>
{% endblock %}
<p>
{% blocktrans trimmed %}

33
plinth/modules/power/views.py
View File

@ -30,10 +30,13 @@ from plinth.modules import power
def index(request):
"""Serve power controls page."""
return TemplateResponse(request, 'power.html',
{'title': power.name,
'description': power.description,
'pkg_manager_is_busy': _is_pkg_manager_busy()})
return TemplateResponse(
request, 'power.html', {
'title': power.name,
'description': power.description,
'manual_page': power.manual_page,
'pkg_manager_is_busy': _is_pkg_manager_busy()
})
def restart(request):
@ -46,10 +49,13 @@ def restart(request):
else:
form = Form(prefix='power')
return TemplateResponse(request, 'power_restart.html',
{'title': _('Power'),
'form': form,
'pkg_manager_is_busy': _is_pkg_manager_busy()})
return TemplateResponse(
request, 'power_restart.html', {
'title': _('Power'),
'form': form,
'manual_page': power.manual_page,
'pkg_manager_is_busy': _is_pkg_manager_busy()
})
def shutdown(request):
@ -62,10 +68,13 @@ def shutdown(request):
else:
form = Form(prefix='power')
return TemplateResponse(request, 'power_shutdown.html',
{'title': _('Power'),
'form': form,
'pkg_manager_is_busy': _is_pkg_manager_busy()})
return TemplateResponse(
request, 'power_shutdown.html', {
'title': _('Power'),
'form': form,
'manual_page': power.manual_page,
'pkg_manager_is_busy': _is_pkg_manager_busy()
})
def _is_pkg_manager_busy():

36
plinth/modules/privoxy/__init__.py
View File

@ -21,16 +21,12 @@ FreedomBox app to configure Privoxy.
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
from plinth.views import ServiceView
version = 1
is_essential = False
@ -48,7 +44,6 @@ description = [
'capabilities for enhancing privacy, modifying web page data and '
'HTTP headers, controlling access, and removing ads and other '
'obnoxious Internet junk. '),
format_lazy(
_('You can use Privoxy by modifying your browser proxy settings to '
'your {box_name} hostname (or IP address) with port 8118. '
@ -63,19 +58,21 @@ reserved_usernames = ['privoxy']
service = None
manual_page = 'Privoxy'
def init():
"""Intialize the module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-cloud-upload', 'privoxy:index', short_description)
menu.add_urlname(name, 'glyphicon-cloud-upload', 'privoxy:index',
short_description)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0], name, ports=['privoxy'],
is_external=False,
enable=enable, disable=disable)
service = service_module.Service(managed_services[0], name,
ports=['privoxy'], is_external=False,
enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -87,20 +84,18 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
managed_services[0], name, ports=['privoxy'],
is_external=False,
enable=enable, disable=disable)
service = service_module.Service(managed_services[0], name,
ports=['privoxy'], is_external=False,
enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut('privoxy', name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('privoxy:index'),
login_required=True)
frontpage.add_shortcut(
'privoxy', name, short_description=short_description,
details=description, configure_url=reverse_lazy('privoxy:index'),
login_required=True)
def enable():
@ -119,6 +114,7 @@ class PrivoxyServiceView(ServiceView):
service_id = managed_services[0]
diagnostics_module_name = 'privoxy'
description = description
manual_page = manual_page
def diagnose():

39
plinth/modules/quassel/__init__.py
View File

@ -21,14 +21,12 @@ FreedomBox app for Quassel.
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
from plinth.views import ServiceView
from .manifest import clients
version = 1
@ -51,8 +49,7 @@ description = [
'the client is disconnected. {box_name} can run the Quassel '
'core service keeping you always online and one or more Quassel '
'clients from a desktop or a mobile can be used to connect and '
'disconnect from it.'),
box_name=_(cfg.box_name)),
'disconnect from it.'), box_name=_(cfg.box_name)),
_('You can connect to your Quassel core on the default Quassel port '
'4242. Clients to connect to Quassel from your '
'<a href="http://quassel-irc.org/downloads">desktop</a> and '
@ -64,6 +61,8 @@ clients = clients
reserved_usernames = ['quasselcore']
manual_page = 'Quassel'
def init():
"""Initialize the quassel module."""
@ -74,13 +73,9 @@ def init():
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0],
name,
ports=['quassel-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'quassel-plinth'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -91,6 +86,7 @@ class QuasselServiceView(ServiceView):
diagnostics_module_name = "quassel"
description = description
clients = clients
manual_page = manual_page
def setup(helper, old_version=None):
@ -98,24 +94,17 @@ def setup(helper, old_version=None):
helper.install(managed_packages)
global service
if service is None:
service = service_module.Service(
managed_services[0],
name,
ports=['quassel-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'quassel-plinth'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut(
'quassel',
name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('quassel:index'),
'quassel', name, short_description=short_description,
details=description, configure_url=reverse_lazy('quassel:index'),
login_required=True)

44
plinth/modules/radicale/__init__.py
View File

@ -22,15 +22,12 @@ import augeas
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import cfg
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, cfg, frontpage
from plinth.menu import main_menu
from plinth.utils import format_lazy
from .manifest import clients
from .manifest import clients
version = 1
@ -57,21 +54,23 @@ clients = clients
reserved_usernames = ['radicale']
manual_page = 'Radicale'
CONFIG_FILE = '/etc/radicale/config'
def init():
"""Initialize the radicale module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-calendar', 'radicale:index', short_description)
menu.add_urlname(name, 'glyphicon-calendar', 'radicale:index',
short_description)
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0], name, ports=['http', 'https'],
is_external=True,
enable=enable, disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -83,20 +82,18 @@ def setup(helper, old_version=None):
helper.call('post', actions.superuser_run, 'radicale', ['setup'])
global service
if service is None:
service = service_module.Service(
managed_services[0], name, ports=['http', 'https'],
is_external=True,
enable=enable, disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'http', 'https'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut('radicale', name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('radicale:index'),
login_required=True)
frontpage.add_shortcut(
'radicale', name, short_description=short_description,
details=description, configure_url=reverse_lazy('radicale:index'),
login_required=True)
def enable():
@ -113,8 +110,8 @@ def disable():
def load_augeas():
"""Prepares the augeas."""
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
augeas.Augeas.NO_MODL_AUTOLOAD)
aug = augeas.Augeas(
flags=augeas.Augeas.NO_LOAD + augeas.Augeas.NO_MODL_AUTOLOAD)
# INI file lens
aug.set('/augeas/load/Puppet/lens', 'Puppet.lns')
@ -137,7 +134,8 @@ def diagnose():
results.append(action_utils.diagnose_port_listening(5232, 'tcp4'))
results.append(action_utils.diagnose_port_listening(5232, 'tcp6'))
results.extend(action_utils.diagnose_url_on_all(
'https://{host}/radicale', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/radicale',
check_certificate=False))
return results

7
plinth/modules/radicale/views.py
View File

@ -36,6 +36,7 @@ class RadicaleServiceView(ServiceView):
diagnostics_module_name = 'radicale'
form_class = RadicaleForm
service_id = managed_services[0]
manual_page = radicale.manual_page
def get_initial(self):
"""Return the values to fill in the form."""
@ -47,9 +48,9 @@ class RadicaleServiceView(ServiceView):
"""Change the access control of Radicale service."""
data = form.cleaned_data
if get_rights_value() != data['access_rights']:
actions.superuser_run('radicale', [
'configure', '--rights_type', data['access_rights']
])
actions.superuser_run(
'radicale',
['configure', '--rights_type', data['access_rights']])
messages.success(self.request,
_('Access rights configuration updated'))
return super().form_valid(form)

39
plinth/modules/repro/__init__.py
View File

@ -21,12 +21,11 @@ FreedomBox app for repro.
from django.urls import reverse_lazy
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, frontpage
from plinth.menu import main_menu
from plinth.views import ServiceView
from .manifest import clients
version = 2
@ -64,6 +63,8 @@ reserved_usernames = ['repro']
service = None
manual_page = 'Repro'
def init():
"""Initialize the repro module."""
@ -74,13 +75,9 @@ def init():
global service
setup_helper = globals()['setup_helper']
if setup_helper.get_state() != 'needs-setup':
service = service_module.Service(
managed_services[0],
name,
ports=['sip', 'sips', 'rtp-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'sip', 'sips', 'rtp-plinth'
], is_external=True, enable=enable, disable=disable)
if service.is_enabled():
add_shortcut()
@ -91,6 +88,7 @@ class ReproServiceView(ServiceView):
description = description
diagnostics_module_name = "repro"
service_id = managed_services[0]
manual_page = manual_page
def setup(helper, old_version=None):
@ -99,25 +97,18 @@ def setup(helper, old_version=None):
helper.call('post', actions.superuser_run, 'repro', ['setup'])
global service
if service is None:
service = service_module.Service(
managed_services[0],
name,
ports=['sip', 'sips', 'rtp-plinth'],
is_external=True,
enable=enable,
disable=disable)
service = service_module.Service(managed_services[0], name, ports=[
'sip', 'sips', 'rtp-plinth'
], is_external=True, enable=enable, disable=disable)
helper.call('post', service.notify_enabled, None, True)
helper.call('post', add_shortcut)
def add_shortcut():
frontpage.add_shortcut(
'repro',
name,
short_description=short_description,
details=description,
configure_url=reverse_lazy('repro:index'),
login_required=True)
frontpage.add_shortcut('repro', name, short_description=short_description,
details=description,
configure_url=reverse_lazy('repro:index'),
login_required=True)
def enable():

24
plinth/modules/roundcube/__init__.py
View File

@ -20,13 +20,11 @@ FreedomBox app to configure Roundcube.
from django.utils.translation import ugettext_lazy as _
from plinth import actions
from plinth import action_utils
from plinth import frontpage
from plinth import service as service_module
from plinth import action_utils, actions, frontpage
from plinth.menu import main_menu
from .manifest import clients
from .manifest import clients
version = 1
@ -42,14 +40,12 @@ description = [
'full functionality you expect from an email client, including '
'MIME support, address book, folder manipulation, message '
'searching and spell checking.'),
_('You can access Roundcube from <a href="/roundcube">'
'/roundcube</a>. Provide the username and password of the email '
'account you wish to access followed by the domain name of the '
'IMAP server for your email provider, like <code>imap.example.com'
'</code>. For IMAP over SSL (recommended), fill the server field '
'like <code>imaps://imap.example.com</code>.'),
_('For Gmail, username will be your Gmail address, password will be '
'your Google account password and server will be '
'<code>imaps://imap.gmail.com</code>. Note that you will also need '
@ -62,11 +58,14 @@ clients = clients
service = None
manual_page = 'Roundcube'
def init():
"""Intialize the module."""
menu = main_menu.get('apps')
menu.add_urlname(name, 'glyphicon-envelope', 'roundcube:index', short_description)
menu.add_urlname(name, 'glyphicon-envelope', 'roundcube:index',
short_description)
global service
setup_helper = globals()['setup_helper']
@ -93,9 +92,9 @@ def setup(helper, old_version=None):
def add_shortcut():
frontpage.add_shortcut(
'roundcube', name, short_description=short_description, url='/roundcube',
login_required=True)
frontpage.add_shortcut('roundcube', name,
short_description=short_description,
url='/roundcube', login_required=True)
def is_enabled():
@ -119,7 +118,8 @@ def diagnose():
"""Run diagnostics and return the results."""
results = []
results.extend(action_utils.diagnose_url_on_all(
'https://{host}/roundcube', check_certificate=False))
results.extend(
action_utils.diagnose_url_on_all('https://{host}/roundcube',
check_certificate=False))
return results

10
plinth/modules/roundcube/urls.py
View File

@ -14,22 +14,22 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""
URLs for the Roundcube module.
"""
from django.conf.urls import url
from plinth.views import ServiceView
from plinth.modules import roundcube
from plinth.views import ServiceView
urlpatterns = [
url(r'^apps/roundcube/$', ServiceView.as_view(
url(r'^apps/roundcube/$',
ServiceView.as_view(
service_id="roundcube",
diagnostics_module_name="roundcube",
description=roundcube.description,
show_status_block=False
show_status_block=False,
manual_page=roundcube.manual_page,
), name='index'),
]

2
plinth/modules/searx/__init__.py
View File

@ -54,6 +54,8 @@ group = ('web-search', _('Search the web'))
service = None
manual_page = 'Searx'
def init():
"""Intialize the module."""

4
plinth/modules/searx/views.py
View File

@ -23,7 +23,8 @@ from django.utils.translation import ugettext as _
from plinth import actions, views
from plinth.errors import ActionError
from plinth.modules.searx import clients, description, get_safe_search_setting
from plinth.modules.searx import (clients, description,
get_safe_search_setting, manual_page)
from .forms import SearxForm
@ -36,6 +37,7 @@ class SearxServiceView(views.ServiceView):
service_id = 'searx'
form_class = SearxForm
show_status_block = False
manual_page = manual_page
def get_initial(self):
"""Return the status of the service to fill in the form."""

Some files were not shown because too many files have changed in this diff Show More