nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-28 08:03:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
FreedomBox/doc/Quassel.raw.xml
Joseph Nuthalapati 4064d6e231
manual: Link to manual from each service 
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>
2018-03-22 19:49:14 -04:00

314 lines
14 KiB
XML
Raw Blame History

<?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>
Reference in New Issue View Git Blame Copy Permalink