nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-21 07:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Fetch latest manual

Browse Source 
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy 2022-08-29 22:33:34 -04:00
parent eda5e6aa1b
commit a4d0cfb646
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
23 changed files with 155 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/manual/en/Configure.raw.wiki
View File

@ -16,7 +16,7 @@ Configure has some general configuration options:
. Hostname is the local name by which other devices on the local network can reach your !FreedomBox. The default hostname is ''freedombox''.
=== Domain Name ===
. Domain name is the global name by which other devices on the Internet can reach your !FreedomBox. The value set here is used by the [[FreedomBox/Manual/ejabberd|Chat Server (XMPP)]], [[FreedomBox/Manual/MatrixSynapse|Matrix Synapse]], [[FreedomBox/Manual/LetsEncrypt|Certificates (Let's Encrypt)]], and [[FreedomBox/Manual/Monkeysphere|Monkeysphere]].
. Domain name is the global name by which other devices on the Internet can reach your !FreedomBox. The value set here is used by the [[FreedomBox/Manual/ejabberd|Chat Server (XMPP)]], [[FreedomBox/Manual/MatrixSynapse|Matrix Synapse]], and [[FreedomBox/Manual/LetsEncrypt|Certificates (Let's Encrypt)]].
=== Webserver Home Page ===
. This is an advanced option that allows you to set something other than !FreedomBox Service as the home page to be served on the domain name of the !FreedomBox. For example, if your !FreedomBox's domain name is https://myfreedombox.rocks and you set !MediaWiki as the home page, visiting https://myfreedombox.rocks will take you to https://myfreedombox.rocks/mediawiki/ instead of the usual https://myfreedombox.rocks/plinth/.

2
doc/manual/en/Minetest.raw.wiki
View File

@ -24,7 +24,7 @@ If your !FreedomBox is behind a router, you will need to set up port forwarding
=== External links ===
* Website: https://www.minetest.net
* Wiki: https://wiki.minetest.net
## END_INCLUDE

34
doc/manual/en/Monkeysphere.raw.wiki
View File

@ -1,34 +0,0 @@
#language en
~- [[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/FreedomBox/Manual/Monkeysphere|Español]] -~
<<TableOfContents()>>
## BEGIN_INCLUDE
== Monkeysphere ==
{{{#!wiki caution
This application is no longer available in !FreedomBox.
}}}
With Monkeysphere, an OpenPGP key can be generated for each configured domain serving SSH. The OpenPGP public key can then be uploaded to the OpenPGP keyservers. Users connecting to this machine through SSH can verify that they are connecting to the correct host. For users to trust the key, at least one person (usually the machine owner) must sign the key using the regular OpenPGP key signing process. See the [[http://web.monkeysphere.info/getting-started-ssh/|Monkeysphere SSH documentation]] for more details.
Monkeysphere can also generate an OpenPGP key for each Secure Web Server (HTTPS) certificate installed on this machine. The OpenPGP public key can then be uploaded to the OpenPGP keyservers. Users accessing the web server through HTTPS can verify that they are connecting to the correct host. To validate the certificate, the user will need to install some software that is available on the [[https://web.monkeysphere.info/download/|Monkeysphere website]].
=== External links ===
* Upstream project: http://web.monkeysphere.info
* User Documentation: http://web.monkeysphere.info/doc/
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

2
doc/manual/en/OpenVPN.raw.wiki
View File

@ -137,7 +137,7 @@ Some services are known '''not''' to work at this time:
=== External Links ===
https://community.openvpn.net/openvpn
* Wiki / Tracker: https://community.openvpn.net/openvpn
## END_INCLUDE

2
doc/manual/en/Privoxy.raw.wiki
View File

@ -52,7 +52,7 @@ The default installation should provide a reasonable starting point for most. Th
=== External links ===
* Website: https://www.privoxy.org
* User manual: https://www.privoxy.org/user-manual/index.html
## END_INCLUDE

55
doc/manual/en/RSSBridge.raw.wiki Normal file
View File

@ -0,0 +1,55 @@
#language en
##TAG:TRANSLATION-HEADER-START
~- [[FreedomBox/Manual/RSSBridge|English]] - [[es/FreedomBox/Manual/RSSBridge|Español]] - [[DebianWiki/EditorGuide#translation|(+)]]-~
##TAG:TRANSLATION-HEADER-END
<<TableOfContents()>>
## BEGIN_INCLUDE
== RSS Bridge (RSS Feed Generator) ==
||<tablestyle="float: right;"> {{attachment:rssbridge-icon_en_V01.png|RSS Bridge icon}} ||
'''Available since''': version 22.16
=== What is RSS Bridge? ===
RSS-Bridge is a web application capable of generating RSS and Atom feeds for websites that don't have one. For example, with the help of RSS Bridge you can subscribe to !YouTube channels without having to have a !YouTube account.
=== Usage Example ===
==== Subscribing to a YouTube account ====
In this example, we will see one of the ways to subscribe to a given !YouTube channel.
1. Visit the !YouTube channel and copy its name to the clipboard
{{attachment:copy_channel_name.png|Copy YouTube Channel Name - FreedomBox|width=800}}
2.#2 Find "!YouTube Bridge" and click on '''show more'''
{{attachment:show_more.png|RSS Bridge Show More - FreedomBox|width=800}}
3.#3 Paste the previously copied channel name in the '''Custom name''' section and click on '''Generate Feed'''
{{attachment:paste_channel_name.png|RSS Bridge Paste Channel Name - FreedomBox|width=800}}
4.#4 From the available feed types select '''Atom'''. If you're using a Chromium based browser, this will open the Atom feed in a new tab, which you can easily copy into your feed Reader, such as [[FreedomBox/Manual/TinyTinyRSS|Tiny Tiny RSS]]
{{attachment:select_atom_feed.png|RSS Bridge Select Atom Feed - FreedomBox|width=800}}
==== Subscribing to feed with Tiny Tiny RSS ====
1. Copy the URL that RSS Bridge generated
{{attachment:copy_url.png|RSS Bridge Copy URL - FreedomBox|width=800}}
2.#2 In Tiny Tiny RSS select '''Subscribe to feed''' from the drop-down menu on the right side.
3. Paste the generated link from step one into the textbox and select '''This feed requires authentication.'''
4. Submit your !FreedomBox username and password and click on '''Subscribe'''
{{attachment:subscribe_to_feed.png|RSS Bridge Subscribe to Feed - FreedomBox|width=800}}
For a more detailed description of Tiny Tiny RSS, see [[FreedomBox/Manual/TinyTinyRSS|its manual page]]
=== External links ===
* Website: https://rss-bridge.github.io/rss-bridge/
* User documentation: https://rss-bridge.github.io/rss-bridge/General/Project_goals.html
## END_INCLUDE
Back to [[FreedomBox/Features|Features introduction]] or [[FreedomBox/Manual|manual]] pages.
<<Include(FreedomBox/Portal)>>
----
CategoryFreedomBox

42
doc/manual/en/ReleaseNotes.raw.wiki
View File

@ -8,6 +8,48 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 22.19 (2022-08-29) ==
=== Highlights ===
* jsxc: Allow disabling the app
* app: Add a menu item to trigger uninstallation
=== Other Changes ===
* app: Add API to uninstall an app
* avahi: Don't disable after tests
* backups: Use !AppView for the main app page
* container: Display help message when no args are passed
* container: Show default values in command help
* d/control: Break ufw as we use firewalld
* debian: Update Spanish translation template
* diagnostics: Use !AppView for app page
* ejabberd: Set hostname for test that relies on it
* forms: Implement form for uninstallation
* janus: Convert action to privileged
* janus: Handle upgrades to 1.0.*
* letsencrypt: Use !AppView for app page
* locale: Update translations for Bulgarian, Chinese (Simplified), Czech, French, German, Spanish, Turkish, Ukrainian
* names: Use !AppView for app page
* networks: Use !AppView for app page
* operation: Factor out template code into a separate file
* operation: Show operations on app page in addition to setup page
* package: Implement low-level methods for uninstalling
* package: Implement uninstall in Package component
* power: Use !AppView for app page
* security: Use !AppView for app page
* setup: Drop check for already running operation
* setup: Implement operation to uninstall an app
* snapshot: Use !AppView for app page
* tests: Make functional.is_available check faster
* tests: functional: Add install/uninstall test for all apps
* tor: Use !AppView and Operation for app page
* ttrss: Add donation url
* upgrades: Add button to test dist-upgrade in development mode
* upgrades: Hold janus during dist-upgrade
* views: Implement a view to uninstall an app
== FreedomBox 22.18 (2022-08-15) ==
=== Highlights ===

4
doc/manual/en/ServiceDiscovery.raw.wiki
View File

@ -14,9 +14,9 @@ It also allows !FreedomBox to discover other devices and services running on you
Service discovery is not essential and works only on internal networks. It may be disabled to improve security especially when connecting to a hostile local network.
== Troubleshooting ==
=== Troubleshooting ===
=== Unable to reach <hostname>.local ===
==== Unable to reach <hostname>.local ====
If <hostname>.local is not able to be reached, you may simply need to disable and re-enable the Service Discovery feature in !FreedomBox.
To do this, go to '''System -> Service Discovery''', slide the toggle to the left position to disable it (it turns grey), followed by sliding it back to the right to re-enable it (it turns blue).

5
doc/manual/en/Shadowsocks.raw.wiki
View File

@ -14,7 +14,8 @@
'''Available since''': version 0.18.0
=== What is Shadowsocks? ===
[[https://shadowsocks.org/en/index.html|Shadowsocks]] is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your !FreedomBox can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server.
Shadowsocks is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your !FreedomBox can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server.
=== Using the Shadowsocks client? ===
@ -36,7 +37,7 @@ To use Shadowsocks after setup, set the SOCKS5 proxy URL in your device, browser
=== External links ===
* Website: https://shadowsocks.org/en/index.html
* Website: https://shadowsocks.org/
## END_INCLUDE

2
doc/manual/en/freedombox-manual.raw.wiki
View File

@ -38,6 +38,7 @@
<<Include(FreedomBox/Manual/Quassel, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Radicale, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Roundcube, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/RSSBridge, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Samba, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Searx, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
@ -61,7 +62,6 @@
<<Include(FreedomBox/Manual/DynamicDNS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Firewall, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/LetsEncrypt, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Monkeysphere, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/NameServices, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Networks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/PageKite, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>

BIN
doc/manual/en/images/copy_channel_name.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 192 KiB

BIN
doc/manual/en/images/copy_url.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 325 KiB

BIN
doc/manual/en/images/paste_channel_name.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

BIN
doc/manual/en/images/rssbridge-icon_en_V01.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/manual/en/images/select_atom_feed.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 206 KiB

BIN
doc/manual/en/images/show_more.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
doc/manual/en/images/subscribe_to_feed.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

2
doc/manual/es/Manual.raw.wiki
View File

@ -38,6 +38,7 @@
<<Include(FreedomBox/Manual/Quassel, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Radicale, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Roundcube, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/RSSBridge, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Samba, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Searx, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Shadowsocks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
@ -61,7 +62,6 @@
<<Include(FreedomBox/Manual/DynamicDNS, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Firewall, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/LetsEncrypt, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Monkeysphere, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/NameServices, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/Networks, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>
<<Include(FreedomBox/Manual/PageKite, , from="## BEGIN_INCLUDE", to="## END_INCLUDE")>>

1
doc/manual/es/Minetest.raw.wiki
View File

@ -22,6 +22,7 @@ Si tu !FreedomBox está detrás de un router necesitarás configurar la redirecc
=== Enlaces externos ===
* Sitio web: https://www.minetest.net
* Wiki: https://wiki.minetest.net
## END_INCLUDE

2
doc/manual/es/OpenVPN.raw.wiki
View File

@ -135,7 +135,7 @@ Algunos servicios '''no''' funcionan aún con OpenVPN:
=== Enlaces Externos ===
https://community.openvpn.net/openvpn
* Wiki y Administrador de tareas: https://community.openvpn.net/openvpn
## END_INCLUDE

4
doc/manual/es/Privoxy.raw.wiki
View File

@ -49,8 +49,8 @@ La instalación de serie debería proporcionar un punto de partida razonable par
=== Enlaces externos ===
* Website: https://www.privoxy.org
* Sitio web: https://www.privoxy.org
* Manual de usuario: https://www.privoxy.org/user-manual/index.html
## END_INCLUDE

42
doc/manual/es/ReleaseNotes.raw.wiki
View File

@ -8,6 +8,48 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 22.19 (2022-08-29) ==
=== Highlights ===
* jsxc: Allow disabling the app
* app: Add a menu item to trigger uninstallation
=== Other Changes ===
* app: Add API to uninstall an app
* avahi: Don't disable after tests
* backups: Use !AppView for the main app page
* container: Display help message when no args are passed
* container: Show default values in command help
* d/control: Break ufw as we use firewalld
* debian: Update Spanish translation template
* diagnostics: Use !AppView for app page
* ejabberd: Set hostname for test that relies on it
* forms: Implement form for uninstallation
* janus: Convert action to privileged
* janus: Handle upgrades to 1.0.*
* letsencrypt: Use !AppView for app page
* locale: Update translations for Bulgarian, Chinese (Simplified), Czech, French, German, Spanish, Turkish, Ukrainian
* names: Use !AppView for app page
* networks: Use !AppView for app page
* operation: Factor out template code into a separate file
* operation: Show operations on app page in addition to setup page
* package: Implement low-level methods for uninstalling
* package: Implement uninstall in Package component
* power: Use !AppView for app page
* security: Use !AppView for app page
* setup: Drop check for already running operation
* setup: Implement operation to uninstall an app
* snapshot: Use !AppView for app page
* tests: Make functional.is_available check faster
* tests: functional: Add install/uninstall test for all apps
* tor: Use !AppView and Operation for app page
* ttrss: Add donation url
* upgrades: Add button to test dist-upgrade in development mode
* upgrades: Hold janus during dist-upgrade
* views: Implement a view to uninstall an app
== FreedomBox 22.18 (2022-08-15) ==
=== Highlights ===

2
doc/manual/es/Shadowsocks.raw.wiki
View File

@ -36,7 +36,7 @@ Para usar Shadowsocks una vez instalado configura la URL del proxy SOCKS5 en tu
=== Enlaces externos ===
* Sitio web: https://shadowsocks.org/en/index.html
* Sitio web: https://shadowsocks.org
## END_INCLUDE