nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-03-11 09:04:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update manual from latest wiki

Browse Source 
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
Sunil Mohan Adapa 2017-06-06 10:11:02 +05:30
parent 249403a6dd
commit e8bfab2ba1
No known key found for this signature in database
GPG Key ID: 43EA1CFF0AA7C5F2
5 changed files with 307 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

311
doc/freedombox-manual.xml
View File

@ -4167,6 +4167,23 @@ Password:
</entry>
</row>
<row rowsep="1">
<entry align="center" colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Hardware/pcDuino3#">
<inlinemediaobject>
<imageobject>
<imagedata depth="53.5pt" fileref="images/pcduino3s_thumb.jpg" width="117.5pt"/>
</imageobject>
<textobject>
<phrase>pcDuino3</phrase>
</textobject>
</inlinemediaobject>
</ulink>
</para>
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Hardware/pcDuino3#">pcDuino3</ulink>
</para>
</entry>
<entry align="center" colsep="1" rowsep="1">
<para>
<ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">
@ -4201,7 +4218,6 @@ Password:
<ulink url="https://wiki.debian.org/FreedomBox/Hardware/VirtualBox#">VirtualBox</ulink>
</para>
</entry>
<entry colsep="1" rowsep="1"/>
</row>
</tbody>
</tgroup>
@ -4737,6 +4753,62 @@ Password:
</para>
</entry>
</row>
<row rowsep="1">
<entry colsep="1" rowsep="1">
<para>pcDunino3 </para>
</entry>
<entry colsep="1" rowsep="1">
<para>1x2</para>
</entry>
<entry colsep="1" rowsep="1">
<para>armhf/sunxi </para>
</entry>
<entry colsep="1" rowsep="1">
<para>1</para>
</entry>
<entry colsep="1" rowsep="1">
<para>4</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<inlinemediaobject>
<imageobject>
<imagedata depth="8pt" fileref="images/checkmark.png" width="8pt"/>
</imageobject>
<textobject>
<phrase>(./)</phrase>
</textobject>
</inlinemediaobject>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<inlinemediaobject>
<imageobject>
<imagedata depth="8pt" fileref="images/checkmark.png" width="8pt"/>
</imageobject>
<textobject>
<phrase>(./)</phrase>
</textobject>
</inlinemediaobject>
</para>
</entry>
<entry colsep="1" rowsep="1">
<para>100 </para>
</entry>
<entry colsep="1" rowsep="1">
<para>
<inlinemediaobject>
<imageobject>
<imagedata depth="8pt" fileref="images/icon-error.png" width="8pt"/>
</imageobject>
<textobject>
<phrase>{X}</phrase>
</textobject>
</inlinemediaobject>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
@ -5275,6 +5347,51 @@ Password:
<ulink url="http://www.pcengines.ch/apu1d4.htm">apu1d4</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu2b2.htm">apu2b2</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu2b4.htm">apu2b4</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu2c0.htm">apu2c0</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu2c2.htm">apu2c2</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu2c4.htm">apu2c4</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu3a2.htm">apu3a2</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu3a4.htm">apu3a4</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu3b2.htm">apu3b2</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/apu3b4.htm">apu3b4</ulink>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
@ -5345,12 +5462,12 @@ Password:
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/order1.php">PC Engines</ulink>
<ulink url="http://www.pcengines.ch/order.htm">PC Engines</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.pcengines.ch/order.php">Full list of suppliers</ulink>
<ulink url="http://www.pcengines.ch/order.htm">Full list of suppliers</ulink>
</para>
</listitem>
</itemizedlist>
@ -5406,6 +5523,114 @@ Password:
<para>None </para>
</section>
</section>
<section>
<title>pcDuino3</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata depth="155pt" fileref="images/pcduino3s.jpg" width="341pt"/>
</imageobject>
<textobject>
<phrase>LinkSprite pcDuino3S</phrase>
</textobject>
</inlinemediaobject>
</para>
<para><ulink url="http://www.linksprite.com/linksprite-pcduino3s/">LinkSprite pcDuino3S</ulink> is a single board computer running on Allwinner A20 and sold with a good case. FreedomBox images are built and tested for this device for images built after June 2017. For using this board as FreedomBox, a <ulink url="https://wiki.debian.org/FreedomBox/Hardware/USBWiFi#">USB WiFi device</ulink> that does not require non-free firmware is recommended. </para>
<para>Note: The FreedomBox logo is simply a sticker on top of device brought from store. </para>
<section>
<title>Similar Hardware</title>
<para>Although untested, the following similar hardware is also likely to work well with FreedomBox. </para>
<itemizedlist>
<listitem>
<para>
<ulink url="http://www.linksprite.com/linksprite-pcduino3/pcDuino3"/>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.linksprite.com/linksprite-pcduino3/pcDuino3B"/>
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Download</title>
<para>FreedomBox disk <ulink url="https://wiki.debian.org/FreedomBox/Download#">images</ulink> for this hardware are available. Follow the instructions on the <ulink url="https://wiki.debian.org/FreedomBox/Download#">download</ulink> page to create a FreedomBox SD card, USB disk, SSD or hard drive and boot into FreedomBox. Pick the image meant for pcduino3. </para>
<para>An alternative to downloading these images is to <ulink url="https://wiki.debian.org/InstallingDebianOn/Allwinner#">install Debian</ulink> on the APU and then <ulink url="https://wiki.debian.org/FreedomBox/Hardware/Debian#">install FreedomBox</ulink> on it. </para>
</section>
<section>
<title>Build Image</title>
<para>FreedomBox images for this hardware can be built using <ulink url="https://wiki.debian.org/FreedomBox/Maker#">Freedom Maker</ulink>. </para>
</section>
<section>
<title>Availability</title>
<itemizedlist>
<listitem>
<para>Price: 89 USD </para>
</listitem>
<listitem>
<para>
<ulink url="http://store.linksprite.com/pcduino3s-a20-single-board-computer-no-power-supply-or-hdmi-cable/">LinkSprite</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.linksprite.com/buy-2/">Full list of suppliers</ulink>
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Hardware</title>
<itemizedlist>
<listitem>
<para>Open Hardware: No </para>
</listitem>
<listitem>
<para>CPU: AllWinner A20 SoC, 1GHz ARM Cortex A7 Dual Core </para>
</listitem>
<listitem>
<para>RAM: 1 GB </para>
</listitem>
<listitem>
<para>Storage: SD card, 4 GB onboard flash </para>
</listitem>
<listitem>
<para>Architecture: armhf </para>
</listitem>
<listitem>
<para>Ethernet: 10/100 Mbps </para>
</listitem>
<listitem>
<para>WiFi: Built-in <ulink url="https://wiki.debian.org/WiFi#">WiFi</ulink> requires non-free firmware, use a <ulink url="https://wiki.debian.org/FreedomBox/Hardware/USBWiFi#">USB WiFi device</ulink> instead </para>
</listitem>
<listitem>
<para>SATA: 1 SATA host socket </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Non-Free Status</title>
<itemizedlist>
<listitem>
<para>Non-free blobs required: No </para>
</listitem>
<listitem>
<para>WiFi: Requires non-free firmware </para>
</listitem>
<listitem>
<para>Works with stock Debian kernel: Yes </para>
</listitem>
<listitem>
<para>Boot Firmware: <ulink url="https://linux-sunxi.org/BROM">BROM</ulink> (GPLV2+) </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Known Issues</title>
<para>None </para>
</section>
</section>
<section>
<title>VirtualBox</title>
<para>
@ -6236,6 +6461,84 @@ iface lo inet loopback</screen>
</itemizedlist>
</section>
</section>
<section>
<title>Raspberry Pi 3 Model B</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata depth="210.5pt" fileref="images/raspberrypi3.jpg" width="320pt"/>
</imageobject>
<textobject>
<phrase>Raspberry Pi 3</phrase>
</textobject>
</inlinemediaobject>
</para>
<para><ulink url="https://www.raspberrypi.org/products/raspberry-pi-3-model-b/">Raspberry Pi 3</ulink> (Model B ) is a popular single board computer developed with the intention of promoting teaching of basic computer science in schools. It is a successor to Raspberry Pi 2 Model B with a 64-bit processor and on-board Wi-Fi. FreedomBox images built for Raspberry Pi 2 are tested to work well with it. For using this board as FreedomBox, a <ulink url="https://wiki.debian.org/FreedomBox/Hardware/USBWiFi#">USB WiFi device</ulink>, that does not require non-free firmware, is recommended instead of the on-board Wi-Fi. </para>
<section>
<title>Download</title>
<para>FreedomBox SD card <ulink url="https://wiki.debian.org/FreedomBox/Download#">images</ulink> for this hardware are available. Download the image meant for Raspberry Pi 2 and that image will work for this board. Follow the instructions on the <ulink url="https://wiki.debian.org/FreedomBox/Download#">download</ulink> page to create a FreedomBox SD card and boot into FreedomBox. </para>
</section>
<section>
<title>Build Image</title>
<para>FreedomBox images for this hardware can be built using <ulink url="https://wiki.debian.org/FreedomBox/Maker#">Freedom Maker</ulink>. Use the target 'raspberry2' to build the image for this board. </para>
</section>
<section>
<title>Availability</title>
<itemizedlist>
<listitem>
<para>Price: 35 USD </para>
</listitem>
<listitem>
<para>
<ulink url="https://www.raspberrypi.org/products/raspberry-pi-3-model-b/">List of official distributors</ulink>
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Hardware</title>
<itemizedlist>
<listitem>
<para>Open Hardware: No </para>
</listitem>
<listitem>
<para>CPU: 1.2GHz 64-bit quad-core ARMv8 CPU </para>
</listitem>
<listitem>
<para>RAM: 1 GB </para>
</listitem>
<listitem>
<para>Storage: MicroSD card slot </para>
</listitem>
<listitem>
<para>Architecture: armhf </para>
</listitem>
<listitem>
<para>Ethernet: 10/100, RJ45 </para>
</listitem>
<listitem>
<para>WiFi: 802.11n but requires non-free firmware, instead use a <ulink url="https://wiki.debian.org/FreedomBox/Hardware/USBWiFi#">USB WiFi device</ulink> </para>
</listitem>
<listitem>
<para>SATA: None </para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Non-Free Status</title>
<itemizedlist>
<listitem>
<para>Non-free blobs required: boot firmware </para>
</listitem>
<listitem>
<para>WiFi: Requires non-free firmware </para>
</listitem>
<listitem>
<para>Works with stock Debian kernel: No </para>
</listitem>
</itemizedlist>
</section>
</section>
<section>
<title>USB Wi-Fi</title>
<para>FreedomBox works on many single board computers. However, many of these boards do not have built-in Wi-Fi capabilities. Even when Wi-Fi capability is available, non-free proprietary firmware is required to make them work. </para>
@ -7299,7 +7602,7 @@ if __name__ == '__main__':
return results</screen>
<para>There are several helpers available to implement some of the common diagnostic tests. For our application we wish to implement a test to check whether the <code>/ttrss</code> URL is accessible. Since this is a commonly performed test, there is a helper method available and we have used it in the above code. The <code>{host}</code> tag replaced with various IP addresses, hostnames and domain names by the helper to produce different kinds of URLs and they are all tested. Results for all tests are returned which we then pass on to Plinth. </para>
<para>The user can trigger the diagnostics test by going to <code>System -&gt; Diagnostics</code> page. This runs diagnostics for all the applications. If we want users to be able to run diagnostics specifically for this application, we can include a button for it in our template immediately after the application description. </para>
<screen format="linespecific">{% include "diagnostics_button.html" with module="ttrss" %}</screen>
<screen format="linespecific">{% include "diagnostics_button.html" with module="ttrss" enabled=True %}</screen>
</section>
<section>
<title>Logging</title>

BIN
doc/images/pcduino3s.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

BIN
doc/images/pcduino3s_thumb.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/images/plinth_frontpage.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 236 KiB

BIN
doc/images/raspberrypi3.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 159 KiB