nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-21 07:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fetch latest manual from wiki

Browse Source 
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy 2018-10-08 21:55:18 -04:00
parent 8303a98dd9
commit 8ae6b5d530
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
20 changed files with 336 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Quassel.raw.xml
View File

File diff suppressed because one or more lines are too long

2
doc/Radicale.raw.xml
View File

File diff suppressed because one or more lines are too long

2
doc/Storage.raw.xml
View File

File diff suppressed because one or more lines are too long

388
doc/freedombox-manual.raw.xml
View File

@ -1097,7 +1097,7 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]></
<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>
<para>URL: <code>https://</code><emphasis>IP-address-or-domain-for-your-server</emphasis><code>/radicale/</code><emphasis>user</emphasis><code>/</code><emphasis>calendar-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>
@ -1491,56 +1491,291 @@ file = /etc/radicale/rights]]></screen>
<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>
<section>
<title>Desktop</title>
<para>In a Debian system, you can e.g. use <ulink url="https://packages.debian.org/search?keywords=quassel-client">quassel-client</ulink>. The following steps describe how to connect Quassel Client with Quassel Core running on a FreedomBox. The first time you do this connection, Quassel Core will be initialized too. </para>
<orderedlist numeration="arabic">
<listitem>
<para>Launch Quassel Client. You will be greeted with a wizard to <code>Connect to Core</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-1-connect-to-core.png" width="394"/>
</imageobject>
<textobject>
<phrase>Connect to Core</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click the <code>Add</code> button to launch <code>Add Core Account</code> dialog. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-2-add-core-account.png" width="382"/>
</imageobject>
<textobject>
<phrase>Add Core Account</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Fill any value in the <code>Account Name</code> field. Fill proper DNS hostname of your FreedomBox in <code>Hostname</code> filed. <code>Port</code> field must have the value <code>4242</code>. Provide the username and password of the account you wish to create to connect to the Quassel Core in the <code>User</code> and <code>Password</code> fields. Choose <code>Remember</code> if don't wish to be prompted for a password every time you launch Quassel client. </para>
</listitem>
<listitem>
<para>After pressing <code>OK</code> in the <code>Add Core Account</code> dialog, you should see the core account in the <code>Connect to Core</code> dialog. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-3-connect-to-core.png" width="394"/>
</imageobject>
<textobject>
<phrase>Connect to Core</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select the newly created core account and select <code>OK</code> to connect to it. </para>
</listitem>
<listitem>
<para>If this is the first time you are connecting to this core. You will see an <code>Untrusted Security Certificate</code> warning and need to accept the server certificate. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-4-untrusted-security-certficate.png" width="504"/>
</imageobject>
<textobject>
<phrase>Untrusted Security Certificate</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select <code>Continue</code>. Then you will be asked if you wish to accept the certificate permanently. Select <code>Forever</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-5-untrusted-security-certificate.png" width="434"/>
</imageobject>
<textobject>
<phrase>Untrusted Security Certificate</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>If this Quassel Core has not been connected to before, you will then see a <code>Core Configuration Wizard</code>. Select <code>Next</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-6-core-configuration-wizard.png" width="504"/>
</imageobject>
<textobject>
<phrase>Core Configuration Wizard</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the <code>Create Admin User</code> page, enter the username and password you have used earlier to create the core connection. Select <code>Remember password</code> to remember this password for future sessions. Click <code>Next</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-7-create-admin-user.png" width="504"/>
</imageobject>
<textobject>
<phrase>Create Admin User Page</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the <code>Select Storage Backend</code> page, select <code>SQLite</code> and click <code>Commit</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-8-select-storage-backend.png" width="504"/>
</imageobject>
<textobject>
<phrase>Select Storage Backend</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>The core configuration is then complete and you will see a <code>Quassel IRC</code> wizard to configure your IRC connections. Click <code>Next</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-9-welcome-wizard.png" width="504"/>
</imageobject>
<textobject>
<phrase>Welcome Wizard</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <code>Setup Identity</code> page next, provide a name and multiple nicknames. This is how you present yourself to other users on IRC. It is not necessary to give your real world name. Multiple nicknames are useful as fallback nicknames when the first nickname can't be used for some reason. After providing the information click <code>Next</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-10-setup-identity.png" width="504"/>
</imageobject>
<textobject>
<phrase>Setup Identity</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <code>Setup Network Connection</code> page next, provide a network name of your choice. Next provide a list of servers to which Quassel Core should connect to in order to join this IRC network (such as irc.debian.org:6667). </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-11-setup-network-connection.png" width="504"/>
</imageobject>
<textobject>
<phrase>Setup Network Connection</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select the server in the servers list and click <code>Edit</code>. In the <code>Server Info</code> dialog, set the port <code>6697</code> (consult your network's documentation for actual list of servers and their secure ports) and click <code>Use SSL</code>. Click <code>OK</code>. This is to ensure that communication between your FreedomBox and the IRC network server is encrypted. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-12-server-info.png" width="390"/>
</imageobject>
<textobject>
<phrase>Server Info</phrase>
</textobject>
</inlinemediaobject>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-13-server-info-ssl.png" width="390"/>
</imageobject>
<textobject>
<phrase>Server Info SSL</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Back in the <code>Setup Network Connection</code> dialog, provide a list of IRC channels (such as #freedombox) to join upon connecting to the network. Click <code>Save &amp; Connect</code>. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-14-setup-network-connection.png" width="504"/>
</imageobject>
<textobject>
<phrase>Setup Network Connection</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You should connect to the network and see the list of channels you have joined on the <code>All Chats</code> pane on the left of the Quassel Client main window. </para>
<itemizedlist>
<listitem override="none">
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Quassel?action=AttachFile&amp;do=get&amp;target=quassel-client-15-quassel-main.png" width="644"/>
</imageobject>
<textobject>
<phrase>Quassel Main Window</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select a channel and start seeing messages from others in the channel and send your own messages. </para>
</listitem>
</orderedlist>
</section>
<section>
<title>Android</title>
<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>
</section>
</section>
</section>
<section>
@ -4869,15 +5104,16 @@ nmcli con modify "<connection_name>" connection.zone internal]]></screen>
</section>
<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><emphasis>Storage</emphasis> allows you to see the storage devices attached to your FreedomBox and their disk space usage. </para>
<para>FreedomBox can automatically detect and mount removable media like USB flash drives. They are listed under the <emphasis>Removable Devices</emphasis> section along with an option to eject them. </para>
<para>If there is some free space left after the root partition, the option to expand the root partition is also available. This is typically not shown, since expanding the root partition happens automatically when the FreedomBox starts up for the first time. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Storage?action=AttachFile&amp;do=get&amp;target=Disks.png"/>
<imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/Storage?action=AttachFile&amp;do=get&amp;target=Storage.png"/>
</imageobject>
<textobject>
<phrase>Disks.png</phrase>
<phrase>Storage.png</phrase>
</textobject>
</inlinemediaobject>
</para>
@ -7490,6 +7726,48 @@ wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw]
<section>
<title>Release Notes</title>
<para>The following are the release notes for each FreedomBox version. </para>
<section>
<title>Version 0.40.0 (2018-10-08)</title>
<itemizedlist>
<listitem>
<para>Backups </para>
<itemizedlist>
<listitem>
<para>Enable backup/restore for mumble, privoxy, roundcube, searx, jsxc, coquelicot, transmission, quassel, shadowsocks, sharing, pagekite, and cockpit. </para>
</listitem>
<listitem>
<para>Allow backup archives to be downloaded/uploaded through browser. </para>
</listitem>
<listitem>
<para>mediawiki: Backup/restore settings as well as data. </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>User Interface </para>
<itemizedlist>
<listitem>
<para>Change card text style and position. </para>
</listitem>
<listitem>
<para>Change maximum cards per row. </para>
</listitem>
<listitem>
<para>Add tint effect on card icons under "Apps". </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>mediawiki: Run update script for 1.31 upgrade. </para>
</listitem>
<listitem>
<para>customization: Show custom shortcuts on frontpage. </para>
</listitem>
<listitem>
<para>Updated translations for Norwegian Bokmål, Portuguese, Spanish, Czech, German, French, and Italian. </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Version 0.39.0 (2018-09-24)</title>
<itemizedlist>

BIN
doc/images/Storage.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

BIN
doc/images/quassel-client-1-connect-to-core.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
doc/images/quassel-client-10-setup-identity.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
doc/images/quassel-client-11-setup-network-connection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
doc/images/quassel-client-12-server-info.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
doc/images/quassel-client-13-server-info-ssl.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
doc/images/quassel-client-14-setup-network-connection.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
doc/images/quassel-client-15-quassel-main.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
doc/images/quassel-client-2-add-core-account.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
doc/images/quassel-client-3-connect-to-core.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
doc/images/quassel-client-4-untrusted-security-certficate.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
doc/images/quassel-client-5-untrusted-security-certificate.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/images/quassel-client-6-core-configuration-wizard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/images/quassel-client-7-create-admin-user.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/quassel-client-8-select-storage-backend.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

BIN
doc/images/quassel-client-9-welcome-wizard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB