# FreedomBox Manual

## 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 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.

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.

FreedomBox can also host a Wi-Fi access point, ad blocking proxy and VPN. More advanced users can replace their router with a FreedomBox.

To set up FreedomBox at home on a specific hardware or on your computer running Debian may require a bit of technical expertise or help from the community. Once installed the interface is easy to use, similar to a smart phone.

Related documentation:

- FreedomBox applications

- Machines that support FreedomBox

- Download and Install

- Manual

- Live Help from the community

### 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 using GNU Social and Diaspora, 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 used to connect to public networks at work, school or office to avail its services.

It could be used in a village to make available digital communications throughout the village. In the future, FreedomBox intends to deliver support for alternative ways of connecting to the Internet such as Mesh networking.

### FreedomBox Interface

#### Screenshot

freedombox-frontpage-2018-02-26.png

#### Screencast introduction

Plinth_Introduction.webm

(36 MB, 13 Min.)

#### More video resources

Eben Moglen's talk, Eben Moglen - Freedom in the cloud, delivered before the FreedomBox project was started gives insights into the philosophy behind FreedomBox.

First demonstration of FreedomBox at SFLC, University of Columbia by Sunil Mohan Adapa.

## Quick Start

### What you need to get started

- A supported 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 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.

2. Power on the FreedomBox.

3. On first boot, the FreedomBox will perform its initial setup and then reboot. This may take several minutes.

4. After the FreedomBox has rebooted, you can access its web interface (called Plinth) through your web browser.

   - If your computer is connected directly to the FreedomBox through a second (LAN) ethernet port, you can browse to: or .

   - If your computer supports mDNS (GNU/Linux, Mac OSX or Windows with mDNS software installed), you can browse to: (or )

   - If you know your way around the router's web interface, you can look up the IP adress 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 adress, 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 :

              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 . (10.42.0.1 is my laptop.)

5. On accessing Plinth 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.

   - Self-signed certificate warning

   - Add Security Exception

6. The first time you access the FreedomBox web interface, you will see a welcome page. Click the "Start Setup" button to continue.

   - Welcome

7. 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 log in using ssh. You might not want to use the user account you will want to use in daily usage, to prevent security issues. You can later add more users.

   - Account

8. After completing the form, you will be logged in to Plinth and able to access apps and configuration through the interface.

   - Complete

Now you can try 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 Plinth 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.

Front page

#### 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.

Apps

#### 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.

Help

#### System menu

The System menu can be accessed by clicking the gear icon in the top-right corner. It includes a number of pages related to system configuration.

System

#### 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.

User

## Getting Help

This document is intended to give you the information you need to get started with your FreedomBox. However, if you have any questions after reading this document, you can get help by:

- Emailing to our mailinglist at freedombox-discuss@lists.alioth.debian.org. You can also sign up to receive copies of every discussion that happens on the mailing list or read the archives.

- Chatting at #freedombox@irc.oftc.net.

- Reading the wiki.

- Reading the FreedomBox Foundation's website.

- Reading the FreedomBox Project Page.

## Download and Install

Welcome to the FreedomBox download page. You may either install FreedomBox on one of the supported inexpensive hardware devices, on any Linux 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 support page or read the Questions and Answers page based on posts on the 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 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 Hardware section. On the web 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:

- Official Images:

#### Verifying the Downloaded Images

It is important to verify the images you have downloaded to ensure that the file has not be corrupted during the transmission and that it is indeed the image built by FreedomBox developers.

- 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

- 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

- Finally, verify your downloaded image with its signature file `.sig`. For example:

      $ gpg --verify freedombox-unstable-free_2015-12-13_cubietruck-armhf.img.xz.sig freedombox-unstable-free_2015-12-13_cubietruck-armhf.img.xz
      gpg: Signature made Thursday 15 January 2015 09:27:50 AM IST using RSA key ID 0C9BC971
      gpg: Good signature from "Sunil Mohan Adapa <sunil@medhas.org>"
      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: BCBE BD57 A11F 70B2 3782  BC57 36C3 6144 0C9B C971

#### Installation

After the download you can use the image to boot your chosen 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.

   2. Run `dmesg -w` to show and follow the kernel messages.

   3. 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

   4. 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.

2. Decompress the downloaded image using tar:

       $ xz -d freedombox-unstable-free_2015-12-13_cubietruck-armhf.img.xz

   The above command is an example for the cubietruck image built on 2015-12-13. Your downloaded file name will be different.

3. 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-unstable-free_2015-12-13_cubietruck-armhf.img of=/dev/sdg conv=fdatasync

An alternative to copy to SD card command

-     $ cat freedombox-unstable-free_2015-12-13_cubietruck-armhf.img > /dev/sdg ; sync

On MS Windows you will need a tool like etcher.

- The above command is an example for the cubietruck image built on 2015-12-13. 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.

- 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 Hardware section).

- Read (the rest of) the Manual for instructions on how to use applications in FreedomBox.

## Apps

### Anonymity Network (Tor)

#### 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 and follow the instructions on that site to install and run it.

#### Using Tor Hidden Service to access your FreedomBox

Tor Hidden Service provides a way to access your FreedomBox, even if it's behind a router or firewall.

To enable Tor Hidden Service, first navigate to the Anonymity Network (Tor) page. (If you don't see it, click on the FreedomBox logo at the top-left of the page, to go to the main Apps page.) On the Anonymity Network (Tor) page, under Configuration, check "Enable Tor Hidden Service", then press the Update setup button. Tor will be reconfigured and restarted.

After a while, the page will refresh and under Status, you will see a table listing the Hidden Service .onion address. Copy the entire address (ending in .onion) and paste it into the Tor Browser's address field, and you should be able to access your FreedomBox. (You may see a certificate warning because FreedomBox has a self-signed certificate.)

Tor Browser - Plinth

Currently only HTTP (port 80), HTTPS (port 443), and SSH (port 22) are accessible through the Tor Hidden Service configured on the FreedomBox.

#### 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 Plinth.

At the bottom of the Tor page in Plinth, there is a list of ports used by the Tor relay. If your FreedomBox is behind a router, you will need to configure port forwarding on your router so that these ports can be reached from the public Internet.

#### Using Tor SOCKS port (advanced)

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.

### BitTorrent (Transmission)

#### 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 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

Transmission Web Interface

#### Using Transmission

After installing Transmission, it can be accessed at `https://<your freedombox>/transmission`. When you try to access this page, you will be required to login with a username and password. The default for both is "transmission". You can change the username and password using the configuration form in Plinth.

#### Known Issues

- The initial password is shown in the Plinth configuration form in a hashed format. This prevents it from being read or copied. However, after the password is changed, it is shown directly, without hashing.

### BitTorrent (Deluge)

#### 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: 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

Deluge Web UI

#### 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:

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.

Deluge Connection Manager (Offline)

Now it should say "Online". Click "Connect" to complete the setup.

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.

### Block Sandbox (Minetest)

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 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

### Calendar and Addressbook (Radicale)

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 Plinth

  1. select Applications

  2. go to Calendar and Addressbook (Radicale) 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.

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 does not have a user interface. An external supported client application is needed.

Now open your client application to create new calendar and address books that will use your FreedomBox and Radicale server. The Radicale website provides 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

    2. For "Type," select "CalDAV"

    3. When "CalDAV" is selected, additional options will appear in the dialogue window.

    4. URL: `https://`IP-address-or-domain-for-your-server`/radicale/`user`/`contact-file-name`.ics/`. Items in italics need to be changed to match your settings.

       - note the trailing `/` in the path, it is important.

    5. Enable "Use a secure connection."

    6. Name the calendar

       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.

- Android

  - There are various Apps that allow the integration of the *radicale* server. This example uses DAVdroid, which is available e.g. on F-Droid.

  - If you intend to use ToDo-Lists as well, the compatible app OpenTasks has to be installed first.

  - Install DAVdroid

  - Create an account in DAVdroid with the same settings as described for Evolution

  - Click the newly created account and synchronize.

  - The settings, such as periodicity of synchronization, can be adjusted.

  - A contact or calendar file, that was created before appears.

  - Enable it.

  - It may take some minutes before e.g. the calendar is visible in your calendar app.

#### 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

2. edit file `/etc/radicale/config` and make the following changes in section `[rights)`

   -     [rights]
         type = from_file
         file = /etc/radicale/rights

3. Restart the radicale server or the FreedbomBox

##### 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.

### Chat Server (XMPP)

#### What is XMPP?

XMPP is a federated protocol for Instant Messaging. This means that users who have accounts on one server, can talk to users that are on another server. XMPP can also be used for voice and video calls, if supported by the clients.

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.

2. 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 public Internet. You can read more about obtaining a Domain Name in the 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 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 Pagekite does not support the XMPP protocol at this time.

#### Registering XMPP users through SSO

Currently, all users created through Plinth will be able to login to the XMPP server. You can add new users through the System Users and Groups module. It does not matter which Groups are selected for the new user.

#### Using the web client

After the XMPP module install completes, the JSXC web client for XMPP can be accessed at `https://<your freedombox>/plinth/apps/xmpp/jsxc/`. It will automatically check the BOSH server connection to the configured domain name.

#### Using a desktop or mobile client

XMPP clients are available for various desktop and mobile platforms.

#### 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)

### Chat Server (Matrix Synapse)

#### What is the Matrix?

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. Each instance of a Matrix server federates with other instances such that all your contacts need not hold accounts on your server. See more detailed info about Matrix.

Note: The Matrix Synapse is available in FreedomBox starting with Plinth version 0.14.

#### How to access the Matrix?

We recommend the Riot client to access the Matrix server. You can download Riot for desktops. Mobile applications for Android and iOS are available from app stores.

#### Setting up your FreedomBox for Matrix

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. All the registered users will have their Matrix IDs as `@username:domain`. Currently, you will not be able to change the domain once is it configured.

#### 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.

### Email Client (Roundcube)

#### 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`.

### File Sharing (Coquelicot)

#### About Coquelicot

Coquelicot is a "one-click" file sharing web application with a focus on protecting users' privacy.

Read more about Coquelicot at 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 instead

Coquelicot can only provide a reasonable degree of privacy. If anonymity is required, you should consider using the desktop application 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 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 Matrix Synapse or 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 Thunderbird.

### File Synchronization (Syncthing)

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.

Note: Syncthing is available in FreedomBox starting with Plinth version 0.14.

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 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.

Syncthing_GUI.png

Syncthing has android apps available on the F-Droid and Google Play app stores. Cross-platform desktop apps are also available.

To learn more about Syncthing, please visit their official website and documentation.

### IRC Client (Quassel)

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 running 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 Plinth

  1. select Applications

  2. go to IRC Client (Quassel) and

  3. install the application and make sure it is enabled

     Quassel_Installation.png

  4. now your Quassel core is running

- Configure in your router port forwarding for port `4242`

  - on my device, this setting can be found in the section Network > NAT & Port rules > Port Forwarding

    Quassel_PortForwarding.png

#### Clients

Clients to connect to Quassel from your desktop and mobile devices are available.

In a Debian system, you can e.g. use quassel-client

1. With the first start you create a user-ID you want to use in your IRC channel

2. Configure the network connection, e.g. server `irc.debian.org/freedombox`

3. Communication takes place in a channel, e.g. `freedombox`

4. Add a core

   1. Chose an account name

   2. Computer name is the DNS name to access your FreedomBox

   3. Port: 4242

   4. User and password

For Android devices you may use e.g. Quasseldroid from F-Droid

- enter core, username etc. as above

  - Quasseldroid.png

By the way, the German verb quasseln means talking a lot, to jabber.

### News Feed Reader (Tiny Tiny RSS)

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 Plinth will be able to login and use this app.

Tiny Tiny RSS

##### Adding a new feed

1. Go to the website you want the RSS feed for and copy the RSS/Atom feed link from it.

Selecting feeds

2. Select "Subscribe to feed.." from the Actions dropdown.

Subscribe to feed

3. In the dialog box that appears, paste the URL for copied in step 1 and click the Subscribe button.

Subscription dialog box

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 WikiNews

As you can see in the image below, TT-RSS detected and added the Atom feed of WikiNews to our list of feeds.

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.

Unsubscribe from a feed

##### 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.

OPML feeds page

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 . 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.

Tiny Tiny RSS Tiny Tiny RSS Tiny Tiny RSS Tiny Tiny RSS Tiny Tiny RSS

### SIP Server (repro)

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.

   - Repro Domains

2. Add users at /repro/addUser.html.

   - Repro Users

3. 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

### SOCKS5 proxy (Shadowsocks)

#### What is Shadowsocks?

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.

Note: Shadowsocks is available in FreedomBox starting with Plinth version 0.18.

#### 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

### Virtual Private Network (OpenVPN)

#### 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.

#### Setting up

1. In Plinth apps menu, select Virtual Private Network (OpenVPN) and click Install.

2. After the module is installed, there is an additional setup step that may take a long time to complete. Click "Start setup" to begin.

   plinth_openvpn.png

3. Wait for the setup to finish. This could take a while.

4. 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.

5. The ovpn file contains all the information a vpn client needs to connect to the server.

6. If you are behind a modem, you may have to change the ip address (if not, you can skip this step). Open the ovpn file in any text editor. The second line shows the IP address or hostname the client will try to connect to. This should be your WAN IP address or your hostname. This line also contains the port number, 1194 being the default. You may have to open this port on your modem and enable port forwarding.

    client
    remote mybox.sds-ip.de 1194
    proto udp

1. Install an OpenVPN client for your system

2. Open the ovpn file with the OpenVPN client.

3. Try to ping the FreedomBox or other devices on the local network.

#### External Links

### Voice Chat (Mumble)

#### 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. 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

### Web Proxy (Privoxy)

A web proxy acts as a filter for incoming and outgoing internet traffic. Thus, you can instruct any computer in your network to pass internet traffic through the proxy to remove unwanted ads and tracking mechanisms.

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: Privoxy FAQ).

#### Screencast

Watch the screencast on how to setup and use Privoxy in FreedomBox.

#### Setting up

1. In Plinth install Web Proxy (Privoxy)

   Privoxy-Installation.png

2. 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.

   Privoxy-BrowserSettings.png

3. Go to page or . If Privoxy is installed properly, you will be able to configure it in detail; if not you will see an error message.

4. 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.

2. While using Privoxy, you can see its configuration details and documentation at or .

3. 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.

4. Now you find an `EDIT` button on the configuration screen in `http://config.privoxy.org/`.

5. The Quickstart is a good starting point to read on how to define own blocking and filtering rules.

### Web Search (Searx)

#### About Searx

Searx is a 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 official website.

Available since: version 0.24.0

#### 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 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 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 can be added as a search engine to the Firefox browser's search bar. See 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.

### Wiki (MediaWiki)

#### About MediaWiki

MediaWiki is the software that powers the Wikimedia suite of wikis.

Read more about MediaWiki on Wikipedia

Available since: version 0.20.0

#### 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 page in the Plinth UI.

##### 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

- 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

MediWiki's new Visual Editor gives a WYSIWYG user interface to creating wiki pages. Unfortunately, it is not yet available in the current version of MediaWiki on Debian.

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 Pandoc.

### Wiki and Blog (Ikiwiki)

#### 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 Plinth. 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.

ikiwiki: Create

#### 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.

ikiwiki: Manage

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 Plinth (under System configuration, the gear icon at the top right corner of the page). Create or modify a user, and add them to the wiki group. (Users in the admin group will also have wiki access.)

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".

## System

### Configure

Configure covers a couple of general topics:

1. Hostname

   - Hostname is the local name by which other devices on the local network can reach your FreedomBox. Default is freedombox.

2. 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 Chat Server (XMPP), Certificates (Let's Encrypt), and Monkeysphere.

3. Language

   - Language for the web administration interface Plinth

### 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).

DateTime.png

### 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.

### Disks

Disks shows free space of mounted partitions.

If there is some free space left after the root partition, the option to expand the root partition is also available.

- Note: The expand partition feature is not working in Plinth v0.13.1. A fix is planned for v0.14.0.

Disks.png

### Dynamic DNS Client

#### What is Dynamic DNS?

In order to reach a server on the Internet, the server needs to have permanent address also know as the static IP address. Many Internet service providers don't provide home users with a static IP address or they charge more providing a static IP address. Instead they provide the home user with an IP address that changes every time the user connects to the Internet. Clients wishing to contact the server will have difficulty reaching the server.

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 .

2. In FreedomBox UI, enable the Dynamic DNS Service.

3. Select GnuDIP as Service type, enter your Dynamic DNS service provider address (for example, gnudip.datasystems24.net) into GnuDIP Server Address field.

   DynamicDNS-Settings.png

4. 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.

2. In FreedomBox UI, enable the Dynamic DNS service.

3. Select other Update URL as Service type, enter the update URL given by your provider into Update URL field.

4. 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.

5. 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.

6. 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.

2. 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".

3. Check that the last update status is not failed.

#### Recap: How to create a DNS name with GnuDIP

1. Access to GnuIP login page (answer Yes to all pop ups)

2. Click on "Self Register"

3. Fill the registration form (Username and domain will form the public IP address [username.domain])

4. Take note of the username/hostname and password that will be used on the FreedomBox app.

5. Save and return to the GnuDIP login page to verify your username, domain and password (enter the datas, click login).

6. 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).

7. Leave the GnuDIP interface and open the Dynamic DNS Client app page in your FreedomBox.

8. Click on "Set Up" in the top menu.

9. Activate Dynamic DNS

10. Choose GnuDIP service.

11. Add server address (gnudip.datasystems24.net)

12. Add your fresh domain name (username.domain, ie [username].freedombox.rocks)

13. Add your fresh username (the one used in your new IP address) and password

14. Add your GnuDIP password

15. Fill the option with (try this url in your browser, you will figure out immediatly)

### 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 Plinth web interface of FreedomBox 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.

Firewall.png

Firewall management in FreedomBox is done using FirewallD.

#### Interfaces

Each interface is needs to be assigned to one (and only one) 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 Networks section.

#### 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 Plinth source for lib/freedombox/first-run.d/90_firewall and Firewall status page in Plinth UI.

Service | Port | External | Enabled by default | Status shown in Plinth | Managed by Plinth
Minetest | 30000/udp | {*} | {X} | (./) | (./)
XMPP Client | 5222/tcp | {*} | {X} | (./) | (./)
XMPP Server | 5269/tcp | {*} | {X} | (./) | (./)
XMPP Bosh | 5280/tcp | {*} | {X} | (./) | (./)
NTP | 123/udp | {o} | (./) | (./) | (./)
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/tdp | {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 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

### Certificates (Let's Encrypt)

A digital certficate allows users of a web service to verify the identity of the service and to securely communicate with it. FreedomBox can automatically obtain and setup digital certificates for each available domain. It does so by proving itself to be the owner of a domain to Let's Encrypt, a certificate authority (CA).

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)

2. Make the domain name known:

   - In Configure insert your domain name, e.g. `MyWebName.com` LetsEncrypt-Configure.png

3. Verify the domain name was accepted

   - Check that it is enabled in Name Services LetsEncrypt-NameServices.png

4. 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

     LetsEncrypt.png

5. Verify in your browser by checking `https://MyWebName.com`

   - LetsEncrypt-Certificate.png

Screencast: Let's Encrypt.webm

#### 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.

### 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 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 Monkeysphere website.

### Name Services

Name Services provides an overview of ways the box can be reached from the public Internet: domain name, Tor hidden service, and Pagekite. For each type of name, it is shown whether the HTTP, HTTPS, and SSH services are enabled or disabled for incoming connections through the given name.

### Networks

This section describes how networking is setup by default in FreedomBox and how you can customize it. See also the 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.

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.

##### 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.

2. 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.

#### 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:

To see the current status of the firewall and manually operate it, see the Firewall section.

### Power

Power provides an easy way to restart or shut down FreedomBox. After you select "Restart" or "Shut Down", you will be asked to confirm.

### Public Visibility (PageKite)

#### 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 .

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.

2. Add a kite to your account. Note your kite name and kite secret.

3. In Plinth, go to the "Configure PageKite" tab on the Public Visibility (PageKite) page.

4. Check the "Enable PageKite" box, then enter your kite name and kite secret. Click "Save settings".

5. 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.

6. On the Certificates (Let's Encrypt) page, you can obtain a Let's Encrypt certificate for your kite name.

### Secure Shell

#### 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

##### Plinth First Log In: Admin Account

When creating an account in Plinth 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 Plinth, then you don't need to do this. You can use the user account created in Plinth 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 .

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 Quick Start process.

`fbx` is the default user present on FreedomBox with superuser privileges. Any other user created using Plinth 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 Plinth you have enabled hidden 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 hidden service address for your 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.

#### Changing Password

To change the password of a user managed by Plinth, use the change password page. However, the `fbx` default user is not managed by Plinth and its password cannot be changed in the web interface.

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.

### Security

When this option is enabled, only users in the "admin" group will be able to log in to console or via SSH. Console users may be able to access some services without further authorization.

You can define the group of the users in the Users section.

Security.png

### 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.

### 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.

snapshots.png

### Software Upgrades

FreedomBox can automatically install security upgrades. On the Upgrades page of the Settings section in Plinth you can turn on automatic upgrades. For FreedomBox versions above 0.5, this feature is enabled by default and there is no manual action necessary. It is strongly recommended that you have this option enabled to keep your FreedomBox secure.

Upgrades are performed every day at night. If you wish to shutdown FreedomBox every day after use, keep it running at night once a week or so to let the automatic upgrades happen. Alternatively, you can perform manual upgrades as described below.

upgrades.png

#### Manual Upgrades

In the Plinth web interface, you can initiate a manual upgrade process from Upgrades page of the Settings section. Note that once the upgrades start, it may take a long time to complete and Plinth may seem to wait for the page to load.

Under some circumstances, automatic upgrades may fail and require you perform a manual upgrade action. Even upgrades initiated from Plinth may not finish properly. This may be because the upgrade process requires you to make a decision. In these cases, manual upgrade on the terminal may be the only option.

In addition, while the upgrade task is running any application installations will wait until the upgrade task is finished. Depending on the hardware, the upgrade task may take a little time, therefore, giving the impression that the application installation stalled.

To perform manual upgrades on the terminal, login into FreedomBox on a terminal or using a remote secure shell (see Secure Shell section). Then run the following commands:

    $ sudo su -
    Password:
    # apt-get update
    # apt-get dist-upgrade

This will ask you if it is alright to install/upgrade (or remove) some packages and use (or release) some disk space. Say yes after review. In some cases, during the upgrades process you will be asked questions about modified configuration files, answering with a default Keep current configuration is usually safe.

### 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

- 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).

These characteristics 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.

#### Known Issues

- Currently, Plinth does not distinguish between users and administrators. Every user added through Plinth will have full access to the Plinth interface.

## Hardware

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 plan to support/customize existing hardware.

In addition to supporting various single board computers and other devices, FreedomBox also supports being installed in a virtual machine. Also, any Debian machine can be turned into a FreedomBox by installing the `freedombox-setup` package. See the manual for more details.

### Supported Hardware

#### Recommended Hardware

FreedomBox Danube Edition FreedomBox - Danube Edition (based on Cubietruck) | Cubieboard 2 Cubieboard2 | BeagleBone Black BeagleBone Black
A20 OLinuXino Lime2 A20 OLinuXino Lime2 | A20 OLinuXino MICRO A20 OLinuXino MICRO | PC Engines APU PC Engines APU
pcDuino3 pcDuino3 | Debian Debian | VirtualBox VirtualBox

##### Recommended Hardware chart

Name | Speed (GHz) | Debian arch | Ram (GB) | disk (GB) | battery | SATA | Ethernet speed | 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}

#### Also Working Hardware

This hardware works but is not recommended due to freedom, performance-per-cost, or other concerns:

DreamPlug DreamPlug | Raspberry Pi Raspberry Pi | Raspberry Pi 2 Raspberry Pi 2
Raspberry Pi 3 Raspberry Pi 3 | . | .

Note: As FreedomBox is currently in the development stage, Supported Hardware means that FreedomBox images are built for said hardware and at least one developer has reported the basic functions to be working.

### Targeted Hardware

#### List of Targeted Hardware

Although the project may focus on supporting specific devices, we are looking to support as much hardware as possible given that it is suitable for FreedomBox's needs. Take a look at the list of targeted hardware for more information.

#### Adding Hardware Support

If you are a developer, consider adding hardware support for your device by modifying Freedom Maker and FreedomBox Setup. If you have access to one of these targeted hardware devices and would like to work with us to make it run FreedomBox, please contact us!

### Cubietruck

#### FreedomBox Danube Edition

FreedomBox Danube Edition

FreedomBox Danube Edition is a custom casing around Cubietruck and an SSD-hard drive.

#### Cubietruck / Cubieboard3

Cubietruck (Cubieboard3) is a single board computer with very good performance compared to many other boards. FreedomBox images are built for this device. To use this board as FreedomBox, a separate USB WiFi device that does not require non-free firmware is recommended.

#### Download

FreedomBox SD card 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 install Debian on the Cubietruck and then install FreedomBox on it.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

FreedomBox Danube Edition

- A limited number of units are planned to be shipped along with the release of FreedomBox 1.0. If you wish to get one, express your interest.

Cubietruck / Cubieboard3

- Price: 89 USD

- 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

- Works with stock Debian kernel: yes

#### Known Issues

- The on-board WiFi does not work with free software. A separate USB WiFi device is recommended.

### Beagle Bone Black

Beagle Bone 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. To use this device as a FreedomBox, a separate USB WiFi device that does not require non-free firmware is recommended.

#### Download

FreedomBox SD card images are available for this device. Follow the instructions on the 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 install Debian on the BeagleBone and then install FreedomBox on it.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: ~ 59 USD (50 EUR)

- Mouser Electronics

- Full list of suppliers

#### Hardware

- Open Source Hardware (OSHW): Yes

- CPU: 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 USB WiFi device

- SATA: None

#### Non-Free Status

- Non-free blobs required: No

- WiFi: Not available

- Works with stock Debian kernel: Yes

#### Known Issues

None

### A20 OLinuXino Lime2

A20 OLinuXino Lime2

Olimex's 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. FreedomBox images are built and tested for this device starting with version 0.7. To use this device as a FreedomBox, a separate USB WiFi device that does not require non-free firmware is recommended.

#### Similar Hardware

The following similar hardware will also work well with FreedomBox.

- Olimex's A20 OLinuXino Lime2 4GB. This hardware merely has extra 4GB NAND storage that is not used by FreedomBox.

#### Download

FreedomBox SD card images are available for this device. Follow the instructions on the 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 install Debian on the device and then install FreedomBox on it.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: 45 EUR (A20 OLinuXino Lime2)

- Price: 55 EUR (A20 OLinuXino Lime2 4GB)

- Olimex Store

#### Hardware

- Open Source Hardware (OSHW): 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 USB WiFi device

- SATA: 1x port

#### Non-Free Status

- Non-free blobs required: No

- WiFi: Not available

- Works with stock Debian kernel: Yes

- Boot Firmware: BROM (GPLV2+)

#### Known Issues

- None

### A20 OLinuXino MICRO

A20 OLinuXino MICRO

Olimex's 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. FreedomBox images are built and tested for this device starting with version 0.7. To use this device as a FreedomBox, a separate USB WiFi device that does not require non-free firmware is recommended.

#### Similar Hardware

The following similar hardware will also work well with FreedomBox.

- Olimex's A20 OLinuXino MICRO 4GB. This hardware merely has extra 4GB NAND storage that is not used by FreedomBox.

#### Download

FreedomBox SD card images are available for this device. Follow the instructions on the 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 install Debian on the device and then install FreedomBox on it.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: 55 EUR (A20 OLinuXino MICRO)

- Price: 65 EUR (A20 OLinuXino MICRO 4GB)

- Olimex Store

#### Hardware

- Open Source Hardware (OSHW): 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 USB WiFi device

- SATA: 1x port

#### Non-Free Status

- Non-free blobs required: No

- WiFi: Not available

- Works with stock Debian kernel: Yes

- Boot Firmware: BROM (GPLV2+)

#### Known Issues

- None

### APU

PC Engines APU 1D

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. For using this board as FreedomBox, a USB WiFi device that does not require non-free firmware is recommended.

#### Similar Hardware

Although untested, the following similar hardware is also likely to work well with FreedomBox.

- Using amd64 image:

  - apu1c

  - apu1c4

  - apu1d4

  - apu2b2

  - apu2b4

  - apu2c0

  - apu2c2

  - apu2c4

  - apu3a2

  - apu3a4

  - apu3b2

  - apu3b4

- Using i386 image:

  - alix1d

  - alix1e

  - alix2d2

  - alix2d3

  - alix2d13

  - alix3d2

  - alix3d3

  - alix6f2

#### Download

FreedomBox disk images for this hardware are available. Follow the instructions on the 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 install Debian on the APU and then 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.

#### Build Image

FreedomBox images for this hardware, which is for all amd64 machines, can be built using Freedom Maker.

#### Availability

- Price: 110 - 170 USD (depending on the board and supplier)

- PC Engines

- Full list of suppliers

#### Hardware

- Open Hardware: No

- CPU: 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 USB WiFi device

- SATA: 1 m-SATA and 1 SATA

#### Non-Free Status

- Non-free blobs required: No

- WiFi: Not available

- Works with stock Debian kernel: Yes

- Boot firmware: Coreboot

#### Known Issues

None

### pcDuino3

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 for images built after June 2017. For using this board as FreedomBox, a USB WiFi device that does not require non-free firmware is recommended.

Note: The FreedomBox logo is simply a sticker on top of device brought from store.

#### Similar Hardware

Although untested, the following similar hardware is also likely to work well with FreedomBox.

#### Download

FreedomBox disk images for this hardware are available. Follow the instructions on the 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 install Debian on the APU and then install FreedomBox on it.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: 89 USD

- LinkSprite

- 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 USB WiFi device instead

- SATA: 1 SATA host socket

#### Non-Free Status

- Non-free blobs required: No

- WiFi: Requires non-free firmware

- Works with stock Debian kernel: Yes

- Boot Firmware: BROM (GPLV2+)

#### Known Issues

None

### VirtualBox

VirtualBox

This page will help you get started with using FreedomBox on a 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 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 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 install Debian on VirtualBox and then install FreedomBox on it.

VirtualBox itself is available from (or your distribution's package manager).

#### Download

Follow the instructions on the download page to download and verify a VirtualBox image. As pr. 2016-03-26 the latest images are v0.7-amd64 and v0.7-i386.

#### Creating a Virtual Machine

1. Decompress the downloaded VDI image (tool for Windows, Mac).

2. Create a new VM in the VirtualBox UI with OS type Linux and Version Debian (32/64-bit according to the downloaded image).

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.

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.

VirtualBox recommended network setting

#### 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 web interface (aka. Plinth) in a browser.

FreedomBox console after booting successfully

To access the web interface you need to find out your FreedomBox's IP address as described in section: 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 (f.ex. the host). If all is well, you are now presented with a welcome message and invited to complete the first boot process.

FreedomBox welcomes you to the first boot

This mainly consist of creating an administrative user for the system.

#### Using

See the FreedomBox usage page for more details.

You can log in to the Debian GNU/Linux system as the user created during Plinth 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 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.

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 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.

2. 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.

3. 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 You will need to add a mapping for each such services from host to guest.

4. 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} | (./) | (./) | (./) | (./)

