Translation(s): ?Deutsch - English

Quick Start

1. What you need to get started

2. 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: http://freedombox/ or http://10.42.0.1/.

    • If your computer supports mDNS (GNU/Linux, Mac OSX or Windows with mDNS software installed), you can browse to: http://freedombox.local/ (or http://the-hostname-you-entered-during-install.local/)

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

           Nmap scan report for 192.168.0.165
           Host is up (0.00088s latency).
           PORT   STATE SERVICE VERSION
           80/tcp open  http    Apache httpd 2.4.17 ((Debian))
      If nmap does not find anything with the above command, you can try replacing 192.168.0.0/24 with 10.42.0.255/24.
           nmap -n -sP 10.42.0.255/24
      The scan report will show something similar to the following:
           Nmap scan report for 10.42.0.1
           Host is up (0.00027s latency).
           Nmap scan report for 10.42.0.50
           Host is up (0.00044s latency).

      In this example, the FreedomBox is accessible at http://10.42.0.50. (10.42.0.1 is my laptop.)

  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.
    • [ATTACH]

    • [ATTACH]

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

    • [ATTACH]

  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.

    • [ATTACH]

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

Now you can try any of the Apps that are available on FreedomBox.

3. Finding your way around

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

[ATTACH]

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

[ATTACH]

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

[ATTACH]

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

[ATTACH]

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

[ATTACH]


Intro

Information

Support

Contribute

Reports

Promote

Vision

Hardware

Live Help

Where To Start

Translate

Calls

Talks

Overview

Download

Q&A

To Do

Design

Releases

Press

Features

Manual

Contributors

Code

Blog

FreedomBox for Communities

FreedomBox Developer Manual

HELP & DISCUSSIONS: Discussion Forum - Matrix - Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project

Next call: Saturday, April 13 at 14:00 UTC

This page is copyright its contributors and is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.


CategoryFreedomBox