nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-06-03 10:50:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: Add raw wiki files of included pages

Browse Source 
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
James Valleroy 2020-04-28 12:56:54 -04:00
parent 4c78bcf89c
commit 9890271da4
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
174 changed files with 14473 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
doc/manual/en/A20-OLinuXino-Lime2.raw.wiki Normal file
View File

@ -0,0 +1,76 @@
== A20 OLinuXino Lime2 ==
{{attachment:a20-olinuxino-lime2.jpg|A20 OLinuXino Lime2|width=640,height=432}}
Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-LIME2/open-source-hardware|A20 OLinuXino Lime2]] is a fully Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. It uses the Allwinner A20 Dual Core ARM processor.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
The following similar hardware will also work well with !FreedomBox.
* Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-LIME2-4GB/open-source-hardware|A20 OLinuXino Lime2 4GB]]. This hardware merely has extra 4GB NAND storage that is not used by !FreedomBox.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device. These SD card images are meant for use with the on-board SD card slot and won't work when used with a separate SD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 45 EUR (A20 OLinuXino Lime2)
* Price: 55 EUR (A20 OLinuXino Lime2 4GB)
* [[https://www.olimex.com/Products/OLinuXino/A20/open-source-hardware|Olimex Store]]
=== Hardware ===
* Open Source Hardware (OSHW): [[https://github.com/OLIMEX/OLINUXINO/tree/master/HARDWARE|Yes]]
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 1 GiB DDR3
* Storage: 4 GB NAND flash built-in (only on 4GB model), 1x microSD slot
* Architecture: armhf
* Ethernet: 10/100/1000, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1x port
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot Firmware: [[https://linux-sunxi.org/BROM|BROM]] (GPLV2+)
=== Known Issues ===
* Revision C hardware has [[DebianBug:845128|poor performance when receiving Ethernet data in Gigabit mode]]. To workaround the problem, you can switch to 100 Mbps mode instead of Gigabit mode. Login to your !FreedomBox as root (or plugin the SD card into another computer) and create the file /etc/NetworkManager/dispatcher.d/20-fix-ethernet-problem with the following contents:
{{{
#!/bin/bash
set -e # Exit with code on error
IFACE="$1"
ACTION="$2"
if [[ "$IFACE" != "eth0" ]]; then
exit 0
fi
case ${ACTION} in
up)
logger "Setting up $IFACE in 100Mbps mode"
mii-tool eth0 -A 100BaseTx-FD
;;
*)
;;
esac
}}}
* Revision G2 hardware has [[DebianBug:927397|poor performance when transmitting Ethernet data in Gigabit mode]]. Download and use the [[https://ftp.freedombox.org/pub/freedombox/pioneer/|Pioneer Edition image]] to fix the issue. It contains a slightly [[https://salsa.debian.org/freedombox-team/u-boot/commit/2cb18893ef|modified u-boot]]. The above workaround to put the Ethernet into 100 Mbps mode also fixes this issue.
* Revision K hardware is [[https://salsa.debian.org/freedombox-team/freedom-maker/issues/148|not working properly]].
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

54
doc/manual/en/A20-OLinuXino-MICRO.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
== A20 OLinuXino MICRO ==
{{attachment:a20-olinuxino-micro.jpg|A20 OLinuXino MICRO|width=640,height=359}}
Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-MICRO/open-source-hardware|A20 OLinuXino MICRO]] is a fully Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. It uses the Allwinner A20 Dual Core ARM processor.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
The following similar hardware will also work well with !FreedomBox.
* Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-MICRO-4GB/open-source-hardware|A20 OLinuXino MICRO 4GB]]. This hardware merely has extra 4GB NAND storage that is not used by !FreedomBox.
=== Download ===
!FreedomBox MicroSD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox MicroSD card and boot the device. These MicroSD card images are meant for use with the on-board MicroSD card slot and won't work on the SD card slot or when using a separate MicroSD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 50 EUR (A20 OLinuXino MICRO)
* Price: 63 EUR (A20 OLinuXino MICRO 4GB)
* [[https://www.olimex.com/Products/OLinuXino/A20/open-source-hardware|Olimex Store]]
=== Hardware ===
* Open Source Hardware (OSHW): [[https://github.com/OLIMEX/OLINUXINO/tree/master/HARDWARE|Yes]]
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 1 GiB DDR3
* Storage: 4 GB NAND flash built-in (only on 4GB model), 1x microSD slot
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1x port
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot Firmware: [[https://linux-sunxi.org/BROM|BROM]] (GPLV2+)
=== Known Issues ===
* Not visible on local network
* When booting the 'stable' image (made on 2017-06-18) the board does not automatically get an IP address from the router's DHCP server over ethernet. Booting the 'testing' image (2018-06) the board does get an IP address. Tested on MICRO hardware revision J. see also: [[https://www.olimex.com/forum/index.php?topic=5839.msg24167#msg24167]]
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

75
doc/manual/en/APU.raw.wiki Normal file
View File

@ -0,0 +1,75 @@
== APU ==
{{attachment:apu1d.jpg|PC Engines APU 1D|width=632,height=319}}
[[http://www.pcengines.ch/apu1d.htm|PC Engines APU 1D]] is a single board computer with 3 Gigabit ethernet ports, a powerful AMD APU and Coreboot firmware. !FreedomBox images built for AMD64 machines are tested to work well for it.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
Although untested, the following similar hardware is also likely to work well with !FreedomBox.
* Using amd64 image:
* [[http://www.pcengines.ch/apu1c.htm|apu1c]]
* [[http://www.pcengines.ch/apu1c4.htm|apu1c4]]
* [[http://www.pcengines.ch/apu1d4.htm|apu1d4]]
* [[http://www.pcengines.ch/apu2b2.htm|apu2b2]]
* [[http://www.pcengines.ch/apu2b4.htm|apu2b4]]
* [[http://www.pcengines.ch/apu2c0.htm|apu2c0]]
* [[http://www.pcengines.ch/apu2c2.htm|apu2c2]]
* [[http://www.pcengines.ch/apu2c4.htm|apu2c4]]
* [[http://www.pcengines.ch/apu3a2.htm|apu3a2]]
* [[http://www.pcengines.ch/apu3a4.htm|apu3a4]]
* [[http://www.pcengines.ch/apu3b2.htm|apu3b2]]
* [[http://www.pcengines.ch/apu3b4.htm|apu3b4]]
* Using i386 image:
* [[http://www.pcengines.ch/alix1d.htm|alix1d]]
* [[http://www.pcengines.ch/alix1e.htm|alix1e]]
* [[http://www.pcengines.ch/alix2d2.htm|alix2d2]]
* [[http://www.pcengines.ch/alix2d3.htm|alix2d3]]
* [[http://www.pcengines.ch/alix2d13.htm|alix2d13]]
* [[http://www.pcengines.ch/alix3d2.htm|alix3d2]]
* [[http://www.pcengines.ch/alix3d3.htm|alix3d3]]
* [[http://www.pcengines.ch/alix6f2.htm|alix6f2]]
=== Download ===
!FreedomBox disk [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card, USB disk, SSD or hard drive and boot into !FreedomBox. Pick the image meant for all amd64 machines.
An alternative to downloading these images is to [[InstallingDebianOn/Alix3d2|install Debian]] on the APU and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Networking ===
The first network port, the left most one in the above picture, is configured by !FreedomBox to be an upstream Internet link and the remaining 2 ports are configured for local computers to connect to.
=== Availability ===
* Price: 110 - 170 USD (depending on the board and supplier)
* [[http://www.pcengines.ch/order.htm|PC Engines]]
* [[http://www.pcengines.ch/order.htm|Full list of suppliers]]
=== Hardware ===
* Open Hardware: No
* CPU: [[http://www.amd.com/en-gb/products/embedded/processors/g-series|AMD G series T40E]]
* RAM: 2 GB DDR3-1066 DRAM
* Storage: SD card, External USB
* Architecture: amd64
* Ethernet: 3 Gigabit Ethernet ports
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1 m-SATA and 1 SATA
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot firmware: [[http://www.pcengines.ch/apu1d.htm|Coreboot]]
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

48
doc/manual/en/Apache_userdir.raw.wiki Normal file
View File

@ -0,0 +1,48 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Apache_userdir|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== User Websites ==
=== What is User websites? ===
User websites is a module of the Apache webserver enabled to allow users defined in the !FreedomBox system to expose a set of static files on the !FreedomBox filesystem as a website to the local network and/or the internet according to the network and firewall setup.
||||<tablestyle="border:1px solid black;width: 80%">'''Application basics'''||
||Category|| File sharing ||
||Available since version || 0.9.4||
||Upstream project website || https://httpd.apache.org/docs/2.4/mod/mod_userdir.html||
||Upstream end user documentation || https://httpd.apache.org/docs/2.4/howto/public_html.html||
=== Screenshot ===
/* Add when/if an interface is made for FreedomBox */
=== Using User websites ===
The module is always enabled and offers no configuration from the !FreedomBox web interface. There is no configuration or status page shown for this module in the !FreedomBox web interface.
To serve documents, place the files in the designated directory in a !FreedomBox user's home directory in the filesystem.
This directory is: '''public_html'''
Thus the absolute path for the directory of a user named fbx with home directory in /home/fbx will be '''/home/fbx/public_html'''.
User websites will serve documents placed in this directory when requests for documents with the URI path "~fbx" are received. For the the example.org domain thus a request for the document example.org/~fbx/index.html will transfer the file in /home/fbx/public_html/index.html.
=== Using SFTP to create public_html and upload documents ===
/* To be written */
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

100
doc/manual/en/Backups.raw.wiki Normal file
View File

@ -0,0 +1,100 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Backups|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Backups ==
!FreedomBox includes the ability to backup and restore data, preferences, configuration and secrets from most of the applications. The Backups feature is built using Borg backup software. Borg is a deduplicating and compressing backup program. It is designed for efficient and secure backups. This backups feature can be used to selectively backup and restore data on an app-by-app basis. Backed up data can be stored on the !FreedomBox machine itself or on a remote server. Any remote server providing SSH access can be used as a backup storage repository for !FreedomBox backups. Data stored remotely may be encrypted and in such cases remote server cannot access your decrypted data.
=== Status of Backups Feature ===
|| '''App/Feature''' || '''Support in Version''' || '''Notes''' ||
|| Avahi || - || no backup needed ||
|| Backups || - || no backup needed ||
|| Bind || 0.41 || ||
|| Cockpit || - || no backup needed ||
|| Datetime || 0.41 || ||
|| Deluge || 0.41 || does not include downloaded/seeding files ||
|| Diagnostics || - || no backup needed ||
|| Dynamic DNS || 0.39 || ||
|| ejabberd || 0.39 || includes all data and configuration ||
|| Firewall || - || no backup needed ||
|| ikiwiki || 0.39 || includes all wikis/blogs and their content ||
|| infinoted || 0.39 || includes all data and keys ||
|| JSXC || - || no backup needed ||
|| Let's Encrypt || 0.42 || ||
|| Matrix Synapse || 0.39 || includes media and uploads ||
|| !MediaWiki || 0.39 || includes wiki pages and uploaded files ||
|| Minetest || 0.39 || ||
|| MLDonkey || 19.0 || ||
|| Monkeysphere || 0.42 || ||
|| Mumble || 0.40 || ||
|| Names || - || no backup needed ||
|| Networks || No || No plans currently to implement backup ||
|| OpenVPN || 0.48 || includes all user and server keys ||
|| Pagekite || 0.40 || ||
|| Power || - || no backup needed ||
|| Privoxy || - || no backup needed ||
|| Quassel || 0.40 || includes users and logs ||
|| Radicale || 0.39 || includes calendar and cards data for all users ||
|| Roundcube || - || no backup needed ||
|| SearX || - || no backup needed ||
|| Secure Shell (SSH) Server || 0.41 || includes host keys ||
|| Security || 0.41 || ||
|| Shadowsocks || 0.40 || only secrets ||
|| Sharing || 0.40 || does not include the data in the shared folders ||
|| Snapshot || 0.41 || only configuration, does not include snapshot data ||
|| Storage || - || no backup needed ||
|| Syncthing || 0.48 || does not include data in the shared folders ||
|| Tahoe-LAFS || 0.42 || includes all data and configuration ||
|| Tiny Tiny RSS || 19.2 || includes database containing feeds, stories, etc. ||
|| Tor || 0.42 || includes configuration and secrets such as onion service keys ||
|| Transmission || 0.40 || does not include downloaded/seeding files ||
|| Upgrades || 0.42 || ||
|| Users || No || No plans currently to implement backup ||
=== How to install and use Backups ===
'''Step 1'''
{{attachment:Backups_Step1_v49.png|Backups: Step 1|width=800}}
'''Step 2'''
{{attachment:Backups_Step2_v49.png|Backups: Step 2|width=800}}
'''Step 3'''
{{attachment:Backups_Step3_v49.png|Backups: Step 3|width=800}}
'''Step 4'''
{{attachment:Backups_Step4_v49.png|Backups: Step 4|width=800}}
'''Step 5'''
{{attachment:Backups_Step5_v49.png|Backups: Step 5|width=800}}
'''Step 6'''
{{attachment:Backups_Step6_v49.png|Backups: Step 6|width=800}}
'''Step 7'''
{{attachment:Backups_Step7_v49.png|Backups: Step 7|width=800}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

37
doc/manual/en/BananaPro.raw.wiki Normal file
View File

@ -0,0 +1,37 @@
== Banana Pro ==
{{attachment:banana-pro.jpg|Banana Pro|width=640}}
[[http://www.lemaker.org|LeMaker]] Banana Pro is an updated version of its predecessor Banana Pi.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox. Pick the image meant for Banana Pro.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Hardware ===
* Open Source Hardware (OSHW): No
* CPU: Allwinner A20, Dual-core ARM Cortex A7 processor
* RAM: 3 variants - 1 GB
* Storage: SD card
* Architecture: armhf
* Ethernet: 10/100/1000 Mbps
* Battery: No
* !WiFi: WiFi 802.11 b/g/n 2.4GHz (not tested with !FreedomBox)
* SATA: SATA 2.0 (2.5 inch SSD or HDD recommended)
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Unknown
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

46
doc/manual/en/BeagleBone.raw.wiki Normal file
View File

@ -0,0 +1,46 @@
== Beagle Bone Black ==
{{attachment:beagleboard.jpg|Beagle Bone Black|width=632,height=421}}
[[https://beagleboard.org/black|Beagle Bone Black]] (Revision C.1) is an Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. !FreedomBox images are built and tested for this device.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device.
Note: This image is for !BeagleBone Black (Revision C.1) only. It will not work on the !BeagleBone Green, and also not on the Revisions A&B. If you have such a device and would like to help getting !FreedomBox to run on it, contact us!
An alternative to downloading these images is to [[InstallingDebianOn/TI/BeagleBone|install Debian]] on the !BeagleBone and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: ~ 59 USD (50 EUR)
* [[http://dk.mouser.com/access/?pn=595-BB-BBLK-000|Mouser Electronics]]
* [[https://beagleboard.org/black|Full list of suppliers]]
=== Hardware ===
* Open Source Hardware (OSHW): [[http://elinux.org/Beagleboard:BeagleBoneBlack|Yes]]
* CPU: [[http://www.ti.com/product/am3358|AM335x 1GHz ARM Cortex-A8]]
* RAM: 512MB DDR3L 800 Mhz
* Storage: Onboard 4GB, 8bit Embedded MMC and microSD
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Beagle Bone Black image is licensed under a Creative Commons Attribution-!ShareAlike 3.0 Unported License by [[http://elinux.org/File:REV_A5A.jpg|Circuitco]].

23
doc/manual/en/Bind.raw.wiki Normal file
View File

@ -0,0 +1,23 @@
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: - English - [[es/FreedomBox/Manual/Bind|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== BIND (Domain Name Server) ==
BIND enables you to publish your Domain Name System (DNS) information on the Internet, and to resolve DNS queries for your user devices on your network.
Currently, on !FreedomBox, BIND is only used to resolve DNS queries for other machines on local network. It is also incompatible with sharing Internet connection from !FreedomBox.
Note: This service is available only on networks configured as "internal" zone. It is not available when connected via OpenVPN.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

130
doc/manual/en/Cockpit.raw.wiki Normal file
View File

@ -0,0 +1,130 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[FreedomBox/Manual/Cockpit|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Cockpit (Server Administration) ==
Cockpit is a server manager that makes it easy to administer GNU/Linux servers via a web browser. On a !FreedomBox, controls are available for many advanced functions that are not usually required. A web based terminal for console operations is also available.
It can be accessed by any user on your !FreedomBox belonging to the admin group. Cockpit is only usable when you have proper domain name setup for your !FreedomBox and you use that domain name to access Cockpit. See the Troubleshooting section for more information.
{{{#!wiki caution
Use cockpit only if you are an administrator of GNU/Linux systems with advanced skills. !FreedomBox tries to coexist with changes to system by system administrators and system administration tools like Cockpit. However, improper changes to the system might causes failures in !FreedomBox functions.
}}}
=== Using Cockpit ===
Install Cockpit like any other application on !FreedomBox. Make sure that Cockpit is enabled after that.
{{attachment:cockpit-enable.png}}
Ensure that the user account on !FreedomBox that will used for Cockpit is part of the administrators group.
{{attachment:cockpit-admin-user.png}}
Launch the Cockpit web interface. Login using the configured user account.
{{attachment:cockpit-login.png}}
Start using cockpit.
{{attachment:cockpit-system.png}}
Cockpit is usable on mobile interfaces too.
{{attachment:cockpit-mobile.png}}
=== Features ===
The following features of Cockpit may be useful for advanced !FreedomBox users.
==== System Dashboard ====
Cockpit has a system dashboard that
* Shows detailed hardware information
* Shows basic performance metrics of a system
* Allows changing system time and timezone
* Allows changing hostname. Please use !FreedomBox UI to do this
* Shows SSH server fingerprints
{{attachment:cockpit-system.png}}
==== Viewing System Logs ====
Cockpit allows querying system logs and examining them in full detail.
{{attachment:cockpit-logs.png}}
==== Managing Storage ====
Cockpit allows following advanced storage functions:
* View full disk information
* Editing disk partitions
* RAID management
{{attachment:cockpit-storage1.png}}
{{attachment:cockpit-storage2.png}}
==== Networking ====
Cockpit and !FreedomBox both rely on !NetworkManager to configure the network. However, Cockpit offers some advanced configuration not available on !FreedomBox:
* Route configuration
* Configure Bonds, Bridges, VLANs
{{attachment:cockpit-network1.png}}
{{attachment:cockpit-network2.png}}
{{attachment:cockpit-network3.png}}
==== Services ====
Cockpit allows management of services and periodic jobs (similar to cron).
{{attachment:cockpit-services1.png}}
{{attachment:cockpit-services2.png}}
==== Web Terminal ====
Cockpit offers a web based terminal that can be used perform manual system administration tasks.
{{attachment:cockpit-terminal.png}}
=== Troubleshooting ===
Cockpit requires a domain name to be properly setup on your !FreedomBox and will only work when you access it using a URL with that domain name. Cockpit will not work when using IP address in the URL. Using ''freedombox.local'' as the domain name also does not work. For example, the following URLs will not work:
{{{
https://192.168.0.10/_cockpit/
https://freedombox.local/_cockpit/
}}}
Starting with !FreedomBox version 19.15, using ''.local'' domain works. You can access Cockpit using the URL https://freedombox.local/_cockpit/. The ''.local'' domain is based on your hostname. If your hostname is ''mybox'', your ''.local'' domain name will be ''mybox.local'' and the Cockpit URL will be https://mybox.local/_cockpit/.
To properly access Cockpit, use the domain name [[FreedomBox/Manual/Configure|configured]] for your !FreedomBox.Cockpit will also work well when using a [[FreedomBox/Manual/Tor|Tor Onion Service]]. The following URLs will work:
{{{
https://mybox.freedombox.rocks/_cockpit/
https://exampletorhs.onion/_cockpit/
}}}
The reason for this behaviour is that Cockpit uses !WebSockets to connect to the backend server. Cross site requests for !WebSockets must be prevented for security reasons. To implement this, Cockpit maintains a list of all domains from which requests are allowed. !FreedomBox automatically configures this list whenever you add or remove a domain. However, since we can't rely on IP addresses, they are not added by !FreedomBox to this domain list. You can see the current list of allowed domains, as managed by !FreedomBox, in ''/etc/cockpit/cockpit.conf''. You may edit this, but do so only if you understand web security consequences of this.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

39
doc/manual/en/Configure.raw.wiki Normal file
View File

@ -0,0 +1,39 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Configure|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Configure ==
Configure has some general configuration options:
=== Hostname ===
. Hostname is the local name by which other devices on the local network can reach your !FreedomBox. The default hostname is ''freedombox''.
=== Domain Name ===
. 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 [[FreedomBox/Manual/ejabberd|Chat Server (XMPP)]], [[FreedomBox/Manual/MatrixSynapse|Matrix Synapse]], [[FreedomBox/Manual/LetsEncrypt|Certificates (Let's Encrypt)]], and [[FreedomBox/Manual/Monkeysphere|Monkeysphere]].
=== Webserver Home Page ===
. This is an advanced option that allows you to set something other than !FreedomBox Service as the home page to be served on the domain name of the !FreedomBox. For example, if your !FreedomBox's domain name is https://myfreedombox.rocks and you set !MediaWiki as the home page, visiting https://myfreedombox.rocks will take you to https://myfreedombox.rocks/mediawiki/ instead of the usual https://myfreedombox.rocks/plinth/. You can set any web application, Ikiwiki wikis and blogs or Apache's default index.html page as the web server home page.
{{{#!wiki caution
Once some other app is set as the home page, you can only navigate to the !FreedomBox Service by typing https://myfreedombox.rocks/plinth/ into the browser. <<BR>>
''/freedombox'' can also be used as an alias to ''/plinth''
}}}
. ''Tip:'' Bookmark the URL of !FreedomBox Service before setting the home page to some other app.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

108
doc/manual/en/Contribute.raw.wiki Normal file
View File

@ -0,0 +1,108 @@
<<TableOfContents>>
= Get Involved =
## BEGIN_INCLUDE
From code, design and translation to spreading the word and donation, here are a number of ways to contribute to !FreedomBox.
== Quick Links ==
[[https://docs.freedombox.org/|FreedomBox Developer Manual]] <<BR>>
[[FreedomBox/ProgressCalls|Progress calls]] <<BR>>
[[FreedomBox/TODO|TODO page]] <<BR>>
[[https://www.freedomboxfoundation.org/donate/|Donation page]] <<BR>>
== Welcome to newcomers ==
As a new contributor, you are more than welcome to introduce yourself to others on the !FreedomBox [[https://discuss.freedombox.org/c/development|discussion forum]], [[http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|mailing list]] or on the [[irc://irc.debian.org/freedombox|#freedombox IRC]] channel. In addition to make useful contacts, you can start reporting bugs and translate (see below) the wiki website and the !FreedomBox web interface.
== Development priorities ==
Upcoming priorities are discussed on an regular basis. You find the progress of the !FreedomBox Service with its priorities here: [[https://salsa.debian.org/groups/freedombox-team/-/boards|issues board]] and [[https://salsa.debian.org/groups/freedombox-team/-/milestones|milestones]].
Please check next [[FreedomBox/ProgressCalls|progress calls]] to keep yourself on track and meet members of the release team. A [[FreedomBox/TODO|TODO page]] aggregates the complete list of the items to work on for !FreedomBox.
== Contributions needed ==
=== Add an Application ===
If you are a developer and wish to see an application available in !FreedomBox, you can contribute by adding the application to !FreedomBox. See the [[https://docs.freedombox.org/|FreedomBox Developer Manual]].
=== Bugs ===
List of bugs, feature requests and improvements are tracked on the !FreedomBox [[https://salsa.debian.org/freedombox-team/freedombox/issues/|issue tracker]]. In addition to that, see [[FreedomBox/Contribute/Bugs|list of bugs]] to help out the Debian package we depend on. Also see the !FreedomBox [[https://qa.debian.org/developer.php?login=freedombox-pkg-team%40lists.alioth.debian.org&comaint=yes|packaging team's dashboard]] for status of various packages that we use.
=== Code ===
If you are a developer, you can contribute code to one of the sub-projects of !FreedomBox. Step-by-step process of [[/Code|contributing code]] to !FreedomBox is available.
* [[FreedomBox/Plinth|FreedomBox Service]]: a web interface to administer the functions of !FreedomBox.
* [[FreedomBox/Maker|Freedom Maker]]: a script to build !FreedomBox disk images for use on various hardware devices or virtual machines.
You can pickup a task from one of the [[FreedomBox/TODO|TODO]] lists. The individual page project pages contain information availabily of the code, how to build and TODO lists.
=== Design ===
==== User Experience Design ====
If you are a user experience designer, you can help !FreedomBox with the following items:
* UI experience for the !FreedomBox Service web interface
* Web design for [[https://freedombox.org|freedombox.org]], [[https://freedomboxfoundation.org|freedomboxfoundation.org]] and the [[FreedomBox|wiki]] pages
* Logo and branding (we currently have [[https://salsa.debian.org/freedombox-team/freedombox/tree/master/static/themes/default|an identity manual and logos]])
* Possible designs for custom !FreedomBox cases on single board computers
* [[../Design|User experience design]]
==== Technical Design ====
!FreedomBox needs your technical expertise to devise implementation plans for upcoming features. You can contribute to the discussion on various technical design and implementation aspects of !FreedomBox. See !FreedomBox discussion forum's [[https://discuss.freedombox.org/c/development|development category]].
=== Donate ===
The [[https://freedomboxfoundation.org|FreedomBox Foundation]] is a 501(c)(3) federal nonprofit corporation with recognition from the IRS. !FreedomBox project is run by volunteers. You can help the project financially by donating via !PayPal, Bitcoin or by mailing a check. Please see the [[https://www.freedomboxfoundation.org/donate/|donation page]] for details on how to donate.
=== Document: User Manual, Website and Wiki ===
!FreedomBox needs better documentation for users and contributors. !FreedomBox manual is prepared by aggregating various pages on the wiki and exporting to various formats. The manual is then used in !FreedomBox Service and elsewhere.
If you wish to contribute to the !FreedomBox [[FreedomBox|wiki]] (and consequently the !FreedomBox manual), you can create a wiki account and start editing.
For contributing to the website please start a discussion on the !FreedomBox discussion forum's [[https://discuss.freedombox.org/c/development|development category]].
=== Quality Assurance ===
* !FreedomBox already runs on many platforms and it is not possible for developers to test all possible platforms. If you have one of the supported hardware you can help with testing !FreedomBox on the platform.
* When an application is made available on !FreedomBox, not all of its functionality is tested in the real world by developer doing the work. Deploying the application and testing it will help ensure high quality applications in !FreedomBox.
See the [[FreedomBox/QualityAssurance|quality assurance]] page for a basic list of test cases to check for and information on reporting bugs.
=== Localization ===
All text visible to users of !FreedomBox needs to be localized to various languages. This translation work includes:
* [[FreedomBox/Plinth|Web Interface]] for !FreedomBox
* !FreedomBox documentation
* !FreedomBox [[FreedomBox|wiki]], [[https://freedombox.org|website]] and [[https://freedomboxfoundation.org|foundation website]].
* [[https://docs.djangoproject.com/en/dev/internals/contributing/localizing/|Django web framework]] that !FreedomBox uses.
* Individual applications that !FreedomBox exposes to users.
You can contribute to the localization effort using the web-based tool at [[https://hosted.weblate.org/projects/freedombox/|Weblate]] or directly to the source tree via [[https://salsa.debian.org/freedombox-team/freedombox/tree/master/plinth/locale|Salsa]].
If you wish to see !FreedomBox available for one of your languages, please start a discussion on the !FreedomBox discussion forum's [[https://discuss.freedombox.org/c/development|development category]] to work with others translating for that language.
For more information, please visit the !FreedomBox [[FreedomBox/Translate|translators]] page.
=== Spread the Word ===
Speak to your family, friends, local community or at global conferences about
the importance of !FreedomBox. To be a successful project we need many more
participants, be it users or contributors. Write about your efforts at the [[https://www.freedomboxfoundation.org/appearances/index.en.html|talks page]] and on the [[FreedomBox/TalksAndPresentations|wiki]].
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

54
doc/manual/en/Coquelicot.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
== File Sharing (Coquelicot) ==
=== About Coquelicot ===
Coquelicot is a "one-click" file sharing web application with a focus on protecting users' privacy. The basic principle is simple: users can upload a file to the server, in return they get a unique URL which can be shared with others in order to download the file. A download password can be defined.
After the upload you get a unique link that can be shared to your partners in order to
Read more about Coquelicot at [[https://coquelicot.potager.org/README|the Coquelicot README]]
'''Available since:''' version 0.24.0
=== When to use Coquelicot ===
Coquelicot is best used to quickly share a single file.
If you want to share a folder,
1. for a single use, compress the folder and share it over Coquelicot
2. which must be kept synchronized between computers, use [[../Syncthing|Syncthing]] instead
Coquelicot can only provide a reasonable degree of privacy. If anonymity is required, you should consider using the desktop application [[https://onionshare.org/|Onionshare]] instead.
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.
=== Coquelicot on FreedomBox ===
With Coquelicot installed, you can upload files to your !FreedomBox server and privately share them.
Post installation, the Coquelicot page offers two settings.
1. '''Upload Password''': 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.
2. '''Maximum File Size''': You can alter the maximum size of the file that can be transferred through Coquelicot using this setting. The size is in [[https://en.wikipedia.org/wiki/Mebibyte|Mebibytes]]. The maximum file size is only limited by the disk size of your !FreedomBox.
=== Privacy ===
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.
==== Sharing over instant messengers ====
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.
==== Sharing download links privately ====
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 [[../MatrixSynapse| Matrix Synapse]] or [[../ejabberd|XMPP]] (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 [[https://securityinabox.org/en/guide/thunderbird/linux/|Thunderbird]].
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

64
doc/manual/en/Coturn.raw.wiki Normal file
View File

@ -0,0 +1,64 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Coturn|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Coturn (VoIP Helper) ==
||<tablestyle="float: right;"> {{attachment:Coturn-icon_en_V01.png|Coturn icon}} ||
'''Available since''': version 20.8
Coturn is a server to facilitate audio/video calls and conferences by providing an implementation of TURN and STUN protocols. WebRTC, SIP and other communication servers can use it to establish a call between parties who are otherwise unable connect to each other.
It is not meant to be used directly by users. Servers such as Matrix Synapse need to be configured with the details provided on the Coturn app page. Apart from Matrix Synapse, Jitsi, Ejabberd, Nextcloud Talk, etc. can use Coturn server for audio/video calls and conferences. There is no need for the servers to be running on the same machine as !FreedomBox and external servers can use Coturn running on !FreedomBox.
Coturn is configured in !FreedomBox as an advanced app. This means that you need to check "Show advanced apps and features" in "General Configuration" to see Coturn icon in the "Apps" section.
=== How it works ===
When making an audio/video call, it is best to route the media streams between two peers directly. This will give the best possible latency (better signal quality) and avoid depending on a centralized server (privacy). It scales well because a simple chat server can host thousands of calls without involving the server in any way other than to setup the call. However, this approach does not work most of the time to due to how networks are configured. Most peers on the network do not have a unique IP address allocated to them. They work hidden behind a network device that performs "Network Address Translation" (NAT) for them. This means that the two peers have no way of reaching each other.
To address this problem, a simple technique known as STUN was introduced. With the help of a third party STUN server, the peers can trick the NAT devices, to carry the traffic between the two peers. Unfortunately, this trick only works about 80% of the time. So, if STUN fails, peers have no choice but to route their traffic through an intermediary server called TURN server. All the mechanism of trying out STUN first and then falling back to TURN is described in a protocol known as ICE.
On !FreedomBox, Coturn provides both STUN and TURN servers. Both services are provided over TCP as well as UDP. They are provided on unencrypted as well as encrypted channels (with have a higher chance of success). Since STUN servers are very inexpensive and don't consume a lot of server resources, there is no authentication needed to use them. TURN servers on the other hand need authentication. This authentication is highly simplified and does not require maintaining a database of users. A server such as matrix-synapse which is about to setup an audio/video call between two peers will generate a username and password using a shared secret. When the peers use the TURN server, they will be validated using these credentials because the TURN server also knows the same secret.
In summary, a communication server needs to know the URLs of the STUN/TURN servers along with a shared authentication secret for TURN. After that, during audio/video call setup, they will correctly guide the peers to use STUN/TURN servers. Coturn app in !FreedomBox provides exactly this information. This information can be used to configure a communication server irrespective of whether it is running on the same !FreedomBox or on another server.
=== Configuring Matrix Synapse ===
Matrix Synapse server in !FreedomBox can be configured to use Coturn TURN/STUN server. In future, when you install Matrix Synapse, !FreedomBox will automatically install Coturn and configure its parameters into Matrix Synapse. To configure Matrix Synapse, edit the file ''/etc/matrix-synapse/homeserver.yaml'' with the following lines:
{{{
turn_uris: [ "stun:myfreedombox.example.org:3478?transport=udp", "stun:myfreedombox.example.org:3478?transport=tcp", "turn:myfreedombox.example.org:3478?transport=udp", "turn:myfreedombox.example.org:3478?transport=tcp" ]
turn_shared_secret: "my-freedombox-provided-secret"
turn_user_lifetime: 86400000
turn_allow_guests: True
}}}
And then restart matrix-synapse server by disabling and re-enabling the matrix-synapse app.
=== Port Forwarding ===
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 Coturn:
* UDP 3478
* TCP 3478
* UDP 3479
* TCP 3479
* UDP 5349
* TCP 5349
* UDP 5350
* TCP 5350
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

40
doc/manual/en/Cubieboard2.raw.wiki Normal file
View File

@ -0,0 +1,40 @@
== Cubieboard 2 ==
{{attachment:cubieboard2.jpg|Cubieboard 2|width=640,height=426}}
The Cubieboard 2 is a single board computer based on the Allwinner A20 processor. It doesn't require any non-free firmware to run !FreedomBox, and Wifi capability can be added via a USB adaptor if needed. This board is available in two versions, one with on-board flash and a microSD slot, and a version with two microSD card slots.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device.
=== Availability ===
* [[http://cubieboard.org/buy|Full list of suppliers]]
=== Hardware ===
* CPU: ARM Cortex A7 Dual-Core
* RAM: 1GB DDR3 @960M
* Storage: 4GB internal NAND flash, up to 64GB on uSD slot
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: Yes
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Cubieboard 2 image is licensed under a Creative Commons Attribution-!ShareAlike 2.0 Generic License by [[https://www.flickr.com/photos/120586634@N05/14673300334/in/photolist-pMbdDm-omCuYN-o5kVMu-dy9jTD-dy99Kz|Flickr]].

56
doc/manual/en/Cubietruck.raw.wiki Normal file
View File

@ -0,0 +1,56 @@
== Cubietruck ==
=== FreedomBox Danube Edition ===
{{attachment:freedombox-danube.jpg|FreedomBox Danube Edition|width=640,height=561}}
[[http://projectdanube.org|FreedomBox Danube Edition]] is a custom casing around Cubietruck and an SSD-hard drive.
=== Cubietruck / Cubieboard3 ===
[[http://cubieboard.org/model/|Cubietruck]] (Cubieboard3) is a single board computer with very good performance compared to many other boards. !FreedomBox images are built for this device.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are provided for this hardware. These SD card images are meant for use with the on-board SD card slot and do not work when used with a separate SD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the Cubietruck and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
Cubietruck / Cubieboard3
* Price: 89 USD
* [[http://cubieboard.org/buy/|List of suppliers]]
=== Hardware ===
* Open Hardware: No
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 2 GiB DDR3 @ 480 MHz
* Storage: 8 GB NAND flash built-in, 1x microSD slot
* Architecture: armhf
* Ethernet: 10/100/1000, RJ45
* !WiFi: Broadcom BCM4329/BCM40181 (no free !WiFi drivers + firmware available)
* SATA: 1x 2.0 port
=== Non-Free Status ===
* Non-free blobs required: ?
* !WiFi: no free !WiFi drivers + firmware available
=== Known Issues ===
* The on-board !WiFi does not work with free software. A separate [[FreedomBox/Hardware/USBWiFi|USB WiFi device]] is recommended.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
[[http://projectdanube.org/|FreedomBox Danube Edition]] image is copyright Markus Sabadello, used here with permission.

26
doc/manual/en/DateTime.raw.wiki Normal file
View File

@ -0,0 +1,26 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/DateTime|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Date & Time ==
This network time server is a program that maintains the system time in synchronization with servers on the Internet.
You can select your time zone by picking a big city nearby (they are sorted by ''Continent/City'') or select directly the zone with respect to GMT (Greenwich Mean Time).
{{attachment:DateTime.png}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

87
doc/manual/en/Debian.raw.wiki Normal file
View File

@ -0,0 +1,87 @@
#language en
#pragma section-numbers 2
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: [[de/FreedomBox/Hardware/Debian|Deutsch]] - English - [[es/FreedomBox/Hardware/Debian|Español]]-~
## BEGIN_INCLUDE
== Debian ==
##{{attachment:debian.png|Debian|width=425,height=546}}
!FreedomBox is a [[DebianPureBlends|pure blend]] of Debian. This means that all the work on !FreedomBox is available in Debian as packages. It also means that any machine running Debian can be turned into a !FreedomBox.
This page describes the process of installing !FreedomBox on a Debian system. Currently, !FreedomBox works in Debian Stable (Buster), Testing (Bullseye), and Unstable (Sid).
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this approach.
{{{#!wiki caution
'''Use a fresh Debian installation'''
Installing !FreedomBox changes your Debian system in many important ways. This includes installing a firewall and regenerating server certificates. It is hence recommended that you install !FreedomBox on a fresh Debian installation instead of an existing setup.
}}}
{{{#!wiki caution
'''Console/GUI logins for non-admin users will be disabled'''
After !FreedomBox is fully setup, your system will no longer allow users not belonging to the ''admin'' group to log in to the system via console, secure shell (SSH) or graphical login. This behaviour can be disabled from the [[FreedomBox/Manual/Security|Security]] page. Use the administrator account created during !FreedomBox first boot for console logins and add further user accounts to ''admin'' group, if necessary.
}}}
=== Installing on Debian 10.0 (Buster) or newer ===
Check the Troubleshooting section below, for any tips or workarounds that might help during the install.
1. [[InstallingDebianOn|Install Debian]] 10.0 (Buster), or Unstable (Sid) on your hardware.
1. Update your package list.
{{{
$ sudo apt-get update
}}}
1. Install `freedombox` package.
{{{
$ sudo DEBIAN_FRONTEND=noninteractive apt-get install freedombox
}}}
* The "DEBIAN_FRONTEND=noninteractive" will avoid several configuration prompts that would otherwise appear during the install.
1. During the installation, you will be provided a secret key that needs to be entered during the initial configuration process. Note this down. The secret can also be read at a later time from the file `/var/lib/plinth/firstboot-wizard-secret`.
1. You can start [[FreedomBox/Manual/QuickStart|using]] !FreedomBox. During initial wizard, you will need to enter the secret noted above.
=== Tips and Troubleshooting ===
1. !FreedomBox uses !NetworkManager to manage network configuration. If you have configured your network interfaces using Debian installer or by editing `/etc/network/interfaces`, !FreedomBox will not manage those interfaces. (See [[https://bugs.debian.org/797614|bug #797614]].) To let !FreedomBox/NetworkManager manage your network interfaces, edit the `/etc/network/interfaces` manually and ensure that it contains only the following:
{{{
auto lo
iface lo inet loopback
}}}
If you have already completed the setup process without doing this step, you will need to clear out the `/etc/network/interfaces` file keeping only the above lines. Then perform a reboot. On Debian 9 (Stretch), after this network connections configured by the `setup` step above will configure your network. Network interfaces will then be in the `internal` or `external` firewall zone. This is essential for the !FreedomBox's web interface to be reachable from other machines in the network. You can tweak network manager connections with the `nmtui` command if you wish.
1. !FreedomBox will use an automatically configured IP address by default. You can assign a static IP address if necessary. Network configuration changes can be done using !FreedomBox web interface or by using the `nmtui` or `nmcli` commands. `nmcli` can be used as follows:
{{{
nmcli con mod "Ethernet connection 1" \
ipv4.addresses A.A.A.A/X \
ipv4.gateway G.G.G.G \
ipv4.dns N.N.N.N \
ipv4.dns-search somedomain.com \
ipv4.method "manual" \
ipv4.ignore-auto-dns yes \
ipv6.method ignore
}}}
...with the block capitals and somedomain.com replaced with your actual address, mask description, gateway and dns server details.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
See the [[https://www.debian.org/logos/|Debian logo]] page for information on its copyright.

49
doc/manual/en/Deluge.raw.wiki Normal file
View File

@ -0,0 +1,49 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Deluge|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Deluge (BitTorrent Web Client) ==
||<tablestyle="float: right;"> {{attachment:Deluge-icon_en_V01.png|Deluge icon}} ||
'''Available since''': version 0.5
=== What is Deluge? ===
!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: [[FreedomBox/Manual/Transmission|Transmission]] and Deluge. They have similar features, but you may prefer one over the other.
Deluge is a lightweight !BitTorrent client that is highly configurable. Additional functionality can be added by installing plugins.
=== Screenshot ===
{{attachment:deluge.png|Deluge Web UI|width=800}}
=== Initial Setup ===
After installing Deluge, it can be accessed by pointing your browser to {{{https://<your freedombox>/deluge}}}. You will need to enter a password to login:
{{attachment:deluge_login.png|Deluge Login}}
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.
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.
{{attachment:deluge_connection_manager.png|Deluge Connection Manager (Offline)}}
Now it should say "Online". Click "Connect" to complete the setup.
{{attachment:deluge_connection_manager_2.png|Deluge Connection Manager (Online)}}
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.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

6
doc/manual/en/Deprecated.raw.wiki Normal file
View File

@ -0,0 +1,6 @@
{{{#!wiki caution
'''Deprecated Hardware'''
This hardware was supported earlier but is no longer supported. If you downloaded an earlier image and are running !FreedomBox on this hardware, you will keep getting software updates. You can stay secure and up-to-date. However, no new images will be provided for this hardware. It is recommended that you migrate to newer, supported hardware using backup and restore.
}}}

13
doc/manual/en/Developer.raw.wiki Normal file
View File

@ -0,0 +1,13 @@
## BEGIN_INCLUDE
The !FreedomBox Developer Manual provides a step by step tutorial for writing apps for !FreedomBox and an API reference. It is available from [[https://docs.freedombox.org|docs.freedombox.org]].
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

23
doc/manual/en/Diagnostics.raw.wiki Normal file
View File

@ -0,0 +1,23 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Diagnostics|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Diagnostics ==
The system diagnostic test will run a number of checks on your system to confirm that applications and services are working as expected.
Just click ''Run Diagnostics''. This may take some minutes.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

254
doc/manual/en/Download.raw.wiki Normal file
View File

@ -0,0 +1,254 @@
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: [[de/FreedomBox/Download|Deutsch]] - English - [[es/FreedomBox/Download|Español]] - [[fr/FreedomBox/Telecharger|Français]] -~
----
<<TableOfContents()>>
## BEGIN_INCLUDE
= Download and Install =
Welcome to the !FreedomBox download page.
'''Note''': If you purchased a !FreedomBox kit, this section is not meant for you, so you can just skip it entirely. (Unless you specifically want to build an alternative software image).
You may either install !FreedomBox on one of the supported inexpensive [[FreedomBox/Hardware|hardware]] devices, on any [[FreedomBox/Hardware/Debian|Debian]] operating system, or deploy it on a virtual machine.
Installing on a machine running a Debian system is easy because !FreedomBox is available as a package. We do recommend to install !FreedomBox on a supported single board computer (SBC). The board will be dedicated for !FreedomBox use from home, this will prevent a lot of risks, such as accidental misconfiguration by the user. In case of trouble deciding which hardware is best for you or during the installation, please use the [[FreedomBox/Support|support page]] or read the [[FreedomBox/QuestionsAndAnswers|Questions and Answers]] page based on posts on the [[https://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|Freedombox-discuss]] mailing list archives.
== Downloading on Debian ==
If you are installing on an existing Debian installation, you don't need to download these images. Instead, read the [[FreedomBox/Hardware/Debian|instructions]] on setting up !FreedomBox on Debian.
== Downloading for SBC or Virtual Machine ==
=== Prepare your device ===
Read the hardware specific instructions on how to prepare your device at the [[FreedomBox/Hardware|Hardware]] section. On the web, there is a lot of documentation about setting your device up and flashing USB or SD Cards to boot your hardware.
=== Downloading Images ===
Recent images for supported targets are available here:
* Official Images: https://freedombox.org/download/
* Official Images: https://ftp.freedombox.org/pub/freedombox/
=== Verifying the Downloaded Images ===
It is important to verify the images you have downloaded to ensure that the file has not been corrupted during the transmission and that it is indeed the image built by !FreedomBox developers.
'''Note:''' Testing and nightly images are automatically signed by the !FreedomBox CI server.
* First open a terminal and import the public keys of the !FreedomBox developers who built the images:
{{{
$ gpg --recv-keys BCBEBD57A11F70B23782BC5736C361440C9BC971
$ gpg --recv-keys 7D6ADB750F91085589484BE677C0C75E7B650808
# This is the FreedomBox CI server's key
$ gpg --recv-keys 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
}}}
If this command shows an error such as ''new key but contains no user ID - skipped'', then use a different keyserver to download the keys:
{{{
$ gpg --keyserver keys.gnupg.net --recv-keys BCBEBD57A11F70B23782BC5736C361440C9BC971
$ gpg --keyserver keys.gnupg.net --recv-keys 7D6ADB750F91085589484BE677C0C75E7B650808
$ gpg --keyserver keys.gnupg.net --recv-keys 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
}}}
Or
{{{
$ gpg --keyserver keyserver.ubuntu.com --recv-keys BCBEBD57A11F70B23782BC5736C361440C9BC971
$ gpg --keyserver keyserver.ubuntu.com --recv-keys 7D6ADB750F91085589484BE677C0C75E7B650808
$ gpg --keyserver keyserver.ubuntu.com --recv-keys 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
}}}
* Next, verify the fingerprint of the public keys:
{{{
$ gpg --fingerprint BCBEBD57A11F70B23782BC5736C361440C9BC971
pub 4096R/0C9BC971 2011-11-12
Key fingerprint = BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971
uid Sunil Mohan Adapa <sunil@medhas.org>
sub 4096R/4C1D4B57 2011-11-12
$ gpg --fingerprint 7D6ADB750F91085589484BE677C0C75E7B650808
pub 4096R/7B650808 2015-06-07 [expires: 2020-06-05]
Key fingerprint = 7D6A DB75 0F91 0855 8948 4BE6 77C0 C75E 7B65 0808
uid James Valleroy <jvalleroy@mailbox.org>
uid James Valleroy <jvalleroy@freedombox.org>
sub 4096R/25D22BF4 2015-06-07 [expires: 2020-06-05]
sub 4096R/DDA11207 2015-07-03 [expires: 2020-07-01]
sub 2048R/2A624357 2015-12-22
$ gpg --fingerprint 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
pub rsa4096 2018-06-06 [SC]
013D 86D8 BA32 EAB4 A669 1BF8 5D41 53D6 FE18 8FC8
uid [ unknown] FreedomBox CI (Continuous Integration server) <admin@freedombox.org>
sub rsa4096 2018-06-06 [E]
}}}
* Finally, verify your downloaded image with its signature file `.sig`. For example:
{{{
$ gpg --verify freedombox-stable-free_buster_cubietruck-armhf.img.xz.sig
gpg: assuming signed data in 'freedombox-stable-free_buster_cubietruck-armhf.img.xz'
gpg: Signature made Sat 09 May 2020 11:54:01 AM EDT
gpg: using RSA key 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
gpg: Good signature from "FreedomBox CI (Continuous Integration server) <admin@freedombox.org>" [undefined]
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 013D 86D8 BA32 EAB4 A669 1BF8 5D41 53D6 FE18 8FC8
}}}
=== Installation ===
After the download you can use the image to boot your chosen [[FreedomBox/Hardware|hardware]] (including virtual machines). You'll need to copy the image to the memory card or USB stick as follows:
1. Figure out which device your card actually is.
1. Unplug your card.
1. Run `dmesg -w` to show and follow the kernel messages.
1. Plug your card in. You will see messages such as following:
{{{
[33299.023096] usb 4-6: new high-speed USB device number 12 using ehci-pci
[33299.157160] usb 4-6: New USB device found, idVendor=058f, idProduct=6361
[33299.157162] usb 4-6: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[33299.157164] usb 4-6: Product: Mass Storage Device
[33299.157165] usb 4-6: Manufacturer: Generic
[33299.157167] usb 4-6: SerialNumber: XXXXXXXXXXXX
[33299.157452] usb-storage 4-6:1.0: USB Mass Storage device detected
[33299.157683] scsi host13: usb-storage 4-6:1.0
[33300.155626] scsi 13:0:0:0: Direct-Access Generic- Compact Flash 1.01 PQ: 0 ANSI: 0
[33300.156223] scsi 13:0:0:1: Direct-Access Multiple Flash Reader 1.05 PQ: 0 ANSI: 0
[33300.157059] sd 13:0:0:0: Attached scsi generic sg4 type 0
[33300.157462] sd 13:0:0:1: Attached scsi generic sg5 type 0
[33300.462115] sd 13:0:0:1: [sdg] 30367744 512-byte logical blocks: (15.5 GB/14.4 GiB)
[33300.464144] sd 13:0:0:1: [sdg] Write Protect is off
[33300.464159] sd 13:0:0:1: [sdg] Mode Sense: 03 00 00 00
[33300.465896] sd 13:0:0:1: [sdg] No Caching mode page found
[33300.465912] sd 13:0:0:1: [sdg] Assuming drive cache: write through
[33300.470489] sd 13:0:0:0: [sdf] Attached SCSI removable disk
[33300.479493] sdg: sdg1
[33300.483566] sd 13:0:0:1: [sdg] Attached SCSI removable disk
}}}
1. In the above case, the disk that is newly inserted is available as ''/dev/sdg''. Very carefully note this and use it in the copying step below.
1. Decompress the downloaded image using tar:
{{{
$ xz -d freedombox-stable-free_buster_cubietruck-armhf.img.xz
}}}
The above command is an example for the ''cubietruck'' stable image. Your downloaded file name will be different.
1. Copy the image to your card. Double check to make sure you don't
write to your computer's main storage (such as /dev/sda). Also
make sure that you don't run this step as root to avoid potentially
overriding data on your hard drive due to a mistake in identifying the device or errors while typing the command. USB disks and SD cards inserted into the system should typically be write accessible to normal users. If you don't have permission to write to your SD card as a user, you may need to run this command as root. In this case triple check everything before you run the command. Another safety precaution is to unplug all external disks except the SD card before running the command.
For example, if your SD card is ''/dev/sdg'' as noted in the first step
above, then to copy the image, run:
{{{
$ dd bs=1M if=freedombox-stable-free_buster_cubietruck-armhf.img of=/dev/sdg conv=fdatasync status=progress
}}}
An alternative to copy to SD card command
{{{
$ cat freedombox-stable-free_buster_cubietruck-armhf.img > /dev/sdg ; sync
}}}
On MS Windows you will need a tool like ''etcher''.
On MacOS (OSX) you can use programs like ''balenaetcher'' and ''rosaimagewriter''.
The above command is an example for the ''cubietruck'' stable image. Your image file name will be different.
When picking a device, use the drive-letter destination, like ''/dev/sdg'', not a numbered destination, like ''/dev/sdg1''. The device
without a number refers to the entire device, while the device with
a number refers to a specific partition. We want to use the whole
device. Downloaded images contain complete information about how many partitions there should be, their sizes and types. You don't have to format your SD card or create partitions. All the data on the SD card will be wiped off during the write process.
1. Use the image by inserting the SD card or USB disk into the target device and booting from it. Your device should also be prepared (see the [[FreedomBox/Hardware|Hardware]] section).
1. Read (the rest of) the [[FreedomBox/Manual|Manual]] for instructions on how to use applications in !FreedomBox.
== Obtaining Source Code ==
!FreedomBox is fully [[https://www.gnu.org/philosophy/free-sw.html|free software]] and you can obtain the source code to study, modify and distribute improvements.
=== From within FreedomBox ===
!FreedomBox is made up of several software programs and you can obtain the source code to any of them. These instructions are similar to obtaining and [[https://www.debian.org/doc/manuals/maint-guide/build.en.html|building]] [[https://www.debian.org/doc/manuals/apt-howto/ch-sourcehandling.en.html|source code]] [[https://wiki.debian.org/BuildingTutorial|for Debian]] since !FreedomBox is a pure blend of Debian. Using this process you can obtain the source code to the exact version of the package you are currently using in !FreedomBox.
1. To see the list of software packages installed on your !FreedomBox, run the following in a terminal:
{{{
dpkg -l
}}}
1. To obtain the source code for any of those programs, then run:
{{{
apt source <package_name>
}}}
This requires that the [[SourcesList|apt sources list]] contains information about the source code repositories. These are present by default on all !FreedomBox images. If you have installed !FreedomBox using a package from Debian, you need to ensure that source repositories are added in the file.
1. To build the package from source code, first install its dependencies
{{{
apt build-dep <package_name>
}}}
Switch to the source directory created by the ''apt source'' command:
{{{
cd <source_directory>
}}}
Then build the package
{{{
dpkg-buildpackage -rfakeroot -uc
}}}
1. Install the package:
{{{
dpkg -i ../<built_package>.deb
}}}
=== Other Ways to Obtain Source Code ===
1. Source code for any of the packages can be browsed and searched using the web interface at [[https://sources.debian.org/|sources.debian.org]]. For example, see the [[https://sources.debian.org/src/plinth/|plinth]] package.
1. Source code and pre-built binary package for any version of a package including historic versions can be obtained from [[https://snapshot.debian.org/|snapshot.debian.org]]. For example, see the [[https://snapshot.debian.org/package/plinth/|plinth]] package.
1. You can also obtain the links to upstream project homepage, upstream version control, Debian's version control, changelog, etc. from the Debian tracker page for a project at [[https://tracker.debian.org/|tracker.debian.org]]. For example, see the tracker page for [[https://tracker.debian.org/pkg/plinth|plinth]] package.
1. You can build and install a package from its Debian's version control repository. For example,
{{{
git clone https://salsa.debian.org/freedombox-team/freedombox.git
cd freedombox
apt build-dep .
dpkg-buildpackage -rfakeroot -uc
dpkg -i ../freedombox*.deb
}}}
=== Building Disk Images ===
You can also build !FreedomBox disk images for various hardware platforms using the freedom-maker tool. This is also available as a Debian package and source code for it may be obtained using the above methods. [[https://salsa.debian.org/freedombox-team/freedom-maker/blob/master/README.md|Build instructions]] for creating disk images are available as part of the source code for freedom-maker package.
!FreedomBox disk images are built and uploaded to official servers using automated Continuous Integration infrastructure. This infrastructure is available as [[https://salsa.debian.org/freedombox-team/infrastructure|source code]] too and provides accurate information on how !FreedomBox images are built.
==== U-boot on Pioneer Edition Images ====
There is one minor exception to the u-boot package present on the hardware sold as !FreedomBox Home Server Kits Pioneer Edition. It contains a small but important fix that is not part of Debian sources. The fork of the Debian u-boot source repository along with the minor change done by the !FreedomBox is available as a [[https://salsa.debian.org/freedombox-team/u-boot|separate repository]]. We expect this change to be available in upstream u-boot eventually and this repository will not be needed. This package can be built on a Debian armhf machine as follows (cross compiling is also possible, simply follow instructions for cross compiling Debian packages):
{{{
apt install git git-buildpackage
git clone https://salsa.debian.org/freedombox-team/u-boot.git
cd u-boot
pbuilder create --distribution=buster
gbp buildpackage --git-pbuilder
}}}
The u-boot Debian package will be available in ''u-boot-sunxi*.deb''. This package will contain
{{{
mkdir temp
dpkg -x u-boot-suxi*.deb temp
unxz <lime2_image_built_with_freedom_maker>
dd if=temp/usr/lib/u-boot/A20-OLinuXino-Lime2/u-boot-sunxi-with-spl.bin of=<lime2.img> seek=8 bs=1k conv=notrunc
}}}
The resulting image will have the modified u-boot in it.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

69
doc/manual/en/DreamPlug.raw.wiki Normal file
View File

@ -0,0 +1,69 @@
== DreamPlug ==
{{attachment:dreamplug.jpg|DreamPlug|width=640,height=425}}
<<Include(FreedomBox/Hardware/Deprecated)>>
[[https://www.globalscaletechnologies.com/t-dreamplugdetails.aspx|DreamPlug]] is the hardware for which !FreedomBox has been originally targeted. !FreedomBox images are built and tested for it. For using this device as !FreedomBox, a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]] that does not require non-free firmware is recommended.
You can find more support and discussion for !DreamPlug on the [[http://www.plugcomputer.org/plugforum/|official forum]].
'''Recommendation:''' If you are using a board that uses SD cards, when you flash the FreedomBox image onto your SD card, we recommend that you use an SD card with at least 8GB of storage space.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox. See also instructions for using an [[FreedomBox/Hardware/DreamPlug/InternalMicroSD|internal micro-SD]] with !DreamPlug.
An alternative to downloading these images is to [[InstallingDebianOn/DreamPlug|install Debian]] on !DreamPlug and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Networking ===
The network port towards the middle of the box, is configured by !FreedomBox to be an upstream Internet link. The remaining port is configured for a local computer to connect to.
=== Firmware ===
Note that the factory firmware configurations may vary between revisions of the hardware, and render some images incompatible. See the !DreamPlug [[InstallingDebianOn/DreamPlug/U-bootUpgradeFromUSB|firmware]] page for information on what images are compatible and how to update your !DreamPlug firmware.
=== Build Image ===
!FreedomBox images for this hardware can be built using [[FreedomBox/Maker|Freedom Maker]].
=== Testing ===
Instructions on how to [[FreedomBox/Hardware/DreamPlug/Testing|test]] this hardware are available.
=== Availability ===
* Price: 159 USD
* [[http://www.globalscaletechnologies.com/p-54-dreamplug-devkit.aspx|DreamPlug manufacturer]]
* Reseller [[http://www.spinifex.com.au/shop/|Spinifex]] in Australia
=== Hardware ===
* Open Hardware: No
* CPU: Marvell Kirkwood 88F6281 @ 1.2GHz
* RAM: 512MB 16bit DDR2-800 MHz
* Storage: 4 GB on board micro-SD
* Architecture: armel
* Ethernet: 2x 10/100/1000, RJ45
* !WiFi: [[https://origin-www.marvell.com/wireless/assets/8787.pdf|SD8787]], 802.11 b/g/n
* SATA: eSATA 2.0 port
=== Non-Free Status ===
* Non-free blobs required: built-in !WiFi
* !WiFi: no free !WiFi drivers + firmware available
* Works with stock Debian kernel: yes
=== Known Issues ===
* !WiFi does not work with free software. A separate [[FreedomBox/Hardware/USBWiFi|USB WiFi device]] is recommended.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
!DreamPlug image is licensed under Creative Commons Attribution 2.5 Generic License by [[https://commons.wikimedia.org/wiki/File:Globalscale_DreamPlug_n01.jpg|Marie-Lan Nguyen]].

89
doc/manual/en/DynamicDNS.raw.wiki Normal file
View File

@ -0,0 +1,89 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/DynamicDNS|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Dynamic DNS Client ==
=== What is Dynamic DNS? ===
In order to reach a server on the Internet, the server needs to have permanent address also known 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.
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.
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.
=== GnuDIP vs. Update URL ===
There are two main mechanism to notify the Dynamic DNS server of your new IP address; using the ''GnuDIP'' protocol and using the ''Update URL'' mechanism.
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.
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.
=== Using the GnuDIP protocol ===
1. Register an account with any Dynamic DNS service provider. A free service provided by the !FreedomBox community is available at https://gnudip.datasystems24.net .
1. In !FreedomBox UI, enable the Dynamic DNS Service.
1. Select ''GnuDIP'' as ''Service type'', enter your Dynamic DNS service provider address (for example, gnudip.datasystems24.net) into ''GnuDIP Server Address'' field.
{{attachment:DynamicDNS-Settings.png|Dynamic DNS Settings|width=800}}
1. Fill ''Domain Name'', ''Username'', ''Password'' information given by your provider into the corresponding fields.
=== Using an Update URL ===
This feature is implemented because the most popular Dynamic DNS providers are using Update URLs mechanism.
1. 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.
1. In !FreedomBox UI, enable the Dynamic DNS service.
1. Select ''other Update URL'' as ''Service type'', enter the update URL given by your provider into ''Update URL'' field.
1. If you browse the update URL with your Internet browser and a warning message about untrusted certificate appears, then enable ''accept all SSL certificates''. WARNING: your credentials may be readable here because man-in-the-middle attacks are possible! Consider choosing a better service provider instead.
1. If you browse the update URL with your Internet browser and the username/password box appears, enable ''use HTTP basic authentication'' checkbox and provide the ''Username'' and ''Password''.
1. If the update URL contains your current IP address, replace the IP address with the string ''<Ip>''.
=== Checking If It Works ===
1. Make sure that external services you have enabled such as /jwchat, /roundcube and /ikiwiki are available on your domain address.
1. Go to the ''Status'' 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: ''Behind NAT''). If your !FreedomBox has a public IP address assigned, the text should be "Direct connection to the Internet".
1. Check that the last update status is not ''failed''.
=== Recap: How to create a DNS name with GnuDIP ===
/* to delete or to replace the old text */
1. Access to [[https://gnudip.datasystems24.net|GnuIP login page]] (answer Yes to all pop ups)
1. Click on "Self Register"
1. Fill the registration form (Username and domain will form the public IP address [username.domain])
1. Take note of the username/hostname and password that will be used on the !FreedomBox app.
1. Save and return to the GnuDIP login page to verify your username, domain and password (enter the datas, click login).
1. 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).
1. Leave the GnuDIP interface and open the Dynamic DNS Client app page in your !FreedomBox.
1. Click on "Set Up" in the top menu.
1. Activate Dynamic DNS
1. Choose GnuDIP service.
1. Add server address (gnudip.datasystems24.net)
1. Add your fresh domain name (username.domain, ie [username].freedombox.rocks)
1. Add your fresh username (the one used in your new IP address) and password
1. Add your GnuDIP password
1. Fill the option with http://myip.datasystems24.de (try this url in your browser, you will figure out immediately)
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

209
doc/manual/en/Firewall.raw.wiki Normal file
View File

@ -0,0 +1,209 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Firewall|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Firewall ==
Firewall is a network security system that controls the incoming and outgoing network traffic. Keeping a firewall enabled and properly configured reduces risk of security threat from the Internet.
The operation of the firewall in !FreedomBox web interface is automatic. When you enable a service it is automatically permitted in the firewall and when you disable a service it is automatically disabled in the firewall. For services which are enabled by default on !FreedomBox, firewall ports are also enabled by default during the first run process.
{{attachment:Firewall.png|Firewall|width=800}}
Firewall management in !FreedomBox is done using [[https://fedoraproject.org/wiki/FirewallD|FirewallD]].
=== Interfaces ===
Each interface is needs to be assigned to one (and only one) zone. If an interface is not assigned any zone, it is automatically assigned `external` zone. Whatever rules are in effect for a zone, those rules start to apply for that interface. For example, if HTTP traffic is allowed in a particular zone, then web requests will be accepted on all the addresses configured for all the interfaces assigned to that zone.
There are primarily two firewall zones used. The `internal` zone is meant for services that are provided to all machines on the local network. This may include services such as streaming media and simple file sharing. The `external` zone is meant for services that are provided publicly on the Internet. This may include services such as blog, website, email web client etc.
For details on how network interfaces are configured by default, see the [[FreedomBox/Manual/Networks|Networks]] section.
=== Opening Custom Ports ===
Cockpit app provides advanced management of firewall. Both !FreedomBox and Cockpit operate over firewalld and are hence compatible with each other. In particular, Cockpit can be used to open custom services or ports on !FreedomBox. This is useful if you are manually running your own services in addition to the services provided by !FreedomBox on the same machine.
{{attachment:firewalld-cockpit.png}}
=== FreedomBox Ports/Services ===
The following table attempts to document the ports, services and their default statuses in !FreedomBox. If you find this page outdated, see the Firewall status page in !FreedomBox interface.
||'''Service'''||'''Port''' ||'''External'''||'''Enabled by default'''||'''Status shown in !FreedomBox'''||'''Managed by !FreedomBox'''||
|| Minetest || 30000/udp || {*} || {X} || (./) || (./) ||
|| XMPP Client || 5222/tcp || {*} || {X} || (./) || (./) ||
|| XMPP Server || 5269/tcp || {*} || {X} || (./) || (./) ||
|| XMPP Bosh || 5280/tcp || {*} || {X} || (./) || (./) ||
|| NTP || 123/udp || {o} || (./) || (./) || (./) ||
|| !FreedomBox Web Interface (Plinth) || 443/tcp || {*} || (./) || (./) || {X} ||
|| Quassel || 4242/tcp || {*} || {X} || (./) || (./) ||
|| SIP || 5060/tcp || {*} || {X} || (./) || (./) ||
|| SIP || 5060/udp || {*} || {X} || (./) || (./) ||
|| SIP-TLS || 5061/tcp || {*} || {X} || (./) || (./) ||
|| SIP-TLS || 5061/udp || {*} || {X} || (./) || (./) ||
|| RTP || 1024-65535/udp || {*} || {X} || (./) || (./) ||
|| SSH || 22/tcp || {*} || (./) || (./) || {X} ||
|| mDNS || 5353/udp || {o} || (./) || (./) || (./) ||
|| Tor (Socks) || 9050/tcp || {o} || {X} || (./) || (./) ||
|| Obfsproxy || <random>/tcp || {*} || {X} || (./) || (./) ||
|| OpenVPN || 1194/udp || {*} || {X} || (./) || (./) ||
|| Mumble || 64378/tcp || {*} || {X} || (./) || (./) ||
|| Mumble || 64378/udp || {*} || {X} || (./) || (./) ||
|| Privoxy || 8118/tcp || {o} || {X} || (./) || (./) ||
|| JSXC || 80/tcp || {*} || {X} || {X} || {X} ||
|| JSXC || 443/tcp || {*} || {X} || {X} || {X} ||
|| DNS || 53/tcp || {o} || {X} || {X} || {X} ||
|| DNS || 53/udp || {o} || {X} || {X} || {X} ||
|| DHCP || 67/udp || {o} || (./) || {X} || {X} ||
|| Bootp || 67/tcp || {o} || {X} || {X} || {X} ||
|| Bootp || 67/udp || {o} || {X} || {X} || {X} ||
|| Bootp || 68/tcp || {o} || {X} || {X} || {X} ||
|| Bootp || 68/udp || {o} || {X} || {X} || {X} ||
|| LDAP || 389/tcp || {o} || {X} || {X} || {X} ||
|| LDAPS || 636/tcp || {o} || {X} || {X} || {X} ||
=== Manual operation ===
See [[https://fedoraproject.org/wiki/FirewallD|FirewallD]] documentation for more information on the basic concepts and comprehensive documentation.
==== Enable/disable firewall ====
To disable firewall
{{{
service firewalld stop
}}}
or with systemd
{{{
systemctl stop firewalld
}}}
To re-enable firewall
{{{
service firewalld start
}}}
or with systemd
{{{
systemctl start firewalld
}}}
==== Modifying services/ports ====
You can manually add or remove a service from a zone.
To see list of services enabled:
{{{
firewall-cmd --zone=<zone> --list-services
}}}
Example:
{{{
firewall-cmd --zone=internal --list-services
}}}
To see list of ports enabled:
{{{
firewall-cmd --zone=<zone> --list-ports
}}}
Example:
{{{
firewall-cmd --zone=internal --list-ports
}}}
To remove a service from a zone:
{{{
firewall-cmd --zone=<zone> --remove-service=<service>
firewall-cmd --permanent --zone=<zone> --remove-service=<interface>
}}}
Example:
{{{
firewall-cmd --zone=internal --remove-service=xmpp-bosh
firewall-cmd --permanent --zone=internal --remove-service=xmpp-bosh
}}}
To remove a port from a zone:
{{{
firewall-cmd --zone=internal --remove-port=<port>/<protocol>
firewall-cmd --permanent --zone=internal --remove-port=<port>/<protocol>
}}}
Example:
{{{
firewall-cmd --zone=internal --remove-port=5353/udp
firewall-cmd --permanent --zone=internal --remove-port=5353/udp
}}}
To add a service to a zone:
{{{
firewall-cmd --zone=<zone> --add-service=<service>
firewall-cmd --permanent --zone=<zone> --add-service=<interface>
}}}
Example:
{{{
firewall-cmd --zone=internal --add-service=xmpp-bosh
firewall-cmd --permanent --zone=internal --add-service=xmpp-bosh
}}}
To add a port to a zone:
{{{
firewall-cmd --zone=internal --add-port=<port>/<protocol>
firewall-cmd --permanent --zone=internal --add-port=<port>/<protocol>
}}}
Example:
{{{
firewall-cmd --zone=internal --add-port=5353/udp
firewall-cmd --permanent --zone=internal --add-port=5353/udp
}}}
==== Modifying the zone of interfaces ====
You can manually change the assignment of zones of each interfaces after they have been autuomatically assigned by the first boot process.
To see current assignment of interfaces to zones:
{{{
firewall-cmd --list-all-zones
}}}
To remove an interface from a zone:
{{{
firewall-cmd --zone=<zone> --remove-interface=<interface>
firewall-cmd --permanent --zone=<zone> --remove-interface=<interface>
}}}
Example:
{{{
firewall-cmd --zone=external --remove-interface=eth0
firewall-cmd --permanent --zone=external --remove-interface=eth0
}}}
To add an interface to a zone:
{{{
firewall-cmd --zone=<zone> --add-interface=<interface>
firewall-cmd --permanent --zone=<zone> --add-interface=<interface>
}}}
Example:
{{{
firewall-cmd --zone=internal --add-interface=eth0
firewall-cmd --permanent --zone=internal --add-interface=eth0
}}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

43
doc/manual/en/GettingHelp.raw.wiki Normal file
View File

@ -0,0 +1,43 @@
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/GettingHelp|Español]] - [[fr/FreedomBox/Manuel/ObtenirAide|Français]]-~
## BEGIN_INCLUDE
= Getting Help =
<<Anchor(gettinghelp)>>
The !FreedomBox community provides live help via forum, chat and email. Feel free to join and ask anything you like. If you receive help, please consider to report your solution to the [[FreedomBox/QuestionsAndAnswers|Questions and Answers]] page, so others can benefit in the future.
== Discussion Forum ==
The easiest way to get support is by using the [[https://discuss.freedombox.org|discussion forum]]. You can browse solutions to known problems or request help from community contributors by asking a question. This is also the best way to provide community contributors with feedback about your !FreedomBox experience.
To post new content, you will need to register for an account with name and email address (but you can provide pseudonym and non-primary email address). By watching topics and categories or by enabling 'mailing list mode' in your account preferences, you can interact with the forum by just sending and receiving emails similar to a mailing list.
== IRC #freedombox ==
Providing you are familiar with [[http://www.irchelp.org/|Internet Relay Chat]] (IRC) and [[http://www.irchelp.org/irchelp/clients/|IRC client]], you can get an instant online help from the community on '''irc.debian.org''', channel '''#freedombox'''. Potentially it takes some time before some member is answering you, be patient, a reaction will come later.
== Matrix ==
You can join our Matrix room '''#freedombox:matrix.org'''. The room is federated with the IRC channel and remembers the chat history.
If you do not yet have a client installed, you can [[https://riot.im/app/#/room/#freedombox:matrix.org|use your web browser to join]].
For more options, see this [[https://matrix.to/#/#freedombox:matrix.org|matrix client overview page]].
== Email ==
!FreedomBox users and contributors can be reached by email via a discussion list. In order to ask a question and get an answer from the community, please register from the [[https://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|mailing list page]] providing your email adress and creating a password. You can also read [[http://lists.alioth.debian.org/pipermail/freedombox-discuss/|discussions archives]]. This list gathers about 700 readers.
== Help Back ==
Once you've got your solution, don't forget to add it to the [[FreedomBox/QuestionsAndAnswers|Questions and Answers]] page and tell which features do you use from the box on [[FreedomBox/UserExperience|Use Cases]] page. It could help others to use !FreedomBox in a way they would have not imagined.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

54
doc/manual/en/GitWeb.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/GitWeb|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== GitWeb (Simple Git Hosting) ==
||<tablestyle="float: right;"> {{attachment:Gitweb-icon_en_V01.png|Gitweb icon}} ||
'''Available since''': version 19.19
Git is a distributed version-control system for tracking changes in source code during software development. !GitWeb provides a web interface to Git repositories. You can browse history and content of source code, use search to find relevant commits and code. You can also clone repositories and upload code changes with a command-line Git client or with multiple available graphical clients. And you can share your code with people around the world.
To learn more on how to use Git visit [[https://git-scm.com/docs/gittutorial|Git tutorial]].
=== Managing the repositories ===
After installation of !GitWeb, a new repository can be created. It can be marked as ''private'' to limit access.
=== Access ===
!GitWeb can be accessed after installation e.g. by the web client through {{{https://<my_freedombox_name>/gitweb}}}.
=== HTTP basic auth ===
!GitWeb on !FreedomBox currently supports HTTP remotes only. To avoid
having to enter the password each time you pull/push to the repository, you can
edit your remote to include the credentials.
''Example:'' https://username:password@my.freedombox.rocks/gitweb/myrepo
Your username and password will be encrypted. Someone monitoring the network traffic will notice the domain name only.<<BR>>
'''Note:''' If using this method, your password will be stored in plain text in the local repository's {{{.git/config}}} file. For this reason, you should create a !FreedomBox user who has only access to the gitweb and never use an admin account.
=== Mirroring ===
Though your repositories are primarily hosted on your own !FreedomBox, you can
configure a repository on another Git hosting system like GitLab as a mirror.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

169
doc/manual/en/Hardware.raw.wiki Normal file
View File

@ -0,0 +1,169 @@
<<TableOfContents()>>
## BEGIN_INCLUDE
!FreedomBox is designed to be the software for a consumer electronics device that is easy to setup, maintain and use. The project does not aim to create a custom hardware device ourselves, but instead we intend to partner with hardware vendors to build !FreedomBox devices and also support existing hardware. Typically, it is run on single board computers because of their small form factor, low power consumption and favourable price. Some users also run it on old/refurbished desktop or laptop computers or even on virtual machines running on their primary computers.
In addition to supporting various single board computers and other devices, any Debian machine can be turned into a !FreedomBox by installing the `freedombox` package. Debian, the universal operating system, supports a much wider range on hardware. After [[InstallingDebianOn|installing Debian]], see the [[FreedomBox/Hardware/Debian|manual page]] for installing !FreedomBox on Debian.
== Recommended Hardware ==
On April 22nd, 2019, the !FreedomBox Foundation announced the [[https://freedomboxfoundation.org/buy/|sales]] of the Pioneer Edition !FreedomBox Home Server Kits. This is the recommended pre-installed hardware for all users who don't wish to build their own !FreedomBox by choosing the right components, downloading the image and preparing an SD card with !FreedomBox.
The kit includes all the hardware needed for launching a !FreedomBox home server on an Olimex A20-OLinuXino-LIME2 board. This product provides the perfect combination of open source hardware and free and open source software. By purchasing this product, you also support the !FreedomBox Foundation's efforts to create and promote its free and open source server software.
||<style="text-align: center;"> [[FreedomBox/Hardware/PioneerEdition|{{attachment:pioneer-edition_thumb.jpg|Pioneer Edition FreedomBox Home Server Kits|width=320,height=257}}]]<<BR>> [[FreedomBox/Hardware/PioneerEdition|Pioneer Edition FreedomBox Home Server Kits]] ||
== Supported Hardware ==
Use these hardware if you are able to download !FreedomBox images and prepare an SD card by following the manual. If you wish for simper setup process, please buy the !FreedomBox kits from recommended hardware instead. Look at the list of known issues with a hardware before buying it.
||<style="text-align: center;"> [[FreedomBox/Hardware/A20-OLinuXino-Lime2|{{attachment:a20-olinuxino-lime2_thumb.jpg|A20 OLinuXino Lime2|width=235,height=159}}]]<<BR>> [[FreedomBox/Hardware/A20-OLinuXino-Lime2|A20 OLinuXino Lime2]] ||<style="text-align: center;"> [[FreedomBox/Hardware/A20-OLinuXino-MICRO|{{attachment:a20-olinuxino-micro_thumb.jpg|A20 OLinuXino MICRO|width=235,height=132}}]]<<BR>> [[FreedomBox/Hardware/A20-OLinuXino-MICRO|A20 OLinuXino MICRO]] ||<style="text-align: center;"> [[FreedomBox/Hardware/APU|{{attachment:apu1d_thumb.jpg|PC Engines APU|width=235,height=157}}]]<<BR>> [[FreedomBox/Hardware/APU|PC Engines APU]] ||
||<style="text-align: center;"> [[FreedomBox/Hardware/Cubietruck|{{attachment:danube_thumb.png|Cubietruck|width=235,height=206}}]] <<BR>> [[FreedomBox/Hardware/Cubietruck|Cubietruck]] <<BR>> ||<style="text-align: center;"> [[FreedomBox/Hardware/Cubieboard2|{{attachment:cubieboard2_thumb.jpg|Cubieboard 2|width=235,height=156}}]]<<BR>> [[FreedomBox/Hardware/Cubieboard2|Cubieboard2]] ||<style="text-align: center;"> [[FreedomBox/Hardware/BeagleBone|{{attachment:beagleboard_thumb.jpg|BeagleBone Black|width=235,height=157}}]]<<BR>> [[FreedomBox/Hardware/BeagleBone|BeagleBone Black]] ||
||<style="text-align: center;"> [[FreedomBox/Hardware/pcDuino3|{{attachment:pcduino3s_thumb.jpg|pcDuino3|width=235,height=107}}]] <<BR>> [[FreedomBox/Hardware/pcDuino3|pcDuino3]]||<style="text-align: center;"> [[FreedomBox/Hardware/Debian|{{attachment:debian_thumb.png|Debian|width=156,height=201}}]] <<BR>> [[FreedomBox/Hardware/Debian|Debian]]||<style="text-align: center;"> [[FreedomBox/Hardware/VirtualBox|{{attachment:virtualbox_thumb.png|VirtualBox|width=235,height=154}}]] <<BR>> [[FreedomBox/Hardware/VirtualBox|VirtualBox]]||
||<style="text-align: center;"> [[FreedomBox/Hardware/PineA64+|{{attachment:pine64-plus_thumb.jpg|Pine A64+|width=235,height=213}}]] <<BR>> [[FreedomBox/Hardware/PineA64+|Pine A64+]] ||<style="text-align: center;"> [[FreedomBox/Hardware/BananaPro|{{attachment:banana-pro_thumb.jpg|Banana Pro|width=235}}]] <<BR>> [[FreedomBox/Hardware/BananaPro|Banana Pro]]||<style="text-align: center;"> [[FreedomBox/Hardware/OrangePiZero|{{attachment:orange-pi-zero_thumb.jpg|Orange Pi Zero|width=235}}]] <<BR>> [[FreedomBox/Hardware/OrangePiZero|Orange Pi Zero]] ||
||<style="text-align: center;"> [[FreedomBox/Hardware/RockPro64|{{attachment:rockpro64_thumb.jpg|RockPro64|width=235,height=142}}]] <<BR>> [[FreedomBox/Hardware/RockPro64|RockPro64]] ||<style="text-align: center;"> [[FreedomBox/Hardware/Rock64|{{attachment:rock64_thumb.jpg|Rock64|width=235,height=154}}]] <<BR>> [[FreedomBox/Hardware/Rock64|Rock64]]||||
=== Hardware Comparison ===
||'''Name'''||'''Speed (GHz)'''||'''Debian arch'''||'''Ram (GB)'''||'''disk (GB)'''||'''battery'''||'''SATA'''||'''Ethernet speed'''||'''[[OpenSourceHardware|OSHW]]'''||
||APU.1D ||1x2 ||amd64 ||2||-|| - || (./) ||1000x3|| {X} ||
||APU.1D4 ||1x2 ||amd64 ||4||-|| - || (./) ||1000x3|| {X} ||
||!BeagleBone Black C ||1 ||armhf/omap ||½||4|| - || - ||100 || (./) ||
||Cubieboard2 ||1x2 ||armhf/sunxi ||1||4|| (./) || (./) ||100 || {X} ||
||Cubieboard2-Dual ||1x2 ||armhf/sunxi ||1||-|| (./) || (./) ||100 || {X} ||
||Cubieboard3/Cubietruck ||1x2 ||armhf/sunxi ||2||8|| (./) || (./) ||1000 || {X} ||
||OLinuXino A20 LIME ||1x2 ||armhf/sunxi ||½||-|| (./) || (./) ||100 || (./) ||
||OLinuXino A20 LIME2 ||1x2 ||armhf/sunxi ||1||-|| (./) || (./) ||1000 || (./) ||
||OLinuXino A20 MICRO ||1x2 ||armhf/sunxi ||1||-|| (./) || (./) ||100 || (./) ||
||pcDunino3 ||1x2 ||armhf/sunxi ||1||4|| (./) || (./) ||100 || {X} ||
||Pine A64+ ||1.2x4||arm64/sunxi ||½,1,2||-||- || - ||1000 || {X} ||
||Banana Pro ||1.2x2||armhf/sunxi ||1||-||- || (./) ||1000 || {X} ||
||Orange Pi Zero ||?x4 ||armhf/sunxi ||¼,½||-||- || - ||100 || {X} ||
||!RockPro64 ||1.4x4+1.8x2||arm64 ||2,4||16,32,64,128|| - || (./) ||1000 || {X} ||
||Rock64 ||1.5x4||arm64 ||1,2,4||16,32,64,128|| - || (./) ||1000 || {X} ||
== Additional Hardware ==
=== Also Working Hardware ===
This hardware works but is not recommended because the hardware can't run entirely on [[https://www.gnu.org/philosophy/free-sw.en.html|free software]]:
||<style="text-align: center;"> [[FreedomBox/Hardware/RaspberryPi2|{{attachment:raspberry2_thumb.jpg|Raspberry Pi 2|width=235,height=157}}]] <<BR>> [[FreedomBox/Hardware/RaspberryPi2|Raspberry Pi 2]] ||<style="text-align: center;"> [[FreedomBox/Hardware/RaspberryPi3B|{{attachment:raspberrypi3b_thumb.jpg|Raspberry Pi 3 Model B|width=235,height=155}}]] <<BR>> [[FreedomBox/Hardware/RaspberryPi3B|Raspberry Pi 3 Model B]] ||<style="text-align: center;"> [[FreedomBox/Hardware/RaspberryPi3B+|{{attachment:raspberrypi3bplus_thumb.jpg|Raspberry Pi 3 Model B+|width=235,height=153}}]] <<BR>> [[FreedomBox/Hardware/RaspberryPi3B+|Raspberry Pi 3 Model B+]]||
||<style="text-align: center;"> [[FreedomBox/Hardware/RaspberryPi4B|{{attachment:raspberrypi4b_thumb.jpg|Raspberry Pi 4 B|width=235,height=156}}]] <<BR>> [[FreedomBox/Hardware/RaspberryPi4B|Raspberry Pi 4 B]] || || ||
=== Hardware Supported with Generic Images ===
If you already have hardware that you wish turn into a !FreedomBox, don't let the limited list of supported hardware discourage you. If you are using AMD or Intel architecture machines, you can download the generic images of that specific architecture that image will work on any machine of that architecture. For ARM 32-bit or ARM 64-bit architectures, we have a similar solution.
Starting with August 2020, we started building generic images that would work for all single board computers based on a solution involving UEFI standards and u-boot firmware. In this approach, a small board specific firmware resides on an SPI flash or an SD card. It is responsible for loading a generic !FreedomBox image that is placed in an SD card, a USB drive, a SATA drive or an NVMe drive. So, for your hardware, find and get a u-boot based firmware from your board manufacturer and place it on an SPI flash or an SD card. Next, ensure that that kernel in !FreedomBox has support for your board and place it on any of the other storage disks. This approach should work well for a lot of boards that are not listed as specifically supported. See firmware section for more details.
We continue to build images specific to some hardware as we used to earlier. These images have the slight advantage that they are easier to setup because of less step involved. We intend, however, to phase out these images because they can't be booted from all the storage devices and involve development overhead limiting the number of boards we support.
=== Adding Hardware Support ===
If your hardware is not listed above but you were able to get it working using the above described method of using a generic image, drop us a line and we will list it as supported. Further, take a look at the list of [[CheapServerBoxHardware|targeted hardware]] for boards to support.
=== Deprecated Hardware ===
This hardware was supported earlier but is no longer supported. If you downloaded an earlier image and are running !FreedomBox on one of these hardware, you will keep getting software updates. However, no new images will be provided for these hardware. It is recommended that you migrate to newer, supported hardware using backup and restore.
||<style="text-align: center;"> [[FreedomBox/Hardware/DreamPlug|{{attachment:dreamplug_thumb.jpg|DreamPlug|width=235,height=156}}]] <<BR>> [[FreedomBox/Hardware/DreamPlug|DreamPlug]] ||<style="text-align: center;"> [[FreedomBox/Hardware/RaspberryPi|{{attachment:raspberry_thumb.jpg|Raspberry Pi|width=235,height=158}}]] <<BR>> [[FreedomBox/Hardware/RaspberryPi|Raspberry Pi]] ||
''Note'': ''Supported Hardware'' means that !FreedomBox images are built for said hardware and at least one developer has reported the basic functions to be working.
== Common Hardware Information ==
The following sections document common advice related to hardware and peripherals when using them with !FreedomBox.
=== Wi-Fi ===
!FreedomBox can use Wi-Fi hardware for two separate purposes. It can be used to provide internet connectivity or it can be used to share internet connectivity already available to !FreedomBox (via Ethernet, 3G/4G or another Wi-Fi interface) with devices on the network. See the [[FreedomBox/Manual/Networks|Networks]] manual page for instructions on how to configure !FreedomBox for these two cases.
Unfortunately, most built-in Wi-Fi adapters and add-on Wi-Fi adapters require firmware that is not free software. So, !FreedomBox recommends attaching a [[FreedomBox/Hardware/USBWiFi|USB Wi-Fi device]] that does not require non-free firmware. Supported devices automatically show up in the network interface list when configuring networks.
If you have a Wi-Fi device, either built-in or as an add-on, that requires non-free firmware and you are willing to install non-free firmware to get it working, see the Debian [[WiFi|wiki page]]. Once the firmware is installed and the device shows up, it can be configured and used by !FreedomBox.
=== Power Supply ===
On single board computers, one can easily encounter situations where the board and its peripherals are not provided sufficient power and malfunction in unpredictable ways. To avoid this, use a power adapter that can supply the minimum current recommended by the hardware manufacturer. When additional peripherals such as USB drives, Wi-Fi devices, SATA drives or NVMe drives are attached, the power requirements increase. A power supply that can provide higher current than needed is preferable but voltage should match the manufacturer recommendation exactly. Keep in mind that some cheap power supplies don't supply the current they promise to.
=== Firmware ===
Desktops, laptops and virtual machines have software that runs during machine start-up called UEFI/BIOS. This software, sometimes called firmware, can load and hand over control to the operating system (in our case !FreedomBox), when it is present on any of the storage devices. This is not the case with most single board computers.
Single board computers ship with very small amount of software that is typically limited to booting OS from SD cards or eMMCs. They usually can't boot from USB disks, SATA disks or NVMe disks. To remedy this situation, hardware manufacturers started adding a special storage device called SPI flash which is only a few MiB in size. A special software, which we call firmware here, typically based on free and open source boot loader called u-boot is placed in this SPI flash. When the computer starts up, it starts the boot-loader from SPI flash which will in turn load the operating system. Since the firmware is much more powerful, it has the ability to load the OS from any of the storage media. Examples of single board computers with SPI flash include A20-OLinuXino-Lime2 and !RockPro64.
This firmware approach can be used even when SPI flash is not available. Say, one wants to boot from a USB drive and the board does not support booting from it. Firmware can be installed on an SD card (a very tiny one is sufficient) and inserted into the board. Then USB disk will contain !FreedomBox as we wish it. When the board starts, it boots the firmware from SD card which in turn boots the operating system from USB drive or any other storage.
This firmware approach also allows us to use generic download images that work for a large number of hardware boards. While increasing the effort for the user a bit more, it has the advantage of allowing us to support a lot more hardware and allow the OS to be present on any storage media.
When special firmware is needed for a single board computer, !FreedomBox manual for the board discusses how to to obtain and install the firmware before proceeding with installation of !FreedomBox.
=== Storage ===
!FreedomBox can run from various storage media supported by your computer. Choosing the storage is about balancing reliability, capacity and speed against cost. A minimum storage capacity of 8GB is recommended for running !FreedomBox.
==== Secure Digital (SD) Card ====
SD cards are common on single board computers. Most single board computers can boot directly from an SD card without any additional tweaks.
SD cards are typically slowest among the available storage media. Expect your !FreedomBox to perform certain operations slower on these disks. Not all SD cards perform similarly and some perform much better than others. When buying an SD card, pick a card with a speed class of at least 10 (written on the card as a circle around the number 10) or UHS speed class 1 (written on the card as a number 1 inside a bucket). UHS speed class 3 (written on the card as number 3 inside a bucket) or application speed class 1 or above (written as A1 and A2) will perform much better. Finally, users of !FreedomBox have reported cases where SD cards have failed. So, other storage media should be preferred for higher reliability.
==== Embedded MultiMediaCard (eMMC) ====
Many recently released single board computers support eMMC cards. Most single board computers can boot directly from an eMMC without any additional tweaks.
eMMC is sometimes soldered onto the board and you will need to choose the size of eMMC when buying the board. An example of this is the Olimex's A20-OLinuXino-Lime2 board. Other times, a manufacturer will provide eMMC as pluggable peripheral. With this approach, you can add eMMC after you buy the board or upgrade existing one with higher capacity. Do not detach and reattach such pluggable eMMCs too often. They have a very limited number of wear cycles (< 100).
eMMC are much faster than SD cards and spinning disk HDDs but are significantly slower than SSDs. They have much better random write speeds which are needed for many !FreedomBox operations. In general, they should be preferred over SD cards.
!FreedomBox image can be setup on an eMMC in two ways. For a detachable eMMC, there are eMMC to USB converters available. Detach the eMMC from the board, attach it to the USB converter and plug it into your machine and proceed with writing !FreedomBox on it as one would for an SD card. In case the eMMC is not detachable, boot the computer with a media other than the eMMC such as an SD card or USB disk. It could be any operating system. After booting, the eMMC will show up as an additional disk. [[FreedomBox/Download|Download]] and write !FreedomBox image onto it as one would for an SD card.
==== USB Disk Drive ====
Most computers and single board computers have USB ports. These ports accept storage media such as USB flash drives, SSDs or HDDs.
A USB flash drive can also serve as a storage medium for running !FreedomBox. USB 2.0 flash drives are much slower and comparable to SD cards in their performance. USB 3.0 flash drives yield much better performance. Both USB flash drives and SD cards use similar technology so the read/write cycles and hence the reliability as similarly limited.
Apart from USB flash drives, solid state drives (SSDs) and hard disk drives (HDDs) can be inserted into USB ports. This is possible either by buying drives with USB interface or by using convertors such as USB to SATA or USB to M.2 interface. Both SSDs and HDDs have much higher reliability compared to SD cards, eMMC or USB flash drives. These should be preferred whenever possible. In addition, SSDs provide excellent performance when connected via USB 3.0 interface.
When connecting SSDs and HDDs to USB ports on single board computers, care should be taken about the power supply to the drive. If the drive has an extra power supply there is nothing to worry about. Otherwise, ensure that the single board computer is able to power the drive by checking the power requirements of the drive and what the board supports. For the board, always use a power adapter that can supply the minimum current recommended by the hardware manufacturer. Power supply that can provide higher current than needed is preferable but the voltage supplied should match the manufacturer recommendation exactly. Keep in mind that some cheap power supplies don't supply the current they promise to.
Setting up a !FreedomBox image on a USB (flash, SSD or HDD) drive can be straight forward as most computers have USB ports. Plug-in the USB drive to your computer, [[FreedomBox/Download|download]] and write the !FreedomBox image to the USB drive. While laptops, desktops and virtual machines can boot from a USB drive without intervention, many single board computers can't boot from USB drives. To address this, a separate firmware is needed. See firmware section for setting this up.
==== SATA disk drive ====
Some desktops, laptops and single board computers support a SATA interface to connect a solid state drive (SSD) or a hard disk drive (HDD). An example of a single board computer supporting SATA interface is the Olimex's A20-OLinuXino-Lime2. SATA protocol is also used for mSATA ports or M.2 slots (with a B-Key or an M-key). Both SSDs and HDDs have much higher reliability compared to SD cards, eMMC or USB flash drives. SATA interface provides very good data transfer rates (but not as good as NVMe drives based on PCIe). These should be preferred over SD cards, eMMCs or USB flash drives whenever possible.
When connecting SSDs and HDDs to SATA ports on single board computers, care should be taken about the power supply to the drive. If the drive has an extra power supply there is nothing to worry about. Otherwise, ensure that the single board computer is able to power the drive by checking the power requirements of the drive and what the board supports. Always use a power adapter that can supply the minimum current recommended by the hardware manufacturer. Power supply that can provide higher current than needed is preferable but voltage should match the recommendation exactly. Keep in mind that some cheap power supplies don't supply the current they promise to.
To setup !FreedomBox image on a SATA disk drive, boot the computer with a media other than the SATA disk such as an SD card. It could be any operating system. After booting, the SATA disk will show up as an additional disk. [[FreedomBox/Download|Download]] and write !FreedomBox image onto it as one would for an SD card. While laptops, desktops and virtual machines can boot from a SATA drives without additional intervention, many single board computers can't boot from SATA drives. To address this, a separate firmware disk is needed. See firmware section for setting this up.
==== NVMe disk drive ====
Most desktops, laptops and some single board computers support an NVMe interface to connect a solid state drive (SSD). This support is provided either with an M.2 slot (with a B-key or an M-key) or by providing a PCIe expansion slot. If a PCIe expansion slot is provided, a PCIe to M.2 convertor can be used to accommodate an NVMe drive. An example of a single board computer supporting an M.2 slot is the Radxa's Rock Pi 4 board. An example of single board computer providing PCIe slot is the Pine64's !RockPro64 board. NVMe based SSD have much higher reliability compared to SD cards, eMMC or USB flash drives. NVMe drives provide the fastest data transfer rates. These should be preferred over all other types of drives whenever possible.
When connecting NVMe drives to single board computers, care should be taken about the power supply to the drive. Ensure that the single board computer is able to power the drive by checking the power requirements of the drive and what the board supports. Always use a power adapter that can supply the minimum current recommended by the hardware manufacturer. Power supply that can provide higher current than needed is preferable but voltage should match the manufacturer recommendation exactly. Keep in mind that some cheap power supplies don't supply the current they promise to.
To setup !FreedomBox image on an NVMe disk drive, boot the computer with a media other than the NVMe disk such as an SD card. It could be any operating system. After booting NVMe disk will show up as an additional disk. [[FreedomBox/Download|Download]] and write !FreedomBox image onto it as one would for an SD card. While laptops, desktops and virtual machines can boot from NVMe drives without intervention, many single board computers can't boot from NVMe drives. To address this a separate firmware disk is needed. See firmware section for setting this up.
== Building Your Own Images ==
All !FreedomBox disk images for different hardware is built by the project using a tool known as [[FreedomBox/Maker|Freedom Maker]]. If for some reason, you wish to build your own images instead of downloading the provided images, use this tool. The README file in the project provides information about the list of hardware build targets available and how to build images.
=== Status of Software Used ===
* All the software present in !FreedomBox images is from Debian repositories. There are some minor tweaks done by the [[FreedomBox/Maker|Freedom Maker]] script.
* All software present in the images is DFSG compliant free software except in case of Raspberry Pi images where the firmware package is non-free software.
* All images use the Linux kernel from Debian which is in turn based on the mainline Linux kernel.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Images are licensed under various creative commons licenses. See individual linked pages for attribution information.

38
doc/manual/en/I2P.raw.wiki Normal file
View File

@ -0,0 +1,38 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/I2P|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== I2P (Anonymity Network) ==
||<tablestyle="float: right;"> {{attachment:I2P-icon_en_V01.png|I2P icon}} ||
=== About I2P ===
The Invisible Internet Project is an anonymous network layer intended to protect communication from censorship and surveillance. I2P provides anonymity by sending encrypted traffic through a volunteer-run network distributed around the world.
Find more information about I2P on their project [[https://geti2p.net|homepage]].
=== Services Offered ===
The following services are offered via I2P in !FreedomBox by default. Additional services may be available when enabled from I2P router console that can be launched from !FreedomBox web interface.
* '''Anonymous Internet browsing''': I2P can be used to browse Internet anonymously. For this, configure your browser (preferable a Tor Browser) to connect to I2P proxy. This can be done by setting HTTP proxy and HTTPS proxy to ''freedombox.local'' (or your !FreedomBox's local IP address) and ports to ''4444'' and ''4445'' respectively. This service is available only when you are reaching !FreedomBox using local network (networks in internal zone) and not available when connecting to !FreedomBox from the Internet. One exception to this is when you connect to !FreedomBox's VPN service from Internet you can still use this service.
* '''Reaching eepsites''': I2P network can host websites that can remain anonymous. These are called eepsites and end with .i2p in their domain name. For example, http://i2p-projekt.i2p/ is the website for I2P project in the I2P network. eepsites are not reachable using a regular browser via regular Internet connection. To browse eepsites, your browser needs to be configured to use HTTP, HTTPS proxies as described above. This service is available only when you are reaching !FreedomBox using local network (networks in internal zone) and not available when connecting to !FreedomBox from the Internet. One exception to this is when you connect to !FreedomBox's VPN service from Internet you can still use this service.
* '''Anonymous torrent downloads''': I2PSnark, an application for anonymously downloading and sharing files over the !BitTorrent network is available in I2P and enabled by default in !FreedomBox. This application is controlled via a web interface that can be launched from 'Anonymous torrents' section of I2P app in !FreedomBox web interface or from the I2P router console interface. Only logged-in users belonging to 'Manage I2P application' group can use this service.
* '''IRC network''': I2P network contains an IRC network called Irc2P. This network hosts the I2P project's official IRC channel among other channels. This service is enabled by default in !FreedomBox. To use it, open your favourite IRC client. Then configure it to connect to host ''freedombox.local'' (or your !FreedomBox's local IP address) with port number ''6668''. This service is available only when you are reaching !FreedomBox using local network (networks in internal zone) and not available when connecting to !FreedomBox from the Internet. One exception to this is when you connect to !FreedomBox's VPN service from Internet you can still use this service.
* '''I2P router console''': This is the central management interface for I2P. It shows the current status of I2P, bandwidth statistics and allows modifying various configuration settings. You can tune your participation in the I2P network and use/edit a list of your favourite I2P sites (eepsites). Only logged-in users belonging to 'Manage I2P application' group can use this service.
=== Port Forwarding ===
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 I2P:
* TCP 4444
* TCP 4445
* TCP 6668
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>

63
doc/manual/en/Ikiwiki.raw.wiki Normal file
View File

@ -0,0 +1,63 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Ikiwiki|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Ikiwiki (Wiki and Blog) ==
||<tablestyle="float: right;"> {{attachment:Ikiwiki-icon_en_V01.png|Ikiwiki icon}} ||
'''Avaiable since''': version 0.5
=== What is Ikiwiki? ===
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.
=== Quick Start ===
After the app installation on your box administration interface:
* Go to "Create" section and create a wiki or a blog
* Go back to "Configure" section and click on /ikiwiki link
* Click on your new wiki or blog name under "Parent directory"
* Enjoy your new publication page.
=== Creating a wiki or blog ===
You can create a wiki or blog to be hosted on your !FreedomBox through the Wiki & Blog (Ikiwiki) page in !FreedomBox. The first time you visit this page, it will ask to install packages required by Ikiwiki.
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.
{{attachment:ikiwiki_create.png|ikiwiki: Create|width=800}}
=== Accessing your wiki or blog ===
From the Wiki & 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.
{{attachment:ikiwiki_manage.png|ikiwiki: Manage|width=800}}
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.
=== User login through SSO ===
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.
To add a wiki user, go to the Users and Groups page in !FreedomBox (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.)
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.
=== Adding FreedomBox users as wiki admins ===
1. Login to the wiki, using the admin account that was specified when the wiki was created.
2. Click "Preferences", then "Setup".
3. Under "main", in the "users who are wiki admins", add the name of a user on the !FreedomBox.
4. (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.)
5. Click "Save Setup".
6. Click "Preferences", then "Logout".
7. Login as the new admin user using "Login with HTTP auth".
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

30
doc/manual/en/Infinoted.raw.wiki Normal file
View File

@ -0,0 +1,30 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Infinoted|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Infinoted (Gobby Server) ==
||<tablestyle="float: right;"> {{attachment:Infinoted-icon_en_V01.png|Infinoted icon}} ||
'''Available since''': version 0.5
infinoted is a server for Gobby, a collaborative text editor.
To use it, [[https://gobby.github.io/|download Gobby]], desktop client and install it. Then start Gobby and select "Connect to Server" and enter your !FreedomBox's domain name.
=== Port Forwarding ===
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 infinoted:
* TCP 6523
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

72
doc/manual/en/Introduction.raw.wiki Normal file
View File

@ -0,0 +1,72 @@
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: [[de/FreedomBox/Einführung|Deutsch]]- English - [[es/FreedomBox/Introduction|Español]] - [[fr/FreedomBox/Introduction|Français]]-~
## BEGIN_INCLUDE
= FreedomBox: take your online privacy back =
!FreedomBox is a ready made personal server, designed with privacy and data ownership in mind. It is a subset of the [[https://www.debian.org/|Debian universal operating system]] and includes free software only. You can run it on a small, inexpensive and power-efficient computer box in your home that is dedicated for that use. It can also be installed on any computer running Debian or in a virtual machine.<<BR>>
In order to replace third-party communication services that are data mining your entire life, you will be able to host services yourself and use them at home or over the Internet through a browser or specialized apps. These services include chat and voice calls, webmail, file sharing and calendar, address book and news feed synchronization. For example, to start using a private chat service, activate the service from the administration interface and add your friends as authorized users of the service. They will be able to connect to the service hosted on your !FreedomBox, using XMPP chat clients such as Conversations on Android, Pidgin on Windows and Linux, or Messages on Mac OS, for encrypted communications.<<BR>>
!FreedomBox is a product you can just [[https://freedomboxfoundation.org/buy/|buy]], set up and use. Once installed the interface is easy to use, similar to a smart phone.
User documentation:
* List of [[FreedomBox/Features|applications]] offered by !FreedomBox.
* [[FreedomBox/Manual|Manual]]
* [[FreedomBox/Support|Live Help from the community]]
!FreedomBox can also host a Wi-Fi access point, ad blocking proxy and a virtual private network (VPN). More advanced users can replace their router with a !FreedomBox.
Setting up !FreedomBox on a specific hardware or on your computer running Debian may require a bit of technical expertise or help from the community.
Related technical documentation:
* [[FreedomBox/Hardware|Machines that support FreedomBox]]
* [[FreedomBox/Download|Download and Install]]
* [[https://docs.freedombox.org|FreedomBox Developer Manual]]
== Typical usage: Private Cloud ==
!FreedomBox provides services to the computers and mobile devices in your home, and to your friends. This includes secure instant messaging and low-bandwidth, high-quality voice conference calling. !FreedomBox lets you publish your content in a blog and wiki to collaborate with the rest of the world. On the roadmap are a personal email server and federated social networking, to provide privacy-respecting alternatives to Gmail and Facebook.
== Advanced usage: Smart Home Router ==
!FreedomBox runs in a physical computer and can route your traffic. It can sit between various devices at home such as mobiles, laptops and TVs and the Internet, replacing a home wireless router. By routing traffic, !FreedomBox can remove tracking advertisements and malicious web bugs before they ever reach your devices. !FreedomBox can cloak your location and protect your anonymity by "onion routing" your traffic over Tor. !FreedomBox provides a VPN server that you can use while you are away from home to keep your traffic secret on untrusted public wireless networks and to securely access various devices at home.
It can also be carried along with your laptop and set up to offer its services on public networks at work, school or office. In the future, !FreedomBox intends to deliver support for alternative ways of connecting to the Internet such as Mesh networking.
== Advanced usage: For Communities ==
The primary design goal of !FreedomBox is to be used as a personal server at home for use by a single family and their friends. However, at the core, it is a server software that can aid a non-technical user to setup services and maintain them with ease. Security is automatically managed and many of the technical choices in system administration are taken care by the software automatically thereby reducing complexity for a non-technical user. This nature of !FreedomBox makes it well-suited for hosting services for small communities like villages or small firms. Communities can host their own services using !FreedomBox with minimal effort. They can setup Wi-Fi networks that span the entire area of the community and draw Internet connections from long distances. Community members can enjoy previously unavailable Internet connectivity, ubiquitous Wi-Fi coverage, free VOIP services, offline education and entertainment content, etc. This will also boost privacy for individuals in the community, reduce dependence on centralized services provided by large companies and make them resistant to censorship.
The free e-book [[https://en.wikibooks.org/wiki/FreedomBox_for_Communities|FreedomBox for Communities]] describes the motivation and provides detailed instructions to setup !FreedomBox for this use case. Members of the !FreedomBox project are involved in setting up Wi-Fi networks with free Internet connectivity in rural India. This e-book documents their knowledge and experiences.
== FreedomBox Interface ==
=== Screenshot ===
{{attachment:freedombox-frontpage-2019-03-02.png|FreedomBox front page|width=1000}}
{{{#!wiki comment
This video is much too old to be useful here.
=== Screencast introduction ===
[[attachment:Plinth_Introduction.webm]]
(36 MB, 13 Min.)
}}}
=== Video resources ===
Eben Moglen's talk, [[https://www.youtube.com/watch?v=QOEMv0S8AcA|Eben Moglen - Freedom in the cloud]], delivered before the !FreedomBox project was started gives insights into the philosophy behind !FreedomBox.
[[http://moglen.law.columbia.edu/sflc2015/04_freedombox.webm|First demonstration of FreedomBox at SFLC, University of Columbia]] by Sunil Mohan Adapa.
## END_INCLUDE
See the features page for a [[FreedomBox/Features|full list of applications]] offered by !FreedomBox and [[https://freedomboxfoundation.org/buy/|buy]] or [[FreedomBox/Download|download]] yours!
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

52
doc/manual/en/JSXC.raw.wiki Normal file
View File

@ -0,0 +1,52 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/JSXC|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== JSXC (Web Chat Client) ==
||<tablestyle="float: right;"> {{attachment:JSXC-icon_en_V01.png|JSXC icon}} ||
'''Available since''': version 0.11.0
JSXC is a web chat client. It can be used to join compatible chat servers.
!FreedomBox offers both parties, a server ([[FreedomBox/Manual/ejabberd|ejabberd]]) and a web client (JSXC), from its web interface.
=== Technical Specifications ===
JSXC features the XMPP over [[https://en.wikipedia.org/wiki/BOSH_(protocol)|BOSH]] protocol and is implemented in HTML5.
XMPP is a federated server-client 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.
=== Installation ===
You can install JSXC through its icon in the Apps section of !FreedomBox web interface. The ejabberd (XMPP server) icon also offers to launch the web client (and installs JSXC if not yet installed).
=== Usage ===
After the JSXC module install completes, the JSXC can be accessed through its icon in the Apps section of !FreedomBox web interface. The ejabberd (XMPP server) icon also offers to launch the web client. Both will redirect you to {{{https://<your freedombox>/plinth/apps/xmpp/jsxc/}}}.
To use it, you need to input the domain name of the server to connect to. It will automatically check the BOSH server connection to the given domain name as you type it.
||{{attachment:JSXC-KO_en_V01.png|JSXC not connecting|height=250}} || {{attachment:JSXC-ok_en_V01.png|JSXC connecting|height=250}} ||
Check https://www.jsxc.org for further details.
Videoconferencing and file transfer features are offered by JSXC but don't seem to work in !FreedomBox yet.
=== Port Forwarding ===
If your !FreedomBox is behind a router and you want to connect to other servers, you will need to set up port forwarding on your router. You should forward the following ports for XMPP:
* TCP 5222 (client-to-server)
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

58
doc/manual/en/LetsEncrypt.raw.wiki Normal file
View File

@ -0,0 +1,58 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/LetsEncrypt|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Let's Encrypt (Certificates) ==
A digital certificate 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).
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.
=== Why using Certificates ===
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.
=== How to setup ===
1. If your !FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports:
* TCP 80 (http)
* TCP 443 (https)
1. Make the domain name known:
* In [[../Configure|Configure]] insert your ''domain name'', e.g. ''`MyWebName.com`''
{{attachment:LetsEncrypt-Configure.png|Let's Encrypt|width=800}}
1. Verify the domain name was accepted
* Check that it is enabled in [[../NameServices|Name Services]]
{{attachment:LetsEncrypt-NameServices.png|Let's Encrypt Name Services|width=800}}
1. Go to the Certificates (Let's Encrypt) page, and complete the module install if needed. Then click the "Obtain" button for your domain name.
* After some minutes a valid certificate is available
{{attachment:LetsEncrypt.png|Let's Encrypt|width=800}}
1. Verify in your browser by checking ''`https://MyWebName.com`''
{{attachment:LetsEncrypt-Certificate.png|Let's Encrypt Certificate|width=800}}
'''Screencast''': [[attachment:Let's Encrypt.webm|Let's Encrypt|&do=get]]
=== Using ===
The certificate is valid for 3 months. It is renewed automatically and can also be re-obtained or revoked manually.
With running ''diagnostics'' the certificate can also be verified.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

52
doc/manual/en/MLDonkey.raw.wiki Normal file
View File

@ -0,0 +1,52 @@
## page was renamed from FreedomBox/Manual/MLdonkey
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/MLDonkey|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== MLDonkey (Peer-to-peer File Sharing) ==
||<tablestyle="float: right;"> {{attachment:MLDonkey-icon_en_V01.png|MLDonkey icon}} ||
'''Available since:''' version 0.48.0
=== What is MLDonkey? ===
MLDonkey is an open-source, multi-protocol, peer-to-peer file sharing application that runs as a back-end server application on many platforms. It can be controlled through a user interface provided by one of many separate front-ends, including a Web interface, telnet interface and over a dozen native client programs.
Originally a Linux client for the eDonkey protocol, it now runs on many flavors of Unix-like, OS X, Microsoft Windows and MorphOS and supports numerous peer-to-peer protocols including ED2K (and Kademlia and Overnet), !BitTorrent, DC++ and more.
Read more about MLDonkey at [[http://mldonkey.sourceforge.net/Main_Page|the MLDonkey Project Wiki]]
=== Screenshot ===
{{attachment:mldonkey.jpg|MLDonkey Web Interface|width=800}}
=== Using MLDonkey Web Interface ===
After installing MLDonkey, its web interface can be accessed from !FreedomBox at {{{https://<your freedombox>/mldonkey}}}. Users belonging to the ''ed2k'' and ''admin'' groups can access this web interface.
=== Using Desktop/Mobile Interface ===
Many [[http://mldonkey.sourceforge.net/Gui|desktop and mobile applications]] can be used to control MLDonkey. MLDonkey server will always be running on !FreedomBox. It will download files (or upload them) and store them on !FreedomBox even when your local machine is not running or connected to MLDonkey on !FreedomBox. Only users of ''admin'' group can access MLDonkey on !FreedomBox using desktop or mobile clients. This is due to restrictions on which group of users have SSH access into !FreedomBox.
1. Create an admin user or use an existing admin user.
1. On your desktop machine, open a terminal and run the following command. It is recommended that you configure and use SSH keys instead of passwords for the this step.
{{{
$ ssh -L 4001:localhost:4001 -N exampleuser@example.freedombox.rocks
}}}
1. Start the GUI application and then connect it to MLDonkey as if MLDonkey is running on the local desktop machine. After you are done, terminate the SSH command by pressing Control-C.
See MLDonkey documentation for [[http://mldonkey.sourceforge.net/SshTunnel|SSH Tunnel]] for more information.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

62
doc/manual/en/Maker.raw.wiki Normal file
View File

@ -0,0 +1,62 @@
== Freedom Maker ==
Freedom Maker is a script to build !FreedomBox disk images for use on various hardware devices or virtual machines.
Freedom Maker can currently build !FreedomBox disk images for the following:
* [[https://en.wikipedia.org/wiki/OLinuXino#A20-OlinuXino-LIME|A20-OlinuXino-LIME]]
* [[https://en.wikipedia.org/wiki/OLinuXino#A20-OlinuXino-LIME2|A20-OlinuXino-LIME2]]
* [[https://en.wikipedia.org/wiki/OLinuXino#A20-OLinuXino-MICRO|A20-OLinuXino-MICRO]]
* [[https://en.wikipedia.org/wiki/Banana_Pro|Banana Pro]]
* [[https://en.wikipedia.org/wiki/BeagleBoard#BeagleBone|BeagleBone]]
* [[https://en.wikipedia.org/wiki/Cubieboard#Cubieboard2|Cubieboard2]]
* [[https://en.wikipedia.org/wiki/Cubieboard#Cubietruck_.28Cubieboard3.29|Cubietruck]]
* [[http://www.linksprite.com/linksprite-pcduino3/|pcDuino3]]
* [[https://en.wikipedia.org/wiki/Raspberry_Pi|Raspberry Pi 2]]
* [[https://en.wikipedia.org/wiki/Raspberry_Pi|Raspberry Pi 3 Model B]]
* [[https://en.wikipedia.org/wiki/Raspberry_Pi|Raspberry Pi 3 Model B+]]
* [[https://en.wikipedia.org/wiki/VirtualBox|VirtualBox]]
* [[https://en.wikipedia.org/wiki/QEMU|QEMU]]
* [[https://en.wikipedia.org/wiki/X86-64#AMD64|AMD64 (x86-64) Machines]], [[https://en.wikipedia.org/wiki/X86|X86 Machines]] and other virtual machines (using raw disk images)
If a hardware platform is capable of running Debian, it should not be too much effort adopt Freedom Maker to create !FreedomBox images for the platform.
Freedom Maker is [[https://www.gnu.org/philosophy/|Free Software]] licensed under [[https://www.gnu.org/licenses/gpl.html|GNU General Public License]] version 3 or (at your option) a later version.
=== Building FreedomBox Images ===
* You can get Freedom Maker from its [[https://salsa.debian.org/freedombox-team/freedom-maker.git|Git repository]] and follow the instructions in the README to [[https://salsa.debian.org/freedombox-team/freedom-maker/blob/master/README.md|build a FreedomBox image]].
=== Support ===
You may ask for support on
* [[https://discuss.freedombox.org/|The discussion forum]]
* [[http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|The mailing list]]
* [[irc://irc.debian.org/freedombox|#freedombox IRC channel]]
* [[https://matrix.to/#/#freedombox:matrix.org|FreedomBox Matrix channel]]
=== Contributing ===
We are looking for help to improve Freedom Maker.
* Instructions on how to [[FreedomBox/Contribute/Code|contribute code]] are available.
* Freedom Maker is hosted at [[https://salsa.debian.org/freedombox-team/freedom-maker|FreedomBox Salsa Project]]. The primary Git repository is hosted [[https://salsa.debian.org/freedombox-team/freedom-maker.git|there]].
* You can contribute to !FreedomBox by adding support for more hardware platforms. Freedom Maker can be easily adopted to newer platforms if they already support running Debian.
* You can create and test images with Freedom Maker regularly to test for new features and check for regressions.
* List of bugs, TODO items and feature requests are available on the [[https://salsa.debian.org/freedombox-team/freedom-maker/issues|issue tracker]].
* You can request for development assistance on [[https://discuss.freedombox.org/|the discussion forum]], [[http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|the mailing list]] or the [[irc://irc.debian.org/freedombox|#freedombox IRC channel]].
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

72
doc/manual/en/MatrixSynapse.raw.wiki Normal file
View File

@ -0,0 +1,72 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/MatrixSynapse|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Matrix Synapse (Chat Server) ==
||<tablestyle="float: right;"> {{attachment:Matrix-icon_en_V01.png|Matrix Synapse icon}} ||
'''Available since''': version 0.14.0
=== What is Matrix? ===
[[https://matrix.org/|Matrix]] 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 !FreedomBox to host large chat rooms, end-to-end encrypted communication and audio/video calls.
Matrix Synapse is a federated application where chat rooms can exist on any server and users from any server in the federated network can join them. [[https://matrix.org/docs/guides/faq.html|Learn more]] about Matrix.
=== How to access your Matrix Synapse server? ===
We recommend the [[https://element.io/|Element]] client to access the Matrix Synapse server. You can [[https://element.io/get-started|download]] Element for desktops. Mobile applications for Android and iOS are available from their respective app stores.
=== Port Forwarding ===
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 Matrix:
* TCP 8448
=== Setting up Matrix Synapse on your FreedomBox ===
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 -> Configure page. After configuring a domain, you will see that the service is running. The service will be accessible on the configured !FreedomBox domain. Currently, you will not be able to change the domain once is it configured.
Your router has to be configured to forward port 8448.
All the registered users of your !FreedomBox will have their Matrix IDs as `@username:domain`. If public registration is enabled, also your chosen client can be used to register a user account.
=== Federating with other Matrix instances ===
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 `@their-username:their-domain`. You can also join rooms which are in another server and have audio/video calls with contacts on other server.
=== Memory usage ===
The Synapse reference server implemented in Python is known to be quite RAM hungry, especially when loading large rooms with thousands of members like #matrix:matrix.org. It is recommended to avoid joining such rooms if your !FreedomBox device only has 1 GiB RAM or less. Rooms with up to a hundred members should be safe to join. The Matrix team is working on a new implementation of the Matrix server written in Go called Dendrite which might perform better in low-memory environments.
Some large public rooms in the Matrix network are also available as IRC channels (e.g. #freedombox:matrix.org is also available as #freedombox on irc.debian.org). It is better to use IRC instead of Matrix for such large rooms. You can join the IRC channels using [[FreedomBox/Manual/Quassel|Quassel]].
=== Advanced usage ===
1. If you wish to create a large number of users on your Matrix Synapse server, use the following commands on a remote shell as root user:
{{{
cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1 | sed "s+^+registration_shared_secret: +" > /etc/matrix-synapse/conf.d/registration_shared_secret.yaml
chmod 600 /etc/matrix-synapse/conf.d/registration_shared_secret.yaml
chown matrix-synapse:nogroup /etc/matrix-synapse/conf.d/registration_shared_secret.yaml
systemctl restart matrix-synapse
register_new_matrix_user -c /etc/matrix-synapse/conf.d/registration_shared_secret.yaml
}}}
1. If you wish to see the list of users registered in Matrix Synapse, the following as root user:
{{{
apt install sqlite3
echo 'select name from users' | sqlite3 /var/lib/matrix-synapse/homeserver.db
}}}
1. If you wish to create a community in Matrix Synapse, a Matrix user with server admin privileges is needed. In order to grant such privileges to `username` run the following commands as root user:
{{{
sudo apt install sqlite3
echo "UPDATE users SET admin=1 WHERE name='@username:domainname'" | sudo sqlite3 /var/lib/matrix-synapse/homeserver.db
}}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

86
doc/manual/en/MediaWiki.raw.wiki Normal file
View File

@ -0,0 +1,86 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/MediaWiki|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== MediaWiki (Wiki) ==
||<tablestyle="float: right;"> {{attachment:MediaWiki-icon_en_V01.png|MediaWiki icon}} ||
'''Available since:''' version 0.20.0
=== About MediaWiki ===
MediaWiki is the software that powers the Wikimedia suite of wikis.
Read more about !MediaWiki on [[https://en.wikipedia.org/wiki/MediaWiki|Wikipedia]]
=== MediaWiki on FreedomBox ===
!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.
==== User management ====
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 !MediaWiki app page in web interface.
==== Use cases ====
!MediaWiki 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.
===== Personal Knowledge Repository =====
!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.
===== Community Wiki =====
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.
===== Personal Wiki-based Website =====
[[https://www.mediawiki.org/wiki/Sites_using_MediaWiki/en|Several websites]] 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.
==== Editing Wiki Content ====
The !MediaWiki installation on !FreedomBox ships with a basic editor with a toolbar for common options like Bold, Italics etc. Click on the Advanced section for more options like Headings, bullet lists etc.
{{attachment:mediawiki-toolbar.png}}
===== Visual Editor =====
!MediaWiki's new Visual Editor gives a WYSIWYG user interface to creating wiki pages. This is still a Beta feature and is not provided by default with !MediaWiki. A workaround is to use write your content using the Visual Editor in [[https://en.wikipedia.org/wiki/Wikipedia:Sandbox|Wikipedia's Sandbox]], switching to source editing mode and copying the content into your wiki.
===== Other Formats =====
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 [[https://pandoc.org/try/|Pandoc]].
===== Image Uploads =====
Image uploads have been enabled since !FreedomBox version 0.36.0. You can also directly use images from Wikimedia Commons using a feature called [[https://www.mediawiki.org/wiki/InstantCommons|Instant Commons]].
==== Customization ====
===== Skins =====
!MediaWiki's default skin is usually Vector. The default skin set by
!FreedomBox is Timeless.
Vector is a skin best-suited for viewing on desktop
browsers. It is not suitable for mobile screen sizes. Wikimedia sites host
a separate mobile site. It is not worth hosting a separate mobile site for
small !MediaWiki installations like those on !FreedomBox. Using a mobile-friendly skin like Timeless is a cheaper way of solving the problem.
Administrators can choose a default skin from the app configuration. Users of the site also have the choice of viewing it with a different skin.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

29
doc/manual/en/Minetest.raw.wiki Normal file
View File

@ -0,0 +1,29 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Minetest|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Minetest (Block Sandbox) ==
||<tablestyle="float: right;"> {{attachment:Minetest-icon_en_V01.png|Minetest icon}} ||
'''Available since''': version 0.9
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 [[https://www.minetest.net/downloads/|Minetest client]] is needed.
=== Port Forwarding ===
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:
* UDP 30000
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

87
doc/manual/en/MiniDLNA.raw.wiki Normal file
View File

@ -0,0 +1,87 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/MiniDLNA|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== MiniDLNA (Simple Media Server) ==
||<tablestyle="float: right;"> {{attachment:MiniDLNA-icon_en_V01.png|MiniDLNA icon}} ||
'''Available since''': version 19.23
MiniDLNA is a media server with the aim to be compliant with DLNA/UPnP clients.
Note: This service is available only on networks configured as "internal" zone. It is not available when connected via [[FreedomBox/Manual/OpenVPN|OpenVPN]].
=== What is UPnP/DLNA? ===
Universal plug & play is a set of networking protocols that allow devices within
a network such as PCs, TVs, printers etc. to seamlessly discover each other and
establish communication for data sharing. It is zero configuration protocol and
requires only a media server and a media player that are compliant with the
protocol.
DLNA is derived from UPnP as a form of standardizing media interoperability. It
forms a standard/certification which many consumer electronics conform to.
=== Setting up MiniDLNA on your FreedomBox ===
To install/enable the media server you need to navigate at MiniDLNA page and
enable it. The application is intended to be available in the internal (home) network and
therefore it requires a network interface configured for internal traffic.
After installation a web page becomes available on https://<your-freedombox>/_minidlna.
It includes information for how many files the server is detecting, how many connections
exist etc. This is very useful if plugging external disks with media to check
if the new media files are detected properly. If that is not happening, disabling and
enabling the server will fix it.
=== Using MiniDLNA to play media on your devices ===
Any DLNA compliant device or media player should be able to automatically detect, browse and play media from MiniDLNA on !FreedomBox. The following devices and media players have been tested:
* '''GNOME Videos''': Videos is the default media player on the popular GNU/Linux desktop environment GNOME. Open Videos, switch to 'Channels'. You should see a channel named 'freedombox: minidlna'. You will be able to browse and play media from it.
* '''VLC media player''': VLC is a very popular media player for GNU/Linux, Android, Windows and macOS. Open VLC and click on 'View -> Playlist'. In the playlist sidebar that appears, select 'Universal Plug'n'Play'. You should see an item named 'freedombox: minidlna'. You should be able to browse and play media from it.
* '''Kodi''': Kodi is a popular media centre software with user interface designed for Televisions. Open Kodi, goto 'System -> Service settings -> UPnP/DLNA' and 'Enable UPnP support'. Then visit 'Home -> Videos -> Files -> Add videos... -> Browse -> UPnP devices'. You should see 'freedombox: minidlna'. Select it and choose 'OK'. Then choose 'OK in the 'Add video source' dialog. From now on, you should see 'freedombox: minidlna' in 'Videos -> Files' section. You should be able to browse and play media from it. See [[https://kodi.wiki/view/Settings/Services/UPnP_DLNA|Kodi documentation]] for more information.
* '''Roku''': Roku is an appliance connected to a TV for playing Internet streaming services. Many TVs also have Roku built into them. In Roku interface, find a channel called 'Roku Media Player' and open it. You should see an item called 'freedombox: minidlna'. You should be able to browse and play media from it.
* '''Rhythmbox''': Rhythmbox is the default audio player on the popular GNU/Linux desktop environment GNOME. Open Rhythmbox and ensure that the side pane is open by clicking on 'Application menu -> View -> Side Pane'. In the side pane you should see 'freedombox:minidlna' under the 'Shared' section. You should be able to browse and play audio files from it. Video files will not show up.
=== Supported media formats ===
MiniDLNA supports a wide variety of video and audio file formats.
* '''Video''': Files ending with .avi, .mp4, .mkv, .mpg, .mpeg, .wmv, .m4v, .flv, .mov, .3gp, etc.
* '''Audio''': Files ending with .mp3, .ogg, .flac, .wav, .pcm, .wma, .fla, .aac, etc.
* '''Image''': Files ending with .jpg, .jpeg
* '''Playlist''': Files ending with .m3u, .pls
* '''Captions''': Files ending with .srt, .smi
Notably, it does '''not''' support the following file extensions. Renaming the file to a known extension seems to work in most cases.
* '''Video''': Files ending with .webm
In addition to file format support from MiniDLNA, your media player or device needs to support the audio/video codecs with which the media has been encoded. MiniDLNA does not have the ability to translate files into a codec understood by the player. If you face problems with media playback, use the VLC player to find the codecs used in the media and the check your device or media player documentation on whether the codecs are supported.
=== File systems for external drives ===
If using an external drive that is used also from a Windows system the
preferred filesystem should be NTFS. NTFS will keep Linux file permissions and
UTF8 encoding for file names. This is useful if file names are in
your language.
=== External links ===
http://minidlna.sourceforge.net/
https://en.wikipedia.org/wiki/Digital_Living_Network_Alliance
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

24
doc/manual/en/Monkeysphere.raw.wiki Normal file
View File

@ -0,0 +1,24 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Monkeysphere|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Monkeysphere ==
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 [[http://web.monkeysphere.info/getting-started-ssh/|Monkeysphere SSH documentation]] 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 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 [[https://web.monkeysphere.info/download/|Monkeysphere website]].
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

55
doc/manual/en/Mumble.raw.wiki Normal file
View File

@ -0,0 +1,55 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Mumble|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Mumble (Voice Chat) Server ==
||<tablestyle="float: right;"> {{attachment:Mumble-icon_en_V01.png|Mumble icon}} ||
'''Available since''': version 0.5
=== What is Mumble? ===
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.
=== Using Mumble ===
!FreedomBox includes the Mumble server. [[https://wiki.mumble.info/wiki/Main_Page|Clients]] are available for desktop and mobile platforms. Users can download one of these clients and connect to the server.
=== Port Forwarding ===
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:
* TCP 64738
* UDP 64738
=== Managing Permissions ===
A super user in Mumble has the ability to create administrator accounts who can in turn manage groups and channel permissions. This can be done after logging in with the username "!SuperUser" using the super user password. See [[https://wiki.mumble.info/wiki/Murmurguide|Mumble Guide]] for information on how to do this.. !FreedomBox currently does not offer a UI to get or set the super user password for Mumble. A super user password is automatically generated during Mumble setup. To get the password, login to the terminal as admin user using [[FreedomBox/Manual/Cockpit|Cockpit]] , [[FreedomBox/Manual/SecureShell|Secure Shell]] or the console. Then, to read the super user password that was automatically generated during Mumble installation run the following command:
{{{
sudo grep SuperUser /var/log/mumble-server/mumble-server.log
}}}
You should see output such as:
{{{
<W>2019-11-06 02:47:41.313 1 => Password for 'SuperUser' set to 'noo8Dahwiesh'
}}}
Alternatively, you can set a new password as follows:
{{{
sudo su -
echo "newpassword" | su mumble-server -s /bin/sh -c "/usr/sbin/murmurd -ini /etc/mumble-server.ini --readsupw"
}}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

21
doc/manual/en/NameServices.raw.wiki Normal file
View File

@ -0,0 +1,21 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/NameServices|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Name Services ==
Name Services provides an overview of ways the box can be reached from the public Internet: domain name, Tor Onion 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.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

292
doc/manual/en/Networks.raw.wiki Normal file
View File

@ -0,0 +1,292 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Networks|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Networks ==
This section describes how networking is setup by default in
!FreedomBox and how you can customize it. See also the [[FreedomBox/Manual/Firewall|Firewall]]
section for more information on how firewall works.
=== Default setup ===
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.
There are two scenarios it handles: when is a single ethernet
interface and when there are multiple ethernet interfaces.
==== Single ethernet interface ====
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 `internal` interface in `automatic` 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.
{{attachment:network_single.png}}
==== Multiple ethernet interface ====
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.
The first network interface is configured to be an WAN or `external`
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.
The remaining network interfaces are configured for the clients of a
router. They are configured as LAN or `internal` interfaces in
`shared` configuration mode. This means that all the services (both
external and internal) services are provided to who ever connects on
this interface. Further, the `shared` 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 `shared` 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.
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.
==== Wi-Fi configuration ====
All Wi-Fi interfaces are configured to be LAN or `internal` interfaces
in `shared` configuration mode. They are also configured to become
Wi-Fi access points with following details.
* Name of the access point will be `FreedomBox` plus the name of the
interface (to handle the case where there are multiple of them).
* Password for connecting to the interface will be `freedombox123`.
=== Internet Connection Sharing ===
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 `shared` mode connection or using an `internal` connection.
When an interface is set in `shared` 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.
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 `internal` 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 `internal` mode are configured to `masquerade` packets from local machines to the Internet and receive packets from Internet and forward them back to local machines.
=== Customization ===
The above default configuration may not be fit for your setup. You
can customize the configuration to suit your needs from the `Networks`
area in the 'setup' section of the !FreedomBox web interface.
==== PPPoE connections ====
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.
==== Connect to Internet via Wi-Fi ====
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 `Infrastructure` instead of `Access Point` mode and `IPv4 Addressing Method`
to `Automatic (DHCP)` instead of `Shared` 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.
===== Problems with Privacy Feature =====
!NetworkManager used by !FreedomBox to connect to the Wi-Fi networks has a privacy feature that uses a different identity when scanning for networks and when actually connecting to the Wi-Fi access point. Unfortunately, this causes [[https://askubuntu.com/questions/910185/rosewill-rnx-n600ube-connectivity-issue-on-ubuntu-17-04|problems]] with some routers that reject connections from such devices. Your connection won't successfully activate and disconnect after trying to activate. If you have control over the router's behaviour, you could also turn off the feature causing problem. Otherwise, the solution is to connect with a remote shell using [[FreedomBox/Manual/SecureShell|SSH]] or [[FreedomBox/Manual/Cockpit|Cockpit]], editing a file `/etc/NetworkManager/NetworkManager.conf` and adding the line `wifi.scan-rand-mac-address=no` in the `[device]` section. This turns off the privacy feature.
Edit a file:
{{{
$ sudo nano /etc/NetworkManager/NetworkManager.conf
}}}
Add the following:
{{{
[device]
wifi.scan-rand-mac-address=no
}}}
Then reboot the machine.
==== Adding a new network device ====
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.
* Then set firewall zone to `internal` and `external` appropriately.
* You can configure the interface to connect to a network or provide
network configuration to whatever machine connects to it.
* 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.
==== Configuring a mesh network ====
!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.
===== Joining a mesh network =====
To join an existing mesh network in your area, first consult the organizers and get information about the mesh network.
1. Create a new connection, then select the connection type as ''Wi-Fi''. In the following dialog, provide the following values:
||'''Field Name'''||'''Example Value'''||'''Explanation'''||
|| ''Connection Name'' || Mesh Join - BATMAN || The name must end with 'BATMAN' (uppercase) ||
|| ''Physical Interface'' || wlan0 || The Wi-Fi device you wish to use for joining the mesh network ||
|| ''Firewall Zone'' || External || Since you don't wish that participants in mesh network to use internal services of !FreedomBox ||
|| ''SSID'' || ch1.freifunk.net || As provided to you by the operators of the mesh network. You should see this as a network in ''Nearby Wi-Fi Networks'' ||
|| ''Mode'' || Ad-hoc || Because this is a peer-to-peer network ||
|| ''Frequency Band'' || 2.4Ghz || As provided to you by the operators of the mesh network ||
|| ''Channel'' || 1 || As provided to you by the operators of the mesh network ||
|| ''BSSID'' || 12:CA:FF:EE:BA:BE || As provided to you by the operators of the mesh network ||
|| ''Authentication'' || Open || Leave this as open, unless you know your mesh network needs it be otherwise ||
|| ''Passphrase'' || || Leave empty unless you know your mesh network requires one ||
|| ''IPv4 Addressing Method'' || Disabled || We don't want to request IP configuration information yet ||
Save the connection. Join the mesh network by activating this newly created connection.
1. Create a second new connection, then select the connection type as ''Generic''. In the following dialog, provide this following values:
||'''Field Name'''||'''Example Value'''||'''Explanation'''||
|| ''Connection Name'' || Mesh Connect || Any name to identify this connection ||
|| ''Physical Interface'' || bat0 || This interface will only show up after you successfully activate the connection in first step ||
|| ''Firewall Zone'' || External || Since you don't wish that participants in mesh network to use internal services of !FreedomBox ||
|| ''IPv4 Addressing Method'' || Auto || 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 ''Manual'' method ||
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.
===== Creating a mesh network =====
To create your own mesh network and share your Internet connection with the rest of the nodes in the network:
1. Follow the instructions as provided above in step 1 of ''Joining a mesh network'' but choose and fix upon your own valid values for ''SSID'' (a name for you mesh network), ''Frequency Band'' (usually 2.4Ghz), ''Channel'' (1 to 11 in 2.4Ghz band) and ''BSSID'' (a hex value like 12:CA:DE:AD:BE:EF). Create this connection and activate it.
2. Follow the instructions as provided above in step 2 of ''Joining a mesh network'' but select ''IPv4 Addressing Method'' as ''Shared''. 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.
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 ''Joining a mesh network'' but use the values for ''SSID'', ''Frequency Band'' and ''Channel'' that you have chosen when you created the mesh network.
=== Advanced Network Operations ===
Cockpit provides many advanced networking features over those offered by !FreedomBox. Both !FreedomBox and Cockpit operate over Network Manager and are hence compatible with each other. Some of the functions provided by Cockpit include:
* Set the maximum transmission unit (MTU) for a network connection
* Change the hardware address (MAC address) of a network interface
* Add more DNS servers and configure routing of a network connection
* Creating bonded devices for highly available network interfaces
* Creating bridge devices to join network interfaces for aggregating separate networks
* Manage VLAN for creating virtual partitions in the physical network
{{attachment:networks-cockpit.png}}
=== Manual Network Operation ===
!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.
On the command line interface:
For text based user interface for configuring network connections:
{{{
nmtui
}}}
To see the list of available network devices:
{{{
nmcli device
}}}
To see the list of configured connections:
{{{
nmcli connection
}}}
To see the current status of a connection:
{{{
nmcli connection show '<connection_name>'
}}}
To see the current firewall zone assigned to a network interface:
{{{
nmcli connection show '<connection_name>' | grep zone
}}}
or
{{{
firewall-cmd --zone=internal --list-all
firewall-cmd --zone=external --list-all
}}}
To create a new network connection:
{{{
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
}}}
To change the firewall zone for a connection:
{{{
nmcli con modify "<connection_name>" connection.zone "<internal|external>"
}}}
For more information on how to use `nmcli` command, see its man page.
Also for a full list of configuration settings and type of connections
accepted by Network Manager see:
https://developer.gnome.org/NetworkManager/stable/ref-settings.html
To see the current status of the firewall and manually operate it, see
the [[FreedomBox/Manual/Firewall|Firewall]] section.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

133
doc/manual/en/OpenVPN.raw.wiki Normal file
View File

@ -0,0 +1,133 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/OpenVPN|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== OpenVPN (Virtual Private Network) ==
||<tablestyle="float: right;"> {{attachment:OpenVPN-icon_en_V01.png|OpenVPN icon}} ||
'''Available since''': version 0.7
=== What is OpenVPN? ===
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.
=== Port Forwarding ===
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 OpenVPN:
* UDP 1194
=== Setting up ===
1. In !FreedomBox apps menu, select ''Virtual Private Network (OpenVPN)'' and click Install.
1. After the module is installed, there is an additional setup step that may take a long time to complete. Click "Start setup" to begin.
{{attachment:plinth_openvpn.png|OpenVPN service page|width=800}}
1. Wait for the setup to finish. This could take a while.
1. Once the setup of the OpenVPN server is complete, you can download your profile. This will download a file called <USER>.ovpn, where <USER> is the name of a !FreedomBox user. Each !FreedomBox user will be able to download a different profile. Users who are not administrators can download the profile from home page after login.
1. The ovpn file contains all the information a vpn client needs to connect to the server.
1. The downloaded profile contains the domain name of the !FreedomBox that the client should connect to. This is picked up from the domain configured in 'Config' section of 'System' page. In case your domain is not configured properly, you may need to change this value after downloading the profile. If your OpenVPN client allows it, you can do this after importing the OpenVPN profile. Otherwise, you can edit the .ovpn profile file in a text editor and change the 'remote' line to contain the WAN IP address or hostname of your !FreedomBox as follows.
{{{
client
remote mybox.sds-ip.de 1194
proto udp
}}}
=== Browsing Internet after connecting to VPN ===
After connecting to the VPN, the client device will be able to browse the Internet without any further configuration. However, a pre-condition for this to work is that you need to have at least one Internet connected network interface which is part of the 'External' firewall zone. Use the networks configuration page to edit the firewall zone for the device's network interfaces.
=== Usage ===
==== On Android/LineageOS ====
1. Visit !FreedomBox home page. Login with your user account. From home page, download the OpenVPN profile. The file will be named ''username''.ovpn.
{{attachment:openvpn_download_profile.png|OpenVPN Download Profile|width=324}}
1. Download an OpenVPN client such as ''OpenVPN for Android''. F-Droid repository is recommended. In the app, select import profile.
{{attachment:openvpn_install_app.png|OpenVPN App|width=324}}
1. In the select profile dialog, choose the ''username''.opvn file you have just downloaded. Provide a name for the connection and save the profile.
{{attachment:openvpn_import_profile.png|OpenVPN import profile|width=324}}
1. Newly created profile will show up. If necessary, edit the profile and set the domain name of your !FreedomBox as the server address.
{{attachment:openvpn_profile_created.png|OpenVPN profile created|width=324}}
{{attachment:openvpn_edit_domain_name.png|OpenVPN edit domain name|width=324}}
1. Connect by tapping on the profile.
{{attachment:openvpn_connect.png|OpenVPN connect|width=324}}
{{attachment:openvpn_connected.png|OpenVPN connected|width=324}}
1. When done, disconnect by tapping on the profile.
{{attachment:openvpn_disconnect.png|OpenVPN disconnect|width=324}}
==== On Debian ====
Install an OpenVPN client for your system
{{{
$ sudo apt install openvpn
}}}
Open the ovpn file with the OpenVPN client.
{{{
$ sudo openvpn --config /path/to/<USER>.ovpn
}}}
If you use Network Manager, you can create a new connection by importing the file:
{{{
$ sudo apt install network-manager-openvpn-gnome
$ sudo nmcli connection import type openvpn file /path/to/<USER>.ovpn
}}}
If you get an error such as `configuration error: invalid 1th argument to “proto” (line 5)` then edit the .ovpn file and remove the line `proto udp6`.
=== Checking if you are connected ===
==== On Debian ====
1. Try to ping the !FreedomBox or other devices on the local network.
1. Running the command `ip addr` should show a `tun0` connection.
1. The command `traceroute freedombox.org` should show you the ip address of the VPN server as the first hop.
=== Accessing internal services ===
After connecting to OpenVPN, you will be able to access !FreedomBox services that are only meant to be accessed on internal networks. This is in addition to being able to access external services. This can be done by using the IP address 10.91.0.1 as the host name for these services.
The following services are known to '''work''':
* [[FreedomBox/Manual/Privoxy|Privoxy]],
* [[FreedomBox/Manual/Tor|Tor Socks]],
* [[FreedomBox/Manual/Shadowsocks|Shadowsocks]],
* [[FreedomBox/Manual/I2P|I2P Proxy]] and
* [[FreedomBox/Manual/Samba|Samba]].
Some services are known '''not''' to work at this time:
* Avahi,
* [[FreedomBox/Manual/Bind|bind]] and
* [[FreedomBox/Manual/MiniDLNA|MiniDLNA]].
=== External Links ===
https://community.openvpn.net/openvpn
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

39
doc/manual/en/OrangePiZero.raw.wiki Normal file
View File

@ -0,0 +1,39 @@
== Orange Pi Zero ==
{{attachment:orange-pi-zero.jpg|Orange Pi Zero|width=649,height=537}}
[[http://www.orangepi.org/orangepizero/|Orange Pi Zero]] is a single board computer available at very low price. It uses the Allwinner H2 SoC, and has 256MB/512MB DDR3 SDRAM. It doesn't require any non-free firmware to run !FreedomBox. However, the onboard Wi-Fi module needs proprietary firmware to work. The board is available in two versions: with 256MB RAM and 512MB RAM. The version with 512 MB RAM is recommended for !FreedomBox. Even then, !FreedomBox is expected to gracefully run only a small number of services.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device.
=== Availability ===
* [[https://www.aliexpress.com/store/group/H2/1553371_511831299.html|AliExpress]]
=== Hardware ===
* CPU: ARM Cortex-A7 Quad-Core (Allwinner H2)
* RAM: 256MB/512MB DDR3 SDRAM
* Storage: Up to 32GB on uSD slot, 2MB SPI Flash
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: Onboard 802.11 b/g/n, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
=== Non-Free Status ===
* Non-free blobs required: No (without Wi-Fi)
* Wi-Fi: no free Wi-Fi drivers + firmware available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Orange Pi Zero image is licensed under a Creative Commons Attribution 3.0 Unported License by [[https://linux-sunxi.org/File:OPi_Zero_Top.jpg|Linux Sunxi]].

34
doc/manual/en/PageKite.raw.wiki Normal file
View File

@ -0,0 +1,34 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/PageKite|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== PageKite (Public Visibility) ==
=== What is PageKite? ===
!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 https://pagekite.net.
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.
=== Using PageKite ===
1. Create an account on a !PageKite relay service.
1. Add a kite to your account. Note your kite name and kite secret.
1. In !FreedomBox, go to the "Configure !PageKite" tab on the Public Visibility (!PageKite) page.
1. Check the "Enable !PageKite" box, then enter your kite name and kite secret. Click "Save settings".
1. On the "Standard Services" tab, you can enable HTTP and HTTPS (recommended) and SSH (optional).
* HTTP is needed to obtain the Let's Encrypt certificate. You can disable it later.
1. On the [[FreedomBox/Manual/LetsEncrypt|Certificates (Let's Encrypt)]] page, you can obtain a Let's Encrypt certificate for your kite name.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

25
doc/manual/en/Performance.raw.wiki Normal file
View File

@ -0,0 +1,25 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Performance|Español]] -~
## BEGIN_INCLUDE
== Performance (System Monitoring) ==
'''Available since''': version 20.9.7
Performance app allows you to collect, store and view information about utilization of the hardware. This can gives you basic insights into usage patterns and whether the hardware is overloaded by users and services.
Performance metrics are collected by Performance Co-Pilot and can be viewed using the [[FreedomBox/Manual/Cockpit|Cockpit]] app. When this system app is installed and enabled, cockpit's graphs shows the past (up to one year at a time).
{{attachment:performance-one-week.png}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

48
doc/manual/en/PineA64+.raw.wiki Normal file
View File

@ -0,0 +1,48 @@
== Pine A64+ ==
{{attachment:pine64-plus.jpg|Pine 64+|width=640,height=579}}
[[https://www.pine64.org/?page_id=1194|Pine A64+]] is an affordable single board computer with good performance.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
* Both 1GB and 2GB versions of Pine A64+ are supported with the same !FreedomBox image.
* Pine A64-LTS is not supported yet.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox. Pick the image meant for Pine A64+.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 29 USD (for the 2 GB variant), 21 USD (for the 1 GB variant)
* [[https://www.pine64.org/?product=pine-a64-board-1gb|Pine A64+ with 1 GB RAM at Pine64 Store]]
* [[https://www.pine64.org/?product=pine-a64-board-2gb|Pine A64+ with 2 GB RAM at Pine64 Store]]
=== Hardware ===
* Open Source Hardware (OSHW): No
* CPU: Allwinner A64, Quad-core ARM Cortex A53 64-bit processor
* RAM: 3 variants - 512 MB (not recommended), 1 GB and 2 GB (recommended)
* Storage: SD card, eMMC (module sold separately but not tested with !FreedomBox)
* Architecture: arm64
* Ethernet: Gigabit Ethernet port
* Battery: Supports battery backup using a Li-Po battery
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

176
doc/manual/en/PioneerEdition.raw.wiki Normal file
View File

@ -0,0 +1,176 @@
<<TableOfContents()>>
## BEGIN_INCLUDE
== Pioneer Edition FreedomBox ==
Pioneer !FreedomBox Home Servers are produced and sold by Olimex, a company which specializes in Open Source Hardware (OSHW). The kit includes pocket-sized server hardware, an SD card with the operating system pre-installed, and a backup battery which can power the hardware for 4-5 hours in case of outages. It sells for 69 euro. An optional storage add-on for high capacity hard disk (HDD) or solid-state drive (SSD) is also available from Olimex. By purchasing this product, you also support the !FreedomBox Foundation's efforts to create and promote its free and open source server software.
{{attachment:pioneer-edition.jpg|Pioneer Edition FreedomBox Home Server Kit|width=320,height=257}}
=== Product Features ===
The [[https://www.olimex.com/Products/OLinuXino/Home-Server/Pioneer-FreedomBox-HSK/|Pioneer Edition FreedomBox Home Server Kit]] includes all the hardware needed for launching a !FreedomBox home server on an Olimex [[FreedomBox/Hardware/A20-OLinuXino-Lime2|A20-OLinuXino-LIME2]] board:
* the A20-!OlinuXino-LIME2,
* a custom metal case with a laser-engraved !FreedomBox logo,
* a high-speed 32GB micro SD card with the !FreedomBox software pre-installed,
* a backup battery,
* a power adapter, and
* an Ethernet cable.
* an optional storage add-on for hard disk (HDD) or solid-state drive (SSD)
=== Recommended Hardware ===
This is the hardware recommended for all users who just want a turn-key !FreedomBox, and '''don't''' want to '''build''' their own one.
(Building your own !FreedomBox means some technical stuff like choosing and buying the right components, downloading the image and preparing the SD card).
=== Availability ===
The Pioneer Edition !FreedomBox Home Server is the first commercially available version of !FreedomBox.
* Price: 69 EUR
* [[https://www.olimex.com/Products/OLinuXino/Home-Server/Pioneer-FreedomBox-HSK/|Olimex Store]]
* The US version is also available through [[https://www.mouser.com/ProductDetail/Olimex-Ltd/Pioneer-FreedomBox-HSK-US?qs=TiOZkKH1s2S0e0CDanQrkw%3D%3D|Mouser Electronics]].
=== Hardware Specifications ===
Pioneer Edition !FreedomBox Home Server is based on A20-OLinuXino-LIME2 Rev.G.
* Open Source Hardware (OSHW): [[https://github.com/OLIMEX/OLINUXINO/tree/master/HARDWARE|Yes]]
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 1 GiB DDR3
* Storage: 32GB class 10+ microSD card pre-loaded with !FreedomBox
* SATA: 1 SATA port 2.6 compliant 3Gb/s
* USB: 2 USB 2.0 Hi-Speed host ports
* Battery: 3.3V Li-Po, 1400mAh (4-5 hours of backup without additional devices connected via USB)
* Ethernet: 10/100/1000, RJ45 (1 meter cable included)
* Power adapter: 110-220 V input, 5V output, EU style (with optional UK or US sockets)
* Power consumption: 1.5W and 5W depending on load (0.3A to 1A current)
* Box: Custom metallic box with !FreedomBox decal
Further information:
* [[https://www.olimex.com/Products/OLinuXino/Home-Server/Pioneer-FreedomBox-HSK/open-source-hardware|Quick start leaflet]]
* [[https://www.olimex.com/Products/OLinuXino/Home-Server/Pioneer-FreedomBox-HSK/open-source-hardware|Hardware source files]]
* [[https://www.olimex.com/Products/OLinuXino/Home-Server/Pioneer-FreedomBox-HSK/open-source-hardware|A20-OLinuXino-LIME2 rev.G schematic]]
* [[http://dl.linux-sunxi.org/A20/A20%20Brief%202013-02-27.pdf|A20 SOC datasheet]]
The kits run entirely on Free Software. They work with Kernel and u-boot from Debian repositories. Even the boot firmware in ROM called [[https://linux-sunxi.org/BROM|BROM]] is free software (GPLV2+).
=== Storage Add-on ===
You can order a storage add-on along with the Pioneer Edition !FreedomBox Home Server. The storage add-on is a SATA disk drive enclosure case optionally with a hard disk or solid-state drive of size 128GB to 2000GB. If you have already purchased the Home Server without the add-on, you can order the add-on separately.
* [[https://www.olimex.com/Products/OLinuXino/Home-Server/BAY-HDD-1000GB/|Olimex Store]]
* Price: 9 EUR (without the hard disk, only for the case, you need to add your own HDD/SSD to it)
* Price: 42 EUR (with 128GB Solid-State Drive)
* Price: 69 EUR (with 512GB Solid-State Drive)
* Price: 42 EUR (with 320GB Hard Disk)
* Price: 53 EUR (with 500GB Hard Disk)
* Price: 64 EUR (with 1000GB Hard Disk)
* Price: 86 EUR (with 2000GB Hard Disk)
=== Download ===
The kits come with an SD card pre-loaded with !FreedomBox. There's '''NO need to download images'''.
However, if you wish to reset your devices to a pristine state, then you can do so with the image provided. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device. Make sure to download the [[https://ftp.freedombox.org/pub/freedombox/pioneer/|Pioneer Edition]] images. These SD card images are meant for use with the on-board SD card slot and won't work when used with a separate SD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Build Image ===
!FreedomBox images for this hardware can be built using [[FreedomBox/Maker|Freedom Maker]].
=== Known Issues ===
* The image that shipped with the kits uses a [[https://salsa.debian.org/freedombox-team/u-boot|slightly modified u-boot]] from Debian and not stock Debian like the rest of !FreedomBox. So, if you wish to get the source code, please use the !FreedomBox team's [[https://salsa.debian.org/freedombox-team/u-boot|u-boot repository]].
=== Obtaining Source Code ===
After you purchase and receive your Pioneer Edition FreedomBox, you may want to obtain the source code of the software running in it. Continue reading this section for instructions.
!FreedomBox is fully [[https://www.gnu.org/philosophy/free-sw.html|free software]] and you can obtain the source code to study, modify and distribute improvements.
==== From within FreedomBox ====
!FreedomBox is made up of several software programs and you can obtain the source code to any of them. These instructions are similar to obtaining and [[https://www.debian.org/doc/manuals/maint-guide/build.en.html|building]] [[https://www.debian.org/doc/manuals/apt-howto/ch-sourcehandling.en.html|source code]] [[https://wiki.debian.org/BuildingTutorial|for Debian]] since !FreedomBox is a pure blend of Debian. Using this process you can obtain the source code to the exact version of the package you are currently using in !FreedomBox.
1. To see the list of software packages installed on your !FreedomBox, run the following in a terminal:
{{{
dpkg -l
}}}
1. To obtain the source code for any of those programs, then run:
{{{
apt source <package_name>
}}}
This requires that the file [[https://www.debian.org/doc/manuals/apt-howto/ch-basico.en.html|/etc/apt/sources.list]] file contains the information about the source code repositories. These are present by default on all !FreedomBox images. If you have installed !FreedomBox using a package from Debian, you need to ensure that source repositories are added in the file.
1. To build the package from source code, first install its dependencies
{{{
apt build-dep <package_name>
}}}
Switch to the source directory created by the ''apt source'' command:
{{{
cd <source_directory>
}}}
Then build the package
{{{
dpkg-buildpackage -rfakeroot -uc
}}}
1. Install the package:
{{{
dpkg -i ../<built_package>.deb
}}}
==== Other Ways to Obtain Source Code ====
1. Source code for any of the packages can be browsed and searched using the web interface at [[https://sources.debian.org/|sources.debian.org]]. For example, see the [[https://sources.debian.org/src/plinth/|plinth]] package.
1. Source code and pre-built binary package for any version of a package including historic versions can be obtained from [[https://snapshot.debian.org/|snapshot.debian.org]]. For example, see the [[https://snapshot.debian.org/package/plinth/|plinth]] package.
1. You can also obtain the links to upstream project homepage, upstream version control, Debian's version control, changelog, etc. from the Debian tracker page for a project at [[https://tracker.debian.org/|tracker.debian.org]]. For example, see the tracker page for [[https://tracker.debian.org/pkg/plinth|plinth]] package.
1. You can build and install a package from its Debian's version control repository. For example,
{{{
git clone https://salsa.debian.org/freedombox-team/freedombox.git
cd freedombox
apt build-dep .
dpkg-buildpackage -rfakeroot -uc
dpkg -i ../freedombox*.deb
}}}
==== Building Disk Images ====
You can also build !FreedomBox disk images for various hardware platforms using the freedom-maker tool. This is also available as a Debian package and source code for it may be obtained using the above methods. [[https://salsa.debian.org/freedombox-team/freedom-maker/blob/master/README.md|Build instructions]] for creating disk images are available as part of the source code for freedom-maker package.
!FreedomBox disk images are built and uploaded to official servers using automated Continuous Integration infrastructure. This infrastructure is available as [[https://salsa.debian.org/freedombox-team/infrastructure|source code]] too and provides accurate information on how !FreedomBox images are built.
==== U-boot on Pioneer Edition Images ====
There is one minor exception to the u-boot package present on the hardware sold as !FreedomBox Home Server Kits Pioneer Edition. It contains an small but important fix that is not part of Debian sources. The fork of the Debian u-boot source repository along with the minor change done by the !FreedomBox is available as a [[https://salsa.debian.org/freedombox-team/u-boot|separate repository]]. We expect this change to be available in upstream u-boot eventually and this repository will not be needed. This package can be built on a Debian armhf machine as follows (cross compiling is also possible, simply follow instructions for cross compiling Debian packages):
{{{
apt install git git-buildpackage
git clone https://salsa.debian.org/freedombox-team/u-boot.git
cd u-boot
pbuilder create --distribution=buster
gbp buildpackage --git-pbuilder
}}}
The u-boot Debian package will be available in ''u-boot-sunxi*.deb''. This package will contain
{{{
mkdir temp
dpkg -x u-boot-suxi*.deb temp
unxz <lime2_image_built_with_freedom_maker>
dd if=temp/usr/lib/u-boot/A20-OLinuXino-Lime2/u-boot-sunxi-with-spl.bin of=<lime2.img> seek=8 bs=1k conv=notrunc
}}}
The resulting image will have the modified u-boot in it.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

71
doc/manual/en/Plinth.raw.wiki Normal file
View File

@ -0,0 +1,71 @@
== FreedomBox Service (Plinth) ==
!FreedomBox Service (Plinth) is a web interface to administer the functions of the !FreedomBox.
!FreedomBox Service is [[https://www.gnu.org/philosophy/|Free Software]] under [[https://www.gnu.org/licenses/agpl.html|GNU Affero General Public License]] version 3 or (at your option) a later version.
=== Using ===
* !FreedomBox Service comes installed with all !FreedomBox images. You can [[FreedomBox/Download|download]] !FreedomBox images and run on any of the supported hardware. Then, you can access !FreedomBox Service by visiting the URL [[http://freedombox/plinth]] or [[https://freedombox.local/plinth]].
* If you are on a Debian box, you may install !FreedomBox Service from Debian package archive. Currently, only Buster (stable), Bullseye (testing), and Sid (unstable) are supported. To install !FreedomBox Service run:
{{{
$ sudo apt-get install freedombox
}}}
* You can also get !FreedomBox Service from its [[https://salsa.debian.org/freedombox-team/freedombox/|Git repository]] and [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/INSTALL.md|install from source]].
=== Screenshots ===
[[attachment:freedombox-screenshot-home.png|{{attachment:freedombox-screenshot-home.png|Home Page|width=300}}]]
[[attachment:freedombox-screenshot-apps.png|{{attachment:freedombox-screenshot-apps.png|Apps Page|width=300}}]]
[[attachment:freedombox-screenshot-system.png|{{attachment:freedombox-screenshot-system.png|System Page|width=300}}]]
[[attachment:freedombox-screenshot-tor.png|{{attachment:freedombox-screenshot-tor.png|Enabling Tor Onion Services|width=300}}]]
[[attachment:freedombox-screenshot-ttrss.png|{{attachment:freedombox-screenshot-ttrss.png|Newsfeed from anywhere|width=300}}]]
[[attachment:freedombox-screenshot-roundcube.png|{{attachment:freedombox-screenshot-roundcube.png|Email Client|width=300}}]]
[[attachment:freedombox-screenshot-manual.png|{{attachment:freedombox-screenshot-manual.png|Manual Pages|width=300}}]]
[[attachment:freedombox-screenshot-about.png|{{attachment:freedombox-screenshot-about.png|About Page|width=300}}]]
=== Support ===
You may ask for support on
* [[https://discuss.freedombox.org/|The discussion forum]]
* [[AliothList:freedombox-discuss|The mailing list]]
* [[irc://irc.debian.org/freedombox|#freedombox IRC channel]]
* [[https://matrix.to/#/#freedombox:matrix.org|FreedomBox Matrix channel]]
=== Contributing ===
We are looking for help to improve !FreedomBox Service. You can contribute to !FreedomBox Service by not just by coding but also by translating, documenting, designing, packaging and providing support.
* Instructions on how to [[FreedomBox/Contribute/Code|contribute code]] are available.
* The primary Git repository is hosted at [[https://salsa.debian.org/freedombox-team/freedombox/|FreedomBox Salsa Page]].
* Instructions for [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/INSTALL.md|installing from source]] and [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/HACKING.md|hacking the source]] are available.
* List of bugs, TODO items and feature requests are available on the [[https://salsa.debian.org/freedombox-team/freedombox/issues|issue tracker]].
* Before contributing to !FreedomBox Service code, you need understand [[https://www.python.org/|Python]] and [[https://www.djangoproject.com/|Django]] on top which it is built.
* You can request for development assistance on [[https://discuss.freedombox.org/|the discussion forum]], [[AliothList:freedombox-discuss|the mailing list]] or the [[irc://irc.debian.org/freedombox|#freedombox IRC channel]].
==== Debian Package ====
* !FreedomBox Service is [[DebianPkg:freedombox|packaged]] for Debian. !FreedomBox Service is a native package and packaging source code is part of the main package source code.
* Issues related to packaging are listed on [[DebianBug:freedombox|Debian BTS]].
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

22
doc/manual/en/Power.raw.wiki Normal file
View File

@ -0,0 +1,22 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Power|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Power ==
To restart or shut down !FreedomBox, click the user dropdown menu on the top right of the page. After you select "Restart" or "Shut Down", you will be asked to confirm.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

58
doc/manual/en/Privoxy.raw.wiki Normal file
View File

@ -0,0 +1,58 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Privoxy|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Privoxy (Web Proxy) ==
||<tablestyle="float: right;"> {{attachment:Privoxy-icon_en_V01.png|Privoxy icon}} ||
'''Available since''': version 0.1
A web proxy acts as a filter for incoming and outgoing web traffic. Thus, you can instruct any computer in your network to pass internet traffic through the proxy to remove unwanted ads and tracking mechanisms.
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: [[https://www.privoxy.org/faq/index.html|Privoxy FAQ]]).
=== Screencast ===
Watch the [[attachment:Privoxy_Installation.webm|screencast]] on how to setup and use Privoxy in !FreedomBox.
=== Setting up ===
1. In !FreedomBox, install ''Web Proxy (Privoxy)''
{{attachment:Privoxy-Installation.png|Privoxy Installation|width=800}}
1. 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.
{{attachment:Privoxy-BrowserSettings.png|Privoxy Browser Settings|width=800}}
1. Go to page http://config.privoxy.org/ or 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.
1. 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.
=== Advanced Users ===
1. 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.
1. While using Privoxy, you can see its configuration details and documentation at http://config.privoxy.org/ or http://p.p.
1. To enable changing these configurations, you first have to change the value of `enable-edit-actions` in `/etc/privoxy/config` to `1`. Before doing so, read carefully the manual, especially:
''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.''
1. Now you find an `EDIT` button on the configuration screen in `http://config.privoxy.org/`.
1. The [[https://www.privoxy.org/user-manual/quickstart.html|Quickstart]] is a good starting point to read on how to define own blocking and filtering rules.
## END_INCLUDE
----
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

97
doc/manual/en/Quassel.raw.wiki Normal file
View File

@ -0,0 +1,97 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Quassel|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Quassel (IRC Client) ==
||<tablestyle="float: right;"> {{attachment:Quassel-icon_en_V02.png|Quassel icon}} ||
'''Available since''': version 0.8
''Quassel'' 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.
=== Why run Quassel? ===
Many discussions about !FreedomBox are being done on the IRC-Channel `irc://irc.debian.org/freedombox`. If your !FreedomBox is running ''Quassel'', 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 ''client'' to connect to the ''Quassel'' core to read and respond whenever you have time and are available.
=== How to setup Quassel? ===
* Within !FreedomBox's web interface
1. select ''Applications''
1. go to ''IRC Client (Quassel)'' and
1. install the application and make sure it is enabled
{{attachment:Quassel_Installation.png|Quassel Installation|width=800}}
1. now your Quassel core is running
=== Port Forwarding ===
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 Quassel:
* TCP 4242
* Example configuration in router:
{{attachment:Quassel_PortForwarding_en_v01.png}}
=== Clients ===
Clients to connect to Quassel from your [[http://quassel-irc.org/downloads|desktop]] and [[https://quasseldroid.info/|mobile]] devices are available.
==== Desktop ====
In a Debian system, you can e.g. use [[https://packages.debian.org/search?keywords=quassel-client|quassel-client]]. 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.
1. Launch Quassel Client. You will be greeted with a wizard to `Connect to Core`.
{{attachment:quassel-client-1-connect-to-core.png|Connect to Core|width=394}}
1. Click the `Add` button to launch `Add Core Account` dialog.
{{attachment:quassel-client-2-add-core-account.png|Add Core Account|width=382}}
1. Fill any value in the `Account Name` field. Fill proper DNS hostname of your !FreedomBox in `Hostname` filed. `Port` field must have the value `4242`. Provide the username and password of the account you wish to create to connect to the Quassel Core in the `User` and `Password` fields. Choose `Remember` if don't wish to be prompted for a password every time you launch Quassel client.
1. After pressing `OK` in the `Add Core Account` dialog, you should see the core account in the `Connect to Core` dialog.
{{attachment:quassel-client-3-connect-to-core.png|Connect to Core|width=394}}
1. Select the newly created core account and select `OK` to connect to it.
1. If this is the first time you are connecting to this core. You will see an `Untrusted Security Certificate` warning and need to accept the server certificate.
{{attachment:quassel-client-4-untrusted-security-certficate.png|Untrusted Security Certificate|width=504}}
1. Select `Continue`. Then you will be asked if you wish to accept the certificate permanently. Select `Forever`.
{{attachment:quassel-client-5-untrusted-security-certificate.png|Untrusted Security Certificate|width=434}}
1. If this Quassel Core has not been connected to before, you will then see a `Core Configuration Wizard`. Select `Next`.
{{attachment:quassel-client-6-core-configuration-wizard.png|Core Configuration Wizard|width=504}}
1. In the `Create Admin User` page, enter the username and password you have used earlier to create the core connection. Select `Remember password` to remember this password for future sessions. Click `Next`.
{{attachment:quassel-client-7-create-admin-user.png|Create Admin User Page|width=504}}
1. In the `Select Storage Backend` page, select `SQLite` and click `Commit`.
{{attachment:quassel-client-8-select-storage-backend.png|Select Storage Backend|width=504}}
1. The core configuration is then complete and you will see a `Quassel IRC` wizard to configure your IRC connections. Click `Next`.
{{attachment:quassel-client-9-welcome-wizard.png|Welcome Wizard|width=504}}
1. In `Setup Identity` 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 `Next`.
{{attachment:quassel-client-10-setup-identity.png|Setup Identity|width=504}}
1. In `Setup Network Connection` 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).
{{attachment:quassel-client-11-setup-network-connection.png|Setup Network Connection|width=504}}
1. Select the server in the servers list and click `Edit`. In the `Server Info` dialog, set the port `6697` (consult your network's documentation for actual list of servers and their secure ports) and click `Use SSL`. Click `OK`. This is to ensure that communication between your !FreedomBox and the IRC network server is encrypted.
{{attachment:quassel-client-12-server-info.png|Server Info|width=390}}
{{attachment:quassel-client-13-server-info-ssl.png|Server Info SSL|width=390}}
1. Back in the `Setup Network Connection` dialog, provide a list of IRC channels (such as #freedombox) to join upon connecting to the network. Click `Save & Connect`.
{{attachment:quassel-client-14-setup-network-connection.png|Setup Network Connection|width=504}}
1. You should connect to the network and see the list of channels you have joined on the `All Chats` pane on the left of the Quassel Client main window.
{{attachment:quassel-client-15-quassel-main.png|Quassel Main Window|width=644}}
1. Select a channel and start seeing messages from others in the channel and send your own messages.
==== Android ====
For Android devices you may use e.g. ''Quasseldroid'' from [[https://f-droid.org/en/packages/com.iskrembilen.quasseldroid/|F-Droid]]
* enter core, username etc. as above
{{attachment:Quasseldroid.png}}
By the way, the German verb ''quasseln'' means ''talking a lot'', to ''jabber''.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

125
doc/manual/en/QuickStart.raw.wiki Normal file
View File

@ -0,0 +1,125 @@
#language en
#pragma section-numbers 2
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[de/FreedomBox/Handbuch/Schnelleinstieg|Deutsch]] - English - [[es/FreedomBox/Manual/QuickStart|Español]] -~
## BEGIN_INCLUDE
= Quick Start =
== What you need to get started ==
The easy way is to [[https://freedomboxfoundation.org/buy/|buy]] a !FreedomBox kit.
Alternatively you may choose to build it yourself, by gathering all the components:
* A supported [[FreedomBox/Hardware|device]] (including any device that can run Debian). We will call that the !FreedomBox in the rest of this manual.
* A power cable for your device.
* An ethernet cable.
* A microSD card (or equivalent storage media for your device), prepared according to the instructions on the [[FreedomBox/Download|Download]] page.
== How to get started ==
1. Plug one end of your ethernet cord into your !FreedomBox's ethernet port, and plug the other end into your router.
1. Power on the !FreedomBox.
* '''Note:''' On most single board computers, don't expect any output on a monitor connected via HDMI as the support may not exist in the kernel. See below to access and control your !FreedomBox via network.
1. On first boot, !FreedomBox will perform its initial setup (older versions of !FreedomBox reboot after this step). This process may take several minutes on some machines. After giving it about 10 minutes, proceed to the next step.
* '''Note:''' Currently, due a known bug, you need to restart your !FreedomBox after 10m and then proceed to the next step. /* Is this still the case? */
1. After the !FreedomBox has finished its initial setup, you can access its web interface through your web browser.
* If your computer is connected directly to the !FreedomBox through a second (LAN) ethernet port, you can browse to: http://freedombox/ or http://10.42.0.1/.
* If your computer supports mDNS (GNU/Linux, Mac OSX or Windows with mDNS software installed), you can browse to: http://freedombox.local/ (or http://the-hostname-you-entered-during-install.local/)
* If you know your way around the router's web interface, you can look up the IP address of the !FreedomBox there, and browse to that address.
* If none of these methods are available, then you will need to figure out the IP address of your !FreedomBox. You can use the "nmap" program from your computer to find its IP address:
{{{
nmap -p 80 --open -sV 192.168.0.0/24 (replace the ip/netmask with the one the router uses)
}}}
In most cases you can look at your current IP address, and change the last digits with zero to find your home network, like so: XXX.XXX.XXX.0/24
Your !FreedomBox will show up as an IP address with an open tcp port 80 using Apache httpd service on Debian, such as the example below which would make it accessible at http://192.168.0.165:
{{{
Nmap scan report for 192.168.0.165
Host is up (0.00088s latency).
PORT STATE SERVICE VERSION
80/tcp open http Apache httpd 2.4.17 ((Debian))
}}}
If nmap does not find anything with the above command, you can try replacing 192.168.0.0/24 with 10.42.0.255/24.
{{{
nmap -n -sP 10.42.0.255/24
}}}
The scan report will show something similar to the following:
{{{
Nmap scan report for 10.42.0.1
Host is up (0.00027s latency).
Nmap scan report for 10.42.0.50
Host is up (0.00044s latency).
}}}
In this example, the !FreedomBox is accessible at http://10.42.0.50. (10.42.0.1 is my laptop.)
1. On accessing !FreedomBox's web interface your browser will warn you that it communicates securely but that it regards the security certificate for doing so as invalid. This is a fact you need to accept because the certificate is auto generated on the box and therefore "self-signed" (the browser might also use words such as "untrusted", "not private", "privacy error" or "unknown issuer/authority"). Telling your browser that you are aware of this might involve pressing buttons such as "I understand the Risks", "proceed to ... (unsafe)" or "Add exception". After installation this certificate can be changed to a normal one using the Let's Encrypt option.
. {{attachment:ui_insecure_connection.png|Self-signed certificate warning|width=600}}
. {{attachment:ui_add_security_exception.png|Add Security Exception|width=400}}
1. The first time you access the !FreedomBox web interface, you will see a welcome page. Click the "Start Setup" button to continue.
. {{attachment:ui_firstboot_welcome.png|Welcome|width=500}}
If you have installed !FreedomBox using a [[FreedomBox/Hardware/Debian|Debian]] package, you will be asked for a secret key. This secret was generated during the installation of the Debian package. It can be read from the file `/var/lib/plinth/firstboot-wizard-secret`.
1. The next page asks you to provide a user name and password. Fill in the form, and then click "Create Account."
* Note: The user that you create here has ``Admin`` privileges and can also [[FreedomBox/Manual/SecureShell|log in using ssh]]. For additional security, you may want to use a separate account for administrative tasks and for your normal, daily use. You can add more users later.
. {{attachment:ui_firstboot_account.png|Account|width=500}}
1. After completing the form, you will be logged in to !FreedomBox's web interface and able to access apps and configuration through the interface.
. {{attachment:ui_firstboot_complete.png|Complete|width=500}}
Now you can try [[FreedomBox/Features|any of the Apps]] that are available on !FreedomBox.
== Finding your way around ==
=== Front page ===
The front page is the page that you will see when accessing the web root of your !FreedomBox. You can also access it by clicking the !FreedomBox logo in the top-left corner of the !FreedomBox's web interface.
The front page includes shortcuts to apps that have been installed and are enabled. For web apps, clicking the shortcut will take you directly to the app's web page. For other services, clicking the shortcut will show more information about the service.
{{attachment:ui_frontpage.png|Front page|width=600}}
{{attachment:ui_frontpage_with_app.png|Front page|width=600}}
=== Apps menu ===
The Apps menu can be accessed by clicking the grid icon, next to the !FreedomBox logo. This page lists all of the apps that are available for installing on !FreedomBox. Click the name of an app to visit its page, where you can install and configure it.
{{attachment:ui_apps.png|Apps|width=600}}
=== Help menu ===
The Help menu can be accessed by clicking the question mark icon in the top-right corner. It includes helpful links and the !FreedomBox manual.
{{attachment:ui_help.png|Help|width=600}}
=== System menu ===
The System menu can be accessed by clicking the gear icon in the top-left corner. It includes a number of pages related to system configuration.
{{attachment:ui_system.png|System|width=600}}
=== User menu ===
In the top-right corner, the name of the currently logged-in user is shown. A drop-down menu includes options for editing the current user or logging out of the user interface.
{{attachment:ui_user_menu.png|User|width=600}}
=== Burger menu ===
!FreedomBox's web interface is responsive. When the display or browser window is very narrow, menu options may be hidden.
{{attachment:ui_burger_icon.png|User|width=600}}
That is because the top menu options are collapsed into the burger icon shown at the top right corner of the window. Click on it to display a drop-down menu.
{{attachment:ui_burger_menu.png|User|width=600}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

186
doc/manual/en/Radicale.raw.wiki Normal file
View File

@ -0,0 +1,186 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Radicale|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Radicale (Calendar and Addressbook) ==
||<tablestyle="float: right;"> {{attachment:Radicale-icon_en_V01.png|Radicale icon}} ||
'''Available since''': version 0.9
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.
=== Why should I run Radicale? ===
Using Radicale, you can get rid of centralized services like Google Calendar or Apple Calendar (iCloud) data mining your events and social connections.
=== How to setup Radicale? ===
First, the Radicale server needs to be activated on your box.
* Within !FreedomBox Service:
1. select ''Apps''
2. go to ''Radicale (Calendar and Addressbook)'' and
3. 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.
4. define the access rights:
* Only the owner of a calendar/addressbook can view or make changes
* Any user can view any calendar/addressbook, but only the owner can make changes
* Any user can view or make changes to any calendar/addressbook
Note, that only users with a !FreedomBox login can access Radicale.
{{attachment:Radicale-Plinth.png}}
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.
Radicale provides a basic web interface, which only supports creating new calendars and addressbooks. To add events or contacts, an external [[https://radicale.org/master.html#documentation/supported-clients|supported client application]] is needed.
{{attachment:radicale_web.png}}
* Creating addressbook/calendar using the web interface
* Visit `https://`''IP-address-or-domain-for-your-server''`/radicale/`
* Log in with your !FreedomBox account
* Select "Create new addressbook or calendar"
* Provide a title and select the type
* Optionally, provide a description or select a color
* Click "Create"
* The page will show the URL for your newly created addressbook or calendar
Now open your client application to create new calendar and address books that will use your !FreedomBox and Radicale server. The Radicale website provides [[https://radicale.org/master.html#documentation/supported-clients|an overview of supported clients]], but do ''not'' use the URLs described there; !FreedomBox uses another setup, follow this manual. Below are the steps for two examples:
* Example of setup with Evolution client:
* Calendar
1. Create a new calendar
1. For "Type," select "CalDAV"
1. When "CalDAV" is selected, additional options will appear in the dialogue window.
1. URL: `https://`''IP-address-or-domain-for-your-server''`/radicale/`''user''`/`''calendar-name''`.ics/`. Items in ''italics'' need to be changed to match your settings.
* note the trailing `/` in the path, it is important.
1. Enable "Use a secure connection."
1. Name the calendar
{{attachment:Radicale-Evolution-Docu.png}}
* TODO/Tasks list: Adding a TODO/Tasks list is basically the same as a calendar.
* Contacts
* Follow the same steps described above and replace CalDAV with WebDAV. The extension of the address book will be .vcf.
=== Synchronizing over Tor ===
In !FreedomBox, setting up a calendar with Radicale over Tor is the same as over the clear net. Here is a short summary:
1. When logged in to !FreedomBox interface over Tor, click on Radicale, and at the prompt provide your !FreedomBox user name and password.
1. In the Radicale web interface, log in using your !FreedomBox user name and password.
1. Click on "Create new address book or calendar", provide a title, select a type, and click "Create".
1. Save the URL, e.g., `https://`''ONION-ADDRESS-FOR-YOUR-SERVER''`.onion/radicale/`''USERNAME''`/`''CALENDAR-CODE''`/`. Items in ''italics'' need to be changed to match your settings.
These instructions are for Thunderbird/Lightning. Note that you will need to be connected to Tor with the Tor Browser Bundle.
1. Open Thunderbird, install the Torbirdy add-on, and restart Thunderbird. (This may not be necessary.)
1. In the Lightning interface, under Calendar/Home in the left panel right click with the mouse and select "New calendar".
1. Select the location of your calendar as "On the Network".
1. Select CalDAV and for the location copy the URL, e.g., `https://`''ONION-ADDRESS-FOR-YOUR-SERVER''`.onion/radicale/`''USERNAME''`/`''CALENDAR-CODE''`/`. Items in ''italics'' need to be changed to match your settings.
1. Provide a name, etc. Click "Next". Your calendar is now syncing with your !FreedomBox over Tor.
1. If you have not generated a certificate for your !FreedomBox with "Let's Encrypt", you may need to select "Confirm Security Exception" when prompted.
=== Synchronizing with your Android phone ===
There are various Apps that allow integration with the Radicale server. This example uses DAVx5, which is available e.g. on [[https://f-droid.org/repository/browse/?fdid=at.bitfire.davdroid|F-Droid]].
If you intend to use !ToDo-Lists as well, the compatible app [[https://f-droid.org/repository/browse/?fdid=org.dmfs.tasks|OpenTasks]] has to be installed first.
Follow these steps for setting up your account with the Radicale server running on your !FreedomBox.
1. Install DAVx5
1. Create a new account on DAVx5 by clicking on the floating + button.
1. Select the second option as shown in the first figure below and enter the base url as ''https://<your.freedombox.address>/radicale/username/'' (don't miss the `/` at the end). DAVx5 will be able to discover both CalDAV and WebDAV accounts for the user.
1. Follow this video from [[https://www.davdroid.com/faq/existing-contacts-are-not-synced|DAVx5 FAQ]] to learn how to migrate your existing contacts to Radicale.
'''Synchronizing contacts'''
1. Click on the hamburger menus of CalDAV and CardDAV and select either "Refresh ..." in case of existing accounts or "Create ..." in case of new accounts (see the second screenshot below).
1. Check the checkboxes for the address books and calendars you want to synchronize and click on the sync button in the header. (see the third screenshot below)
{{attachment:DAVdroid-setup-account.png|DAVx5 account setup|width=288}}
{{attachment:DAVdroid-refresh.png|DAVx5 refresh|width=288}}
{{attachment:DAVdroid-sync-account.png|DAVx5 account sync|width=288}}
=== Advanced Users ===
==== Sharing resources ====
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 `User1` and `User2` are granted access to a calendar. This requires SSH-access to the !FreedomBox.
1. create a file `/etc/radicale/rights`
{{{
[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
}}}
* `[friends_calendar]` is just an identifier, can be any name.
* The `[owner-write]` section makes sure that owners have access to their own files
1. edit file `/etc/radicale/config` and make the following changes in section `[rights]`
{{{
[rights]
type = from_file
file = /etc/radicale/rights
}}}
1. Restart the radicale server or the !FreedomBox
==== Importing files ====
If you are using a contacts file exported from another service or application, it should be copied to: /var/lib/radicale/collections/''user''/''contact file name''.vcf.
=== Migrating from Radicale Version 1.x to Version 2.x ===
During the month of February 2019, radicale in Debian testing was upgraded from version 1.x to version 2.x. Version 2.x is a better version but is incompatible with data and configuration used with 1.x. Automatic upgrade mechanism in !FreedomBox, handled by unattended-upgrades does not automatically upgrade radicale to version 2.x due to changes in configuration files. However, !FreedomBox version 19.1, which is available on February 23rd, 2019 in testing will perform data and configuration migration to radicale version 2.x. Typical users require no action, this will happen automatically.
If for some reason, you need to manually run `apt dist-upgrade` on your machine, then radicale will be upgraded to 2.x and then !FreedomBox will not be able to perform its upgrade (due to upstream project deciding to remove migration tools in radicale 2.x version). To avoid this situation, the following process is recommended if you wish to perform an upgrade.
{{{
sudo su -
apt hold radicale
apt dist-upgrade
apt unhold radicale
}}}
However, if you already happen to perform an upgrade to radicale 2.x without help from !FreedomBox, you need to perform data and configuration migration yourself. Follow this procedure:
{{{
sudo su -
tar -cvzf /root/radicale_backup.tgz /var/lib/radicale/ /etc/radicale/ /etc/default/radicale
apt install -y python-radicale
python -m radicale --export-storage=/root/radicale-migration
cp -dpR /root/radicale-migration/collection-root /var/lib/radicale/collections/collection-root/
(remove this directory if it already exists. Or perhaps merge the contents.)
chown -R radicale:radicale /var/lib/radicale/collections/collection-root/
apt remove -y python-radicale
if [ -f /etc/radicale/config.dpkg-dist ] ; then cp /etc/radicale/config.dpkg-dist /etc/radicale/config ; fi
if [ -f /etc/default/radicale.dpkg-dist ] ; then cp /etc/default/radicale.dpkg-dist /etc/default/radicale ; fi
(After FreedomBox 19.1 is available, goto FreedomBox web interface and set your preference for calendar sharing again, if it is not the default option, as it will have been lost.)
}}}
Notes:
* python-radicale is an old package from radicale 1.x version that is still available in testing. This is a hack to use the `--export-storage` feature that is responsible for data migration. This feature is not available in radicale 2.x unfortunately.
* Files ending with .dpkg-dist will exist only if you have chosen 'Keep your currently-installed version' when prompted for configuration file override during radicale 2.x upgrade. The above process will overwrite the old configuration with new fresh configuration. No changes are necessary to the two configuration files unless you have changed the setting for sharing calendars.
* Note that during the migration, your data is safe in /var/lib/radicale/collections directory. New data will be created and used in /var/lib/radicale/collections/collections-root/ directory.
* The tar command takes a backup your configuration and data in /root/radicale_backup.tgz in case you do something goes wrong and you want to undo the changes.
=== Troubleshooting ===
1. If you are using !FreedomBox Pioneer Edition or installing !FreedomBox on Debian Buster, then radicale may not be usable immediately after installation. This is due to a bug which has been fixed later. To overcome the problem, upgrade !FreedomBox by clicking on 'Manual Update' from 'Updates' app. Otherwise, simply wait a day or two and let !FreedomBox upgrade itself. After that install radicale. If radicale is already installed, disable and re-enable it after the update is completed. This will fix the problem and get radicale working properly.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

54
doc/manual/en/RaspberryPi.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
== Raspberry Pi Model B+ ==
{{attachment:raspberrypi.jpg|Raspberry Pi (Model B+)|width=640,height=429}}
<<Include(FreedomBox/Hardware/Deprecated)>>
[[http://www.raspberrypi.org/products/model-b-plus/|Raspberry Pi]] (Model B+) is a popular single board computer developed with the intention of promoting teaching of basic computer science in schools. !FreedomBox images are built and tested for it. For using this board as !FreedomBox, a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]] that does not require non-free firmware is recommended.
''Note:'' The Debian architecture used for this device is `armel`. This means floating point computations are done in software and most operations are slower than what Raspberry Pi is capable of.
'''Recommendation:''' When you flash the FreedomBox image onto your SD card, we recommend that you use an SD card with at least 8GB of storage space.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox.
=== Build Image ===
!FreedomBox images for this hardware can be built using [[FreedomBox/Maker|Freedom Maker]].
=== Availability ===
* Price: 35 USD
* [[http://www.raspberrypi.org/products/model-b-plus/|List of official distributors]]
=== Hardware ===
* Open Hardware: No
* CPU: ARM1176JZF-S (ARMv6k) 700 MHz
* RAM: 512 MB
* Storage: MicroSD card slot
* Architecture: armel
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: boot firmware
* !WiFi: Not available
* Works with stock Debian kernel: No
=== Known Issues ===
* The Debian architecture used for this device is `armel`. This means floating point computations are done in software and generally most operations are slower than what Raspberry Pi is capable of.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Raspberry Pi image is licensed under Creative Commons Attribution-Share Alike 3.0 Unported license by [[https://commons.wikimedia.org/wiki/File:Raspberry_Pi_B%2B_top.jpg|Lucasbosch]].

43
doc/manual/en/RaspberryPi2.raw.wiki Normal file
View File

@ -0,0 +1,43 @@
== Raspberry Pi 2 Model B ==
{{attachment:raspberrypi2.jpg|Raspberry Pi 2|width=640,height=428}}
[[https://www.raspberrypi.org/products/raspberry-pi-2-model-b/|Raspberry Pi 2]] (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 Model B+ with much faster processor and more RAM. !FreedomBox images are built and tested for it.
Please do not expect any output on a monitor connected via HDMI to this device as it does not display anything beyond the message 'Starting kernel...'. See the [[FreedomBox/Manual/QuickStart|Quick Start page]] to access and control your !FreedomBox from network.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox.
=== Availability ===
* Price: 35 USD
* [[https://www.raspberrypi.org/products/raspberry-pi-2-model-b/|List of official distributors]]
=== Hardware ===
* Open Hardware: No
* CPU: 900 MHz quad-core ARM Cortex-A7
* RAM: 1 GB
* Storage: MicroSD card slot
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: boot firmware
* !WiFi: Not available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Raspberry Pi 2 image is licensed under Creative Commons Attribution-!ShareAlike 4.0 International license by [[https://commons.wikimedia.org/wiki/File:Raspberry_Pi_2_Model_B_v1.1_top_new_%28bg_cut_out%29.jpg|Multicherry]].

43
doc/manual/en/RaspberryPi3B+.raw.wiki Normal file
View File

@ -0,0 +1,43 @@
== Raspberry Pi 3 Model B+ ==
{{attachment:raspberrypi3bplus.jpg|Raspberry Pi 3 Model B+|width=640,height=418}}
[[https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/|Raspberry Pi 3 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 3 Model B with better Ethernet and a 5Ghz Wi-Fi. A !FreedomBox "testing" image is available for Raspberry Pi 3 Model B+.
Please do not expect any output on a monitor connected via HDMI to this device as it does not display anything beyond the message 'Starting kernel...'. See the [[FreedomBox/Manual/QuickStart|Quick Start page]] to access and control your !FreedomBox from network.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Download the "testing" image for Raspberry Pi 3 Model B+. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox.
=== Availability ===
* Price: 35 USD
* [[https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/|List of official distributors]]
=== Hardware ===
* Open Hardware: No
* CPU: 1.4GHz 64-bit quad-core ARMv8 CPU
* RAM: 1 GB
* Storage: MicroSD card slot
* Architecture: armhf
* Ethernet: 10/100/1000, RJ45
* !WiFi: 802.11ac but requires non-free firmware, instead use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: boot firmware
* !WiFi: Requires non-free firmware
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Raspberry Pi 3 Model B+ image is licensed under Creative Commons Attribution-!ShareAlike 2.0 license by [[https://commons.wikimedia.org/wiki/File:Raspberry_Pi_3_B%2B_(39906369025).png|Gareth Halfacree]].

44
doc/manual/en/RaspberryPi3B.raw.wiki Normal file
View File

@ -0,0 +1,44 @@
## page was renamed from FreedomBox/Hardware/RaspberryPi3
== Raspberry Pi 3 Model B ==
{{attachment:raspberrypi3.jpg|Raspberry Pi 3 Model B|width=640,height=421}}
[[https://www.raspberrypi.org/products/raspberry-pi-3-model-b/|Raspberry Pi 3 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. A !FreedomBox "testing" image is available for Raspberry Pi 3 Model B.
Please do not expect any output on a monitor connected via HDMI to this device as it does not display anything beyond the message 'Starting kernel...'. See the [[FreedomBox/Manual/QuickStart|Quick Start page]] to access and control your !FreedomBox from network.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Download the "testing" image for Raspberry Pi 3 Model B. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox.
=== Availability ===
* Price: 35 USD
* [[https://www.raspberrypi.org/products/raspberry-pi-3-model-b/|List of official distributors]]
=== Hardware ===
* Open Hardware: No
* CPU: 1.2GHz 64-bit quad-core ARMv8 CPU
* RAM: 1 GB
* Storage: MicroSD card slot
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: 802.11n but requires non-free firmware, instead use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: boot firmware
* !WiFi: Requires non-free firmware
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Raspberry Pi 3 image is licensed under Creative Commons Attribution-!ShareAlike 4.0 International license by [[https://commons.wikimedia.org/wiki/File:Raspberry_Pi_3_Model_B.png|Herbfargus]].

54
doc/manual/en/RaspberryPi4B.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
== Raspberry Pi 4 Model B ==
{{attachment:raspberrypi4b.jpg|Raspberry Pi 4 Model B|width=640,height=424}}
[[https://www.raspberrypi.org/products/raspberry-pi-4-model-b/|Raspberry Pi 4 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 3 Model B+ with better processor and ability to drive multiple displays. A !FreedomBox "testing" image is available for Raspberry Pi 4 Model B.
Please do not expect any output on a monitor connected via HDMI to this device as it does not display anything beyond the message 'Starting kernel...'. See the [[FreedomBox/Manual/QuickStart|Quick Start page]] to access and control your !FreedomBox from network.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
Before downloading and using !FreedomBox you need to ensure that latest [[https://github.com/pftf/RPi4|Raspberry Pi 4 UEFI Firmware]] is available on an SD card. See [[https://github.com/pftf/RPi4#installation|instructions]] on how to create an SD card with this firmware. The gist is that you download the firmware zip files, erase the SD card, create a FAT partition, unzip the files to SD card and finally insert the SD card into the board.
!FreedomBox images meant for all "arm64" hardware work well for this device. Currently only "testing" images work and "stable" images. However, the firmware must present in SD card. This means that !FreedomBox itself must be present on a different disk such as a USK flash disk or USB SATA disk. Follow the instructions on the download page to create a !FreedomBox USB disk and boot the device. These images also work well for USB 2.0 and USB 3.0 disk drives and the process for preparing them is same as for an SD card.
An alternative to downloading these images is to install Debian on the device and then install !FreedomBox on it.
=== Build Image ===
!FreedomBox images for this hardware can be built using [[FreedomBox/Maker|Freedom Maker]]. Use the target 'arm64' with distribution 'testing' to build the image for this board.
=== Availability ===
* Price: 35 USD (2GB RAM)
* Price: 50 USD (4GB RAM)
* Price: 75 USD (8GB RAM)
* [[https://www.raspberrypi.org/products/raspberry-pi-4-model-b/|List of official distributors]]
=== Hardware ===
* Open Hardware: No
* CPU: Broadcom BCM2711 SOC (4x Cortex-A72``@1.5GHz)
* RAM: 2 GB or 4GB or 8 GB
* Storage: MicroSD card slot
* USB: 2x USB 2.0, 2x USB 3.0, USB Type-C power supply
* Architecture: arm64
* Ethernet: 10/100/1000, RJ45
* !WiFi: 802.11ac but requires non-free firmware, instead use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: boot firmware
* !WiFi: Requires non-free firmware
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Raspberry Pi 4 Model B image is licensed under Creative Commons Attribution-!ShareAlike 4.0 license by [[https://commons.wikimedia.org/wiki/File:Raspberry_Pi_4_Model_B_-_Top.jpg|Michael Henzler]].

1273
doc/manual/en/ReleaseNotes.raw.wiki Normal file
View File

File diff suppressed because it is too large Load Diff

42
doc/manual/en/Repro.raw.wiki Normal file
View File

@ -0,0 +1,42 @@
## page was renamed from FreedomBox/Manual/repro
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Repro|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Repro (SIP Server) ==
{{{#!wiki caution
'''App removed'''
repro has been removed from Debian 10 (Buster), and therefore is no longer available in !FreedomBox.
}}}
## END_INCLUDE
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.
=== How to set up the SIP server ===
1. Configure the domain at /repro/domains.html on the !FreedomBox.
. {{attachment:repro_domains.png|Repro Domains|width=800}}
1. Add users at /repro/addUser.html.
. {{attachment:repro_users.png|Repro Users|width=800}}
1. Disable and re-enable the repro application in Plinth.
=== Port Forwarding ===
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:
* TCP 5060
* TCP 5061
* UDP 5060
* UDP 5061
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

51
doc/manual/en/Rock64.raw.wiki Normal file
View File

@ -0,0 +1,51 @@
== Rock64 ==
{{attachment:rock64.jpg|Rock64|width=640,height=420}}
Pine64's [[https://www.pine64.org/devices/single-board-computers/rock64/|Rock64]] is a powerful single board computer. It uses the Rockchip RK3328 Quad Core ARM64 processor. !FreedomBox images are built and tested for this device.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
Before downloading and using !FreedomBox you need to ensure that latest u-boot based firmware is installed into the SPI flash chip. Download the [[https://github.com/ayufan-rock64/linux-mainline-u-boot/releases/latest|latest u-boot]] to write to SPI flash and then see instructions on how to [[http://wiki.pine64.org/index.php?title=NOOB#Flashing_u-boot_to_SPI_Flash|write u-boot firmware into SPI flash]]. The gist is that you download and write an image to an SD card. Boot with SD card and wait for white LED to blink continuosly. After that power off remove SD card and proceed with !FreedomBox download.
!FreedomBox [[FreedomBox/Download|images]] meant for all "arm64" hardware work well for this device. However, u-boot firmware must present in SPI flash (or on a separate SD card, which is not explained here). Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device. These images also work well for eMMC disk which an optional attachment to this board and disk drives in USB 2.0 ports (but not in the USB 3.0 port). The process for preparing them is same as for an SD card.
An alternative to downloading these images is to [[InstallingDebianOn|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 25 USD (1GB)
* Price: 35 USD (2GB)
* Price: 45 USD (4GB)
* [[https://store.pine64.org/product/rockpro64-2gb-single-board-computer/|Pine64 Store]]
=== Hardware ===
* Open Source Hardware (OSHW): No
* CPU: Rockchip RK3328 Quad-Core SOC (4x Cortex A53@1.5Ghz)
* GPU: Mali 450MP2
* RAM: 1 GiB or 2 GiB or 4 GiB LPDDR3
* Storage: eMMC module slot, microSD slot, 16 MiB SPI Flash
* USB: 2x USB 2.0, 1x USB 3.0
* Architecture: arm64
* Ethernet: 10/100/1000, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
=== Known Issues ===
* !FreedomBox does not work when booted from USB 3.0 port (but works from eMMC, SD card or USB 2.0 disk).
* !FreedomBox does not work when booted form the top USB 2.0 port with some u-boot firmware versions (the one listed above). It only works with the bottom USB 2.0 port (the one closer to the board).
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

49
doc/manual/en/RockPro64.raw.wiki Normal file
View File

@ -0,0 +1,49 @@
== RockPro64 ==
{{attachment:rockpro64.jpg|RockPro64|width=640,height=385}}
Pine64's [[https://www.pine64.org/rockpro64/|RockPro64]] is a powerful single board computer. It uses the Rockchip RK3399 Hexa Core ARM64 processor. !FreedomBox images are built and tested for this device.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
Before downloading and using !FreedomBox you need to ensure that latest u-boot based firmware is installed into the SPI flash chip. See instructions on how to [[https://github.com/sigmaris/u-boot/wiki/Flashing-U-Boot-to-SPI|write u-boot firmware into SPI flash]]. The gist is that you download and write an image to an SD card. Boot with SD card and wait for white LED blinking to stop. After that power off, remove the SD card and proceed with !FreedomBox download.
!FreedomBox [[FreedomBox/Download|images]] meant for all "arm64" hardware work well for this device. However, u-boot firmware must present in SPI flash (or on a separate SD card, which is not explained here). Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device. These images also work well for USB 2.0 and USB 3.0 disk drives and the process for preparing them is same as for an SD card.
An alternative to downloading these images is to [[InstallingDebianOn|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 60 USD ([[https://store.pine64.org/product/rockpro64-2gb-single-board-computer/|RockPro64 2GB]])
* Price: 80 USD ([[https://store.pine64.org/product/rockpro64-4gb-single-board-computer/|RockPro64 4GB]])
=== Hardware ===
* Open Source Hardware (OSHW): No
* CPU: Rockchip RK3399 SOC (2x Cortex A72@1.8Ghz, 4x Cortex A53@1.4Ghz)
* GPU: Mali T860 MP4 GPU
* RAM: 2 GiB or 4 GiB LPDDR4
* Storage: eMMC module slot, microSD slot, 16 MiB SPI Flash
* USB: 2x USB 2.0, 1x USB 3.0, 1x USB-C
* Expansion slot: 1x PCIe 4x slot (NVMe disks, etc.)
* Architecture: arm64
* Ethernet: 10/100/1000, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
=== Known Issues ===
* !FreedomBox does not work when booted from eMMC module (but works from SD card, USB 2.0 disk or USB 3.0 disk). !FreedomBox on NMVe disk has not been tested.
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

37
doc/manual/en/Roundcube.raw.wiki Normal file
View File

@ -0,0 +1,37 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Roundcube|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Roundcube (Email Client) ==
||<tablestyle="float: right;"> {{attachment:Roundcube-icon_en_V01.png|Roundcube icon}} ||
'''Available since''': version 0.5
=== What is Roundcube? ===
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.
=== Using Roundcube ===
After Roundcube is installed, it can be accessed at {{{https://<your freedombox>/roundcube}}}. Enter your username and password. The username for many mail services will be the full email address such as ''exampleuser@example.org'' and not just the username like ''exampleuser''. Enter the address of your email service's IMAP server address in the ''Server'' field. You can try providing your domain name here such as ''example.org'' for email address ''exampleuser@example.org'' and if this does not work, consult your email provider's documentation for the address of the IMAP server. Using encrypted connection to your IMAP server is strongly recommended. To do this, prepend 'imaps://' at the beginning of your IMAP server address. For example, ''imaps://imap.example.org''.
{{attachment:roundcube-riseup.png|Logging into your IMAP server|width=606}}
=== Using Gmail with Roundcube ===
If you wish to use Roundcube with your Gmail account, you need to first enable support for password based login in your Google account preferences. This is because Gmail won't allow applications to login with a password by default. To do this, visit [[https://www.google.com/settings/security/lesssecureapps|Google Account preferences]] and enable ''Less Secure Apps''. After this, login to Roundcube by providing your Gmail address as ''Username'', your password and in the server field use ''imaps://imap.gmail.com''.
{{attachment:roundcube-gmail.png|Logging into Gmail|width=606}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

65
doc/manual/en/Samba.raw.wiki Normal file
View File

@ -0,0 +1,65 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Samba|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Samba (Network File Storage) ==
||<tablestyle="float: right;"> {{attachment:Samba-icon_en_V01.png|Samba icon}} ||
'''Available since''': version 19.22
Samba lets you have shared folders over the local network that can be
used from multiple computers running different operating systems. We refer to these shared folders as "shares".
You can have a personal folder shared between your own devices (Home share), a folder shared with a trusted group (Group share) or one that is shared with every device on the network (Open share).
Samba lets you to treat a share as if it's a local folder on your computer. However, shares are available only on the local network.
To learn more about Samba, please refer to the [[https://wiki.samba.org/index.php/User_Documentation|user documentation]] on their wiki.
=== Using Samba ===
After installation, you can choose which disks to use for sharing. Enabled shares are accessible in the file manager on your computer at location \\freedombox (on Windows) or smb://freedombox.local (on Linux and Mac). There are three types of shares you can choose from:
'''Open share''' - accessible to everyone in your local network.<<BR>>
'''Group share''' - accessible only to !FreedomBox users who are in the ''freedombox-share'' group.<<BR>>
'''Home share''' - every user in the ''freedombox-share group'' can have their own private space.
==== On Android ====
To access Samba shares on an Android device, install "Android Samba Client" from F-Droid or Google Play. Enter ''smb://freedombox.local/<disk>'' as the share path in the app. Your shared folders should then be visible in the file manager app. Samba shares can also be used by VLC for Android which automatically discovers them.
=== Integration with other apps ===
Transmission app on !FreedomBox provides a setting to allow downloads to be saved directly to a Samba share.
If you want to make available files synchronized with Syncthing through Samba you need to make sure you synchronize in a Samba share folder. Additionally in order to make Syncthing shares available in Samba Open share or Group share you will need to ensure you click "Permissions > Ignore" button under the "Advanced" tab in folder you wish in the Syncthing web UI. This will ensure that the files will be writable through Samba.
=== Comparison with other apps ===
==== Syncthing ====
[[FreedomBox/Manual/Syncthing|Syncthing]] maintains a copy of the shared folder
on each device that it is shared with. Samba maintains only one copy on your
!FreedomBox device.
Syncthing can synchronize your shared folders between devices over the Internet.
Samba shares are only available on the local network.
Since Syncthing is primarily a synchronization solution, it has features like
conflict resolution and versioning. Samba has only copy of the file, so it
doesn't need such features. For example, if two people are editing a spreadsheet
stored on a Samba share, the last one to save the file wins.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

61
doc/manual/en/Searx.raw.wiki Normal file
View File

@ -0,0 +1,61 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Searx|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Searx (Web Search) ==
||<tablestyle="float: right;"> {{attachment:Searx-icon_en_V01.png|Searx icon}} ||
'''Available since''': version 0.24.0
=== About Searx ===
Searx is a [[https://en.wikipedia.org/wiki/Metasearch_engine|metasearch engine]]. A metasearch engine aggregates the results from various search engines and presents them in a unified interface.
Read more about Searx on their [[https://asciimoo.github.io/searx/|official website]].
=== Screenshot ===
{{attachment:searx-screenshot.png|Searx Screenshot|width=800}}
=== Screencast ===
[[attachment:Searx.webm|Searx installation and first steps|&do=get]] (14 MB)
=== Why use Searx? ===
==== Personalization and Filter Bubbles ====
Search engines have the ability to profile users and serve results most relevant to them, putting people into [[https://en.wikipedia.org/wiki/Filter_bubble|filter bubbles]], 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.
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.
Searx avoids storing cookies from search engines as a means of preventing tracking and profiling by search engines.
==== Advertisement filtering ====
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.
==== Privacy ====
Searx uses HTTP POST instead of GET by default to send your search queries to the [[https://en.wikipedia.org/wiki/Web_search_engine|search engines]], so that anyone snooping your traffic wouldn't be able to read your queries. The search queries wouldn't stored in browser history either.
'''Note:''' Searx used from Chrome browser's omnibar would make GET requests instead of POST.
=== Searx on FreedomBox ===
* 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.
* SearX is easily accessible via Tor.
* Searx can be added as a search engine to the Firefox browser's search bar. See [[https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox|Firefox Help]] on this topic. Once Searx is added, you can also set it as your default search engine.
* Searx also offers search results in csv, json and rss formats, which can be used with scripts to automate some tasks.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

154
doc/manual/en/SecureShell.raw.wiki Normal file
View File

@ -0,0 +1,154 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/SecureShell|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Secure Shell (SSH) Sever ==
=== What is Secure Shell? ===
!FreedomBox runs `openssh-server` 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.
=== Setting Up A User Account ===
==== FreedomBox First Log In: Admin Account ====
When creating an account in !FreedomBox's web interface for the first time, this user will automatically have administrator capabilities. `Admin` users are able to log in using ssh (see Logging In below) and have superuser privileges via ``sudo``.
==== Default User Account ====
* Note: If you can access !FreedomBox's web interface, then you don't need to do this. You can use the user account created in !FreedomBox's web interface to connect to SSH.
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.
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:
1. Decompress the image file.
2. Get a copy of freedom-maker from https://salsa.debian.org/freedombox-team/freedom-maker/.
3. Run {{{sudo ./bin/passwd-in-image <image-file> fbx}}}.
4. Copy the image file to SD card and boot device as normal.
The "fbx" user also has superuser privileges via ``sudo``.
=== Logging In ===
==== Local ====
To login via SSH, to your !FreedomBox:
{{{
$ ssh fbx@freedombox
}}}
Replace `fbx` with the name of the user you wish to login as. `freedombox` should be replaced with the hostname or IP address of you !FreedomBox device as found in the [[FreedomBox/Manual/QuickStart|Quick Start]] process.
`fbx` is the default user present on !FreedomBox with superuser privileges. Any other user created using !FreedomBox and belonging to the group `admin` will be able to login. The `root` account has no password set and will not be able to login. Access will be denied to all other users.
`fbx` and users in `admin` group will also be able to login on the terminal directly. Other users will be denied access.
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 `libpam-abl` package that !FreedomBox installs by default. To control this behavior consult `libpam-abl` documentation.
==== SSH over Tor ====
If in !FreedomBox you have enabled onion services via Tor, you can access your !FreedomBox using ssh over Tor. On a GNU/Linux computer, install netcat-openbsd.
{{{
$ sudo apt-get install netcat-openbsd
}}}
Edit ~/.ssh/config to enable connections over Tor.
{{{
$ nano ~/.ssh/config
}}}
Add the following:
{{{
Host *.onion
user USERNAME
port 22
ProxyCommand nc -X 5 -x 127.0.0.1:9050 %h %p
}}}
Replace USERNAME with, e.g., an `admin` username (see above).
Note that in some cases you may need to replace 9050 with 9150.
Now to connect to the !FreedomBox, open a terminal and type:
{{{
$ ssh USERNAME@ADDRESS.onion
}}}
Replace USERNAME with, e.g., an `admin` username, and ADDRESS with the onion service address for your !FreedomBox.
==== SSH Over Pagekite ====
If in !FreedomBox you are using Pagekite to expose services to the Internet, you can access your !FreedomBox using SSH over Pagekite. On a GNU/Linux computer install netcat-openbsd.
{{{
$ sudo apt-get install netcat-openbsd
}}}
Edit ~/.ssh/config to enable connections over Pagekite.
{{{
$ nano ~/.ssh/config
}}}
Add the following:
{{{
Host *.pagekite.me
CheckHostIP no
ProxyCommand /bin/nc -X connect -x %h:443 %h %p
}}}
Now to connect to !FreedomBox, open a terminal and type:
{{{
$ ssh USERNAME@KITENAME.pagekite.me
}}}
Replace USERNAME with, e.g., an `admin` username, and KITENAME with your kite name provided by pagekite.net as configured in !FreedomBox.
=== Becoming Superuser ===
After logging in, if you want to become the superuser for performing administrative activities:
{{{
$ sudo su
}}}
Make a habit of logging in as root ''only when you need to''. If you aren't logged in as root, you can't accidentally break everything.
<<Anchor(changingpassword)>>
=== Changing Password ===
To change the password of a user managed by !FreedomBox's web interface, use the change password page. However, the `fbx` default user is not managed by !FreedomBox's web interface and its password cannot be changed through it.
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:
{{{
$ passwd
}}}
This will ask you for your current password before giving you the opportunity to set a new one.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

32
doc/manual/en/Security.raw.wiki Normal file
View File

@ -0,0 +1,32 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Security|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Security ==
Press the ''Show security report'' button to see a report including the following:
* Number of security vulnerabilities in installed version of !FreedomBox.
* Number of security vulnerabilities for each installed app.
* Whether each installed app supports security sandboxing.
* For each enabled app, the security sandbox coverage as a percentage.
=== Configuration ===
When the ''Restrict console logins'' option is enabled, only users in the ''admin'' group will be able to log in via console, secure shell (SSH) or graphical login. When this option is disabled, any user with an account on !FreedomBox will be able to log in. They may be able to access some services without further authorization. This option should only be disabled if all the users of the system are well trusted. If you wish to use your !FreedomBox machine also as a desktop and allow non-admin users to login via GUI, this option must be disabled. You can define the list of users belonging to ''admin'' group in the [[../Users|Users]] section.
{{attachment:Security.png}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

25
doc/manual/en/ServiceDiscovery.raw.wiki Normal file
View File

@ -0,0 +1,25 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/ServiceDiscovery|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Service Discovery ==
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 <hostname>.local (for example: freedombox.local).
It also allows !FreedomBox to discover other devices and services running on your local network.
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.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

41
doc/manual/en/Shadowsocks.raw.wiki Normal file
View File

@ -0,0 +1,41 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Shadowsocks|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Shadowsocks (SOCKS5 proxy) ==
||<tablestyle="float: right;"> {{attachment:Shadowsocks-icon_en_V01.png|Shadowsocks icon}} ||
'''Available since''': version 0.18.0
=== What is Shadowsocks? ===
[[https://shadowsocks.org/en/index.html|Shadowsocks]] is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your !FreedomBox 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.
=== Using the Shadowsocks client? ===
The current implementation of Shadowsocks in !FreedomBox only supports configuring !FreedomBox as a Shadowsocks client. The current use case for Shadowsocks is as follows:
* Shadowsocks client (!FreedomBox) is in a region where some parts of the Internet are blocked or censored.
* Shadowsocks server is in a different region, which doesn't have these blocks.
* The !FreedomBox provides SOCKS proxy service on the local network for other devices to make use of its Shadowsocks connection.
At a future date it will be possible to configure !FreedomBox as Shadowsocks server.
=== Configuring your FreedomBox for the Shadowsocks client ===
To enable Shadowsocks, first navigate to the Socks5 Proxy (Shadowsocks) page and install it.
Server: the Shadowsocks server is not the !FreedomBox 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.
To use Shadowsocks after setup, set the SOCKS5 proxy URL in your device, browser or application to http://freedombox_address:1080/
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

52
doc/manual/en/Sharing.raw.wiki Normal file
View File

@ -0,0 +1,52 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Sharing|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Sharing (File Publishing) ==
||<tablestyle="float: right;"> {{attachment:Sharing-icon_en_V01.png|Sharing icon}} ||
'''Available since''': version 0.25
=== What Is Sharing App? ===
Sharing app allows you to share content over the web. Shared content can be individual files or whole directories.
The content can be shared publicly or restricted to the users of listed allowed groups. Allowed users will be able to access the shared content from their web browser at {{{https://your_freedombox/share/content_name}}}. Users not belonging to any of the allowed groups won't see or access the content through this mechanism.
=== Setting Up Shares ===
For the users to access the content through their browser it must exist and have a share. A share is an entry in the Sharing app relating:
* the Name (an thereby the URL) with which the users will ask for the content,
* the Disk Path of the content to be served and
* the sharing mode. On restricted mode, it also has the list of allowed groups.
Many shares can coexist in the same server.
Only admins can create, edit or remove shares. They'll find the Sharing app in the Apps section of !FreedomBox web interface. Sharing app is an easy to use web application with an evident interface.
Each share has its own sharing mode (public or restricted) setting. Only groups recognized by !FreedomBox service can be combined in the list of allowed groups. Groups created in the CLI won't be offered by the Sharing app.
=== Providing/Updating Content ===
The content can be created before or after the share is created and they can be updated independently.
The content doesn't need to be provided by an admin either. Any user with write access to the share's disk path can create or update it.
Multiple shares might point to the same content.
If you are user of !FreedomBox and your admin refuses to create shares for you, and you don't need to restrict the access to your content, you still can fall back to the [[FreedomBox/Manual/Apache_userdir|User Websites]] mechanism or the P2P networks ([[FreedomBox/Manual/Deluge|Deluge]] or [[FreedomBox/Manual/Transmission|Transmission]] for Torrent, or [[FreedomBox/Manual/MLDonkey|MLDonkey]]) to publish your files.
=== Technicalities ===
Sharing will share the content using the built-in Apache web server.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

26
doc/manual/en/Snapshots.raw.wiki Normal file
View File

@ -0,0 +1,26 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Snapshots|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Storage Snapshots ==
''Snapshots'' allows you to create filesystem snapshots, and rollback the system to a previous snapshot.
* Note: This feature requires a Btrfs filesystem. All of the !FreedomBox stable disk images use Btrfs.
{{attachment:snapshots.png|Snapshots|width=800}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

39
doc/manual/en/Storage.raw.wiki Normal file
View File

@ -0,0 +1,39 @@
## page was renamed from FreedomBox/Manual/Disks
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Storage|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Storage ==
''Storage'' allows you to see the storage devices attached to your !FreedomBox and their disk space usage.
!FreedomBox can automatically detect and mount removable media like USB flash drives. They are listed under the ''Removable Devices'' section along with an option to eject them.
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.
{{attachment:Storage.png||width=800}}
=== Advanced Storage Operations ===
Cockpit provides many advanced storage features over those offered by !FreedomBox. Both !FreedomBox and Cockpit operate over Udisks2 storage daemon and are hence compatible with each other. Some of the functions provided by Cockpit include:
* Format a disk or partition with a fresh filesystem
* Add, remove partitions or wipe the partition table
* Create and unlock encrypted file systems
* Create and manage RAID devices
{{attachment:storage-cockpit.png}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

65
doc/manual/en/Syncthing.raw.wiki Normal file
View File

@ -0,0 +1,65 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Syncthing|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Syncthing (File Synchronization) ==
||<tablestyle="float: right;"> {{attachment:Syncthing-icon_en_V01.png|Syncthing icon}} ||
'''Available since''': version 0.14
With ''Syncthing'' 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.
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.
After installation follow the instructions in the [[https://docs.syncthing.net/intro/getting-started.html|getting started of the Syncthing project]].
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.
In order to access to the web client of the Syncthing instance running on your !FreedomBox, use the path ''/syncthing''. 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.
{{attachment:Syncthing_GUI.png|Syncthing web interface|width=800}}
Syncthing has android apps available on the [[https://f-droid.org/repository/browse/?fdid=com.nutomic.syncthingandroid | F-Droid]] and [[https://play.google.com/store/apps/details?id=com.nutomic.syncthingandroid |Google Play]] app stores. Cross-platform desktop apps are also available.
To learn more about Syncthing, please visit their [[https://syncthing.net | official website]] and [[https://docs.syncthing.net | documentation]].
=== Synchronizing over Tor ===
Syncthing should automatically sync with your !FreedomBox even if it is only accessible as a Tor Onion Service.
If you would like to proxy your Syncthing client over Tor, set the `all_proxy` environment variable:
{{{
$ all_proxy=socks5://localhost:9050 syncthing
}}}
For more information, see the Syncthing documentation on [[https://docs.syncthing.net/users/proxying.html | using proxies]].
=== Avoiding Syncthing Relays ===
Syncthing uses dynamic connections by default to connect with other peers. This means that if you are synchronizing over the Internet, the data might have to go through public Syncthing relays to reach your devices. This doesn't take advantage of the fact that your !FreedomBox has a public IP address.
When adding your !FreedomBox as a device in other Syncthing clients, set the address like "tcp://<my.freedombox.domain>" instead of "dynamic". This allows your Syncthing peers to directly connect to your !FreedomBox avoiding the need for relays. It also allows for fast on-demand syncing if you don't want to keep Syncthing running all the time on your mobile devices.
=== Using Syncthing with other applications ===
==== Password Manager ====
Password managers that store their databases in files are suitable for synchronization using Syncthing. The following example describes using a free password manager called KeePassXC in combination with Syncthing to serve as a replacement for proprietary password managers that store your passwords in the cloud.
KeePassXC stores usernames, passwords etc. in files have the .kdbx extension. These kdbx files can be stored in a Syncthing shared folder to keep them synchronized on multiple machines. Free software applications which can read this file format are available for both desktop and mobile. You typically have to just point the application at the .kdbx file and enter the master password to access your stored credentials. For example, the same kdbx file can be accessed by using KeePassXC on desktop and KeePassDX on Android. KeePassXC can also be used to fill credentials into login fields in the browser by installing a browser extension.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

93
doc/manual/en/TinyTinyRSS.raw.wiki Normal file
View File

@ -0,0 +1,93 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/TinyTinyRSS|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Tiny Tiny RSS (News Feed Reader) ==
||<tablestyle="float: right;"> {{attachment:TinyTinyRSS-icon_en_V01.png|Tiny Tiny RSS icon}} ||
'''Available since''': version 0.9
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.
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.
=== Using the Web Interface ===
When enabled, Tiny Tiny RSS will be available from ''/tt-rss'' path on the web server. Any user created through !FreedomBox will be able to login and use this app.
{{attachment:ttrss.png|Tiny Tiny RSS|width=800}}
==== Adding a new feed ====
1. Go to the website you want the RSS feed for and copy the RSS/Atom feed link from it.
{{attachment:Select-RSS-feed.png|Selecting feeds|width=800}}
2. Select "Subscribe to feed.." from the Actions dropdown.
{{attachment:Subscribe-to-feed.png|Subscribe to feed}}
3. In the dialog box that appears, paste the URL for copied in step 1 and click the '''Subscribe''' button.
{{attachment:Subscribe-dialog.png|Subscription dialog box|width=800}}
Give the application a minute to fetch the feeds after clicking Subscribe.
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.
You can try this now with the homepage of [[https://en.wikinews.org/wiki/Main_Page|WikiNews]]
As you can see in the image below, TT-RSS detected and added the Atom feed of !WikiNews to our list of feeds.
{{attachment:WikiNews-feed.png|WikiNews feed added}}
If you don't want to keep this feed, right click on the feed shown in the above image, select '''Edit feed''' and click '''Unsubscribe''' in the dialog box that appears.
{{attachment:Unsubscribe.png|Unsubscribe from a feed|width=800}}
==== Importing your feeds from another feed reader ====
In your existing feed reader, find an option to ''Export'' 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
Click on the ''Actions'' menu at the top left corner and select ''Preferences''. You will be taken to another page.
Select the second tab called ''Feeds'' in the top header. Feeds has several sections. The second one is called ''OPML''. Select it.
{{attachment:OPML.png| OPML feeds page|width=960}}
To import your Subscriptions.opml file into TT-RSS,
1. Click ''Browse'' and select the file from your file system
2. Click ''Import my OPML''
After importing, you'll be taken to the '''Feeds''' 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.
In the next section, we will discuss setting up the mobile app, which can let you read your feeds on the go.
=== Using the Mobile App ===
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 '''not''' to work.
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.
To configure, first install the application, then in the setting page, set URL as ''https://<your.freedombox.address>/tt-rss-app/''. 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.
{{attachment:ttrssapp1.png|Tiny Tiny RSS|width=288}}
{{attachment:ttrssapp2.png|Tiny Tiny RSS|width=288}}
{{attachment:ttrssapp3.png|Tiny Tiny RSS|width=288}}
{{attachment:ttrssapp4.png|Tiny Tiny RSS|width=288}}
{{attachment:ttrssapp5.png|Tiny Tiny RSS|width=288}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

96
doc/manual/en/Tor.raw.wiki Normal file
View File

@ -0,0 +1,96 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Tor|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Tor (Anonymity Network) ==
||<tablestyle="float: right;"> {{attachment:Tor-icon_en_V01.png|Tor icon}} ||
'''Available since''': version 0.3
=== What is Tor? ===
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.
=== Using Tor to browse anonymously ===
Tor Browser is the recommended way to browse the web using Tor. You can download the Tor Browser from https://www.torproject.org/projects/torbrowser.html and follow the instructions on that site to install and run it.
=== Using Tor Onion Service to access your FreedomBox ===
Tor Onion Service provides a way to access your !FreedomBox, even if it's behind a router, firewall, or carrier-grade NAT (i.e., your Internet Service Provider does not provide a public IPv4 address for your router).
To enable Tor Onion 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 Onion Service", then press the Update setup button. Tor will be reconfigured and restarted.
After a while, the page will refresh and under Status, you will see a table listing the Onion 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.)
{{attachment:tor_browser_plinth.png|Tor Configuration - FreedomBox|width=800}}
Currently only HTTP (port 80), HTTPS (port 443), and SSH (port 22) are accessible through the Tor Onion Service configured on the !FreedomBox.
=== Apps accessible via Tor ===
The following apps can be accessed over Tor. Note that this list is not exhaustive.
* Calendar and Addressbook ([[FreedomBox/Manual/Radicale|Radicale]])
* File Synchronization ([[FreedomBox/Manual/Syncthing|Syncthing]])
* Feed reader ([[FreedomBox/Manual/TinyTinyRSS|TinyTinyRSS]])
* Web Search ([[FreedomBox/Manual/Searx|Searx]])
* Wiki ([[FreedomBox/Manual/MediaWiki|MediaWiki]])
* Wiki and Blog ([[FreedomBox/Manual/Ikiwiki|Ikiwiki]])
=== Running a Tor relay ===
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 !FreedomBox.
At the bottom of the Tor page in !FreedomBox, 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.
The requirements to run a relay are listed in the [[https://community.torproject.org/relay/|Tor Relay Guide]]. In short, it is
* recommended that a relay has at least 16 Mbit/s (Mbps) upload and download bandwidth available for Tor. More is better.
* required that a Tor relay be allowed to use a minimum of 100 GByte of outbound and of incoming traffic per month.
* recommended that a <40 Mbit/s non-exit relay should have at least 512 MB of RAM available; A relay faster than 40 Mbit/s should have at least 1 GB of RAM.
=== (Advanced) Usage as a SOCKS proxy ===
!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.
==== Example with Firefox ====
Your web browser can be configured to use the Tor network for all of your
browsing activity. This allows for censorship circumvention and also hides your
IP address from websites during regular browsing. For anonymity, using tor
browser is recommended.
Configure your local !FreedomBox IP address and port 9050 as a SOCKS v5 proxy in
Firefox. There are extensions to allow for easily turning the proxy on and off.
{{attachment:tor-socks-firefox.png|Configuring Firefox with Tor SOCKS proxy|width=800}}
With the SOCKS proxy configured, you can now access any onion URL directly
from Firefox. !FreedomBox itself has an onion v3 address that you can connect to
over the Tor network (bookmark this for use in emergency situations).
=== Circumventing Tor censorship ===
If your ISP is trying to block Tor traffic, you can use tor bridge relays to connect to the tor network.
1. Get the bridge configuration from the [[https://bridges.torproject.org/bridges|Tor BridgeDB]]
{{attachment:tor-bridge-db.png|Tor BridgeDB|width=800}}
2. Add the lines to your !FreedomBox Tor configuration as show below.
{{attachment:tor-bridge-configuration.png|Tor Configuration Page|width=800}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

42
doc/manual/en/Transmission.raw.wiki Normal file
View File

@ -0,0 +1,42 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Transmission|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Transmission (BitTorrent Web Client) ==
||<tablestyle="float: right;"> {{attachment:Transmission-icon_en_V01.png|Transmission icon}} ||
'''Available since''': version 0.5
=== What is Transmission ? ===
!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 [[FreedomBox/Manual/Deluge|Deluge]]. They have similar features, but you may prefer one over the other.
Transmission is a lightweight !BitTorrent client that is well known for its simplicity and a default configuration that "Just Works".
=== Screenshot ===
{{attachment:transmission.png|Transmission Web Interface|width=800}}
=== Using Transmission ===
After installing Transmission, it can be accessed at {{{https://<your freedombox>/transmission}}}. Transmission uses single sign-on from !FreedomBox, which means that if you are logged in on your !FreedomBox, you can directly access Transmission without having to enter the credentials again. Otherwise, you will be prompted to login first and then redirected to the Transmission app.
=== Tips ===
==== Transferring Downloads from the FreedomBox ====
1. Transmission's downloads directory can be added as a shared folder in the "Sharing" app. You can then access your downloads from this shared folder using a web browser.
2. (Advanced) If you have the ssh access to your !FreedomBox, you can use sftp to browse the downloads directory using a suitable file manager or web browser (e.g. dolphin or Konqueror).
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

31
doc/manual/en/USBWiFi.raw.wiki Normal file
View File

@ -0,0 +1,31 @@
== USB Wi-Fi ==
!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.
A solution to the problem is to plug-in a USB Wi-Fi device into one of the available USB ports. There are many such devices available which do not require non-free firmware to work. The following is a list of such devices that work with !FreedomBox devices. Some devices based on these chips have tested to work well with !FreedomBox including functions such as access point mode.
* [[https://wikidevi.com/wiki/AR7010|Devices with Atheros AR7010 chip]]
* [[https://wikidevi.com/wiki/AR9271|Devices with Atheros AR9271 chip]]
=== Firmware Installation ===
The free firmware for these devices is not packaged in Debian yet. You can manually download and install the firmware as follows:
{{{
sudo su [enter password]
cd /lib/firmware
wget https://www.thinkpenguin.com/files/ath9k-htc/version-1.4-beta/htc_9271.fw
wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw
}}}
=== Resources ===
* [[WiFi#USB_Devices|Debian Wiki on WiFi drivers]]
* [[https://en.wikipedia.org/wiki/Comparison_of_open-source_wireless_drivers#Linux_drivers_for_802.11_.22wireless.22|Wikipedia: Comparison of open-source Linux wireless network drivers]]
* [[https://wikidevi.com/wiki/Main_Page|WikiDevi: database of computer hardware]]
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

74
doc/manual/en/Upgrades.raw.wiki Normal file
View File

@ -0,0 +1,74 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Upgrades|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Software Updates ==
!FreedomBox can automatically install security updates. On the ''Update'' page of the ''System'' section in !FreedomBox web interface you can turn on automatic updates. 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.
Updates 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 updates happen. Alternatively, you can perform manual updates as described below.
Note that once the updates start, it may take a long time to complete. During automatic update process that runs every night or during manual update process, you will not be able to install apps from !FreedomBox web interface.
{{attachment:upgrades.png}}
=== When Will I Get the Latest Features? ===
Although updates are done every day for security reasons, latest features of !FreedomBox will not propagate to all the users. The following information should help you understand how new features become available to users.
'''Stable Users''': This category of users include users who bought the [[FreedomBox/Hardware/PioneerEdition|FreedomBox Pioneer Edition]], installed !FreedomBox on a [[FreedomBox/Hardware/Debian|Debian]] stable distribution or users who downloaded the ''stable'' images from [[https://freedombox.org|freedombox.org]]. As a general rule, only security updates to various packages are provided to these users. One exception to this rule is where !FreedomBox service itself is updated when a release gains high confidence from developers. This means that latest !FreedomBox features may become available to these users although not as quickly or frequently as ''testing'' users. If an app is available only in ''testing'' distribution but not in ''stable'' distribution, then that app will show up in the web interface but will not be installable by ''stable'' users. Some apps are also provided an exception to the rule of "security updates only" when the app is severely broken otherwise. Every two years, a major release of Debian stable happens with the latest versions of all the software packages and !FreedomBox developers will attempt to upgrade these users to the new release without requiring manual intervention.
'''Testing Users''': This category of users include users who installed !FreedomBox on a [[FreedomBox/Hardware/Debian|Debian]] ''testing'' distribution or users who downloaded the ''testing'' images from [[https://freedombox.org|freedombox.org]]. Users who use Debian ''testing'' are likely to face occasional disruption in the services and may even need manual intervention to fix the issue. As a general rule, these users receive all the latest features and security updates to all the installed packages. Every two weeks, a new version of !FreedomBox is released with all the latest features and fixes. These releases will reach ''testing'' users approximately 2-3 days after the release.
'''Unstable Users''': This category of users include users who installed !FreedomBox on a [[FreedomBox/Hardware/Debian|Debian]] ''unstable'' distribution or users who downloaded the ''unstable'' images from [[https://freedombox.org|freedombox.org]]. Users who use Debian ''unstable'' are likely to face occasional disruption in the services and may even need manual intervention to fix the issue. As a general rule, these users receive all the latest features to all the installed packages. Every two weeks, a new version of !FreedomBox is released with all the latest features and fixes. Theses releases will reach ''unstable'' users on the day of the release. Only developers, testers and other contributors to the !FreedomBox project should use the ''unstable'' distribution and end users and advised against using it.
=== Manual Updates from Web Interface ===
To get updates immediately and not wait until the end of the day, you may want to trigger updates manually. You can do this by pressing the ''Update now'' button in ''Manual update'' tab for ''Update'' page in ''System'' section. Note that this step is not necessary if you have enabled ''Auto-updates'' as every night this operation is performed automatically.
When installing apps you may receive an error message such as
{{{
Error installing packages: E: dpkg was interrupted, you must manually run 'dpkg --configure -a' to correct the problem
}}}
This is typically caused by shutting down !FreedomBox while it is installing apps, while performing daily updates or during some other operations. This situation can be rectified immediately by running manual update.
=== Manual Updates from Terminal ===
Some software packages may require manual interaction for updating due to questions related to configuration. In such cases, !FreedomBox updates itself and brings in new knowledge necessary to update the package by answering configuration questions. After updating itself, !FreedomBox acts on behalf of the user and updates the packages by answering the questions. Until !FreedomBox has a chance to update the package, such packages should not be be updated manually. The manual update triggered from the web interface is already mindful of such packages and does not update them.
In some rare situations, !FreedomBox itself might fail to update or the update mechanism might fall into a situation that might need manual intervention from a terminal. To perform manual upgrades on the terminal, login into !FreedomBox on a terminal (if you have monitor and keyboard connected), via a web terminal (using [[FreedomBox/Manual/Cockpit]]) or using a remote secure shell (see [[FreedomBox/Manual/SecureShell|Secure Shell]] section). Then run the following commands:
{{{
$ sudo su -
Password: <enter user password here>
# dpkg --configure -a
# apt update
# apt -f install
# unattended-upgrade --debug
# apt install freedombox
# apt update
}}}
If `apt-get update` asks for a confirmation to change ''Codename'' or other release information, confirm ''yes''. If during update of ''freedombox'' package, if a question about overwriting configuration files is asked, answer to install new configuration files from the latest version of the package. This process will upgrade only packages that don't require configuration file questions (except for ''freedombox'' package). After this, let !FreedomBox handle the upgrade of remaining packages. Be patient while new releases of !FreedomBox are made to handle packages that require manual intervention.
If you want to go beyond the recommendation to upgrade all the packages on your !FreedomBox and if you are really sure about handling the configuration changes for packages yourself, run the following command:
{{{
$ apt dist-upgrade
}}}
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

39
doc/manual/en/Users.raw.wiki Normal file
View File

@ -0,0 +1,39 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Users|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Users and Groups ==
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
* admin
* bit-torrent
* ed2k
* feed-reader
* syncthing
* web-search
* wiki
are supported.
The user will be able to log in to services that support single sign-on through LDAP, if they are in the appropriate group.
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).
A user's groups can also be changed later-on.
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.
A user's account can be deactivated, which will temporarily disable the account.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

214
doc/manual/en/VirtualBox.raw.wiki Normal file
View File

@ -0,0 +1,214 @@
== VirtualBox ==
{{attachment:virtualbox.png|VirtualBox|width=726,height=475}}
This page will help you get started with using !FreedomBox on a [[https://en.wikipedia.org/wiki/Virtual_machine|virtual machine]] using !VirtualBox. While !VirtualBox images are primarily used for testing and development, they can also be used for regular use if you have spare resources on one of your machines. This setup is useful if:
* You don't own one of the [[FreedomBox/Hardware|supported hardware]] devices.
* You don't use Debian GNU/Linux as your operating system.
* You don't want to disturb your Debian installation to try out !FreedomBox.
Prebuilt !FreedomBox images for !VirtualBox are routinely made available in !VirtualBox's own [[https://www.virtualbox.org/manual/ch05.html#vdidetails|VDI image file format]]. They contain a Debian GNU/Linux operating system and an installation of !FreedomBox with all dependencies ready to run on any OS supported by !VirtualBox (Windows, Linux, Macintosh, and Solaris).
A more adventurous alternative to downloading one of these images is to [[InstallingDebianOn|install Debian]] on !VirtualBox and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
!VirtualBox itself is available from https://www.virtualbox.org/ (or your distribution's package manager).
=== Download ===
Follow the instructions on the [[FreedomBox/Download|download]] page to download and verify a !VirtualBox image. The latest images are available on [[https://freedombox.org/download/|freedombox.org]].
=== Creating a Virtual Machine ===
1. Decompress the downloaded VDI image (tool for [[http://www.7-zip.org/|Windows]], [[http://unarchiver.c3.cx/unarchiver|Mac]]).
1. Create a new VM in the !VirtualBox UI with OS type ''Linux'' and Version ''Debian'' (32/64-bit according to the downloaded image).
{{attachment:virtualbox_os_type.png|VirtualBox Name and OS dialog}}
1. In the ''Hard disk'' dialog choose ''Use an existing virtual hard disk file'' and select the .vdi file you extracted in step 1.
{{attachment:virtualbox_harddisk_file.png|VirtualBox Hard disk dialog}}
1. When created, go to the virtual machine's Settings -> [Network] -> [Adapter 1]->[Attached to:] and choose the network type your want the machine to use according to the explanation in Network Configuration below. The recommended type is the ''Bridged adapter'' option, but be aware that this exposes the !FreedomBox's services to your entire local network.
{{attachment:virtualbox_network_type.png|VirtualBox recommended network setting}}
'''Note:''' It is important to make sure that you have provided the correct network interface in the above step. For example, if the virtual machine is running on a laptop connected to a Wi-Fi network, then the wireless interface (starts with ''wlp'') must be chosen as shown in the screenshot.
=== First Boot ===
When satisfied with the VM settings click the start button in the !VirtualBox UI and your new !FreedomBox will boot.
The console of the VM will show the textual screen below when finished booting, from here most interaction with !FreedomBox will be through the [[FreedomBox/Plinth|web interface]] in a browser.
{{attachment:virtualbox_console_after_boot.png|FreedomBox console after booting successfully}}
If everything went well so far, you should be able to access the web interface of !FreedomBox by pointing a browser on the host machine to https://freedombox.local.
In case freedombox.local cannot be resolved, you need to find out your !FreedomBox's IP address as described in [[#finding-ip-address-of-vm|Finding out the IP address of the virtual machine]]. Then access this IP from a web browser which is on the same network as the VM (for example, the host). If all is well, you are now presented with a welcome message and invited to complete the ''first boot'' process.
{{attachment:plinth_first_boot.png|FreedomBox welcomes you to the first boot}}
This mainly consist of creating an administrative user for the system.
=== Using ===
See the !FreedomBox [[FreedomBox/Manual/QuickStart|usage]] page for more details.
You can log in to the Debian GNU/Linux system as the user created during !FreedomBox first boot on the !VirtualBox console or remotely via ssh.
After logging in, you can become root with the command `sudo su`.
=== Build Image ===
If you wish to build your own images instead of downloading available images, it can be done using [[FreedomBox/Maker|Freedom Maker]].
=== Tips & Troubleshooting ===
==== Network Configuration ====
!VirtualBox provides many types of networking options. Each has its
advantages and disadvantages. For more information about how various
networking types work in !VirtualBox, see !VirtualBox's networking
documentation. https://www.virtualbox.org/manual/ch06.html
For a simple setup, it is recommended that you use a single network
interface in your guest machine. This will make the first boot script
automatically configure that interface as an `internal` network with
`automatic` network configuration. Inside the guest machine, the
networking is configured automatically and all the services are made
available on this network interface. For more information on how
networks are configured by default in !FreedomBox, see
[[FreedomBox/Manual/Networks|Networks]] section.
What remains is to make those services available to the host machine
or to other machines in the network. You must then choose one of the
following types of networking for the network interface on your guest
machine. To set a particular type of network for the guest's network
adapter, go to the guest VM's settings then the network options and
then select the adapter you wish to configure. There, set the network
type from the available list of networks.
1. First and the recommended option is to use the ''Bridged'' type of
network. This option exposes the guest machine to the same network
that host network is connected to. The guest obtains network
configuration information from a router or DHCP server on the
network. The guest will appear as just another machine in the
network. A major advantage of this of setup is that the host and all
other machines in the network will be able to access the services
provided by guest without requiring any further setup.
The only drawback of this approach is that if the host is not
connected to any network, the guest's network will remain
unconfigured making it inaccessible even from the host.
1. Second method is ''Host only'' type of networking. With a
guest's network interface configured in this manner, it will only be
accessible from the host machine. The guest will not able access any
other machine but the host, so you do not have internet access on the guest.
All services on the guest are available to the host machine without any
configuration such as port forwarding.
1. The third option is to use the ''NAT'' type of network. This the
networking type that !VirtualBox assigns to a freshly created virtual
machine. This option works even when host is not connected to any
network. The guest is automatically configured and is able to access
the internet and local networks that host is able to connect to.
However, the services provided by the guest require port forwarding
configuration setup to be available outside.
To configure this go to VM settings -> [Network] -> [Adapter] ->
[Port Forwarding]. Map a port such as 2222 from host to guest port
22 and you will be able to ssh into !FreedomBox from host machine as
follows:
{{{
ssh -p 2222 fbx@localhost
}}}
Map 4443 on host to 443 on the guest. This make !FreedomBox HTTPS
service available on host using the URL https://localhost:4443/
You will need to add a mapping for each such services from host to
guest.
1. The final option is to create two network interfaces, one ''host only''
and one ''NAT'' type. This way you can access the guest without
any additional configuration, and you have internet access on the guest.
The guest will be invisible to any other machines on the network.
Summary of various network types:
|| - ||'''Guest accessible from other machines'''||'''Guest accessible from host'''||'''Works without port forwarding'''||'''Works without host connected to network'''||'''Guest has internet access'''||
|| '''Bridged''' || (./) || (./) || (./) || {X} || (./) ||
|| '''Host only''' || {X} || (./) || (./) || (./) || {X} ||
|| '''NAT''' || (./) || (./) || {X} || (./) || (./) ||
|| '''NAT and Host || {X} || (./) || (./) || (./) || (./) ||
<<Anchor(finding-ip-address-of-vm)>>
==== Finding out the IP address of the virtual machine ====
This depends on the network configuration you chose. With a ''bridged adapter'',
your virtual machine gets its IP address from the DHCP server of your network, most likely of your Router. You can try the first couple of IP addresses or check your router web interface for a list of connected devices.
If you chose ''host-only adapter'', the IP address is assigned by the DHCP server of your !VirtualBox network. In the !VirtualBox Manager, go to File -> Preferences -> Network -> Host-only Networks. You can see and edit the DHCP address range there, typically you get assigned addresses close to the ''Lower Address Bound''.
Another possibility of finding the IP address is to login via the !VirtualBox Manager (or similar software). The !FreedomBox images do not have any default user accounts, so you need to set an initial user and password using the [[https://salsa.debian.org/freedombox-team/freedom-maker/blob/master/bin/passwd-in-image|passwd-in-image script]].
See also [[FreedomBox/Manual/QuickStart|QuickStart]] for instructions on how to scan your network to discover the IP of the VM.
==== Networking Problems with macchanger ====
The package `macchanger` can cause network problems with !VirtualBox. If you have a valid IP address on your guest's host network adapter (like 192.168.56.101) but are not able to ping or access the host (like 192.168.56.1), try uninstalling `macchanger`:
{{{
$ dpkg --ignore-depends=freedombox-setup --remove macchanger
}}}
You might have to manually remove the script `/etc/network/if-prep-up/macchanger`.
If Debian complains about unmet dependencies when you use a package manager (apt-get, aptitude, dpkg), try to remove 'macchanger' from the dependencies of 'freedombox-setup' in the file `/var/lib/dpkg/status`.
==== Mounting Images Locally ====
If you want to mount images locally, use the following to copy built images off the !VirtualBox:
{{{
$ mkdir /tmp/vbox-img1 /tmp/vbox-root1
$ vdfuse -f freedombox-unstable_2013.0519_virtualbox-i386-hdd.vdi /tmp/vbox-img1/
$ sudo mount -o loop /tmp/vbox-img1/Partition1 /tmp/vbox-root1
$ cp /tmp/vbox-root1/home/fbx/freedom-maker/build/freedom*vdi ~/
$ sudo umount /tmp/vbox-root1
# $ sudo umount /tmp/vbox-img1 # corruption here.
}}}
==== Fixing the time after suspend and resume ====
The virtual machine loses the correct time/date after suspending and resuming. One way to fix this is to create a cron-job that restarts the time service `ntp`. You can add a crontab entry as root to restart ntp every 15 minutes by typing
`'crontab -e'` and adding this line:
{{{
*/15 * * * * /etc/init.d/ntp restart
}}}
Do not restart this service too often as this increases the load of publicly and freely available NTP servers.
==== UUID collision in VB ====
Whenever this happens !VirtualBox shows following error message: ''Cannot register the hard disk A with UUID ... because a hard disk B with UUID ... already exists in the media registry''
Creating several VMs from the same image causes collisions due to ID's (hostname, IP, UUID, etc) that are expected to be universally unique.
Most can be handeled operating the running VM. But !VirtualBox complains before that (at the very creation of the VM) about the hard disk's UUID. This is usual stuff when you develop/test e.g. !FreedomBox.
You can change a clone's UUID in the terminal as follows:
{{{
$ VBoxManage internalcommands sethduuid path/to/the/hd/vdi/file
}}}
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

77
doc/manual/en/bepasty.raw.wiki Normal file
View File

@ -0,0 +1,77 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/bepasty|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Bepasty (File & Snippet Sharing) ==
||<tablestyle="float: right;"> {{attachment:bepasty-icon_en_V01.png|bepasty icon}} ||
'''Available since''': version 20.14
=== What is bepasty? ===
bepasty is a web application that allows large files to be uploaded and shared. Text and code snippets can also be pasted and shared. Text, image, audio, video and PDF documents can be previewed in the browser. Shared files can be set to expire after a time period.
=== Screenshot ===
{{attachment:bepasty_logged_in_page.png|Screenshot of bepasty|width=800}}
=== Passwords and Permissions ===
bepasty uses only passwords (without usernames) to control access. Depending on which password is used to login to bepasty, the user will have different permissions. They can have any combination of the following permissions:
* '''read''': Read a file, if they know the URL.
* '''list''': List all files.
* '''create''': Paste or upload a new file.
* '''delete''': Delete a file.
* '''admin''': Can lock and unlock files.
After bepasty is installed, it comes pre-configured for the following roles:
* Viewer: can view and list files
* Editor: can view, list, create, and delete files
* Administrator: has all permissions
These roles support a use-case of file sharing between known, authorized users. If needed, you can re-configure bepasty to support other roles and use-cases.
=== Distributing passwords ===
By default, the Public Access configuration is set to ''None'', so a password is required for any use of bepasty. This means that you will need to distribute the passwords to the appropriate users, through any communication channels that you have.
Note that you may want to create multiple passwords with the same permissions. This allows you to distribute a unique password to each user (or to a group of users). Then if you want to revoke access to one user, you can simply delete their password. The other users with their own passwords will not be affected.
=== Using bepasty ===
After logging in to bepasty, if you have the Create permission, you will see a large text box where you can paste any text. Optionally, you can provide a filename or Content-Type for the data. After clicking Submit, the file is created.
You can also drag and drop files in the area at the bottom. They are uploaded immediate after dropping them in this area. You can also create a list to track a collection of uploaded files.
For either case, you can set a maximum lifetime value. After this time expires, the file will be deleted.
If you have the List permission, then you will see a link ''List all Items'' at the top of the page. This will show all files that have been created or uploaded.
If you have the Delete or Admin permission, you will see extra actions shown next to each file on the list page.
If you only have the Read permission, then to read files, you will need to have both a password and one or more URLs for existing files.
=== Managing passwords ===
The bepasty configuration page in !FreedomBox interface allows you to create new passwords, or to remove a password. When you create a password, you can choose any combination of the permissions described above. Note that a typical Administrator should have all of the permissions (not just "Admin").
You can also set a Comment. This is recommended, and you should use the comment to help yourself remember the purpose of the password, or who will be using the password.
You can also configure Public Access, which sets the default permissions that are available even without logging in with a password. You can set this to allow reading files by their URL, or reading and listing all files.
=== External links ===
https://bepasty-server.readthedocs.io/en/latest/user.html
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

63
doc/manual/en/ejabberd.raw.wiki Normal file
View File

@ -0,0 +1,63 @@
## page was renamed from FreedomBox/Manual/XMPP
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/ejabberd|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Ejabberd (Chat Server) ==
||<tablestyle="float: right;"> {{attachment:ejabberd-icon_en_V01.png|ejabberd icon}} ||
'''Available since''': version 0.3
=== What is XMPP? ===
XMPP is a federated server-client 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.
Currently !FreedomBox offers both, a server (ejabberd) and a web client ([[FreedomBox/Manual/JSXC|JSXC]]) from its web interface.
=== Privacy ===
With XMPP, there are two ways that conversations can be secured:
1. 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.
1. 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.
=== Setting the Domain Name ===
For XMPP to work, your !FreedomBox needs to have a Domain Name that can be accessed over the network.
If you only need the local network (LAN) users to chat with each other you can invent your domain name, but if you want users from the internet to join your rooms you need a public domain name. You can read more about obtaining a Domain Name in the [[../DynamicDNS|Dynamic DNS section of this manual]].
Once you have a Domain Name, you can tell your !FreedomBox to use it by setting the Domain Name in the System [[../Configure|Configuration]].
'''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.
Please note that [[FreedomBox/Manual/PageKite|PageKite]] does not support the XMPP protocol at this time.
=== Registering FreedomBox users to use XMPP ===
Currently, all users created through !FreedomBox 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.
=== Port Forwarding ===
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:
* TCP 5222 (client-to-server)
* TCP 5269 (server-to-server)
* TCP 5280 (?)
=== Compatible clients ===
* !FreedomBox provides a web client: [[FreedomBox/Manual/JSXC|JSXC]].
* [[https://xmpp.org/software/clients.html|XMPP clients]] are available for various desktop and mobile platforms.
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

120
doc/manual/en/freedombox-manual.raw.wiki Normal file
View File

@ -0,0 +1,120 @@
<<TableOfContents(2)>>
<<Include(FreedomBox/Introduction, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/QuickStart, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/GettingHelp, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Download, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= Apps =
/* Add entries here sorted after the level 2 heading inside the page to keep the list alphabetically sorted */
<<Include(FreedomBox/Manual/bepasty, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Coturn, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Deluge, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/ejabberd, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/GitWeb, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/I2P, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Ikiwiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Infinoted, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/JSXC, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/MatrixSynapse, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/MediaWiki, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Minetest, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/MiniDLNA, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/MLDonkey, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Mumble, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/OpenVPN, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Privoxy, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Quassel, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Radicale, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Roundcube, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Samba, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Searx, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Sharing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Syncthing, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/TinyTinyRSS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Tor, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Transmission, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Apache_userdir, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= System =
<<Include(FreedomBox/Manual/Backups, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Bind, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Cockpit, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Configure, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/DateTime, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Diagnostics, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/DynamicDNS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Firewall, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/LetsEncrypt, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Monkeysphere, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/NameServices, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Networks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/PageKite, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Performance, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Power, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/SecureShell, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Security, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/ServiceDiscovery, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Storage, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Snapshots, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Upgrades, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Users, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= Hardware =
<<Include(FreedomBox/Hardware, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/PioneerEdition, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/A20-OLinuXino-Lime2, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/A20-OLinuXino-MICRO, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/APU, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/Cubietruck, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/Cubieboard2, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/BeagleBone, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/pcDuino3, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/Debian, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/VirtualBox, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/PineA64+, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/BananaPro, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/OrangePiZero, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RockPro64, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/Rock64, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RaspberryPi2, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RaspberryPi3B, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RaspberryPi3B+, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RaspberryPi4B, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/USBWiFi, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/DreamPlug, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Hardware/RaspberryPi, , to="## END_INCLUDE")>>
<<Include(FreedomBox/ReleaseNotes, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= Contributing =
<<Include(FreedomBox/Contribute, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= Developer Guide =
<<Include(FreedomBox/Manual/Developer, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
= Hacking =
!FreedomBox consists of two main projects:
* !FreedomBox Service (Plinth), the web interface
* Freedom Maker, a script to build disk images for various hardware
<<Include(FreedomBox/Plinth, , to="## END_INCLUDE")>>
<<Include(FreedomBox/Maker, , to="## END_INCLUDE")>>
= Tell people around you =
* [[https://freedombox.org/|FreedomBox]]
* [[../Press|FreedomBox in the Press]]
* [[../Conferences|Conferences]]
* [[../TalksAndPresentations|Talks and presentations]]
* [[../TalksAndPresentations/AvailableMaterial|Available Material]] Slides and other raw material
* [[http://www.facebook.com/freedomboxfoundation|Facebook]]
* [[http://twitter.com/#!/FreedomBoxFndn|Twitter]]
* [[https://mastodon.social/@freedomboxfndn|Mastodon]]
* [[http://meetings-archive.debian.net/pub/debian-meetings/2011/debconf11/low/|Debconf11 Videos]]

52
doc/manual/en/pcDuino3.raw.wiki Normal file
View File

@ -0,0 +1,52 @@
== pcDuino3 ==
{{attachment:pcduino3s.jpg|LinkSprite pcDuino3S|width=682,height=310}}
[[https://www.linksprite.com/linksprite-pcduino3s/|LinkSprite pcDuino3S]] is a single board computer running on Allwinner A20 and sold with a good case. !FreedomBox images are built and tested for this device.
Note: The !FreedomBox logo is simply a sticker on top of device brought from store.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
Although untested, the following similar hardware is also likely to work well with !FreedomBox.
* [[https://www.linksprite.com/linksprite-pcduino3/]] also covers pcDuino3B
=== Download ===
!FreedomBox disk [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card, USB disk, SSD or hard drive and boot into !FreedomBox. Pick the image meant for pcduino3.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the APU and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 89 USD
* [[http://store.linksprite.com/pcduino3s-a20-single-board-computer-no-power-supply-or-hdmi-cable/|LinkSprite]]
* [[http://www.linksprite.com/buy-2/|Full list of suppliers]]
=== Hardware ===
* Open Hardware: No
* CPU: !AllWinner A20 SoC, 1GHz ARM Cortex A7 Dual Core
* RAM: 1 GB
* Storage: SD card, 4 GB onboard flash
* Architecture: armhf
* Ethernet: 10/100 Mbps
* !WiFi: Built-in WiFi requires non-free firmware, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]] instead
* SATA: 1 SATA host socket
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Requires non-free firmware
* Boot Firmware: [[https://linux-sunxi.org/BROM|BROM]] (GPLV2+)
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

76
doc/manual/es/A20-OLinuXino-Lime2.raw.wiki Normal file
View File

@ -0,0 +1,76 @@
== A20 OLinuXino Lime2 ==
{{attachment:a20-olinuxino-lime2.jpg|A20 OLinuXino Lime2|width=640,height=432}}
Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-LIME2/open-source-hardware|A20 OLinuXino Lime2]] is a fully Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. It uses the Allwinner A20 Dual Core ARM processor.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
The following similar hardware will also work well with !FreedomBox.
* Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-LIME2-4GB/open-source-hardware|A20 OLinuXino Lime2 4GB]]. This hardware merely has extra 4GB NAND storage that is not used by !FreedomBox.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device. These SD card images are meant for use with the on-board SD card slot and won't work when used with a separate SD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 45 EUR (A20 OLinuXino Lime2)
* Price: 55 EUR (A20 OLinuXino Lime2 4GB)
* [[https://www.olimex.com/Products/OLinuXino/A20/open-source-hardware|Olimex Store]]
=== Hardware ===
* Open Source Hardware (OSHW): [[https://github.com/OLIMEX/OLINUXINO/tree/master/HARDWARE|Yes]]
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 1 GiB DDR3
* Storage: 4 GB NAND flash built-in (only on 4GB model), 1x microSD slot
* Architecture: armhf
* Ethernet: 10/100/1000, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1x port
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot Firmware: [[https://linux-sunxi.org/BROM|BROM]] (GPLV2+)
=== Known Issues ===
* Revision C hardware has [[DebianBug:845128|poor performance when receiving Ethernet data in Gigabit mode]]. To workaround the problem, you can switch to 100 Mbps mode instead of Gigabit mode. Login to your !FreedomBox as root (or plugin the SD card into another computer) and create the file /etc/NetworkManager/dispatcher.d/20-fix-ethernet-problem with the following contents:
{{{
#!/bin/bash
set -e # Exit with code on error
IFACE="$1"
ACTION="$2"
if [[ "$IFACE" != "eth0" ]]; then
exit 0
fi
case ${ACTION} in
up)
logger "Setting up $IFACE in 100Mbps mode"
mii-tool eth0 -A 100BaseTx-FD
;;
*)
;;
esac
}}}
* Revision G2 hardware has [[DebianBug:927397|poor performance when transmitting Ethernet data in Gigabit mode]]. Download and use the [[https://ftp.freedombox.org/pub/freedombox/pioneer/|Pioneer Edition image]] to fix the issue. It contains a slightly [[https://salsa.debian.org/freedombox-team/u-boot/commit/2cb18893ef|modified u-boot]]. The above workaround to put the Ethernet into 100 Mbps mode also fixes this issue.
* Revision K hardware is [[https://salsa.debian.org/freedombox-team/freedom-maker/issues/148|not working properly]].
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

54
doc/manual/es/A20-OLinuXino-MICRO.raw.wiki Normal file
View File

@ -0,0 +1,54 @@
== A20 OLinuXino MICRO ==
{{attachment:a20-olinuxino-micro.jpg|A20 OLinuXino MICRO|width=640,height=359}}
Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-MICRO/open-source-hardware|A20 OLinuXino MICRO]] is a fully Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. It uses the Allwinner A20 Dual Core ARM processor.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
The following similar hardware will also work well with !FreedomBox.
* Olimex's [[https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXIno-MICRO-4GB/open-source-hardware|A20 OLinuXino MICRO 4GB]]. This hardware merely has extra 4GB NAND storage that is not used by !FreedomBox.
=== Download ===
!FreedomBox MicroSD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox MicroSD card and boot the device. These MicroSD card images are meant for use with the on-board MicroSD card slot and won't work on the SD card slot or when using a separate MicroSD card reader connected via USB.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: 50 EUR (A20 OLinuXino MICRO)
* Price: 63 EUR (A20 OLinuXino MICRO 4GB)
* [[https://www.olimex.com/Products/OLinuXino/A20/open-source-hardware|Olimex Store]]
=== Hardware ===
* Open Source Hardware (OSHW): [[https://github.com/OLIMEX/OLINUXINO/tree/master/HARDWARE|Yes]]
* CPU: Allwinner A20, ARM Cortex-A7 @ 1GHz dual-core
* RAM: 1 GiB DDR3
* Storage: 4 GB NAND flash built-in (only on 4GB model), 1x microSD slot
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1x port
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot Firmware: [[https://linux-sunxi.org/BROM|BROM]] (GPLV2+)
=== Known Issues ===
* Not visible on local network
* When booting the 'stable' image (made on 2017-06-18) the board does not automatically get an IP address from the router's DHCP server over ethernet. Booting the 'testing' image (2018-06) the board does get an IP address. Tested on MICRO hardware revision J. see also: [[https://www.olimex.com/forum/index.php?topic=5839.msg24167#msg24167]]
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

75
doc/manual/es/APU.raw.wiki Normal file
View File

@ -0,0 +1,75 @@
== APU ==
{{attachment:apu1d.jpg|PC Engines APU 1D|width=632,height=319}}
[[http://www.pcengines.ch/apu1d.htm|PC Engines APU 1D]] is a single board computer with 3 Gigabit ethernet ports, a powerful AMD APU and Coreboot firmware. !FreedomBox images built for AMD64 machines are tested to work well for it.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Similar Hardware ===
Although untested, the following similar hardware is also likely to work well with !FreedomBox.
* Using amd64 image:
* [[http://www.pcengines.ch/apu1c.htm|apu1c]]
* [[http://www.pcengines.ch/apu1c4.htm|apu1c4]]
* [[http://www.pcengines.ch/apu1d4.htm|apu1d4]]
* [[http://www.pcengines.ch/apu2b2.htm|apu2b2]]
* [[http://www.pcengines.ch/apu2b4.htm|apu2b4]]
* [[http://www.pcengines.ch/apu2c0.htm|apu2c0]]
* [[http://www.pcengines.ch/apu2c2.htm|apu2c2]]
* [[http://www.pcengines.ch/apu2c4.htm|apu2c4]]
* [[http://www.pcengines.ch/apu3a2.htm|apu3a2]]
* [[http://www.pcengines.ch/apu3a4.htm|apu3a4]]
* [[http://www.pcengines.ch/apu3b2.htm|apu3b2]]
* [[http://www.pcengines.ch/apu3b4.htm|apu3b4]]
* Using i386 image:
* [[http://www.pcengines.ch/alix1d.htm|alix1d]]
* [[http://www.pcengines.ch/alix1e.htm|alix1e]]
* [[http://www.pcengines.ch/alix2d2.htm|alix2d2]]
* [[http://www.pcengines.ch/alix2d3.htm|alix2d3]]
* [[http://www.pcengines.ch/alix2d13.htm|alix2d13]]
* [[http://www.pcengines.ch/alix3d2.htm|alix3d2]]
* [[http://www.pcengines.ch/alix3d3.htm|alix3d3]]
* [[http://www.pcengines.ch/alix6f2.htm|alix6f2]]
=== Download ===
!FreedomBox disk [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card, USB disk, SSD or hard drive and boot into !FreedomBox. Pick the image meant for all amd64 machines.
An alternative to downloading these images is to [[InstallingDebianOn/Alix3d2|install Debian]] on the APU and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Networking ===
The first network port, the left most one in the above picture, is configured by !FreedomBox to be an upstream Internet link and the remaining 2 ports are configured for local computers to connect to.
=== Availability ===
* Price: 110 - 170 USD (depending on the board and supplier)
* [[http://www.pcengines.ch/order.htm|PC Engines]]
* [[http://www.pcengines.ch/order.htm|Full list of suppliers]]
=== Hardware ===
* Open Hardware: No
* CPU: [[http://www.amd.com/en-gb/products/embedded/processors/g-series|AMD G series T40E]]
* RAM: 2 GB DDR3-1066 DRAM
* Storage: SD card, External USB
* Architecture: amd64
* Ethernet: 3 Gigabit Ethernet ports
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: 1 m-SATA and 1 SATA
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
* Boot firmware: [[http://www.pcengines.ch/apu1d.htm|Coreboot]]
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

44
doc/manual/es/Apache_userdir.raw.wiki Normal file
View File

@ -0,0 +1,44 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Apache_userdir|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Sitios Web de Usuario (User websites) ==
=== ¿Qué es User websites? ===
''User websites'' es un módulo del servidor web ''Apache'' habilitado para permitir a los usuarios definidos en el sistema !FreedomBox exponer un conjunto de archivos del sistema de ficheros de !FreedomBox como sitio web a la red local y/o a internet de acuerdo a la configuración de la red y el cortafuegos.
||||<tablestyle="border:1px solid black;width: 80%">'''Datos básicos de la aplicación'''||
||Categoría|| Compartición de archivos ||
||Disponible desde la versión || 0.9.4||
||Sitio web del proyecto original || https://httpd.apache.org/docs/2.4/mod/mod_userdir.html||
||Documentación original de usuario || https://httpd.apache.org/docs/2.4/howto/public_html.html||
=== Captura de pantalla ===
/* Añadir cuando/si se crea un interfaz para FreedomBox */
=== Usar User websites ===
El módulo está siempre activado y el interfaz web de !FreedomBox no ofrece configuración ni página de estado para este módulo.
Para servir documentos con el módulo solo se necesita poner los documentos en un subdirectorio designado '''`/home/<un_usuario_de_plinth>/public_html`'''.
`User websites` servirá los archivos que haya en este directorio cuando se reciban peticiones con la URI `~<un_usuario_de_freedombox>`. Por tanto para un dominio `ejemplo.org` con un usuario `pepe` una petición `ejemplo.org/~pepe/index.html` transferirá el fichero `/home/pepe/public_html/index.html`.
=== Usar SFTP para crear public_html y subir archivos ===
/* Pendiente de redactar */
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

96
doc/manual/es/Backups.raw.wiki Normal file
View File

@ -0,0 +1,96 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Backups|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Copias de respaldo (backups) ==
!FreedomBox incluye la posibilidad de copiar y restaurar datos, preferencias, configuración y secretos de la mayoría de las aplicaciones. La funcionalidad de ''Backups'' se resuelve con el software de ''backup'' ''Borg''. ''Borg'' es un programa de ''backup'' con deduplicación y compresión. Está diseñado para hacer ''backups'' eficientes y seguros. Esta funcionalidad de ''backups'' se puede emplear para respaldar y recuperar datos aplicación por aplicación. Las copias de respaldado se pueden almacenar en la propia máquina !FreedomBox o en un servidor remoto. Cualquier servidor remoto con acceso por SSH se puede emplear como almacenamiento para los ''backups'' de la !FreedomBox. Las copias remotas se pueden cifrar para que el servidor remoto no pueda leer los datos que alberga.
=== Estados de la Funcionalidad de Backups ===
|| '''App/Funcionalidad''' || '''Soporte en Versión''' || '''Notas''' ||
|| Avahi || - || no precisa ''backup'' ||
|| Backups || - || no precisa ''backup'' ||
|| Bind || 0.41 || ||
|| Cockpit || - || no precisa ''backup'' ||
|| Datetime || 0.41 || ||
|| Deluge || 0.41 || '''no''' incluye archivos descargados ni semillas ||
|| Diagnostics || - || no precisa ''backup'' ||
|| Dynamic DNS || 0.39 || ||
|| ejabberd || 0.39 || incluye todos los datos y configuración ||
|| Firewall || - || no precisa ''backup'' ||
|| ikiwiki || 0.39 || incluye todos los wikis/blogs y sus contenidos ||
|| infinoted || 0.39 || incluye todos los datos y claves ||
|| JSXC || - || no precisa ''backup'' ||
|| Let's Encrypt || 0.42 || ||
|| Matrix Synapse || 0.39 || incluye media y cargas ||
|| !MediaWiki || 0.39 || incluye páginas de wiki y archivos adjuntos ||
|| Minetest || 0.39 || ||
|| MLDonkey || 19.0 || ||
|| Monkeysphere || 0.42 || ||
|| Mumble || 0.40 || ||
|| Names || - || no precisa ''backup'' ||
|| Networks || No || sin planes para implementar ''backup'', de momento ||
|| OpenVPN || 0.48 || incluye a todos los usuarios y claves de servidor ||
|| Pagekite || 0.40 || ||
|| Power || - || no precisa ''backup'' ||
|| Privoxy || - || no precisa ''backup'' ||
|| Quassel || 0.40 || incluye usuarios y registros de ejeución (''logs'') ||
|| Radicale || 0.39 || incluye calendario y datos de tarjetas de todos los usuarios ||
|| Roundcube || - || no precisa ''backup'' ||
|| SearX || - || no precisa ''backup'' ||
|| Secure Shell (SSH) Server || 0.41 || incluye las claves del servidor ||
|| Security || 0.41 || ||
|| Shadowsocks || 0.40 || solo secretos ||
|| Sharing || 0.40 || '''no''' incluye datos de las carpetas compartidas ||
|| Snapshot || 0.41 || solo configuración, '''no''' incluye datos de capturas (snapshots) ||
|| Storage || - || no precisa ''backup'' ||
|| Syncthing || 0.48 || '''no''' incluye datos de las carpetas compartidas ||
|| Tahoe-LAFS || 0.42 || incluye todos los datos y configuración ||
|| Tiny Tiny RSS || 19.2 || incluye base de datos con ''feeds'', historias, etc. ||
|| Tor || 0.42 || includes configuración y secretos como las claves de servicios Tor Onion ||
|| Transmission || 0.40 || '''no''' incluye archivos descargados ni semillas ||
|| Upgrades || 0.42 || ||
|| Users || No || sin planes para implementar ''backup'', de momento ||
=== Cómo instalar y usar Backups ===
'''Paso 1: Ir a la página de Copias de Seguridad'''
{{attachment:Backups_Step1_es_v02.png|Backups: Paso 1|width=800}}
'''Paso 2: Pulsar el botón Instalar'''
{{attachment:Backups_Step2_v49.png|Backups: Paso 2|width=800}}
'''Paso 3: Esperar a que se instalen todos los componentes de la aplicación'''
{{attachment:Backups_Step3_es_v01.png|Backups: Paso 3|width=800}}
'''Paso 4: Pulsar el botón de Crear Copia de Seguridad'''
{{attachment:Backups_Step4_es_v02.png|Backups: Paso 4|width=800}}
'''Paso 5: Seleccionar las aplicaciones a respaldar y pulsar Enviar'''
{{attachment:Backups_Step5_es_v02.png|Backups: Paso 5|width=800}}
'''Paso 6: Pulsar en el botón Descargar'''
{{attachment:Backups_Step6_es_v02.png|Backups: Paso 6|width=800}}
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

37
doc/manual/es/BananaPro.raw.wiki Normal file
View File

@ -0,0 +1,37 @@
== Banana Pro ==
{{attachment:banana-pro.jpg|Banana Pro|width=640}}
[[http://www.lemaker.org|LeMaker]] Banana Pro is an updated version of its predecessor Banana Pi.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot into !FreedomBox. Pick the image meant for Banana Pro.
An alternative to downloading these images is to [[InstallingDebianOn/Allwinner|install Debian]] on the device and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Hardware ===
* Open Source Hardware (OSHW): No
* CPU: Allwinner A20, Dual-core ARM Cortex A7 processor
* RAM: 3 variants - 1 GB
* Storage: SD card
* Architecture: armhf
* Ethernet: 10/100/1000 Mbps
* Battery: No
* !WiFi: WiFi 802.11 b/g/n 2.4GHz (not tested with !FreedomBox)
* SATA: SATA 2.0 (2.5 inch SSD or HDD recommended)
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Unknown
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

46
doc/manual/es/BeagleBone.raw.wiki Normal file
View File

@ -0,0 +1,46 @@
== Beagle Bone Black ==
{{attachment:beagleboard.jpg|Beagle Bone Black|width=632,height=421}}
[[https://beagleboard.org/black|Beagle Bone Black]] (Revision C.1) is an Open Source Hardware (OSHW) single board computer. This means that the designer is actively helping people using the platform for their own designs, and supports them in adding hardware functionality and production advice. This is a part of freedom that is often overlooked, but very much aligned with the !FreedomBox goals. !FreedomBox images are built and tested for this device.
'''Important:''' Read [[FreedomBox/Hardware|general advice]] about hardware before building a !FreedomBox with this single board computer.
=== Download ===
!FreedomBox SD card [[FreedomBox/Download|images]] are available for this device. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card and boot the device.
Note: This image is for !BeagleBone Black (Revision C.1) only. It will not work on the !BeagleBone Green, and also not on the Revisions A&B. If you have such a device and would like to help getting !FreedomBox to run on it, contact us!
An alternative to downloading these images is to [[InstallingDebianOn/TI/BeagleBone|install Debian]] on the !BeagleBone and then [[FreedomBox/Hardware/Debian|install FreedomBox]] on it.
=== Availability ===
* Price: ~ 59 USD (50 EUR)
* [[http://dk.mouser.com/access/?pn=595-BB-BBLK-000|Mouser Electronics]]
* [[https://beagleboard.org/black|Full list of suppliers]]
=== Hardware ===
* Open Source Hardware (OSHW): [[http://elinux.org/Beagleboard:BeagleBoneBlack|Yes]]
* CPU: [[http://www.ti.com/product/am3358|AM335x 1GHz ARM Cortex-A8]]
* RAM: 512MB DDR3L 800 Mhz
* Storage: Onboard 4GB, 8bit Embedded MMC and microSD
* Architecture: armhf
* Ethernet: 10/100, RJ45
* !WiFi: None, use a [[FreedomBox/Hardware/USBWiFi|USB WiFi device]]
* SATA: None
=== Non-Free Status ===
* Non-free blobs required: No
* !WiFi: Not available
## END_INCLUDE
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox
Beagle Bone Black image is licensed under a Creative Commons Attribution-!ShareAlike 3.0 Unported License by [[http://elinux.org/File:REV_A5A.jpg|Circuitco]].

24
doc/manual/es/Bind.raw.wiki Normal file
View File

@ -0,0 +1,24 @@
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: - [[FreedomBox/Manual/Bind|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== BIND (Servidor de Nombre de Dominio) ==
BIND te permite publicar en Internet tu información de Sistema de Nombre de Dominio (DNS) y resolver consultas DNS de los dispositivos de usuario en tu red.
Actualmente en !FreedomBox BIND solo se usa para resolver consultas DNS de otras máquinas en tu red local. También es incompatible con compartir conexiones a Internet de tu !FreedomBox.
Nota: Este servicio solo está disponible en redes configuradas como zona "interna". Tampoco está disponble a través de OpenVPN (es incompatible).
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

131
doc/manual/es/Cockpit.raw.wiki Normal file
View File

@ -0,0 +1,131 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Cockpit|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Cockpit (Administración de Servidor) ==
Cockpit es una aplicación que facilita administrar servidores GNU/Linux desde el navegador web. En una !FreedomBox, hay disponibles controles para muchas funciones avanzadas que normalmente no se necesitan. También hay disponible un terminal web para operaciones de consola.
Cualquier usuario del grupo de administradores de to !FreedomBox puede acceder a Cockpit. Cockpit solo se puede usar si tienes una configuración de nombre de dominio apropiada para tu !FreedomBox y usas ese nombre de dominio para acceder a Cockpit. Para más información mira la sección de Resolución de Problemas.
{{{#!wiki caution
Usa cockpit sólo si eres un administrador de sistemas GNU/Linux con habilidades avanzadas. !FreedomBox intenta coexistir con los cambios al sistema que efectúan los administradores y sus herramientas, como Cockpit. Sin embargo, los cambios al sistema inadecuados pueden causar fallos en las funciones de !FreedomBox.
}}}
=== Usar Cockpit ===
Instala Cockpit como cualquier otra aplicación de !FreedomBox. Y a continuación asegúrate de que Cockpit está habilitado.
{{attachment:cockpit-enable.png}}
Asegúrate de que la cuenta de usuario de !FreedomBox que se empleará con Cockpit es parte del grupo de administradores.
{{attachment:cockpit-admin-user.png}}
Arranca el interfaz web de Cockpit. Ingresa con la cuenta de usuario configurada.
{{attachment:cockpit-login.png}}
Empieza a usar cockpit.
{{attachment:cockpit-system.png}}
Cockpit también funciona con interfaces mobiles.
{{attachment:cockpit-mobile.png}}
=== Funcionalidades ===
Las siguientes funcionalidades de Cockpit pueden ser útiles para usuarios avanzados de !FreedomBox.
==== Cuadro de Mando del Sistema ====
Cockpit tiene un cuadro de mando del sistema que
* Muestra información detallada del ''hardware''.
* Muestra métricas básicas de rendimiento del sistema.
* Permite cambiar la hora y el huso del sistema.
* Permite cambiar el ''hostname''. Por favor usa el interfaz de usuario de !FreedomBox UI para hacer esto.
* Muestra las huellas del servidor SSH.
{{attachment:cockpit-system.png}}
==== Visualización de los Registros de Ejecución (logs) del Sistema ====
Cockpit permite consultar los registros de ejecución (logs) del sistema y examinarlos a todo detalle.
{{attachment:cockpit-logs.png}}
==== Administración de Almacenamiento ====
Cockpit permite las siguientes funciones avanzadas de almacenamiento:
* Visualización de llenado de discos.
* Edición de particiones de disco.
* Administración de RAID.
{{attachment:cockpit-storage1.png}}
{{attachment:cockpit-storage2.png}}
==== Redes ====
Tanto Cockpit como !FreedomBox se apoyan en !NetworkManager para configurar la red. No obstante, Cockpit ofrece alguna configuración avanzada no disponible en !FreedomBox:
* Configuración de rutas.
* Configuración de enlaces, puentes y VLANs.
{{attachment:cockpit-network1.png}}
{{attachment:cockpit-network2.png}}
{{attachment:cockpit-network3.png}}
==== Servicios ====
Cockpit permite agendar servicios y tareas periódicas (como cron).
{{attachment:cockpit-services1.png}}
{{attachment:cockpit-services2.png}}
==== Terminal Web ====
Cockpit ofrece un terminal web que se puede usar para ejecutar tareas manuales de administración del sistema.
{{attachment:cockpit-terminal.png}}
=== Resolución de Problemas ===
Cockpit require un nombre de dominio adecuadamente configurado en tu !FreedomBox y solo funcionará cuando accedas a él mediante una URL con ese nombre de dominio. Cockpit no funcionará con una dirección IP en la URL. Tampoco con ''freedombox.local'' como nombre de dominio. Por ejemplo, las URLs siguientes no funcionarán:
{{{
https://192.168.0.10/_cockpit/
https://freedombox.local/_cockpit/
}}}
A partir de la versión 19.15 funciona el dominio ''.local''. Puedes acceder a Cockpit mediante la URL https://freedombox.local/_cockpit/. El dominio ''.local'' se basa en tu ''hostname''. Si tu ''hostname'' es ''mifb'' tu nombre de dominio ''.local'' será ''mifb.local'' y la URL de Cockpit será https://mifb.local/_cockpit/.
Para acceder apropiadamente a Cockpit, usa el nombre de dominio [[es/FreedomBox/Manual/Configure|configurado]] en tu !FreedomBox. Cockpit también funcionará cuando se use un [[es/FreedomBox/Manual/Tor|Servicio Tor Onion]]. Las siguientes URLs funcionarán:
{{{
https://mybox.freedombox.rocks/cockpit/
https://exampletorhs.onion/cockpit/
}}}
La razón para este comportamiento es que Cockpit emplea !WebSockets para conectar con el servidor de ''backend''. Por seguridad se deben evitar las peticiones a !WebSockets con servidores cruzados. Para implementar esto Cockpit maintiene una lista de todos los dominios desde los que se admiten peticiones. !FreedomBox configura automaticamente esta lista cuando añades o borras un dominio. Sin embargo, como no podemos fiarnos de las direcciones IP, !FreedomBox no las añade a esta lista. Puedes mirar la lista actual de dominios aceptados administrada por !FreedomBox en ''/etc/cockpit/cockpit.conf''. Puedes editarla pero hazlo solo si comprendes sus consecuencias para la seguridad web.
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

39
doc/manual/es/Configure.raw.wiki Normal file
View File

@ -0,0 +1,39 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Configure|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Configurar ==
Configurar tiene algunas opciones generales de configuración:
=== Hostname ===
. ''Hostname'' es el nombre local por el que otros dispositivos pueden alcanzar tu !FreedomBox desde la red local. El ''hostname'' por defecto es ''freedombox''.
=== Nombre de Dominio ===
. El Nombre de Dominio es el nombre global por el que otros dispositivos pueden alcanzar tu !FreedomBox desde la Internet. El valor que se asigne aquí es el que usarán [[FreedomBox/Manual/ejabberd|Chat Server (XMPP)]], [[FreedomBox/Manual/MatrixSynapse|Matrix Synapse]], [[FreedomBox/Manual/LetsEncrypt|Certificates (Let's Encrypt)]], y [[FreedomBox/Manual/Monkeysphere|Monkeysphere]].
=== Página Principal (home) del Servidor Web ===
. Esta es una opción avanzada que te permite establecer como ''home'' algo diferente al servicio !FreedomBox para que se sirva a quien acceda con el navegador al nombre de dominio de !FreedomBox. Por ejemplo, si el nombre de dominio de tu !FreedomBox es https://myfreedombox.rocks y estableces a !MediaWiki como ''home'', al visitar https://mifreedombox.mola te llevará a https://myfreedombox.rocks/mediawiki/ en vez de a https://mifreedombox.mola/plinth/. Puedes asignar la ''home'' a cualquier aplicación web, los wikis y blogs de Ikiwiki o la página index.html por defecto de Apache.
{{{#!wiki caution
Una vez asignada como ''home'' otra aplicación, ya solo puedes navegar al servicio !FreedomBox tecleando en el navegador https://mifreedombox.mola/plinth/. <<BR>>
''/freedombox'' también se puede usar como alias para ''/plinth''
}}}
. ''Consejo:'' Guarda la URL del servicio !FreedomBox antes de asignar la ''home'' a otra app.
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

108
doc/manual/es/Contribute.raw.wiki Normal file
View File

@ -0,0 +1,108 @@
<<TableOfContents>>
= Participa =
## BEGIN_INCLUDE
Desde la codificación, el diseño y la traducción hasta la divulgación y las donaciones he aquí varias formas de contribuir a !FreedomBox.
== Enlaces Rápidos ==
[[https://docs.freedombox.org/|Manual del Desarrollador de FreedomBox]] <<BR>>
[[FreedomBox/ProgressCalls|Reuniones de revisión de avance]] <<BR>>
[[FreedomBox/TODO|Página de trabajos pendientes]] <<BR>>
[[https://www.freedomboxfoundation.org/donate/|Página de Donaciones]]<<BR>>
== Bienvenida a los recién llegados ==
Como nuevo contribuyente, eres más que bienvenido a presentarte a otros en el [[https://discuss.freedombox.org/c/development|foro de debate]], la [[http://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss|lista de correo]] o el [[irc://irc.debian.org/freedombox|canal de IRC]] de !FreedomBox. Además de hacer contactos útiles, puedes empezar a informar fallos y traducir (ver abajo) el wiki y el interfaz de !FreedomBox.
== Prioridades de Desarrollo ==
Las prioridades se discuten regularmente. Encontrarás el avance del Servicio !FreedomBox con sus prioridades aquí: [[https://salsa.debian.org/groups/freedombox-team/-/boards|panel de tareas]] e [[https://salsa.debian.org/groups/freedombox-team/-/milestones|hitos]].
Por favor, asiste a las próximas [[FreedomBox/ProgressCalls|reuniones de avance]] para mantenerte al día y tratar con los miembros del equipo de publicación (release). La [[FreedomBox/TODO|Página de trabajos pendientes]] recopila la lista completa de los elementos en los que trabajar para !FreedomBox.
== Se necesitan Contribuciones ==
=== Añadir una Aplicación ===
Si eres desarrollador y quieres ver disponible en !FreedomBox alguna aplicación, puedes contribuir añadiéndola a !FreedomBox. Mira el [[https://docs.freedombox.org/|Manual del Desarrollador de FreedomBox]].
=== Defectos ===
Las listas de defectos, peticiones de funcionalidad y mejoras se controlan en el [[https://salsa.debian.org/freedombox-team/freedombox/issues/|gestor de tiquets]] de !FreedomBox. Mira también la [[FreedomBox/Contribute/Bugs|lista de defectos]] para ayudar al paquete Debian del que dependemos y el [[https://qa.debian.org/developer.php?login=freedombox-pkg-team%40lists.alioth.debian.org&comaint=yes|cuadro de mando del equipo de paquetizado]] de !FreedomBox para ver el estado los paquetes que usamos.
=== Codificar ===
Si eres desarrollador puedes contribuir código a algún sub-proyecto de !FreedomBox. Éste es el procedimiento paso a paso para [[FreedomBox/Contribute/Code|contribuir código]].
* [[FreedomBox/Plinth|Servicio FreedomBox]]: un interfaz web para administrar las funciones de !FreedomBox.
* [[FreedomBox/Maker|Freedom Maker]]: un script para construir imágenes de disco de !FreedomBox para usarlas en dispositivos de hardware variados o en máquinas virtuales.
Puedes tomar una tarea de la [[FreedomBox/TODO|Página de trabajos pendientes]]. Las páginas de cada proyecto contienen información acerca de acceso al código, cómo construir y listas de trabajos pendientes.
=== Diseño ===
==== Diseño de Experiencia de Usuario (UX) ====
Si eres diseñador de UX, puedes ayudar a !FreedomBox con esto:
* Experiencia de interacción para el interfaz web del Servicio !FreedomBox.
* Diseño web para los sitios [[https://freedombox.org|freedombox.org]], [[https://freedomboxfoundation.org|freedomboxfoundation.org]] y el [[FreedomBox|wiki]].
* Logo y marca (actualmente tenemos [[https://salsa.debian.org/freedombox-team/freedombox/tree/master/static/themes/default|un manual de identidad y logos]]).
* Propuestas de diseño para casos de uso de !FreedomBox sobre SBCs personalizados.
* [[FreedomBox/Design|Diseño de UX]]
==== Diseño Técnico ====
!FreedomBox necesita tu conocimiento técnico para elaborar planes de implementación de nuevas funcionalidades. Puedes contribuir a los debates acerca de varios aspectos de diseño técnico e implementación de !FreedomBox. Mira la [[https://discuss.freedombox.org/c/development|sección de desarrollo]] de los foros de discusión.
=== Donar ===
La ''[[https://freedomboxfoundation.org|FreedomBox Foundation]]'' es una corporación federal 501(c)(3) reconocida por el IRS. El proyecto !FreedomBox lo llevan voluntarios. Puedes ayudar a su financiación donando mediante !PayPal, Bitcoin o enviando un cheque. Mira por favor la [[https://www.freedomboxfoundation.org/donate/|página de donación]] para más detalles acerca de cómo donar.
=== Documentar: Manual de Usuario, Sitio Web y Wiki ===
!FreedomBox necesita mejor documentación para usuarios y contribuyentes. El manual de !FreedomBox se prepara agregando diferentes páginas del wiki y exportando a various formatos. El manual se usa en el Servicio !FreedomBox y en otros sitios.
Si quieres contribuir al [[FreedomBox|wiki]] (y por extensión al manual) de !FreedomBox, puedes crear una cuenta en el wiki y empezar a editar.
Para contribuir al sitio web por favor inicia un debate en la [[https://discuss.freedombox.org/c/development|sección de desarrollo]] del foro de !FreedomBox.
=== Asegurar la Calidad ===
* !FreedomBox ya funciona sobre muchas plataformas y a los desarrolladores les resulta imposible probar en todas. Si tienes algún hardware soportado puedes ayudar probando !FreedomBox en tu platforma.
* Cuando se integra una nueva aplicación en !FreedomBox, el desarrollador que hace el trabajo no prueba toda la functionalidad en el mundo real. Desplegar la aplicación y probarla ayudará a tener aplicaciones de alta calidad en !FreedomBox.
Mira en la página de [[FreedomBox/QualityAssurance|aseguramiento de la calidad]] la lista de casos de prueba que hay que verificar y la información acerca de cómo informar defectos.
=== Localizar (l10n) ===
Todo texto visible por los usuarios de !FreedomBox necesita ser localizado a varios idiomas. Este trabajo de traducción incluye:
* El [[FreedomBox/Plinth|Interfaz web]] de !FreedomBox
* La documentación de !FreedomBox
* El [[FreedomBox|wiki]] y los sitios web de [[https://freedombox.org|FreedomBox]] y la ''[[https://freedomboxfoundation.org|Freedombox Foundation]]''.
* El [[https://docs.djangoproject.com/en/dev/internals/contributing/localizing/|framework Django]] que emplea !FreedomBox.
* Cada aplicación que !FreedomBox expone a sus usuarios.
Puedes contribuir al esfuerzo de localización usando la herramienta web [[https://hosted.weblate.org/projects/freedombox/|Weblate]] o directamente en el repositorio de código mediante [[https://salsa.debian.org/freedombox-team/freedombox/tree/master/plinth/locale|Salsa]].
Si quieres ver a !FreedomBox disponible en alguno de tus idiomas, por favor abre un debate en la [[https://discuss.freedombox.org/c/development|sección de desarrollo]] del foro de !FreedomBox para trabajar con otros traduciendo para ese idioma.
Para más información, por favor visita la página de [[FreedomBox/Translate|traductores]].
=== Correr la Voz ===
Cuenta a tu familia, amistades, comunidad local o en conferencias globales la importancia de !FreedomBox. Para ser un proyecto exitoso necesitamos muchos más
participantes, ya sean usuarios o contribuyentes. Comenta tus esfuerzos de divulgación en la [[https://www.freedomboxfoundation.org/appearances/index.en.html|página de charlas]] y en el [[FreedomBox/TalksAndPresentations|wiki]].
## END_INCLUDE
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

50
doc/manual/es/Coquelicot.raw.wiki Normal file
View File

@ -0,0 +1,50 @@
== Compartición de Archivos (Coquelicot) ==
=== Acerca de Coquelicot ===
''Coquelicot'' es aplicación web para compartir archivos enfocada a proteger la privacidad de sus usuarios. El principio básico es simple: los usuarios pueden subir un archivo al servidor y a cambio reciben una URL única para descargarlo que se puede compartir con terceros. Además se puede establecer una contraseña para reforzar el acceso.
Más información acerca de Coquelicot en [[https://coquelicot.potager.org/README|su LEEME]]
'''Disponible desde:''' versión 0.24.0
=== Cuando usar Coquelicot ===
El mejor uso de Coquelicot es para compartir rápidamente un archivo suelto.
Si quieres compartir una carpeta...
* ...para usar y tirar, comprime la carpeta y compartela como archivo con Coquelicot
* ...que deba mantenerse sincronizada entre ordenadores usa mejor [[../Syncthing|Syncthing]]
Coquelicot también puede proporcionar un grado de privacidad razonable. Si se necesita anonimato mejor sopesas emplear la aplicación de escritorio [[https://onionshare.org/|Onionshare]].
Como Coquelicot carga todo el archivo al servidor tu !FreedomBox consumirá ancho de banda tanto para la subida como para la descarga. Para archivos muy grandes sopesa compartirlos creando un fichero !BitTorrent privado. Si se necesita anonimato usa Onionshare. Es P2P y no necesita servidor.
=== Coquelicot en FreedomBox ===
Con Coquelicot instalado puedes subir archivos a tu servidor !FreedomBox y compartirlos en privado.
Tras la instalación la página de Coquelicot ofrece 2 preferencias.
1. '''Contraseña de Subida''': Actualmente y por facilidad de uso Coquelicot está configurado en !FreedomBox para usar autenticación simple por contraseña. Recuerda que se trata de una contraseña global para esta instancia de Coquelicot y no tu contraseña de usuario para !FreedomBox. Tienes que acordarte de esta contraseña. Puedes establecer otra en cualquier momento desde el interfaz Plinth.
2. '''Tamaño Máximo de Archivo''': Puedes alterar el tamaño máximo de los archivos a transferir mediante Coquelicot usando esta preferencia. El tamaño se expresa en [[https://en.wikipedia.org/wiki/Mebibyte|Mebibytes]] y el máximo solo está limitado por el espacio en disco de tu !FreedomBox.
=== Privacidad ===
Alguien que monitorice tu tráfico de red podría averiguar que se está transfiriendo un archivo en tu !FreedomBox y posiblemente también su tamaño pero no sabrá su nombre. Coquelicot cifra los archivos en el servidor y sobrescribe los contenidos con 0s al borrarlos, eliminando el riesgo de que se desvelen los contenidos del fichero si tu !FreedomBox resultara confiscada o robada. El riesgo real que hay que mitigar es que además del destinatario legítimo un tercero también descargue tu fichero.
==== Compartir mediante mensajería instantánea ====
Algunas aplicaciones de mensajería instantánea con vista previa de sitios web podrían descargar tu fichero para mostrarla (su vista previa) en la conversación. Si configuras la opción de descarga única para un archivo podrías notar que la aplicación de mensajería consume la única descarga. Si compartes mediante estas aplicaciones usa una contraseña de descarga en combinación con la opción de descarga única.
==== Compartir en privado enlaces de descarga ====
Se recomienda compartir las contraseñas y los enlaces de descarga de tus archivos por canales cifrados. Puedes evitar todos los problemas anteriores con las vistas previas de la mensajería instantánea símplemente empleando aplicaciones de mensajería que soporten conversaciones cifradas como Riot con [[../MatrixSynapse| Matrix Synapse]] o [[../ejabberd|XMPP]] (servidor ejabberd en !FreedomBox) con clientes que soporten cifrado punto a punto. Envía la contraseña y el enlace de descarga separados en 2 mensajes distintos (ayuda que tu aplicación de mensajería soporte ''perfect forward secrecy'' como XMPP con OTR). También puedes compartir tus enlaces por correo electrónico cifrado con PGP usando [[https://securityinabox.org/en/guide/thunderbird/linux/|Thunderbird]].
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

63
doc/manual/es/Coturn.raw.wiki Normal file
View File

@ -0,0 +1,63 @@
#language es
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Coturn|English]] - Español -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Coturn (Asistente para VoIP) ==
||<tablestyle="float: right;"> {{attachment:FreedomBox/Manual/Coturn/Coturn-icon_en_V01.png|icono de Coturn}} ||
'''Disponible desde''': versión 20.8
Coturn es un servidor para facilitar llamadas y conferencias de audio/video proporcionando una implementación de los protocolos TURN y STUN. Los servidores de comunicación por WebRTC, SIP y otros pueden usarlo para establecer una llamada entre partes que de otro modo no podrían conectarse entre si.
No está pensado para que lo usen diréctamente los usuarios. Los servidores como Matrix Synapse necesitan configurarse con los datos proporcionados en la página de app de Coturn. Además de Matrix Synapse, Jitsi, Ejabberd, Nextcloud Talk, etc. pueden usar el servidor Coturn para llamadas y conferencias de audio/video. No hace falta que los servidores se ejecuten en la misma máquina que !FreedomBox. Los servidores externos pueden usar un Coturn ejecutado en !FreedomBox.
Coturn está configurada en !FreedomBox como app avanzada. Esto implica que para ver el icono de Coturn en la sección "Apps" necesitas marcar en "Mostrar apps y funcionalidades avanzadas" en "Configuración General".
=== Cómo funciona ===
Al hacer una llamada de audio/video lo mejor es enrutar los flujos multimedia directamente entre los pares porque minimiza la latencia (mejor calidad de señal) y evita depender de un servidor centralizado (privacidad). Esto escala bien porque un servidor de chat simple puede albergar miles de llamadas sin involucrarse de ningún otro modo que para establecer la llamada. Sin embargo este enfoque no suele funcionar la mayoría de las veces por cómo se configuran las redes. La mayoría de los pares de la red carecen de una dirección IP propia reservada para ellos y suelen operar detrás de un dispositivo de red que les traduce las direcciones de red (NAT: ''"Network Address Translation"''). Esto significa que en realidad estos pares no tienen modo de alcanzarse entre sí directamente.
Para abordar este problema se introdujo una técnica simple conocida como STUN. Con ayuda de un servidor STUN los pares pueden prescindir de los dispositivos NAT para transmitir entre ellos. Desafortunadamente este truco solo funciona un 80% de las ocasiones. Así que si STUN falla, los pares no tienen más opción que enrutar su comunicación a través de un intermediario llamado servidor TURN. Todo el mecanismo de intentar primero con STUN y recaer en TURN se describe en un protocolo llamado ICE.
En !FreedomBox, Coturn proporciona servidores STUN y TURN. Ambos servicios se proporcionan tanto sobre TCP como sobre UDP y tanto en canales cifrados (que tienen mayor probabilidad de éxito) como sin cifrar. Como los servidores STUN son baratos y no consumen muchos recursos no se necesita autenticación para usarlos. Por otra parte los servidores TURN sí la necesitan. Esta autenticación está altamente simplificada y no requiere mantener una base de datos de usuarios. Un servidor como matrix-synapse que vaya a establecer una llamada de audio/video entre dos pares generará un nombre de usuario y contraseña empleando un secreto compartido. Cuando los pares usen el servidor TURN se les validará usando estas credenciales porque el servidor TURN conoce este secreto.
En resumen, un servidor de comunicaciones necesita saber las URLs de los servidores STUN/TURN junto con el secreto de autenticación para TURN. Después, durante el establecimiento de la llamada de audio/video guiarán a los pares a usar los servidores STUN/TURN. La app Coturn de !FreedomBox proporciona exactamente ésta información, que se puede usar para configurar un servidor de comunicaciones independientemente de que se ejecute en la misma máquina que !FreedomBox o en otro servidor.
=== Configurar Matrix Synapse ===
El servidor de Matrix Synapse de !FreedomBox se puede configurar para que use el servidor de TURN/STUN Coturn. En el futuro, cuando instales Matrix Synapse !FreedomBox instalará Coturn automáticamente y configurará sus parámetros en Matrix Synapse. Para configurar Matrix Synapse, edita el fichero ''/etc/matrix-synapse/homeserver.yaml'' con las siguientes líneas:
{{{
turn_uris: [ "stun:myfreedombox.example.org:3478?transport=udp", "stun:myfreedombox.example.org:3478?transport=tcp", "turn:myfreedombox.example.org:3478?transport=udp", "turn:myfreedombox.example.org:3478?transport=tcp" ]
turn_shared_secret: "my-freedombox-provided-secret"
turn_user_lifetime: 86400000
turn_allow_guests: True
}}}
Y luego reinicia el servidor matrix-synapse deshabilitando y rehabilitando la app de matrix-synapse.
=== Redirección de Puertos ===
Si tu !FreedomBox está detrás de un router, necesitarás configurar la redirección de los siguientes puertos para Coturn:
* UDP 3478
* TCP 3478
* UDP 3479
* TCP 3479
* UDP 5349
* TCP 5349
* UDP 5350
* TCP 5350
## END_INCLUDE
Volver a la [[es/FreedomBox/Features|descripción de Funcionalidades]] o a las páginas del [[es/FreedomBox/Manual|manual]].
<<Include(es/FreedomBox/Portal)>>
----
CategoryFreedomBox

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