##### 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 passwd-in-image script.

See also 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.

### Debian

FreedomBox is a 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 (Stretch), Testing (Buster), and Unstable (Sid).

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.

#### Installing on Debian

1. Check the Troubleshooting section below, for any tips or work-arounds that might help during the install.

2. Install Debian Stable (Stretch), Testing (Buster), or Unstable (Sid) on your hardware.

3. Update your package list.

       $ sudo apt-get update

4. Install `freedombox-setup` package.

       $ sudo DEBIAN_FRONTEND=noninteractive apt-get install freedombox-setup

   - The "DEBIAN_FRONTEND=noninteractive" will avoid several configuration prompts that would otherwise appear during the install.

   - Note: If you are using Debian Buster or later, then the steps below (running setup script and rebooting) do not apply. You can jump to using FreedomBox.

5. Run FreedomBox setup program. This installs further packages and sets up basic configuration.

       $ sudo /usr/lib/freedombox/setup | tee freedombox-setup.log

   You may have to clear your existing network configuration. See Troubleshooting note #2 below.

6. Reboot the system. This is necessary to trigger the first-run script.

       $ sudo reboot

7. After the system boots up, wait for it to reboot again. The first-run scripts sets up a few things and initiates a reboot.

8. After the second reboot you can start using FreedomBox.

#### Troubleshooting

1. There is a bug in policykit-1 package that causes errors and hangs during installation of freedombox-setup package. A workaround is to first install policykit-1 package and then reboot. After that, follow the above procedure setup procedure.

       $ sudo apt-get update
       $ sudo apt-get install policykit-1
       $ sudo reboot

