diff --git a/doc/freedombox-manual.xml b/doc/freedombox-manual.xml
index 6852cf6f3..82838724e 100644
--- a/doc/freedombox-manual.xml
+++ b/doc/freedombox-manual.xml
@@ -147,7 +147,61 @@
Release Notes
The following are the release notes for each FreedomBox version.
- Version 0.9.3 (2016-06-xx)
+ Version 0.10 (2016-08)
+
+
+ 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.
@@ -471,7 +525,10 @@
Downloading Images
Recent images for supported targets are available here:
-
+
+ Official Images:
+
+
Official Images:
@@ -482,11 +539,11 @@
First open a terminal and import the public key of the FreedomBox developer who built the images:
- $ gpg --keyserver x-hkp://pool.sks-keyservers.net --recv-keys 0x36C361440C9BC971
+ $ gpg --keyserver x-hkp://pool.sks-keyservers.net --recv-keys BCBEBD57A11F70B23782BC5736C361440C9BC971
Next, verify the fingerprint of the public key:
- $ gpg --fingerprint 0x36C361440C9BC971
+ $ 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>
@@ -501,6 +558,17 @@ 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
+
+ For version 0.9, some of the images are signed using the following key instead of the regular key:
+ $ 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
+
@@ -607,6 +675,12 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971
Shaarli
+
+
+ Currently not functional
+
+ Shaarli is currently not available in Debian testing and the version in sid is said to be not functional. We are expecting this will soon be resolved and Shaarli will be again available in the FreedomBox.
+
What is Shaarli?
Shaarli is personal (single-user) bookmarking application to install on your FreedomBox. It can also be used for micro-blogging, pastebin, online notepad and snippet archive. Shaarli is designed as a no-database delicious clone. As such, it provides very fast services, easy backup and import/export links as desktop or mobile browser bookmarks. Links stored can be public or private. Shaarli delivers ATOM and RSS feeds from its minimalist interface.
@@ -761,6 +835,12 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971
ownCloud
+
+
+ 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.
+
What is ownCloud?
ownCloud is a self-hosted file sync and share server. It provides access to your data through a platform to view, sync and share across devices. Calendars and Contacts feature will help you keeping google at a nice distance. ownCloud's functionalities are native or available via plugins (Collaborative Editing, Play Music, Watch Movies, Store Passwords, Dashboard, Mozilla Sync...) via
@@ -854,10 +934,81 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971
- Privoxy
+ 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).
- What is Privoxy?
- Privoxy is a software for security, privacy, and accurate control over the web. It provides a much more powerful web proxy (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). Learning about networking protocols like HTTP, about HTML, and "Regular Expressions" can help a lot using Privoxy.
+ Setting up
+
+
+ In Plinth install Web Proxy (Privoxy)
+
+
+
+
+
+
+
+
+ Privoxy-Installation.png
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+ 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.
+
+
+ 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
+
+
+ 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.
+
+
+ While using Privoxy, you can see its configuration details and documentation at or .
+
+
+ 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.
+
+
+
+
+
+ Now you find an EDIT button on the configuration screen in http://config.privoxy.org/.
+
+
+ The Quickstart is a good starting point to read on how to define own blocking and filtering rules.
+
+
+ Screencast of the setting-up: Privoxy_Installation.webm
@@ -1005,63 +1156,162 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971
- Radicale
-
- What is Radicale?
- Radicale is a CalDAV and CardDAV server. It allows synchronization and sharing of calendar and contact data. To use the application, a supported client application is needed. Radicale can be accessed by any user with a FreedomBox login.
-
+ Calendar, ToDo-List and Addressbook Server (through radicale)
+ With radicale you can synchronize your personal Calendars, ToDo-Lists and Addressbooks with your various computers, tables, smartphones etc. and share them with friends without letting third parties know your personal Schedule or Contacts.
Why running Radicale?
Using Radicale, you can get rid of centralized services like Google Calendar or Apple Calendar (iCloud) mining your events and social connections.
How to setup Radicale?
- First, the Radicale server needs to be activated on your box. Then the mobile and computer clients need to be configured.
+ First, the Radicale server needs to be activated on your box.
- From your FreedomBox interface, go to "Calendar and Addressbook (Radicale)" page and 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 server CalDAV.
-
-
- Now open your clients to create new calendar and address books that will use your FreedomBox and Radicale server. Remember, your clients must be CalDAV and CardDAV compatible. The Radicale website provides tutorials to setup a large selection of clients.
+ Within Plinth
+
+
+ select Applications
+
+
+ go to Calendar and Addressbook (Radicale) and
+
+
+ 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 server CalDAV. Radicale-Plinth-Docu.png
+
+
+
+ Radicale can be accessed by any user with a FreedomBox login. However, each user only has access to his data. If you want to share a calendar with friends, the simplest approach is to create an additional user for your friends 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 tutorials to setup a large selection of clients. Below are the steps for two examples:
+
Example of setup with Evolution client:
- Contacts
+ Calendar
- Create new address book
+ Create a new calendar
- For "Type," select "WebDAV"
+ For "Type," select "CalDAV"
- When "WebDAV" is selected, additional options will appear in the dialogue window.
+ When "CalDAV" is selected, additional options will appear in the dialogue window.
- URL: https://IP address or domain for your server/radicale/user/contact file name.vcf/. In addition, 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. Items in italics need to be changed to match your settings.
+ 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.
+
+
Select/check "Use a secure connection."
- Name the address book
+ Name the calendar
+
+
+ A ToDo-List is basically the same as a calendar. Radicale-Evolution-Docu.png
- Calendar
+ Contacts
- Follow the same steps described above and replace WebDAV with CalDAV. The extension of the calendar file will be .ics.
+ 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 accound DAVdroid with the same settings as described for Evolution
+
+
+ Click the newly created account and synchronize.
+
+
+ The settings, such as periodicity of synchronizsation, 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.
+
+
+
+
+ Experienced Users
+
+ Sharing ressources
+ Above was shown an easy way to create a ressource 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.
+
+
+ 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
+
+
+
+
+ edit file /etc/radicale/config and make the following changes in section [rights)
+
+
+ [rights]
+type = from_file
+file = /etc/radicale/rights
+
+
+
+
+ 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.
+
+
SIP Server (repro)
diff --git a/doc/images/Privoxy-BrowserSettings.png b/doc/images/Privoxy-BrowserSettings.png
new file mode 100644
index 000000000..cb00c1a25
Binary files /dev/null and b/doc/images/Privoxy-BrowserSettings.png differ
diff --git a/doc/images/Privoxy-Installation.png b/doc/images/Privoxy-Installation.png
new file mode 100644
index 000000000..8956348ce
Binary files /dev/null and b/doc/images/Privoxy-Installation.png differ
diff --git a/doc/images/Radicale-Evolution-Docu.png b/doc/images/Radicale-Evolution-Docu.png
new file mode 100644
index 000000000..42bc6567e
Binary files /dev/null and b/doc/images/Radicale-Evolution-Docu.png differ
diff --git a/doc/images/Radicale-Plinth-Docu.png b/doc/images/Radicale-Plinth-Docu.png
new file mode 100644
index 000000000..4a6e4e408
Binary files /dev/null and b/doc/images/Radicale-Plinth-Docu.png differ