diff --git a/doc/freedombox-manual.xml b/doc/freedombox-manual.xml index cea0ca8bd..d1060ce38 100644 --- a/doc/freedombox-manual.xml +++ b/doc/freedombox-manual.xml @@ -48,17 +48,27 @@ 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 avaible digital communications throughout the village. In future, FreedomBox intends to deliver support for alternative ways of connecting to the Internet such as Mesh networks.
- FreedomBox Interface Screenshot - - - - - - - freedombox2.png - - - + FreedomBox Interface +
+ Screenshot + + + + + + + freedombox2.png + + + +
+
+ Screencast introduction + + Plinth_Introduction.webm + + (36 MB, 13 Min.) +
@@ -94,13 +104,21 @@ If your computer supports mDNS (GNU/Linux, Mac OSX and Windows with mDNS software installed), you can browse to: (or ) - If neither of these methods are available, then you will need to figure out the IP address of your FreedomBox. You can use the "nmap" program to find its IP address: + If neither 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 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.) @@ -111,7 +129,7 @@ On the intial access you will see a welcome page that asks you to provide some basic information for setting up your FreedomBox. - After completing the form, you will be logged in to Plinth and able to access apps and configuration through the interface. + After completing the form, you will be logged in to Plinth and able to access apps and configuration through the interface. Note that this first user has Admin privileges and can also log in using ssh. If your computer is connected directly to the FreedomBox, your FreedomBox can act as a router, allowing you to access the Internet. @@ -147,7 +165,57 @@ Release Notes The following are the release notes for each FreedomBox version.
- Version 0.11.0 (2016-09-xx) + 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. @@ -210,7 +278,7 @@
- Version 0.10 (2016-08) + Plinth v0.10.0 (2016-08-21) Updated Plinth to support Django 1.10. @@ -1111,6 +1179,7 @@ file = /etc/radicale/rights ownCloud was removed from Debian ownCloud was removed from Debian, so it is not available in the FreedomBox any more. Existing installations however are still working for time being. We are working on finding an adequate alternative. + Migrate to the official owncloud repository can be done in following this post
What is ownCloud? @@ -3477,23 +3546,50 @@ nmcli con modify "<connection_name>" connection.zone internal 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.
- Default User Account - 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. + 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 + 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 - 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. +
+ 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 @@ -3851,7 +3947,7 @@ Password: - FreedomBox Danube Edition is a custom casing around Cubietruck coupled with an SSD. + FreedomBox Danube Edition is a custom casing around Cubietruck coupled with an SSD.
Cubietruck / Cubieboard3 @@ -3871,7 +3967,7 @@ Password: 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. + 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 @@ -5302,7 +5398,7 @@ wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw<
Development priorities - Upcoming priorities have been discussed end of October 2015 by several core developers and the Freedombox Foundation. You'll find on the mailing list archives a Medium Term Roadmap for 2015 and 2016. We want to enjoy soon a version 1.0. We are targeting mid January for a 0.8 release. The main focus of the 0.8 release is going to be integrated in the PGP based SSL Client authentication work. We are planning on a 0.9 polish release for late February with general usability improvements. + Upcoming priorities are discussed on an regular basis. You find the progress of the webinterface Plinth with it's priorities here:Project Progess. 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.
@@ -5404,10 +5500,10 @@ wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw< FreedomBox website and wiki - Individual applications that FreedomBox exposes to users such as ownCloud, JWChat etc. + 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 GitHub. + 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 GitHub. 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.
@@ -5985,23 +6081,23 @@ Plinth module to configure Tiny Tiny RSS. - + - + - Setting up ownCloud + Setting up Email Client - + - + - Automatic Firewall Operation + Newsfeed from anywhere diff --git a/doc/images/about.png b/doc/images/about.png index da90ea340..5bda5544d 100644 Binary files a/doc/images/about.png and b/doc/images/about.png differ diff --git a/doc/images/emailclient.png b/doc/images/emailclient.png new file mode 100644 index 000000000..67cf1ba09 Binary files /dev/null and b/doc/images/emailclient.png differ diff --git a/doc/images/newsfeed.png b/doc/images/newsfeed.png new file mode 100644 index 000000000..541b31c9e Binary files /dev/null and b/doc/images/newsfeed.png differ diff --git a/doc/images/tor.png b/doc/images/tor.png index bd78b058a..0f19e400c 100644 Binary files a/doc/images/tor.png and b/doc/images/tor.png differ