2. Freedombox does not support network device configuration via `/etc/network/interfaces`, and it will not manage any non-loopback interfaces mentioned there. (See bug #797614.) Future versions of freedombox-setup will clear this file automatically; for now, edit it 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. 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.

### DreamPlug

DreamPlug

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 USB WiFi device that does not require non-free firmware is recommended.

You can find more support and discussion for DreamPlug on the official forum.

#### Download

FreedomBox SD card images for this hardware are available. Follow the instructions on the download page to create a FreedomBox SD card and boot into FreedomBox. See also instructions for using an internal micro-SD with DreamPlug.

An alternative to downloading these images is to install Debian on DreamPlug and then 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 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 Freedom Maker.

#### Testing

Instructions on how to test this hardware are available.

#### Availability

- Price: 159 USD

- DreamPlug manufacturer

- Reseller 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: 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 USB WiFi device is recommended.

### Raspberry Pi Model B+

Raspberry Pi (Model B+)

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 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.

#### Download

FreedomBox SD card images for this hardware are available. Follow the instructions on the download page to create a FreedomBox SD card and boot into FreedomBox.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: 35 USD

- 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 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.

### Raspberry Pi 2 Model B

Raspberry Pi 2

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. For using this board as FreedomBox, a USB WiFi device that does not require non-free firmware is recommended.

Note: For FreedomBox release 0.5, 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 2 is capable of. Starting with FreedomBox release 0.6 separate `armhf` images with full hardware floating point support are available.

#### Download

FreedomBox SD card images for this hardware are available. Follow the instructions on the download page to create a FreedomBox SD card and boot into FreedomBox.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker.

#### Availability

- Price: 35 USD

- 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 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 2 is capable of. However, starting with FreedomBox 0.6 separate images for Raspberry Pi 2 with `armhf` architecture will be built.

### Raspberry Pi 3 Model B

Raspberry Pi 3

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. FreedomBox images built for Raspberry Pi 2 are tested to work well with it. For using this board as FreedomBox, a USB WiFi device, that does not require non-free firmware, is recommended instead of the on-board Wi-Fi.

#### Download

FreedomBox SD card images for this hardware are available. Download the image meant for Raspberry Pi 2 and that image will work for this board. Follow the instructions on the download page to create a FreedomBox SD card and boot into FreedomBox.

#### Build Image

FreedomBox images for this hardware can be built using Freedom Maker. Use the target 'raspberry2' to build the image for this board.

#### Availability

- Price: 35 USD

- 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 USB WiFi device

- SATA: None

#### Non-Free Status

- Non-free blobs required: boot firmware

- WiFi: Requires non-free firmware

- Works with stock Debian kernel: No

### 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.

- Devices with Atheros AR7010 chip

- 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

- Debian Wiki on WiFi drivers

- Wikipedia: Comparison of open-source Linux wireless network drivers

- WikiDevi: database of computer hardware

### Release Notes

The following are the release notes for each FreedomBox version.

#### Plinth v0.24.0 (2018-02-26)

- Add file-sharing application Coquelicot.

- Add metasearch engine application Searx.

- Add locale for Hungarian (hu).

- mediawiki: Allow shortcut to be publicly visible on front page.

- clients: Add and correct Client Apps.

- locale: Preferred language can be set in each user's profile.

- locale: Anonymous users can select preferred language.

- config: Remove language selection from config page.

- matrixsynapse: Fix mail attribute for ldap login.

#### Plinth v0.23.0 (2018-02-12)

- snapshots: Modify configurations to reduce disk usage.

- snapshots: Skip currently active snapshot when deleting all snapshots.

- jsxc: Use consistent url format.

- sso: Increase timeout to 60 minutes.

- theme: Change font from Helvetica to Lato.

- Translation updates for Czech, German, Gujarati, and Telugu.

#### Plinth v0.22.0 (2018-01-30)

- matrix-synapse: Make sure configuration file does not get corrupted.

- tor: Show enabled status properly.

- first_setup: Fix not showing admin user creation step.

- Migrate from GitHub to Salsa

- Migrate from CirceCI to GitLab CI on Salsa.

- Translation updates for Czech, Dutch, Gujarati, Hindi, Russian and Telugu.

- Started new translation for Ukrainian.

#### Plinth v0.21.0 (2018-01-15)

- navigation bar: Change label from 'Configuration' to 'System'.

- storage: Removed beta warning for expanding partition.

- groups: Consistently show available user groups, even before applications are installed.

- syncthing: Restrict administration to users in "syncthing" group.

- help: Show menu on smaller screens also.

- diagnostics: Enable the "Run Diagnostics" button when applications are enabled but not running.

#### Plinth v0.20.0 (2018-01-01)

- bind: Don't use forwarders by default

- ejabberd: Remove redundant button Client Apps

- mediawiki: Add wiki application

- users: Make sure first run actually works

- bind: Add information about current utility

#### Plinth v0.19.0 (2017-12-18)

- ejabberd: Use dynamic reload instead of restart when changing configuration.

- manual: Make manual available as a PDF download.

- minetest: Show domain information for users to connect to minetest.

- snapshots: Add button to delete all snapshots.

- snapshots: Add option to enable/disable automatic timeline snapshots.

- users: Add groups for bit-torrent and feed-reader, available when these applications are installed.

#### Plinth v0.18.0 (2017-12-04)

- Add Shadowsocks client with socks5 proxy.

- Fix SSO regressions and conflict with captcha.

- transmission: Fix sso not being enabled on upgrade.

- avahi: Add service for FreedomBox discovery.

- Add client information for modules.

#### Plinth v0.17.0 (2017-11-20)

- transmission: Enable Single Sign On.

- cockpit: Add short description to frontpage shortcut.

- fail2ban: Fix spelling and sentence structure.

#### Plinth v0.16.0 (2017-11-06)

##### Added

- Add mobile, web and desktop client info for modules.

- Enable django SecurityMiddleware to improve security ratings.

- cockpit: New module for server administration and web terminal.

##### Fixed

- letsencrypt: Fix internal server error when obtaining a certificate.

- ejabberd: Fix LDAP server entry in config file during setup.

- jsxc: Fix outdated URLs for connecting to local ejabberd server.

#### Plinth v0.15.3 (2017-10-20)

##### Changed

- Rename Disks to Storage.

- Rename Snapshot to Storage Snapshots.

- tt-rss: Enable API access by default.

- Allow access to Plinth from outside the LAN.

- matrix-synapse: Disable public registration by default.

- power: Merge actions into the user dropdown.

##### Added

- Add locales for Kannada (kn) and for Bengali (bn).

- ejabberd: Use Let's Encrypt certificate, also across renewals.

- matrix-synapse: Add enable/disable public registrations.

- Add captcha validation on 3 failed attempts.

- matrix-synapse: Enable LDAP integration.

- letsencrypt: Automatically obtain and revoke SSL certificates.

##### Fixed

- Fix front page label names.

- Fix vertical alignment of shortcut icons.

- storage: Fix issue with locales that use other decimal separators.

- Make tt-rss api accessible using Apache basic auth.

- letsencrypt: Handle case where current domain is empty.

- Handle both admin and non-admin user names in update user template.

#### Plinth v0.15.2 (2017-09-24)

##### Added

- letsencrypt: Show more info on cert validity status.

- letsencrypt: Add option to delete certificates.

- letsencrypt: Add option to let Plinth manage certbot's renewal hooks.

- power: Warn if a package manager is running before shutdown/restart.

- security: Install and manage fail2ban.

- names: Include domain and services from dynamicdns.

- disks: Add low disk space warning to system and disks page.

- ssh: New application to manage SSH server.

- Add api module to get enabled services and access info.

- Add Django password validators.

- ejabberd, ikiwiki, ttrss: Add user login descriptions.

##### Removed

- diaspora: Disable for this release due to issues affecting package.

- Remove help from navbar before firstboot complete.

##### Fixed

- i18n: Don't use backslash-newline for wrapping long lines.

- radicale: Update link to documentation.

- sso: Upgrade crypto to 4096-bit RSA and SHA-512.

- Users: Allow non-admin users to log out.

##### Changed

- letsencrypt: Make Let's Encrypt an essential module.

- UI: Make apps and configure pages responsive on small screens.

- Make help accessible for logged-in non-admin users.

#### Plinth v0.15.0 (2017-07-01)

- Added Tahoe-LAFS module for distributed file storage.

- Added Diaspora* module for federated social networking.

  - Currently only available in "contrib" repository.

- New Locales for Czech (cs) and Tamil (ta).

- Added SSO using auth_pubtkt for Syncthing, TT-RSS, and the Repro admin panel.

  - If you are logged in to Plinth, you will be automatically logged in to these web apps.

- ejabberd: Added option to enable/disable Message Archive Management.

- help: Added Debian release name to about page.

- firstboot: De-bloat first welcome screen.

- Pinned footer to the bottom of the viewport.

- disks: Restrict precision of reported available space on root partition.

- diagnostics: Disable button if app/service is not running.

- help: Only show help pages if user is logged in.

- navbar: Moved logout to user drop-down and added a new power drop-down.

- disks: Show disabled partition resize option if no space is available.

- Added line break to titles to fix frontpage layout.

- syncthing: Fixed typos and clarity in description.

- firewall: Fix 500 error when firewalld is not running.

- setup: Disable install/upgrade when dpkg/apt is running.

- disks: Use information from lsblk for more accuracy.

- datetime: Show timezone properly when it not in expected list.

#### Plinth v0.14.0 (2017-04)

- tor: Added option to use upstream bridges.

- openvpn: Added shortcut to front page, shown only when logged-in.

- openvpn: Non-admin users can download their own profiles.

- Added new locales for Hindi (hi) and Gujarati (gu).

- Added Syncthing module for file synchronization.

- Added Matrix Synapse as chat server with groups, audio and video.

- Require admin access for all system configuration pages.

- Changed appearance of topbar and footer.

- openvpn: Regenerate user key or certificate if empty.

- disks: Workaround issue in parted during resize.

#### Plinth v0.13.1 (2017-01-22)

- Two new apps were added:

  - Gobby Server (infinoted) for collaborative editing of text documents

  - Domain Name Server (BIND), in system menu

- Added JavaScript license web labels to provide partial support for LibreJS.

- Added basic configuration form for Minetest server.

- Added indicator to Help->About page if new Plinth version is available.

- Show app logos on front page instead of generic icons.

- Prevent anonymous users from accessing setup pages.

- Split Chat Server (XMPP) app into Chat Server (ejabberd) and Chat Client (jsxc).

#### Plinth v0.12.0 (2016-12-08)

- Open up RTP ports in the firewall for repro (SIP server).

- Front page shortcuts for services show a Configure button in the details box for logged-in users.

- Add mods packages to be installed with Minetest server.

- Fix issue with reading Dynamic DNS status as non-root user.

- After the hostname is changed, ensure the domain name is still set correctly.

- Allow the domain name to be cleared, and properly set the configuration in this case.

- On the Certificates (Let's Encrypt) page, show a more informative message when no domains are configured.

- On the Chat Server (XMPP) page, show more clearly if domain is not set.

- Apps that require login will not be shown on the front page, unless the user is logged in.

- Show status block for News Feed Reader (Tiny Tiny RSS).

- Change appearance of front page with larger icons and repositioned text.

- Firewall page only lists services that have been setup. The port lists are collapsible under each service.

- Support configuring IPv6 networks.

- Make it less likely to accidentally delete the only Plinth user.

- Updated to work with JSXC 3.0.0 (XMPP web client).

#### Plinth v0.11.0 (2016-09-29)

- Added loading icon for additional busy operations.

- Added basic front page with shortcuts to web apps, and information about enabled services.

- networks: Add batctl as dependency, required for batman-adv mesh networking.

- users:

  - Fixed checking restricted usernames.

  - Display error message if unable to set SSH keys.

  - Flush nscd cache after user operations to avoid some types of errors.

- monkeysphere:

  - Adopted to using SHA256 fingerprints.

  - Sort items for consistent display.

  - Handle new uid format of gpg2.

  - Fixed handling of unavailable imported domains.

- minetest: Fixed showing status block and diagnostics.

- Fixed stretched favicon.

- Switched base template from container-fluid to container. This will narrow the content area for larger displays.

- Plinth is now able to run as "plinth" user instead of root user.

- xmpp: Replaced jwchat with jsxc.

- ikiwiki: Allow only alphanumerics in wiki/blog name to avoid invalid paths.

#### Plinth v0.10.0 (2016-08-21)

- Updated Plinth to support Django 1.10.

- Added a page to display recent status log from Plinth. It is accessible from the 500 error page.

- Tor: Added options to toggle relay and bridge relay modes.

- Radicale: Added access rights control.

- Ikiwiki: Updated suggested packages.

- Users and Groups: Fixed editing users without SSH keys.

- Networks: Added basic support for configuring batman-adv mesh networking.

- Networks: Fixed incorrect access for retrieving DNS entries.

- New languages:

  - Persian (50% translated)

  - Indonesian (not started, contributions needed)

- New modules added to Plinth:

  - Disks: Shows free space of mounted partitions, and allows expanding the root partition.

  - Security: Controls login restrictions.

  - Snapshots: Manages Btrfs snapshots.

#### Version 0.9.4 (2016-06-24)

- Added Polish translation.

- Fixed issue preventing access to Plinth on a non-standard port.

- Dealt with ownCloud removal from Debian. The ownCloud page in Plinth will be hidden if it has not been setup. Otherwise, a warning is shown.

- Fixed issue in Privoxy configuration. Two overlapping listen-addresses were configured, which prevented privoxy service from starting.

- Fixed issue that could allow someone to start a module setup process without being logged in to Plinth.

- Fixed issues with some diagnostic tests that would show false positive results.

- Added check to Diagnostics to skip tests for modules that have not been setup.

- Fixed some username checks that could cause errors when editing the user.

- Added sorting of menu items per locale.

- Moved Dynamic DNS and Pagekite from Applications to System Configuration.

- Allowed setting IP for shared network connections.

- Switched Dreamplug image from "non-free" to "free". This means that we no longer include the non-free firmware for the built-in wifi on Dreamplug.

- Added the "userdir" module for the Apache web server. This allows users in the "admin" group to create a folder called "public_html" under their home folder, and to publicly share files placed in this folder.

- New wiki and manual content licence: Creative Commons Attribution-ShareAlike 4.0 International (from June 13rd 2016).

- Switched to using apt-get for module setup in Plinth. This fixes several issues that were seen during package installs.

#### Version 0.9 (2016-04-24)

- Fixed Wi-Fi AP setup.

- Prevent lockout of users in 'sudo' group after setup is complete.

- Improved setup mechanism for Plinth modules. Allows users to see what a module is useful for, before doing the setup and package install. Also allows essential modules to be setup by default during FreedomBox install.

- Added HTTPS certificates to Monkeysphere page. Reorganized so that multiple domains can be added to a key.

- Added Radicale, a CalDAV and CardDAV server.

- Added Minetest Server, a multiplayer infinite-world block sandbox.

- Added Tiny Tiny RSS, a news feed reader.

#### Version 0.8 (2016-02-20)

- Added Quassel, an IRC client that stays connected to IRC networks and can synchronize multiple frontends.

- Improved first boot user interface.

- Fixed Transmission RPC whitelist issue.

- Added translations for Turkish, Chinese, and Russian. Fixed and updated translations in other languages.

- Added Monkeysphere, which uses PGP web of trust for SSH host key verification.

- Added Let's Encrypt, to obtain certificates for domains, so that browser certificate warnings can be avoided.

- Added repro, a SIP server for audio and video calls.

- Allow users to set their SSH public keys, so they can login over SSH without a password.

#### Version 0.7 (2015-12-13)

- Translations! Full translations of the interface in Danish, Dutch, French, German and Norwegian Bokmål, and partial Telugu.

- Support for OLinuXino A20 MICRO and LIME2

- New Plinth applications: OpenVPN, reStore

- Improved first-boot experience

- Many bugfixes and cleanups

#### Version 0.6 (2015-10-31)

- New supported hardware target: Raspberry Pi 2

- New modules in Plinth:

  - Shaarli: Web application to manage and share bookmarks

  - Date & Time: Configure time zone and NTP service

  - Service Discovery: Configure Avahi service

- Documentation revamp including new user manual and developer guide

- Improved diagnostic tests, available in Plinth

- Avoid unnecessary changes when installing on existing Debian system

- Network configuration supports PPPoE connections

- Debian packages can be download over Tor

#### Version 0.5 (2015-08-07)

- New targets: CubieTruck, i386, amd64

- New apps in Plinth: Transmission, Dynamic DNS, Mumble, ikiwiki, Deluge, Roundcube, Privoxy

- NetworkManager handles network configuration and can be manipulated through Plinth.

- Software Upgrades (unattended-upgrades) module can upgrade the system, and enable automatic upgrades.

- Plinth is now capable of installing ejabberd, jwchat, and privoxy, so they are not included in image but can be installed when needed.

- User authentication through LDAP for SSH, XMPP (ejabberd), and ikiwiki.

- Unit test suite is automatically run on Plinth upstream. This helps us catch at least some code errors before they are discovered by users!

- New, simpler look for Plinth.

- Performance improvements for Plinth.

#### Version 0.3 (2015-01-20)

- Tor Bridges: All boxes now act as non-exit Tor bridges, routing traffic for the Tor network.

- Firewall: firewall is on by default and is automatically managed.

- Add BeagleBone support. We now have images for BeagleBone, RaspberryPi, VirtualBox i386/amd64, and DreamPlug.

- Ability to enable and use Tor Hidden Services. Works with Ejabberd/JWChat and ownCloud services.

- Enable Tor obfsproxy with scramblesuit.

- Drop well-known root password (an account with sudo capabilities still exists for now but will be removed soon).

- Switch to unstable as suite of choice for easier development.

- Newer images are built with systemd by default (due to Debian change).

- Install and operate firewall automatically (uses firewalld).

- Major restructuring of Plinth UI using Python3, Django web development framework and Bootstrap3. Code quality is much better and UI is more polished.

- Introduced packaging framework in Plinth UI for on-demand application installation.

#### Version 0.2 (2014-03-16)

- Support for Raspberry Pi and VirtualBox (x86) in addition to the DreamPlug.

- New Services:

  - Configuration Management UI.

  - Instant Messaging.

  - OwnCloud.

  - dnsmasq.

  - Low-Level Configuration Management.

  - Service Announcement.

  - LDAP Server.

  - LXC Support.

  - Source Packages.

- The privoxy setup is now the default from Debian.

#### Version 0.1 (2013-02-26)

- First FreedomBox software release (0.1 image, developer release).

- Full hardware support in Debian

- Support for DreamPlug.

- Basic software tools selected as common working environment:

  - User interface system "plinth"

  - Cryptography tools: gpg or "monkeysphere"

  - Box-to-box communication design: Freedom-buddy (uses TOR network)

  - Web cleaning: "privoxy-freedombox".

## Contributing

From code, design and translation to spreading the world and donation, here is a list of possible contributions to develop FreedomBox.

### Quick Links

Progess calls

TODO page

Donation page

### Welcome to newcomers

As a newcomer, you are more than welcome to introduce yourself to all users and doers on the "FreedomBox-discuss" mailing list or on the #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 web interface Plinth with its priorities here:Project Progress. We want to enjoy soon a version 1.0.

Please check next progess calls to keep yourself on track and meet members of the release team. A 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 FreedomBox Developer Manual.

#### Bugs

List of bugs listed on Debian universal system. Also see the Packages overview for FreedomBox packaging team 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 contributing code to FreedomBox is available.

- FreedomBox Setup: a Debian package for setting up the FreedomBox.

- Plinth: a web interface to administer the functions of FreedomBox.

- 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 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 Plinth web interface

- Web design for freedomboxfoundation.org and FreedomBox wiki pages

- Logo and branding (we currently have an identity manual and logos)

- Possible designs for custom FreedomBox cases on single board computers

- User experience design

##### Technical Design

FreedomBox is still under development any many components are yet to be worked on. You can contribute to the discussion on various technical design and implementation aspects of FreedomBox. See:

- Design portal

#### Donate

The FreedomBox Foundation is a Delaware non-profit corporation in the process of applying for 501(c)(3) federal nonprofit 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 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 Plinth and elsewhere.

If you wish to contribute to the 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 mailing list.

#### 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 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:

- Plinth web interface for FreedomBox

- FreedomBox documentation

- FreedomBox website and wiki

- Individual applications that FreedomBox exposes to users.

The primary user interface (Plinth) was internationalized in the 0.7 release. You can contribute to the localization effort using the web-based tool at Weblate or directly to the source tree via Salsa.

If you wish to see FreedomBox available for one of your languages, please start a discussion on the FreedomBox discuss mailing list or on the #freedombox IRC channel to avoid double translations.

For more information, please visit the FreedomBox translation landing 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 talks page and on the wiki.

## Developer Guide

This manual is meant for developers intending to develop applications for FreedomBox. It provides a step by step tutorial and an API reference.

### Writing Applications - Tutorial

This tutorial covers writing an application for FreedomBox. FreedomBox is a pure blend of Debian with a web interface, known as Plinth, that configures its applications. We shall discuss various aspects of building an application for FreedomBox, by creating an example application.

There are two parts to writing a FreedomBox application. First is to make sure that the application is available as a Debian package uploaded to the repositories. This is the majority of the work involved. However, if an application is already available in Debian repositories, it is trivial to build a FreedomBox UI for it. The second part of writing an application for FreedomBox is to provide a thin web interface layer for configuring the application. This is done by extending Plinth's user interface to provide visibility to the application and to let the user control its operations in a highly simplified way. This layer is referred to as 'Plinth application'.

Plinth applications can either be distributed as part of Plinth source code by submitting the applications to the Plinth project or they can distributed independently. This tutorial covers writing an application that is meant to be distributed as part of Plinth. However, writing independent Plinth applications is also very similar and most of this tutorial is applicable.

Note

The term application, in this tutorial, is used to mean multiple concepts. FreedomBox application is a combination of Debian package and a web interface layer. The web interface layer is also called a Plinth application which is very similar to and built upon a Django application.

#### Before we begin

Plinth is a web interface built using Python3 and Django. FreedomBox applications are simply Django applications within the Plinth project. Hence, for the most part, writing a FreedomBox application is all about writing a Django application.

You should start by reading the Django tutorial. All the concepts described there are applicable for how plinth and its applications are be built.

#### Picking an application

We must first, of course, pick an application to add to FreedomBox. For the purpose of this tutorial, let us pick Tiny Tiny RSS. The project description reads as, Tiny Tiny RSS is an open source web-based news feed (RSS/Atom) reader and aggregator, designed to allow you to read news from any location, while feeling as close to a real desktop application as possible.

Choosing an application

When choosing an application we must make sure that the application respects users' freedom and privacy. By choosing to use FreedomBox, users have explicitly made a choice to keep the data with themselves, to not provide privacy compromising data to centralized entities and to use Free Software that respects their Software Freedom. These are not properties of some of the applications in FreedomBox but all applications must adhere to these principles. Applications should not even ask the users questions to this effect, because users have already made a choice.

#### Packaging the application

Majority of the effort in creating an application for FreedomBox is to package it for Debian and get it uploaded to Debian repositories. Going through the process of packaging itself is outside the scope of this tutorial. It is, however, well documented elsewhere. You should start here.

Debian packaging might seem like an unnecessary process that takes time with its adherence to standards, review process, legal checks, etc. However, upon close examination, one will find that without these steps the goals of the FreedomBox project cannot be met. Some of the advantages of Debian packaging are listed below:

- Legal check ensures that proprietary licensed code or code with bad licenses does not inadvertently creep in.

- Libraries have to be packaged separately easing security handling. When a security vulnerability is identified in a library, just the library will have to be updated and not all the applications that depend on it.

- Upgrades become smoother. The dependency handling of the packaging system, configuration handling tools, tools to deal with various types of well known files help with ensuring a proper upgrade.

- Collaborative maintenance teams ensure that the package is well cared for even if you get busy with other work and can't spend time on your package. Following standards and using common infrastructure is critical to enable this development methodology.

#### Creating the project structure

Create a directory structure as follows with empty files. We will fill them up in a step-by-step manner.

    +- <plinth_root>/
      |
      +- plinth/
      | |
      | +- modules/
      |   |
      |   +- ttrss/
      |     |
      |     +- __init__.py
      |     |
      |     +- forms.py
      |     |
      |     +- urls.py
      |     |
      |     +- views.py
      |     |
      |     +- templates/
      |     | |
      |     | +- ttrss.html
      |     |
      |     +- tests
      |       |
      |       +- __init__.py
      |
      +- actions/
      | |
      | +- ttrss
      |
      +- data/
        |
        +- etc/
          |
          +- plinth/
            |
            +- modules-enabled/
              |
              +- ttrss

The `__init__.py` indicates that the directory in which it is present is a Python module. For now, it is an empty file.

Plinth's setup script `setup.py` will automatically install the `plinth/modules/ttrss` directory (along with other files described later) to an appropriate location. If you are creating an application that stays independent and outside of Plinth source tree, then your `setup.py` script will need to install it a proper location on the system. The `plinth/modules/` directory is a Python3 namespace package. So, you can install it with the `plinth/modules/` directory structure into any Python path and still be discovered as `plinth.modules.*`.

#### Tell Plinth that we exist

The first thing to do is tell Plinth that our application exists. This is done by writing a small file with the Python import path to our application and placing it in `data/etc/plinth/modules-enabled/`. Let us create this file `ttrss`:

    plinth.modules.ttrss

This file is automatically installed to `/etc/plinth/modules-enabled/` by Plinth's installation script `setup.py`. If we are writing a module that resides independently outside the Plinth's source code, the setup script will need to copy it to the target location. Further, it is not necessary for the application to be part of the `plinth.modules` namespace. It can, for example, be `plinth_ttrss`.

#### Writing the URLs

For a user to visit our application in Plinth, we need to provide a URL. When the user visits this URL, a view is executed and a page is displayed. In `urls.py` write the following:

    from django.conf.urls import url

    from . import views

    urlpatterns = [
        url(r'^apps/ttrss/$', views.index, name='index'),
    ]

This routes the `/apps/ttrss/` URL to a view called `index` defined in `plinth/modules/ttrss/views.py`. This is no different than how routing URLs are written in Django. See Django URL dispatcher for more information.

#### Adding a menu item

We have added a URL to be handled by our application but this does not yet show up to be a link in Plinth web interface. Let us add a link in the applications list. In `__init__.py` add the following:

    from plinth import cfg

    def init():
        """Intialize the module."""
        menu = cfg.main_menu.get('apps:index')
        menu.add_urlname('News Feed Reader (Tiny Tiny RSS)', 'glyphicon-bullhorn',
                         'ttrss:index', 850)

As soon as Plinth starts, it will load all the enabled modules into memory. After this, it gives a chance to each of the modules to initialize itself by calling the `init()` method if there is such a method available as `<app>.init()`. Here we have implemented this method and added our menu item to the applications menu as part of the initialization process.

We wish to add our menu item to the list of applications which is why we have retrieved the applications menu which is available under the main menu. After this we add our own menu item to this menu. There are several parameters during this process that are important:

- In the first parameter we are providing the display name to use for our application when showing the menu item.

- In the second parameter we are providing the icon to show for this menu item. This is an icon from the Twitter Bootstrap library. See

  the Twitter Bootstrap library documentation for a list of available icons. We can pick an icon from the available list of icons and just mention its glyphicon class as name here.

- The third parameter is the name of the URL we have created for our application. Note that when including this application's URLs, Plinth will automatically set the name of the module as the Django

  URL namespace. Hence it is `ttrss:index` and not just `index`.

- The final parameter specifies where in the menu this application shows up. This is weightage number with which Plinth sorts the menu items. Higher the weightage, the lower the menu item appears (as it sinks). Since Plinth menu items are alphabetically sorted, for our

  application we wish for it to appear between Public Visibility and Voice Chat. Their weights are 800 and 900 respectively. So we selected 850.

We have used the application menu item to insert our own menu item as a child. To be able to use the application menu item, we need to make sure that the module providing the application menu is loaded before our application is loaded. We will do that in the next step.

#### Specifying module dependencies

Specifying a simple list of applications to be loaded before our application provided to Plinth is sufficient. Add this in `__init__.py`.

    depends = ['plinth.modules.apps']

Plinth will now make sure that the `apps` module is loaded before our module is loaded. Application initialization is also ensured to happen in this order. We can safely use any features of this module knowing that they have been initialized.

Circular dependencies

Circular dependencies are not possible among Plinth applications. Attempting to add them will result in error during startup.

#### Writing the enable/disable form

We wish to provide a user interface to the user to enable and disable the application. Complex modules may require more options but this is sufficient for our application. Add the following `forms.py`.

    from django import forms

    class TtrssForm(forms.Form):
        """Tiny Tiny RSS configuration form."""
        enabled = forms.BooleanField(
            label='Enable Tiny Tiny RSS',
            required=False)

This creates a Django form that shows a single option to enable/disable the application. It also shows its current state. This is how a regular Django form is built. See Django Forms documentation for more information.

Too many options

Resist the temptation to create a lot of configuration options. Although this will put more control in the hands of the users, it will make FreedomBox less usable. FreedomBox is a consumer product. Our target users are not technically savvy and we have make most of the decisions on behalf of the user to make the interface as simple and easy to use as possible.

#### Writing a view

In `views.py`, let us add a view that can handle the URL we have provided above.

    from .forms import TtrssForm

    def index(request):
        """Serve configuration page."""
        status = get_status()

        form = None

        if request.method == 'POST':
            form = TtrssForm(request.POST, prefix='ttrss')
            if form.is_valid():
                _apply_changes(request, status, form.cleaned_data)
                status = get_status()
                form = TtrssForm(initial=status, prefix='ttrss')
        else:
            form = TtrssForm(initial=status, prefix='ttrss')

        return TemplateResponse(request, 'ttrss.html',
                                {'title': 'News Feed Reader (Tiny Tiny RSS)',
                                 'status': status,
                                 'form': form})

This view works with the form we created in the previous step. It shows the current status of the service in form. This status is retrieved with the help of `get_status()` helper method. When the form is posted, again this view is called and it verifies whether the form's input values are correct. If so, it will apply the actions necessary for changed form values using the `_apply_changes()` method.

#### Getting the current status of the application

The view in the previous setup requires the status of the application to be retrieved using the `get_status()` method. Let us implement that method in `views.py`.

    from plinth.modules import ttrss

    def get_status():
        """Get the current status."""
        return {'enabled': ttrss.is_enabled()}

This method retrieves the various statuses of the application for display in the view. Currently, we only need to show whether the application is enabled or disabled. So, we retrieve that using a helper method defined in `__init__.py`.

    from plinth import action_utils

    def is_enabled():
        """Return whether the module is enabled."""
        return action_utils.webserver_is_enabled('50-tt-rss')

This method uses one of the several action utilities provided by Plinth. This method checks whether a webserver configuration named `50-tt-rss` is enabled.

#### Displaying the application page

The view that we have written above requires a template file known as `ttrss.html` to work. This template file controls how the web page for our application is displayed. Let us create this template file in `templates/ttrss.html`.

    {% extends "base.html" %}

    {% load bootstrap %}

    {% block content %}

    <h2>News Feed Reader (Tiny Tiny RSS)</h2>

    <p>Tiny Tiny RSS is a news feed (RSS/Atom) reader and aggregator,
      designed to allow you to read news from any location, while feeling
      as close to a real desktop application as possible.</p>

    <h3>Configuration</h3>

    <form class="form" method="post">
      {% csrf_token %}

      {{ form|bootstrap }}

      <input type="submit" class="btn btn-primary" value="Update setup"/>
    </form>

    {% endblock %}

This template extends an existing template known as `base.html`. This template is available in Plinth core to provide all the basic layout, styling, menus, JavaScript and CSS libraries. We will override the content area of the base template and keep the rest.

Yet again, there is nothing special about the way this template is written. This is a regular Django template. See Django Template documentation.

For styling and UI components, Plinth uses the Twitter Bootstrap project. See Bootstrap documentation for reference.

#### Applying the changes from the form

The view we have created displays the form and processes the form after the user submits it. It used a helper method called `_apply_changes()` to actually get the work done. Let us implement that method in `views.py`.

    from django.contrib import messages

    from plinth import actions

    def _apply_changes(request, old_status, new_status):
        """Apply the changes."""
        modified = False

        if old_status['enabled'] != new_status['enabled']:
            sub_command = 'enable' if new_status['enabled'] else 'disable'
            actions.superuser_run('ttrss', [sub_command])
            modified = True

        if modified:
            messages.success(request, 'Configuration updated')
        else:
            messages.info(request, 'Setting unchanged')

We check to make sure that we don't try to disable the application when it is already disabled or try to enable the application when it is already enabled. Although Plinth's operations are idempotent, meaning that running them twice will not be problematic, we still wish avoid unnecessary operations for the sake of speed.

We are actually perform the operation using Plinth actions. We will implement the action to be performed a bit later.

After we perform the operation, we will show a message on the response page showing that the action was successful or that nothing happened. We use the Django messaging framework to accomplish this. See Django messaging framework for more information.

#### Installing packages required for the application

Plinth takes care of installing all the Debian packages required for our application to work. All we need to do is specify the list of the Debian packages required using a decorator on our view as follows:

    from plinth import package

    @package.required(['tt-rss'])
    def index(request):
        """Serve configuration page."""
        ...

The first time this application's view is accessed, Plinth shows a package installation page and allows the user to install the required packages. After the package installation is completed, the user is shown the application's configuration page.

If there are configuration tasks to be performed immediately before or after the package installation, Plinth provides hooks for it. The `before_install=` and `on_install=` parameters to the `@package.required` decorator take a callback methods that are called before installation of packages and after installation of packages respectively. See the reference section of this manual or the `plinth.package` module for details. Other modules in Plinth that use this feature provided example usage.

#### Writing actions

The actual work of performing the configuration change is carried out by a Plinth action. Actions are independent scripts that run with higher privileges required to perform a task. They are placed in a separate directory and invoked as scripts via sudo. For our application we need to write an action that can enable and disable the web configuration. We will do this by creating a file `actions/ttrss`.

    import argparse

    from plinth import action_utils

    def parse_arguments():
        """Return parsed command line arguments as dictionary."""
        parser = argparse.ArgumentParser()
        subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')

        subparsers.add_parser('enable', help='Enable Tiny Tiny RSS')
        subparsers.add_parser('disable', help='Disable Tiny Tiny RSS')

        return parser.parse_args()

    def subcommand_enable(_):
        """Enable web configuration and reload."""
        action_utils.webserver_enable('50-tt-rss')

    def subcommand_disable(_):
        """Disable web configuration and reload."""
        action_utils.webserver_disable('50-tt-rss')

    def main():
        """Parse arguments and perform all duties."""
        arguments = parse_arguments()

        subcommand = arguments.subcommand.replace('-', '_')
        subcommand_method = globals()['subcommand_' + subcommand]
        subcommand_method(arguments)

    if __name__ == '__main__':
        main()

This is a simple Python3 program that parses command line arguments. While Python3 is preferred, it can be written in other languages also. It uses a helper utility provided by Plinth to actually enable and disable Apache2 web server configuration.

This script is automatically installed to `/usr/share/plinth/actions` by Plinth's installation script `setup.py`. Only from here will there is a possibility of running the script under `sudo`. If you are writing an application that resides indenpendently of Plinth's source code, your `setup.py` script will need to take care of copying the file to the target location.

#### Creating diagnostics

Plinth provides a simple API for showing diagnostics results. The application has to implement a method for actually running the diagnostics and return the results as a list. Plinth then takes care of calling the diagnostics method and displaying the list in a formatted manner.

To implement the diagnostics method, method called `diagnose()` has to be available as `<app>.diagnose()`. It must return a list in which each item is the result of a test performed. The item itself is a two-tuple containing the display name of the test followed by the result as `passed`, `failed` or `error`.

    def diagnose():
        """Run diagnostics and return the results."""
        results = []

        results.extend(action_utils.diagnose_url_on_all(
            'https://{host}/ttrss', extra_options=['--no-check-certificate']))

        return results

There are several helpers available to implement some of the common diagnostic tests. For our application we wish to implement a test to check whether the `/ttrss` URL is accessible. Since this is a commonly performed test, there is a helper method available and we have used it in the above code. The `{host}` tag replaced with various IP addresses, hostnames and domain names by the helper to produce different kinds of URLs and they are all tested. Results for all tests are returned which we then pass on to Plinth.

The user can trigger the diagnostics test by going to `System -> Diagnostics` page. This runs diagnostics for all the applications. If we want users to be able to run diagnostics specifically for this application, we can include a button for it in our template immediately after the application description.

    {% include "diagnostics_button.html" with module="ttrss" enabled=True %}

#### Logging

Sometimes we may feel the need to write some debug messages to the console and Plinth log file. Doing this in Plinth is just like doing this any other Python application.

    import logging

    logger = logging.getLogger(__name__)

    def example_method():
        logger.debug('A debug level message')

        logger.info('Showing application page - %s', request.method)

        try:
            something()
        except Exception as exception:
            # Print stack trace
            logger.exception('Encountered an exception - %s', exception)

For more information see Python logging framework documentation.

#### Adding a License

Plinth is licensed under the GNU Affero General Public License Version 3 or later. FreedomBox UI applications, which run as modules under Plinth, also need to be under the same license or under a compatible license. The license of our application needs to clear for our application to be accepted by users and other developers. Let us add license headers to our application.

    #
    # This file is part of FreedomBox.
    #
    # This program is free software: you can redistribute it and/or modify
    # it under the terms of the GNU Affero General Public License as
    # published by the Free Software Foundation, either version 3 of the
    # License, or (at your option) any later version.
    #
    # This program is distributed in the hope that it will be useful,
    # but WITHOUT ANY WARRANTY; without even the implied warranty of
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    # GNU Affero General Public License for more details.
    #
    # You should have received a copy of the GNU Affero General Public License
    # along with this program.  If not, see <http://www.gnu.org/licenses/>.
    #

The above header needs to be present in every file of the application. It is suitable for Python files. However, in template files, we need to modify it slightly.

    {% extends "base.html" %}
    {% comment %}
    #
    # This file is part of FreedomBox.
    #
    # This program is free software: you can redistribute it and/or modify
    # it under the terms of the GNU Affero General Public License as
    # published by the Free Software Foundation, either version 3 of the
    # License, or (at your option) any later version.
    #
    # This program is distributed in the hope that it will be useful,
    # but WITHOUT ANY WARRANTY; without even the implied warranty of
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    # GNU Affero General Public License for more details.
    #
    # You should have received a copy of the GNU Affero General Public License
    # along with this program.  If not, see <http://www.gnu.org/licenses/>.
    #
    {% endcomment %}

    ...

#### Internationalization

Every string message that is visible to the user must be localized to user's native language. For this to happen, our application needs to be internationalized. This requires marking the user visible messages for translation. Plinth applications use the Django's localization methods to make that happen.

    from django.utils.translation import ugettext as _

    def index(request):
        ...
        return TemplateResponse(request, 'ttrss.html',
                                {'title': _('News Feed Reader (Tiny Tiny RSS)'),
                                 'status': status,
                                 'form': form})

Notice that the page's title is wrapped in the `_()` method call. Let us do that for the menu item of the application too.

    from django.utils.translation import ugettext_lazy as _

    def init():
        """Intialize the module."""
        menu = cfg.main_menu.get('apps:index')
        menu.add_urlname(_('News Feed Reader (Tiny Tiny RSS)'), 'glyphicon-envelope',
                         'ttrss:index', 600)

Notice that in this case, we have used the `ugettext_lazy` and in the first case we have used the regular `ugettext`. This is because in the second case the `gettext` lookup is made once and reused for every user looking at the interface. These users may each have a different language set for their interface. Lookup made for one language should not be used for other users. The `_lazy` method provided by Django makes sure that the return value is an object that will actually be converted to string at the final moment when the string is being displayed. In the first case, the looked is made and string is returned immediately.

All of this is the usual way internationalization is done in Django. See Django internationalization and localization documentation for more information.

#### Coding standards

For readability and easy collaboration it is important to follow common coding standards. Plinth uses the Python coding standards and uses the `pylint` and `flake8` tools to check if the there are any violations. Run these tools on our application and fix any errors and warnings. Better yet, integrate these tools into your favorite IDE for on-the-fly checking.

For the most part, the code we have written so far, is already compliant with the coding standards. This includes variable/method naming, indentation, document strings, comments, etc. One thing we have to add are the module documentation strings. Let us add those. In `__init__.py` add the top:

    """
    FreedomBox app to configure Tiny Tiny RSS.
    """

### Reference Guide

This section describes Plinth API that is most frequently used by application. Note that since Plinth is under development and has not yet reached 1.0, this API is subject to change. This is not usually a problem because all the Plinth applications currently reside in Plinth source repository itself and are updated when the API is updated.

#### Applications

These methods are optionally provided by the application and Plinth calls/uses them if they are present.

##### <application>.init()

Optional. This method is called by Plinth soon after all the applications are loaded. The `init()` call order guarantees that other applications that this application depends on will be initialized before this application is initialized.

##### <application>.diagnose()

Optional. Called when the user invokes system-wide diagnostics by visiting `System -> Diagnositcs`. This method must return an array of diagnostic results. Each diagnostic result must be a two-tuple with first element as a string that is shown to the user as name of the test and second element is the result of the test. It must be one of `passed`, `failed`, `error`. Example return value:

    [('Check http://localhost/app is reachable', 'passed'),
     ('Check configuration is sane', 'passed')]

##### <appliation>.depends

Optional. This module property must contain a list of all applications that this application depends on. The application is specified as string containing the full module load path. For example, `plinth.modules.apps`.

##### plinth.package.required(package_list, before_install=None, on_install=on_install)

Make sure that a set of Debian packages are installed before a view can be accessed. If the packages are not currently installed on the system, a special installation view is displayed showing the list of packages to be installed. If the user chooses to proceed, package installation will start and an installation progress screen will be shown. After completion of the installation process, the original view is shown.

The `package_list` must be an iterable containing the Debian package names as strings. If provided, the `before_install` callable is called just before the installation process starts. Similarly, `on_install` callable is called just after the package installation completes.

#### Actions

Plinth's web front does not directly change any aspect of the underlying operating system. Instead, it calls upon Actions, as shell commands. Actions live in `/usr/share/plinth/actions` directory. They require no interaction beyond passing command line arguments or taking sensitive arguments via stdin. They change the operation of the services and applications of the FreedomBox and nothing else. These actions are also directly usable by a skilled administrator.

The following methods are provided by Plinth to run actions and to implement them easily by reusing code for common tasks.

##### plinth.actions.run(action, options=None, input=None, async=False)

Run an action command present under the `actions/` directory. This runs `subprocess.Popen()` after some checks. The action must be present in the actions/ directory.

`options` are a list of additional arguments to pass to the command. If `input` is given it must be bytearray containing the input to pass on to the executed action. If `async` is set to True, the method will return without waiting for the command to finish.

##### plinth.actions.superuser_run(action, options=None, input=None, async=False)

This is same as `plinth.actions.run()` except the command is run with superuser privelages.

##### plinth.action_utils

Several utlities to help with the implementation of actions and diagnotic tests are implemented in this module. Refer to the module source code for a list of these methods and their documentation.

#### Menus

##### plinth.cfg.main_menu

This is a reference to the global main menu. All menu entries in Plinth are decendents of this menu item. See `Menu.add_item()` and `Menu.add_urlname()` for adding items to this menu or its children.

##### plinth.menu.Menu.get(self, urlname, url_args=None, url_kwargs=None)

Return a child of this menu item. `urlname` must be the name of a URL as configured in Django. `django.core.urlresolvers.reverse()` is called before the lookup for child menu item is performed. `url_args` and `url_kwargs` are passed on to `reverse()`.

##### plinth.menu.Menu.add_item(self, label, icon, url, order=50)

Add a menu item as a child to the current menu item. `label` is the user visible string shown for the menu item. `icon` must be a glyphicon class from the Twitter Bootstrap library. `url` is the relative URL to which this menu item will take the user to.

##### plinth.menu.Menu.add_urlname(self, label, icon, urlname, order=50, url_args=None, url_kwargs=None)

Same as `plinth.menu.Menu.add_item()` but instead of URL as input it is the name of a URL as configured in Django. `django.core.urlresolvers.reverse()` is called before it is added to the parent menu item. `url_args` and `url_kwargs` are passed on to `reverse()`.

#### Services

##### plinth.service.Service.__init__(self, service_id, name, ports=None, is_external=False, enabled=True)

Create a new Service object to notify all applications about the existence and status of a given application. `service_id` is a unique identifier for this application. `name` is a display name of this application that is shown by other applications such as on the firewall status page. `ports` is a list of names recognized by firewalld when enabling or disabling firewalld services. If `is_external` is true, the ports for this service are accessible from external interfaces, that is, from the Internet. Otherwise, the service is only available for client connected via LAN. `enabled` is the current state of the application.

##### plinth.service.Service.is_enabled(self)

Return whether the service is currently enabled.

##### plinth.service.Service.notify_enabled(self, sender, enabled)

Notify other applications about the change of status of this application. `sender` object should identify which application made the change. `enabled` is a boolean that signifies whether the application is enabled (= True) or disabled (= False).

This is typically caught by the firewall application to enable or disable the ports corresponding to an application.

## Hacking

FreedomBox consists of three main projects:

- Plinth, the web interface

- FreedomBox Setup, the Debian package to perform initial setup and

- Freedom Maker, a script to build disk images for various hardware

### Plinth

Plinth is a web interface to administer the functions of the FreedomBox.

Plinth is Free Software under GNU Affero General Public License version 3 or (at your option) a later version.

#### Using

- Plinth comes installed with all FreedomBox images. You can download FreedomBox images and run on any of the supported hardware. Then, you can access Plinth by visiting the URL .

- If you are on a Debian box, you may install Plinth from Debian package archive. Currently, only Stretch (testing) and Sid (unstable) are supported. To install Plinth run:

    $ sudo apt-get install plinth

- You can also get Plinth from its Git repository and install from source.

#### Screenshots

About Page Enabling Tor Hidden Services Setting up Email Client Newsfeed from anywhere

#### Support

You may ask for support on

- The mailing list

- #freedombox IRC channel

#### Contributing

We are looking for help to improve Plinth. You can contribute to Plinth by not just by coding but also by translating, documenting, designing, packaging and providing support.

- Instructions on how to contribute code are available.

- The primary Git repository is hosted at FreedomBox Salsa Page.

- Instructions for installing from source and hacking the source are available.

- List of bugs, TODO items and feature requests are available on the issue tracker.

- Before contributing to Plinth code, you need understand Python and Django on top which it is built.

- You can request for development assistance on the mailing list or the #freedombox IRC channel.

##### Debian Package

- Plinth is packaged for Debian. Plinth is a native package and packaging source code is part of the main package source code.

- Issues related to packaging are listed on Debian BTS.

### FreedomBox Setup

FreedomBox Setup is a Debian package for setting up the FreedomBox. If you download and use pre-built images you don't have to worry about this package.

FreedomBox Setup is responsible for setting up basic networking, web server, user accounts, installing essential packages etc. It performs first part of the setup during the image build process. Later, when the image is booted for the first time on actual hardware (or on a virtual machine), it does the remaining setup and then reboots the machine. It also comes with a diagnostic script to check if the FreedomBox Setup is running as expected.

FreedomBox Setup is Free Software licensed under GNU General Public License version 3 or (at your option) a later version.

#### Using

- FreedomBox Setup comes installed with all FreedomBox images. You can download FreedomBox images and run on any of the supported hardware.

- If you are on a Debian box, you may install FreedomBox Setup from Debian package archive. This essentially turns your Debian installation into a FreedomBox! Currently, only Sid (unstable) is supported. To install FreedomBox Setup, see instructions on setting up FreedomBox on a Debian machine.

- You can also get FreedomBox Setup from its Git repository and build Debian package from source.

#### Support

You may ask for support on

- The mailing list

- #freedombox IRC channel

#### Contributing

We are looking for help to improve FreedomBox Setup.

- Instructions on how to contribute code are available.

- FreedomBox Setup is part of the FreedomBox Salsa Project.

- List of bugs, TODO items, packages issues and feature requests are available on the issue tracker.

- You can request for development assistance on the mailing list or the #freedombox IRC channel.

- See Debian tracker for information on Debian package. FreedomBox Setup is a Debian native package meaning it is primarily built for Debian and comes with Debian packaging scripts in its repository.

### 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:

- A20-OlinuXino-LIME

- A20-OlinuXino-LIME2

- A20-OLinuXino-MICRO

- Banana Pro

- BeagleBone

- Cubieboard2

- Cubietruck

- DreamPlug

- pcDuino3

- Raspberry Pi

- Raspberry Pi 2

- Raspberry Pi 3

- VirtualBox

- QEMU

- AMD64 (x86-64) Machines, X86 Machines and other virtual machines (using raw disk images)

It relies on the vmdebootstrap project actually create 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 Free Software licensed under GNU General Public License version 3 or (at your option) a later version.

#### Building FreedomBox Images

- You can get Freedom Maker from its Git repository and follow the instructions in the README to build a FreedomBox image.

#### Support

You may ask for support on

- The mailing list

- #freedombox IRC channel

#### Contributing

We are looking for help to improve Freedom Maker.

- Instructions on how to contribute code are available.

- Freedom Maker is hosted at FreedomBox Salsa Project. The primary Git repository is hosted 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 issue tracker.

- You can request for development assistance on the mailing list or the #freedombox IRC channel.

## Tell people around you

- FreedomBox in the Press

- Conferences

- Talks and presentations

  - Available Material Slides and other raw material

- Facebook

- Twitter

- Debconf11 Videos