mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-11 09:04:54 +00:00
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy
parent
1b4b4584b6
commit
910e381ac6
@ -1,6 +1,8 @@
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Calibre|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[FreedomBox/Manual/Calibre|English]] - [[es/FreedomBox/Manual/Calibre|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
@ -31,7 +33,7 @@ calibre can be accessed after installation through the web client at {{{https://
|
||||
|
||||
=== External links ===
|
||||
|
||||
* Official website <<BR>> https://calibre-ebook.com/
|
||||
* Official website <<BR>> https://calibre-ebook.com
|
||||
|
||||
## END_INCLUDE
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Coturn|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[FreedomBox/Manual/Coturn|English]] - [[es/FreedomBox/Manual/Coturn|Español]] - [[DebianWiki/EditorGuide#translation|(+)]] -~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
@ -11,7 +13,7 @@
|
||||
|
||||
'''Available since''': version 20.8
|
||||
|
||||
Coturn is a server to facilitate audio/video calls and conferences by providing an implementation of TURN and STUN protocols. WebRTC, SIP and other communication servers can use it to establish a call between parties who are otherwise unable connect to each other.
|
||||
Coturn is a server to facilitate audio/video calls and conferences by providing an implementation of [[https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT|TURN]] and [[https://en.wikipedia.org/wiki/STUN|STUN]] protocols. WebRTC, SIP and other communication servers can use it to establish a call between parties who are otherwise unable connect to each other.
|
||||
|
||||
It is not meant to be used directly by users. Servers such as Matrix Synapse need to be configured with the details provided on the Coturn app page. Apart from Matrix Synapse, Jitsi, Ejabberd, Nextcloud Talk, etc. can use Coturn server for audio/video calls and conferences. There is no need for the servers to be running on the same machine as !FreedomBox and external servers can use Coturn running on !FreedomBox.
|
||||
|
||||
@ -21,9 +23,9 @@ Coturn is configured in !FreedomBox as an advanced app. This means that you need
|
||||
|
||||
When making an audio/video call, it is best to route the media streams between two peers directly. This will give the best possible latency (better signal quality) and avoid depending on a centralized server (privacy). It scales well because a simple chat server can host thousands of calls without involving the server in any way other than to setup the call. However, this approach does not work most of the time to due to how networks are configured. Most peers on the network do not have a unique IP address allocated to them. They work hidden behind a network device that performs "Network Address Translation" (NAT) for them. This means that the two peers have no way of reaching each other.
|
||||
|
||||
To address this problem, a simple technique known as STUN was introduced. With the help of a third party STUN server, the peers can trick the NAT devices, to carry the traffic between the two peers. Unfortunately, this trick only works about 80% of the time. So, if STUN fails, peers have no choice but to route their traffic through an intermediary server called TURN server. All the mechanism of trying out STUN first and then falling back to TURN is described in a protocol known as ICE.
|
||||
To address this problem, a simple technique known as STUN was introduced. With the help of a third party STUN server, the peers can trick the NAT devices, to carry the traffic between the two peers. Unfortunately, this trick only works about 80% of the time. So, if STUN fails, peers have no choice but to route their traffic through an intermediary server called TURN server. All the mechanism of trying out STUN first and then falling back to TURN is described in a protocol known as [[https://en.wikipedia.org/wiki/Interactive_Connectivity_Establishment|ICE]].
|
||||
|
||||
On !FreedomBox, Coturn provides both STUN and TURN servers. Both services are provided over TCP as well as UDP. They are provided on unencrypted as well as encrypted channels (with have a higher chance of success). Since STUN servers are very inexpensive and don't consume a lot of server resources, there is no authentication needed to use them. TURN servers on the other hand need authentication. This authentication is highly simplified and does not require maintaining a database of users. A server such as matrix-synapse which is about to setup an audio/video call between two peers will generate a username and password using a shared secret. When the peers use the TURN server, they will be validated using these credentials because the TURN server also knows the same secret.
|
||||
On !FreedomBox, Coturn provides both STUN and TURN servers. Both services are provided over TCP as well as UDP. They are provided on unencrypted as well as encrypted channels (which have a higher chance of success). Since STUN servers are very inexpensive and don't consume a lot of server resources, there is no authentication needed to use them. TURN servers on the other hand need authentication. This authentication is highly simplified and does not require maintaining a database of users. A server such as matrix-synapse which is about to setup an audio/video call between two peers will generate a username and password using a shared secret. When the peers use the TURN server, they will be validated using these credentials because the TURN server also knows the same secret.
|
||||
|
||||
In summary, a communication server needs to know the URLs of the STUN/TURN servers along with a shared authentication secret for TURN. After that, during audio/video call setup, they will correctly guide the peers to use STUN/TURN servers. Coturn app in !FreedomBox provides exactly this information. This information can be used to configure a communication server irrespective of whether it is running on the same !FreedomBox or on another server.
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Deluge|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[de/FreedomBox/Manual/Deluge|Deutsch]] - [[FreedomBox/Manual/Deluge|English]] - [[es/FreedomBox/Manual/Deluge|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
#language en
|
||||
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~-[[FreedomBox/Manual/GettingHelp|English]] - [[es/FreedomBox/Manual/GettingHelp|Español]] - [[fr/FreedomBox/Manual/GettingHelp|Français]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
~-[[de/FreedomBox/Manual/GettingHelp|Deutsch]] - [[FreedomBox/Manual/GettingHelp|English]] - [[es/FreedomBox/Manual/GettingHelp|Español]] - [[fr/FreedomBox/Manual/GettingHelp|Français]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
## BEGIN_INCLUDE
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/GitWeb|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[FreedomBox/Manual/GitWeb|English]] - [[es/FreedomBox/Manual/GitWeb|Español]] - [[DebianWiki/EditorGuide#translation|(+)]] -~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
=== Using ===
|
||||
|
||||
* !FreedomBox Service comes installed with all !FreedomBox images. You can [[FreedomBox/Download|download]] !FreedomBox images and run on any of the supported hardware. Then, you can access !FreedomBox Service by visiting the URL [[http://freedombox/plinth]] or [[https://freedombox.local/plinth]].
|
||||
* !FreedomBox Service comes installed with all !FreedomBox images. You can [[FreedomBox/Download|download]] !FreedomBox images and run on any of the supported hardware. Then, to access !FreedomBox interface see [[FreedomBox/Manual/QuickStart|quick start]] instructions.
|
||||
|
||||
* If you are on a Debian box, you may install !FreedomBox Service from Debian package archive. Currently, only Buster (stable), Bullseye (testing), and Sid (unstable) are supported. To install !FreedomBox Service run:
|
||||
|
||||
|
||||
@ -10,6 +10,44 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
|
||||
|
||||
The following are the release notes for each !FreedomBox version.
|
||||
|
||||
== FreedomBox 21.0 (2021-01-11) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
* apache2: Allow downloads in openvpn and backups with latest browsers
|
||||
|
||||
=== Other Changes ===
|
||||
|
||||
* locale: Update translations for Dutch, French, German, Hungarian, Polish, Spanish, Swedish, Turkish
|
||||
* app: Add locked flag
|
||||
* app: component: Add app_id and app properties
|
||||
* app: info: Move client validation to info component
|
||||
* backups: Add new component for backup and restore
|
||||
* backups: Don't open a new window for downloading backups
|
||||
* dev-container: 'up' command: Show banner also when container is already running
|
||||
* dev-container: Add command to print container IP address
|
||||
* dev-container: Add subcommand to run tests
|
||||
* doc: dev: Update the tutorial to reflect latest API/code
|
||||
* ejabberd: functional tests: Wait until the jsxc buddy list is loaded
|
||||
* functional tests: Make tests compatible with pytest-bdd v4.0
|
||||
* functional-tests: Fix installation errors in install.sh script
|
||||
* gitweb: Add functional tests for git-access group
|
||||
* gitweb: tests: functional: Fix test failures in localized environment
|
||||
* mumble: Updated mumla and removed plumble from clients list
|
||||
* openvpn: Don't show running status on download profile button
|
||||
* plinth: Fix daemon is enabled check when service alias is provided
|
||||
* radicale: Fix backup and restore of configuration
|
||||
* tests: functional: Improve creating users in tests
|
||||
* transmission: Show port forwarding information
|
||||
* transmission: Update description
|
||||
* upgrades: Add service for dist upgrade
|
||||
* upgrades: Ensure freedombox package is upgraded during dist upgrade
|
||||
* upgrades: Hold tt-rss during dist upgrade, if available
|
||||
* upgrades: Install python3-systemd for unattended-upgrades
|
||||
* upgrades: Restart !FreedomBox service at end of dist-upgrade
|
||||
* upgrades: Use full path to searx action script
|
||||
* users: Skip action script tests if LDAP is not set up
|
||||
|
||||
== FreedomBox 20.21 (2020-12-28) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Tor|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[de/FreedomBox/Manual/Tor|Deutsch]] - [[FreedomBox/Manual/Tor|English]] - [[es/FreedomBox/Manual/Tor|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,7 +1,10 @@
|
||||
## page was renamed from FreedomBox/Manual/XMPP
|
||||
#language en
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/ejabberd|Español]] -~
|
||||
##TAG:TRANSLATION-HEADER-START
|
||||
~- [[FreedomBox/Manual/ejabberd|English]] - [[es/FreedomBox/Manual/ejabberd|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
|
||||
##TAG:TRANSLATION-HEADER-END
|
||||
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Calibre|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/Calibre, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Coturn|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/Coturn, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Deluge|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/Deluge, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/GitWeb|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/GitWeb, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -10,6 +10,44 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
|
||||
|
||||
The following are the release notes for each !FreedomBox version.
|
||||
|
||||
== FreedomBox 21.0 (2021-01-11) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
* apache2: Allow downloads in openvpn and backups with latest browsers
|
||||
|
||||
=== Other Changes ===
|
||||
|
||||
* locale: Update translations for Dutch, French, German, Hungarian, Polish, Spanish, Swedish, Turkish
|
||||
* app: Add locked flag
|
||||
* app: component: Add app_id and app properties
|
||||
* app: info: Move client validation to info component
|
||||
* backups: Add new component for backup and restore
|
||||
* backups: Don't open a new window for downloading backups
|
||||
* dev-container: 'up' command: Show banner also when container is already running
|
||||
* dev-container: Add command to print container IP address
|
||||
* dev-container: Add subcommand to run tests
|
||||
* doc: dev: Update the tutorial to reflect latest API/code
|
||||
* ejabberd: functional tests: Wait until the jsxc buddy list is loaded
|
||||
* functional tests: Make tests compatible with pytest-bdd v4.0
|
||||
* functional-tests: Fix installation errors in install.sh script
|
||||
* gitweb: Add functional tests for git-access group
|
||||
* gitweb: tests: functional: Fix test failures in localized environment
|
||||
* mumble: Updated mumla and removed plumble from clients list
|
||||
* openvpn: Don't show running status on download profile button
|
||||
* plinth: Fix daemon is enabled check when service alias is provided
|
||||
* radicale: Fix backup and restore of configuration
|
||||
* tests: functional: Improve creating users in tests
|
||||
* transmission: Show port forwarding information
|
||||
* transmission: Update description
|
||||
* upgrades: Add service for dist upgrade
|
||||
* upgrades: Ensure freedombox package is upgraded during dist upgrade
|
||||
* upgrades: Hold tt-rss during dist upgrade, if available
|
||||
* upgrades: Install python3-systemd for unattended-upgrades
|
||||
* upgrades: Restart !FreedomBox service at end of dist-upgrade
|
||||
* upgrades: Use full path to searx action script
|
||||
* users: Skip action script tests if LDAP is not set up
|
||||
|
||||
== FreedomBox 20.21 (2020-12-28) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/Tor|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/Tor, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
## page was renamed from FreedomBox/Manual/XMPP
|
||||
#language es
|
||||
|
||||
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: [[FreedomBox/Manual/ejabberd|English]] - Español -~
|
||||
<<Include(FreedomBox/Manual/ejabberd, ,from="^##TAG:TRANSLATION-HEADER-START",to="^##TAG:TRANSLATION-HEADER-END")>>
|
||||
|
||||
<<TableOfContents()>>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user