diff --git a/doc/Apache_userdir.raw.xml b/doc/Apache_userdir.raw.xml new file mode 100644 index 000000000..dcaa6ab6c --- /dev/null +++ b/doc/Apache_userdir.raw.xml @@ -0,0 +1,5 @@ + + +
FreedomBox/Manual/Apache_userdir12019-02-13 23:15:52MikkelKirkgaardNielsenadd draft page
Apache mod_userdir (userdir)
What is Apache mod_userdir?Apache mod_userdir is a module of the Apache webserver enabled to allow users defined in the FreedomBox system to expose a set of static files on the FreedomBox filesystem as a website to the local network and/or the internet according to the network and firewall setup. Read more about Apache mod_userdir in the Apache documentation. Available since: version 0.9.4
ScreenshotAdd when/if an interface is made for Plinth
Using Apache mod_userdirThe module is always enabled and offers no configuration from the Plinth web interface. Currently its existence is not even visible in the Plinth web interface. Using the modules capability to serve documents requires just to place the documents in the designated directory in a Plinth user's home directory in the filesystem. This directory is: public_html Thus the absolute path for the directory of a user named fbx with home directory in /home/fbx will be /home/fbx/public_html. Apache mod_userdir will serve documents placed in this directory when requests for documents with the URI path "~fbx" are received. For the the example.org domain thus a request for the document example.org/~fbx/index.html will transfer the file in /home/fbx/public_html/index.html.
Using SFTP to create public_html and upload documentsTo be written Back to Features introduction or manual pages. InformationSupportWork SpaceReportsPromoteOverview Hardware Live Help Where To Start Translate Calls Talks Features Vision Q&A Design To Do Metrics Press Download Manual Use cases Code Contributors Releases Blog HELP & DISCUSSIONS: Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project Next call: Sunday, February 24th at 17:00 UTC Latest news: Stable FreedomBox images - 2017-08-05 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
\ No newline at end of file diff --git a/doc/MatrixSynapse.raw.xml b/doc/MatrixSynapse.raw.xml index a0f299c1d..fa834465c 100644 --- a/doc/MatrixSynapse.raw.xml +++ b/doc/MatrixSynapse.raw.xml @@ -2,4 +2,4 @@ -
FreedomBox/Manual/MatrixSynapse72019-01-14 20:16:04DrahtseilSystem requirements62018-03-02 12:06:08JosephNuthalapati52018-03-02 10:44:12JosephNuthalapatiNaming was inconsistent42017-06-27 05:13:41JosephNuthalapati32017-03-24 06:42:49SunilMohanAdapaUpdate for explaining more features etc.22017-03-23 06:36:05rahulde12017-03-23 06:33:43rahulde
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 MatrixTo 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. System requirements: At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org
Federating with other Matrix instancesYou 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. Back to Features introduction or manual pages. InformationSupportWork SpaceReportsPromoteOverview Hardware Live Help Where To Start Translate Calls Talks Features Vision Q&A Design To Do Metrics Press Download Manual Use cases Code Contributors Releases Blog HELP & DISCUSSIONS: Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project Next call: Sunday, February 24th at 17:00 UTC Latest news: Stable FreedomBox images - 2017-08-05 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
\ No newline at end of file +
FreedomBox/Manual/MatrixSynapse82019-02-13 09:09:45JosephNuthalapatiRemove pop-culture references. Add notes about large rooms and memory usage.72019-01-14 20:16:04DrahtseilSystem requirements62018-03-02 12:06:08JosephNuthalapati52018-03-02 10:44:12JosephNuthalapatiNaming was inconsistent42017-06-27 05:13:41JosephNuthalapati32017-03-24 06:42:49SunilMohanAdapaUpdate for explaining more features etc.22017-03-23 06:36:05rahulde12017-03-23 06:33:43rahulde
Chat Server (Matrix Synapse)
What is 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. Matrix Synapse is a federated application where chat rooms can exist on any server and users from any server in the federated network can join them. Learn more about Matrix. Available since: version 0.14.0
How to access your Matrix Synapse server?We recommend the Riot client to access the Matrix Synapse server. You can download Riot for desktops. Mobile applications for Android and iOS are available from their respective app stores.
Setting up Matrix Synapse on your FreedomBoxTo 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 instancesYou will be able to interact with any other person running another Matrix instance. This is done by simply starting a conversation with them using their matrix ID which is of the format @their-username:their-domain. You can also join rooms which are in another server and have audio/video calls with contacts on other server.
Memory usageThe Synapse reference server implemented in Python is known to be quite RAM hungry, especially when loading large rooms with thousands of members like #matrix:matrix.org. It is recommended to avoid joining such rooms if your FreedomBox device only has 1 GiB RAM or less. Rooms with up to a hundred members should be safe to join. The Matrix team is working on a new implementation of the Matrix server written in Go called Dendrite which might perform better in low-memory environments. Back to Features introduction or manual pages. InformationSupportWork SpaceReportsPromoteOverview Hardware Live Help Where To Start Translate Calls Talks Features Vision Q&A Design To Do Metrics Press Download Manual Use cases Code Contributors Releases Blog HELP & DISCUSSIONS: Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project Next call: Sunday, February 24th at 17:00 UTC Latest news: Stable FreedomBox images - 2017-08-05 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
\ No newline at end of file diff --git a/doc/Radicale.raw.xml b/doc/Radicale.raw.xml index b50f4c4a3..8e91b0a31 100644 --- a/doc/Radicale.raw.xml +++ b/doc/Radicale.raw.xml @@ -2,7 +2,7 @@ -
FreedomBox/Manual/Radicale352018-09-29 11:28:56JamesValleroyUse calendar-name in CalDAV url342018-07-10 18:04:49BartNotelaers332018-06-17 16:36:11JosephNuthalapatiAdd a missing instruction on how to synchronize using DAVdroid322018-06-01 10:48:04JosephNuthalapatiUpdate DAVdroid account setup with screenshots312018-01-03 08:54:14JosephNuthalapatiUpdate broken link - radicale clients302017-08-06 23:06:11JohannesKeyserupdated dead link to radicale client page, and added warning about misleading URL info292016-12-31 02:28:01JamesValleroystyle changes282016-09-09 15:36:28SunilMohanAdapaMinor indentation fix with screenshot272016-09-09 14:43:07SunilMohanAdapaMinor fix to adjust screenshot262016-09-01 19:11:38Drahtseiladapted title to Plinth wording252016-08-31 17:26:23Drahtseilupdated screenshot242016-08-31 17:24:42DrahtseilAccess rights232016-08-01 16:32:28Drahtseil222016-08-01 16:28:29Drahtseilscreenshots212016-08-01 16:18:30DrahtseilEvolution tutorial to use Calendar instead of Contacts (just happen to have that screenshot)202016-07-31 18:21:39DrahtseilAndroid, advanced user, screenshots still to follow192016-07-31 16:54:46Drahtseil182016-05-18 12:40:51SunilMohanAdapaReduce item nesting to < 4 due to problems in generating FreedomBox Manual172016-04-27 03:35:17StacyCockrumformatting162016-04-27 03:24:18StacyCockrumEditing and added instructions for Evolution Calendar.152016-04-26 06:11:34PhilippeBaretEditing142016-04-25 11:43:17StacyCockrum132016-04-25 11:36:30StacyCockrumI'm not sure if this is the right place to put this kind of information. I thought it would be helpful for a person to know some specifics around the settings. Pls advise if it should go somewhere e122016-04-16 01:38:12PhilippeBaretAdded Why Radical app content112016-04-16 01:36:07PhilippeBaretCorrection102016-04-15 14:58:18StacyCockrum2nd bullet under "How to setup...?" Is it true that a new calendar/address book is created for each client or perhaps the clients need to be configured to access the calendar/address books?92016-04-15 14:53:50StacyCockrumStruggled with the last sentence of the first bullet under "How to setup Radicale?". When the Radicale server is launched does CalDAV become a function of the server or is a CalDAV server?82016-04-11 09:04:25PhilippeBaretCorrection72016-04-11 09:02:38PhilippeBaretCorrection proper terms: CalDAV and CardDAV62016-04-11 09:01:11PhilippeBaretAdded Why running Radicale section52016-04-11 08:53:27PhilippeBaretCorrection42016-04-11 08:48:16PhilippeBaretAdded how to setup Radical server and clients in FreedomBox Manual32016-04-10 07:12:39PhilippeBaretAdded manual link22016-04-10 07:09:27PhilippeBaretAdded Radicale definition on FreedomBox manual12016-04-10 06:40:28PhilippeBaretAdded first content to Radicale manual page
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 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 CalDAV/CardDAV server. 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 Create a new calendar For "Type," select "CalDAV" When "CalDAV" is selected, additional options will appear in the dialogue window. URL: https://IP-address-or-domain-for-your-server/radicale/user/calendar-name.ics/. Items in italics need to be changed to match your settings. note the trailing / in the path, it is important. Enable "Use a secure connection." 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.
Synchronizing with your Android phoneThere are various Apps that allow integration with 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. Follow these steps for setting up your account with the Radicale server running on your FreedomBox. Install DAVdroid Create a new account on DAVdroid by clicking on the floating + button. Select the second option as shown in the first figure below and enter the base url as (see the first screenshot below). DAVdroid will be able to discover both CalDAV and WebDAV accounts for the user. Follow this video from DAVdroid FAQ to learn how to migrate your existing contacts to Radicale. Synchronizing contacts Click on the hamburger menus of CalDAV and CardDAV and select either "Refresh ..." in case of existing accounts or "Create ..." in case of new accounts (see the second screenshot below). Check the checkboxes for the address books and calendars you want to synchronize and click on the sync button in the header. (see the third screenshot below) DAVdroid account setup DAVdroid refresh DAVdroid account sync
Advanced Users
Sharing resourcesAbove 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. create a file /etc/radicale/rights FreedomBox/Manual/Radicale382019-02-10 23:10:19JamesValleroyonly need domain name for DAVx5372019-02-10 23:09:14JamesValleroyrename DAVdroid -> DAVx5362019-02-10 22:59:07JamesValleroyradicale is now in testing352018-09-29 11:28:56JamesValleroyUse calendar-name in CalDAV url342018-07-10 18:04:49BartNotelaers332018-06-17 16:36:11JosephNuthalapatiAdd a missing instruction on how to synchronize using DAVdroid322018-06-01 10:48:04JosephNuthalapatiUpdate DAVdroid account setup with screenshots312018-01-03 08:54:14JosephNuthalapatiUpdate broken link - radicale clients302017-08-06 23:06:11JohannesKeyserupdated dead link to radicale client page, and added warning about misleading URL info292016-12-31 02:28:01JamesValleroystyle changes282016-09-09 15:36:28SunilMohanAdapaMinor indentation fix with screenshot272016-09-09 14:43:07SunilMohanAdapaMinor fix to adjust screenshot262016-09-01 19:11:38Drahtseiladapted title to Plinth wording252016-08-31 17:26:23Drahtseilupdated screenshot242016-08-31 17:24:42DrahtseilAccess rights232016-08-01 16:32:28Drahtseil222016-08-01 16:28:29Drahtseilscreenshots212016-08-01 16:18:30DrahtseilEvolution tutorial to use Calendar instead of Contacts (just happen to have that screenshot)202016-07-31 18:21:39DrahtseilAndroid, advanced user, screenshots still to follow192016-07-31 16:54:46Drahtseil182016-05-18 12:40:51SunilMohanAdapaReduce item nesting to < 4 due to problems in generating FreedomBox Manual172016-04-27 03:35:17StacyCockrumformatting162016-04-27 03:24:18StacyCockrumEditing and added instructions for Evolution Calendar.152016-04-26 06:11:34PhilippeBaretEditing142016-04-25 11:43:17StacyCockrum132016-04-25 11:36:30StacyCockrumI'm not sure if this is the right place to put this kind of information. I thought it would be helpful for a person to know some specifics around the settings. Pls advise if it should go somewhere e122016-04-16 01:38:12PhilippeBaretAdded Why Radical app content112016-04-16 01:36:07PhilippeBaretCorrection102016-04-15 14:58:18StacyCockrum2nd bullet under "How to setup...?" Is it true that a new calendar/address book is created for each client or perhaps the clients need to be configured to access the calendar/address books?92016-04-15 14:53:50StacyCockrumStruggled with the last sentence of the first bullet under "How to setup Radicale?". When the Radicale server is launched does CalDAV become a function of the server or is a CalDAV server?82016-04-11 09:04:25PhilippeBaretCorrection72016-04-11 09:02:38PhilippeBaretCorrection proper terms: CalDAV and CardDAV62016-04-11 09:01:11PhilippeBaretAdded Why running Radicale section52016-04-11 08:53:27PhilippeBaretCorrection42016-04-11 08:48:16PhilippeBaretAdded how to setup Radical server and clients in FreedomBox Manual32016-04-10 07:12:39PhilippeBaretAdded manual link22016-04-10 07:09:27PhilippeBaretAdded Radicale definition on FreedomBox manual12016-04-10 06:40:28PhilippeBaretAdded first content to Radicale manual page
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 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 CalDAV/CardDAV server. 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 Create a new calendar For "Type," select "CalDAV" When "CalDAV" is selected, additional options will appear in the dialogue window. URL: https://IP-address-or-domain-for-your-server/radicale/user/calendar-name.ics/. Items in italics need to be changed to match your settings. note the trailing / in the path, it is important. Enable "Use a secure connection." 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.
Synchronizing with your Android phoneThere are various Apps that allow integration with the Radicale server. This example uses DAVx5, 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. Follow these steps for setting up your account with the Radicale server running on your FreedomBox. Install DAVx5 Create a new account on DAVx5 by clicking on the floating + button. Select the second option as shown in the first figure below and enter the base url as (see the first screenshot below). DAVx5 will be able to discover both CalDAV and WebDAV accounts for the user. Follow this video from DAVx5 FAQ to learn how to migrate your existing contacts to Radicale. Synchronizing contacts Click on the hamburger menus of CalDAV and CardDAV and select either "Refresh ..." in case of existing accounts or "Create ..." in case of new accounts (see the second screenshot below). Check the checkboxes for the address books and calendars you want to synchronize and click on the sync button in the header. (see the third screenshot below) DAVx5 account setup DAVx5 refresh DAVx5 account sync
Advanced Users
Sharing resourcesAbove 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. create a file /etc/radicale/rights [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) Restart the radicale server or the FreedomBox
Importing filesIf 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.
Installing Radicale on ''testing'' version of FreedomboxRadicale is currently not included in the testing version of Freedombox, but can be installed by temporarily using files from the unstable version. Use SSH to connect to your Freedombox: Then edit the sources for the Freedombox software repositories: This will open a command line text editor. Edit the list as seen below. Add one line with the unstable sources and disable the other sources by turning them into comments by adding # in front: After saving this file, refresh the sources: Then you may install Radicale from Plinth. Afterwards, reverse the changes to the software sources list so automatic updates may be processed properly - important for the security of your Freedombox. Back to Features introduction or manual pages. InformationSupportWork SpaceReportsPromoteOverview Hardware Live Help Where To Start Translate Calls Talks Features Vision Q&A Design To Do Metrics Press Download Manual Use cases Code Contributors Releases Blog HELP & DISCUSSIONS: Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project Next call: Sunday, February 24th at 17:00 UTC Latest news: Stable FreedomBox images - 2017-08-05 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
\ No newline at end of file +file = /etc/radicale/rights]]>Restart the radicale server or the FreedomBox
Importing filesIf 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. Back to Features introduction or manual pages. InformationSupportWork SpaceReportsPromoteOverview Hardware Live Help Where To Start Translate Calls Talks Features Vision Q&A Design To Do Metrics Press Download Manual Use cases Code Contributors Releases Blog HELP & DISCUSSIONS: Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project Next call: Sunday, February 24th at 17:00 UTC Latest news: Stable FreedomBox images - 2017-08-05 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
\ No newline at end of file diff --git a/doc/freedombox-manual.raw.xml b/doc/freedombox-manual.raw.xml index 3d8b449d6..a2a5afe65 100644 --- a/doc/freedombox-manual.raw.xml +++ b/doc/freedombox-manual.raw.xml @@ -4,6 +4,12 @@ FreedomBox/Manual + + 69 + 2019-02-13 23:16:48 + MikkelKirkgaardNielsen + place dlmonkey after sort order in app. list, add comment about sorting, add draft userdir page + 68 2019-01-31 00:46:47 @@ -882,6 +888,37 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]>
Apps + + Add entries here sorted after the level 2 heading inside the page to keep the list alphabetically sorted + +
+ Apache mod_userdir (userdir) +
+ What is Apache mod_userdir? + Apache mod_userdir is a module of the Apache webserver enabled to allow users defined in the FreedomBox system to expose a set of static files on the FreedomBox filesystem as a website to the local network and/or the internet according to the network and firewall setup. + Read more about Apache mod_userdir in the Apache documentation. + Available since: version 0.9.4 +
+
+ Screenshot + + Add when/if an interface is made for Plinth + +
+
+ Using Apache mod_userdir + The module is always enabled and offers no configuration from the Plinth web interface. Currently its existence is not even visible in the Plinth web interface. + Using the modules capability to serve documents requires just to place the documents in the designated directory in a Plinth user's home directory in the filesystem. + This directory is: public_html + Thus the absolute path for the directory of a user named fbx with home directory in /home/fbx will be /home/fbx/public_html. Apache mod_userdir will serve documents placed in this directory when requests for documents with the URI path "~fbx" are received. For the the example.org domain thus a request for the document example.org/~fbx/index.html will transfer the file in /home/fbx/public_html/index.html. +
+
+ Using SFTP to create public_html and upload documents + + To be written + +
+
Anonymity Network (Tor)
@@ -1175,20 +1212,20 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]>
Synchronizing with your Android phone - There are various Apps that allow integration with 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. + There are various Apps that allow integration with the Radicale server. This example uses DAVx5, 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. Follow these steps for setting up your account with the Radicale server running on your FreedomBox. - Install DAVdroid + Install DAVx5 - Create a new account on DAVdroid by clicking on the floating + button. + Create a new account on DAVx5 by clicking on the floating + button. - Select the second option as shown in the first figure below and enter the base url as (see the first screenshot below). DAVdroid will be able to discover both CalDAV and WebDAV accounts for the user. + Select the second option as shown in the first figure below and enter the base url as (see the first screenshot below). DAVx5 will be able to discover both CalDAV and WebDAV accounts for the user. - Follow this video from DAVdroid FAQ to learn how to migrate your existing contacts to Radicale. + Follow this video from DAVx5 FAQ to learn how to migrate your existing contacts to Radicale. @@ -1208,7 +1245,7 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]> - DAVdroid account setup + DAVx5 account setup @@ -1216,7 +1253,7 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]> - DAVdroid refresh + DAVx5 refresh @@ -1224,7 +1261,7 @@ Primary key fingerprint: BCBE BD57 A11F 70B2 3782 BC57 36C3 6144 0C9B C971]]> - DAVdroid account sync + DAVx5 account sync @@ -1277,44 +1314,6 @@ file = /etc/radicale/rights]]> 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.
-
- Installing Radicale on ''testing'' version of Freedombox - Radicale is currently not included in the testing version of Freedombox, but can be installed by temporarily using files from the unstable version. Use SSH to connect to your Freedombox: - - - - - - Then edit the sources for the Freedombox software repositories: - - - - - - This will open a command line text editor. Edit the list as seen below. Add one line with the unstable sources and disable the other sources by turning them into comments by adding # in front: - - - - - - After saving this file, refresh the sources: - - - - - - Then you may install Radicale from Plinth. - Afterwards, reverse the changes to the software sources list so automatic updates may be processed properly - important for the security of your Freedombox. -
@@ -1371,30 +1370,26 @@ file = /etc/radicale/rights]]>
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. + What is 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. Matrix Synapse is a federated application where chat rooms can exist on any server and users from any server in the federated network can join them. Learn more about Matrix. + Available since: version 0.14.0
- 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. + How to access your Matrix Synapse server? + We recommend the Riot client to access the Matrix Synapse server. You can download Riot for desktops. Mobile applications for Android and iOS are available from their respective app stores.
- Setting up your FreedomBox for Matrix + Setting up Matrix Synapse on your FreedomBox To enable Matrix, first navigate to the Chat Server (Matrix Synapse) page and install it. Matrix needs a valid domain name to be configured. After installation, you will be asked to configure it. You will be able to select a domain from a drop down menu of available domains. Domains are configured using System -> Configure page. After configuring a domain, you will see that the service is running. The service will be accessible on the configured FreedomBox domain. 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. - - - - System requirements: - At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org - - -
Federating with other Matrix instances You will be able to interact with any other person running another Matrix instance. This is done by simply starting a conversation with them using their matrix ID which is of the format @their-username:their-domain. You can also join rooms which are in another server and have audio/video calls with contacts on other server.
+
+ Memory usage + The Synapse reference server implemented in Python is known to be quite RAM hungry, especially when loading large rooms with thousands of members like #matrix:matrix.org. It is recommended to avoid joining such rooms if your FreedomBox device only has 1 GiB RAM or less. Rooms with up to a hundred members should be safe to join. The Matrix team is working on a new implementation of the Matrix server written in Go called Dendrite which might perform better in low-memory environments. +
Email Client (Roundcube) @@ -1456,6 +1451,50 @@ file = /etc/radicale/rights]]>
+
+ File Sharing (MLDonkey) +
+ What is MLDonkey? + MLDonkey is an open-source, multi-protocol, peer-to-peer file sharing application that runs as a back-end server application on many platforms. It can be controlled through a user interface provided by one of many separate front-ends, including a Web interface, telnet interface and over a dozen native client programs. + Originally a Linux client for the eDonkey protocol, it now runs on many flavors of Unix-like, OS X, Microsoft Windows and MorphOS and supports numerous peer-to-peer protocols including ED2K (and Kademlia and Overnet), BitTorrent, DC++ and more. + Read more about MLDonkey at the MLDonkey Project Wiki + Available since: version 0.48.0 +
+
+ Screenshot + + + + + + + MLDonkey Web Interface + + + +
+
+ Using MLDonkey Web Interface + After installing MLDonkey, its web interface can be accessed from FreedomBox at https://<your freedombox>/mldonkey. Users belonging to the ed2k and admin groups can access this web interface. +
+
+ Using Desktop/Mobile Interface + Many desktop and mobile applications can be used to control MLDonkey. MLDonkey server will always be running on FreedomBox. It will download files (or upload them) and store them on FreedomBox even when your local machine is not running or connected to MLDonkey on FreedomBox. Only users of admin group can access MLDonkey on FreedomBox using desktop or mobile clients. This is due to restrictions on which group of users have SSH access into FreedomBox. + + + Create an admin user or use an existing admin user. + + + On your desktop machine, open a terminal and run the following command. It is recommended that you configure and use SSH keys instead of passwords for the this step. + + + + Start the GUI application and then connect it to MLDonkey as if MLDonkey is running on the local desktop machine. After you are done, terminate the SSH command by pressing Control-C. + + + See MLDonkey documentation for SSH Tunnel for more information. +
+
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. @@ -2461,50 +2500,6 @@ proto udp]]>
-
- File Sharing (MLDonkey) -
- What is MLDonkey? - MLDonkey is an open-source, multi-protocol, peer-to-peer file sharing application that runs as a back-end server application on many platforms. It can be controlled through a user interface provided by one of many separate front-ends, including a Web interface, telnet interface and over a dozen native client programs. - Originally a Linux client for the eDonkey protocol, it now runs on many flavors of Unix-like, OS X, Microsoft Windows and MorphOS and supports numerous peer-to-peer protocols including ED2K (and Kademlia and Overnet), BitTorrent, DC++ and more. - Read more about MLDonkey at the MLDonkey Project Wiki - Available since: version 0.48.0 -
-
- Screenshot - - - - - - - MLDonkey Web Interface - - - -
-
- Using MLDonkey Web Interface - After installing MLDonkey, its web interface can be accessed from FreedomBox at https://<your freedombox>/mldonkey. Users belonging to the ed2k and admin groups can access this web interface. -
-
- Using Desktop/Mobile Interface - Many desktop and mobile applications can be used to control MLDonkey. MLDonkey server will always be running on FreedomBox. It will download files (or upload them) and store them on FreedomBox even when your local machine is not running or connected to MLDonkey on FreedomBox. Only users of admin group can access MLDonkey on FreedomBox using desktop or mobile clients. This is due to restrictions on which group of users have SSH access into FreedomBox. - - - Create an admin user or use an existing admin user. - - - On your desktop machine, open a terminal and run the following command. It is recommended that you configure and use SSH keys instead of passwords for the this step. - - - - Start the GUI application and then connect it to MLDonkey as if MLDonkey is running on the local desktop machine. After you are done, terminate the SSH command by pressing Control-C. - - - See MLDonkey documentation for SSH Tunnel for more information. -
-
System @@ -8784,6 +8779,32 @@ wget https://www.thinkpenguin.com/files/ath9k_firmware_free-version/htc_7010.fw]
Release Notes The following are the release notes for each FreedomBox version. +
+ FreedomBox 19.1 (2019-02-14) + + + radicale: Increment module version to trigger upgrade handling + + + radicale: Remove obsolete diagnostics + + + radicale: Fix server URLs in client info + + + Updated translations for Czech, Norwegian Bokmål, and Spanish. + + + setup: Add option to handle configuration prompts during install + + + radicale: Simplify upgrading to newer packages + + + matrixsynapse: Use Let's Encrypt certificates + + +
FreedomBox 19.0 (2019-02-09) diff --git a/doc/manual-pages.list b/doc/manual-pages.list index 4b7dafcfc..6a9456a38 100644 --- a/doc/manual-pages.list +++ b/doc/manual-pages.list @@ -1,3 +1,4 @@ +Apache_userdir Tor Transmission Deluge @@ -7,6 +8,7 @@ ejabberd MatrixSynapse Roundcube Coquelicot +MLDonkey Syncthing Quassel TinyTinyRSS @@ -18,7 +20,6 @@ Privoxy Searx MediaWiki Ikiwiki -MLDonkey Backups Configure Cockpit