doc: Fetch latest manual

Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy 2025-09-22 20:22:44 -04:00
parent b2827946c4
commit 695cd44010
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
12 changed files with 103 additions and 11 deletions

View File

@ -33,9 +33,9 @@ e.g. A university using !MediaWiki running on !FreedomBox as a course wiki wants
'''Configuration:'''
Create a file called `custom-shortcuts.json` in Plinth's configuration directory `/etc/plinth` and add additional shortcuts in JSON format. The file should have follow the same JSON schema as the Plinth API. You can refer to the JSON schema by visiting https://<my-freedombox-url>/plinth/api/1/shortcuts.
!FreedomBox reads custom shortcuts you have created from various files paths on the server. A shortcuts file can be any file with `.json` extension in the following directories: `/etc/freedombox/custom-shortcuts.json.d/`, `/var/lib/freedombox/custom-shortcuts.json.d/` and `/usr/share/freedombox/custom-shortcuts.json.d/`. Or they can be a file named `custom-shortcuts.json` in these directories: `/etc/freedombox/`, `/etc/plinth/` (only for compatibility), `/var/lib/freedombox/` and `/usr/share/freedombox/`. The file should follow the same JSON schema as the !FreedomBox API. You can refer to the JSON schema by visiting `https://<my-freedombox-url>/plinth/api/1/shortcuts`.
An example file adding one additional shortcut for [[https://nextcloud.com|NextCloud]].
As an example, to add one additional shortcut for [[https://nextcloud.com|NextCloud]] app, create a file called `/etc/freedombox/custom-shortcuts.json.d/nextcloud.json` (create directories as needed).
{{{#!highlight json
{
@ -55,9 +55,9 @@ An example file adding one additional shortcut for [[https://nextcloud.com|NextC
}
}}}
The corresponding icons for the shortcuts listed in the above file should be placed in the directory `/var/www/plinth/custom/static/icons/`. The file names of the icons should match with those provided in `/etc/plinth/custom-shortcuts.json`.
The corresponding icons for the shortcuts listed in the above file should be placed in the directory `/var/www/plinth/custom/static/icons/`. The file names of the icons should match with those provided in `/etc/freedombox/custom-shortcuts.json.d/nextcloud.json`.
After adding an entry for !NextCloud in custom-shortcuts.json and an icon, restart Plinth by executing the command {{{ systemctl restart plinth }}} on the !FreedomBox. You can also restart the !FreedomBox from the web interface.
After adding an entry for !NextCloud in `nextcloud.json` and an icon, restart Plinth by executing the command {{{ systemctl restart plinth }}} on the !FreedomBox. You can also restart the !FreedomBox from the web interface.
After restart the Plinth home page will display an additional shortcut for !NextCloud as shown below: <<BR>>
{{attachment:nextcloud-frontpage-shortcut.png|NextCloud custom shortcut on the Plinth home page}}

View File

@ -27,6 +27,10 @@ Home Assistant is a comprehensive solution for your home automation needs suppor
Many home automation devices connect to or send data to their manufacturers' servers. This can be a serious violation of your home's privacy. These devices may also stop working when their manufacturer goes bankrupt, decides to close the product line, or forces you to purchase newer models. It is strongly recommended that you purchase hardware that works locally with a home automation hub (in this case Home Assistant) without connecting to manufacturer's servers. These are listed under the categories "Local Push" or "Local Polling" in the Home Assistant's integrations page.
=== Need for Subdomain ===
Unlike most other apps in !FreedomBox which work on a path like `https://mydomain.example/app`, Home Assistant requires a separate dedicated subdomain such as `https://homeassistant.mydomain.example`. Before configuring the Home Assistant app, you must create a subdomain using System -> [[FreedomBox/Manual/NameServices|Name Services]]. See the documentation for Name Services to understand how you can acquire a subdomain.
=== Setup ===
After the app is installed, Home Assistant web interface must be setup. An administrator account is created at this time. Home Assistant maintains its own user accounts separate from user accounts created on !FreedomBox.
@ -54,6 +58,10 @@ Home Assistant provides a fully functional web application and a mobile applicat
{{attachment:homeassistant-app.png|Mobile App}}
=== Advanced Manual Configuration ===
If you wish to perform your own customization to Home Assistant setup, feel free to edit Home Assistant configuration files manually. Configuration, scenes, automations, scripts, secrets, database, and log files are all stored in the directory `/var/lib/home-assistant-freedombox/config` directory. You will need to disable and re-enable the app after configuration changes for them to take effect. Note that when !FreedomBox itself modifies these files, it will not preserve comments and other formatting.
=== External links ===
* Website: https://www.home-assistant.io/

View File

@ -12,6 +12,23 @@
Name Services provides an overview of ways the box can be reached from the public Internet: domain name, Tor Onion Service, and Pagekite. For each type of name, it is shown whether the HTTP, HTTPS, and SSH services are enabled or disabled for incoming connections through the given name. It also shows and allows configuring how !FreedomBox performs domain name resolutions.
=== Adding Domain Name to FreedomBox ===
Domain names are unique names assigned to computers and servers to identify and reach them easily without having remember their more technical (IP) addresses.
Adding at least one domain name to your !FreedomBox through one of the supported methods is necessary if you wish to access various apps from outside of your home network. Even at home, adding a domain name allows you to have a TLS certificate that is essential for accessing apps securely through HTTPS. The following types of domains are supported:
* A regular domain that is purchased from a domain registrar. These domains looks like `mydomain.example`. These types of domains require that your !FreedomBox machine or your home network router have a public IP address provided by your ISP. All apps can be accessed using these domains.
* A dynamic domain that can obtained from a dynamic DNS provider. !FreedomBox foundation provides a free dynamic DNS domain for all !FreedomBox users at https://ddns.freedombox.org . These domains look like `mydomain.fbx.one` or `mydomain.freedombox.rocks`. These types of domains require that your !FreedomBox machine or your home network router have a public IP address provided by your ISP. The public IP may be changed by the ISP regularly and DNS records will be updated accordingly. All apps can be accessed using these domains. These types of domains are configured using the [[FreedomBox/Manual/DynamicDNS|Dynamic DNS]] app in !FreedomBox.
* A Tor Onion domain that can be obtained by setting up Tor app. These domains look like `mysitenameyx4fi3l6x2gyzmtmgxjyqyorj9qsb5r543izcwymle.onion`. These types of domains don't require a public IP address from your ISP. However, only web or SSH based services/apps work on this type of domain. Further, only users of Tor will be able to reach these domains. A regular browser will not be able to reach these services. These types of domains are configured using the [[FreedomBox/Manual/Tor|Tor]] app in !FreedomBox.
* A !PageKite domain that can obtained from a !PageKite service provider. This service can be purchased at https://pagekite.net . These domains look like `https://mydomain.pagekite.net`. These types of domains don't require a public IP address from your ISP. However, only web or SSH based services/apps work on this type of domain. These types of domains are configured using the [[FreedomBox/Manual/PageKite|PageKite]] app in !FreedomBox.
=== Subdomains ===
Subdomains are similar to domains, but reside under the a domain name. For example, for a domain `mydomain.example` a subdomain could be `myapp.mydomain.example`. Some applications such as [[FreedomBox/Manual/HomeAssistant|Home Assistant]] in !FreedomBox require you to setup and access them over a subdomain instead of a URL path. You can obtain and setup subdomains in the following ways:
* If you own a regular domain (as described above), you can login to the web console provided by your domain registrar and add a subdomain. Make the subdomain a CNAME of the original domain or assign A and AAAA records similar to the original domain. See your domain registrar's documentation for more information. After adding DNS entries for the subdomain, let !FreedomBox know that it can use the subdomain by adding it as another regular domain. TLS certificates (for HTTPS) will be automatically obtained by !FreedomBox using Let's Encrypt for these subdomains.
* If you have a dynamic domain name from !FreedomBox foundation, you can also get an unlimited number of free subdomains. For this, login to your account at https://ddns.freedombox.org, go to `Change Settings`, check the option `Wild Card`, and click `Save Changes`. After this you can add any number of subdomains like `foo.myaccount.fbx.one` to your !FreedomBox in `System` -> `Names` -> `Add Domain (regular)`. TLS certificates (for HTTPS) will be automatically obtained by !FreedomBox using Let's Encrypt for these subdomains. Also see [[FreedomBox/Manual/DynamicDNS|Dynamic DNS]] documentation page.
=== systemd-resolved ===
From release 24.19, !FreedomBox uses systemd-resolved as caching DNS resolver and replaces resolvconf for managing DNS server configuration. This improves privacy and security. Newer installations will come with systemd-resolved and older machines will automatically switch after an upgrade to this new release.

View File

@ -8,6 +8,30 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 25.12 (2025-09-22) ==
=== Highlights ===
* views: Add a menu entry and view for showing logs of an app
* zoph: Fix cases when CLI user is set to "autodetect"
=== Other Changes ===
* api: Fix showing icons for custom shortcuts
* app: Add ability to retrieve logs from all systemd units of an app
* bepasty: tests: Fix functional test failure to missing / in URL
* bepasty: tests: Override backup/restore test properly
* ci: Don't include defunct extract-source job
* ci: Update container for functional tests from bookworm to trixie
* ci: functional: Provision the privileged daemon properly
* diagnostics, help: Link to diagnostics page logs in 500 error page
* index: Generalize showing custom shortcut icons
* locale: Update translations for Chinese (Simplified Han script), Czech, Dutch, German, Italian, Russian, Turkish, Ukrainian
* torproxy: When disabling apt over tor fails, report error properly
* upgrades: Multiple fixes for parsing Apt's Deb822 style sources
* upgrades: Overwrite apt sources lens with bug fixes
* views: Fix 'internal server error' when showing 404 page
== FreedomBox 25.11 (2025-09-08) ==
=== Highlights ===

View File

@ -37,9 +37,11 @@ Cambiar la [[es/FreedomBox/Manual/Configure#Página_Principal_(home)_del_Servido
'''Configuración:'''
Crea un fichero llamado `custom-shortcuts.json` en el directorio de configuración de Plinth `/etc/plinth` y añade accesos directos en formato JSON siguiendo el esquema publicado en https://<mi-freedombox>/plinth/api/1/shortcuts.
Crea un fichero llamado `custom-shortcuts.json` en el directorio de configuración de Plinth `/etc/plinth` y añade accesos directos en
Un ejemplo de fichero añadiendo un acceso directo a [[https://nextcloud.com|NextCloud]].
!FreedomBox lee los accesos directos que hayas creado en varias rutas de archivo del servidor. Un fichero de acceso directo puede ser cualquiera con extensión `.json` en alguno de estos directorios: `/etc/freedombox/custom-shortcuts.json.d`, `/var/lib/freedombox/custom-shortcuts.json.d` o `/usr/share/freedombox/custom-shortcuts.json.d`. O pueden ser un fichero `custom-shortcuts.json` en estos directorios: `/etc/freedombox`, `/etc/plinth` (solo por compatibilidad), `/var/lib/freedombox` y `/usr/share/freedombox/`. Su formato JSON sigue el esquema publicado en https://<mi-freedombox>/plinth/api/1/shortcuts.
Como ejemplo, para añadir un acceso directo a la aplicación [[https://nextcloud.com|NextCloud]] crea un fichero `/etc/freedombox/custom-shortcuts.json.d/nextcloud.json` (creando los directorios necesarios).
{{{#!highlight json
{
@ -59,9 +61,9 @@ Un ejemplo de fichero añadiendo un acceso directo a [[https://nextcloud.com|Nex
}
}}}
Los iconos correspondientes a los accesos directos listados en el fichero anterior deben estar en el directorio `/var/www/plinth/custom/static/icons/` con los nombres declarados en `/etc/plinth/custom-shortcuts.json`.
Los iconos correspondientes a los accesos directos listados en el fichero anterior deben estar en el directorio `/var/www/plinth/custom/static/icons/` con los nombres declarados en `/etc/freedombox/custom-shortcuts.json.d/nextcloud.json`.
Tras añadir a !NextCloud en `custom-shortcuts.json` y su icono, reinicia el interfaz web de !FreedomBox. Puedes hacerlo desde el propio interfaz o con la orden {{{ systemctl restart plinth }}}.
Tras añadir a !NextCloud en `nextcloud.json` y su icono, reinicia el interfaz web de !FreedomBox. Puedes hacerlo desde el propio interfaz o con la orden {{{ systemctl restart plinth }}}.
Tras el reinicio, la página principal de !FreedomBox ofrecerá el acceso directo nuevo a !NextCloud como se muestra aquí:

View File

@ -16,6 +16,12 @@ Los proveedores de servicio de DNS Dinamico ayudan a solventar este problema. P
Para que esto funcione cada vez que te conectes a Internet tendrás que decirle a tu proveedor de servicio de DNS Dinamico cual es tu dirección IP provisional actual. Por esto necesitas tener un software especial en tu servidor que haga esto. La funcionalidad DNS Dinamico de tu !FreedomBox permite a los usuarios sin dirección IP pública fija mantener su dirección IP pública temporal actualizada en el servicio de DNS Dinamico. Esto te permite exponer servicios de tu !FreedomBox, como ownCloud, a Internet.
=== Un dominio gratuito pata tu FreedomBox ===
Puedes obtener un nombre de dominio para tu !FreedomBox usando el servicio gratuíto de DNS dinámica proporcionado por la comunidad de !FreedomBox en https://ddns.freedombox.org. Con este servicio tu nombre de dominio será algo así como ''midominio.fbx.one'' o ''midominio.freedombox.rocks'', donde ''midominio'' es la cuenta que te creas en el servicio.
El servicio también proporciona una cantidad ilimitada de subdominios gratuítos. Ingresa a tu cuenta, vé a ''Cambiar Ajustes'', marca la opción ''Comodín'', y haz clic en ''Guardar cambios''. Tras esto puedes añadir cualquier cantidad de subdominios como ''foo.midominio.fbx.one'' a tu !FreedomBox en ''Sistema -> Nombres -> Añadir Dominio (normal)''. !FreedomBox obtendrá automaticamente los certificados TLS (para HTTPS) usando Let's Encrypt para esos subdominios. Los subdominios son especialmente útiles para aplicaciones que requiren alojarse en dominios exclusivos, como [[es/FreedomBox/Manual/HomeAssistant|Home Assistant]].
=== GnuDIP vs. Update URL ===
Eisten 2 mecanismos principales para notificar al the servicio de DNS Dinamico cual es tu dirección IP provisional actual: empleando el protocolo ''GnuDIP'' o empleando el mecanismo ''URL de actualización''.

View File

@ -26,6 +26,11 @@ Home Assistant es una solución completa si tu automatización del hogar necesit
Muchos dispositivos de automatización del hogar se conectan a los servidores de los fabricantes y les envían tus datos. Esto pserious ede suponer una violación muy seria de la privacidad de tu hogar. Estos dispositivos podrían también dejar de funcionar si su fabricante quebrara, decidiera descontinuar la línea de producto, o te forzara a comprar modelos más modernos. Se recomienda decididamente que compres hardware que funcione localmente con un centro de automatización del hogar (en este caso Home Assistant) sin conectarse a los servidores del fabricante. En la página de [[https://www.home-assistant.io/integrations/|integraciones]] de Home Assistant, estos dispositivos aparecen listados en las categorías "Local Push" o "Local Polling".
=== Necesidad de un Subdominio ===
A diferencia de otras aplicaciones de !FreedomBox que trabajan con una ruta como `https://mi_dominio.ejemplo/app`, Home Assistant require un subdominio propio (dedicado y separado) como `https://homeassistant.mi_dominio.ejemplo`.
Antes de configurar la app de Home Assistant tienes que crear un subdominio usando Sistema -> [[FreedomBox/Manual/NameServices|Servicios de Nombre]]. Mira la documentación de Servicios de Nombre para entender cómo obtener un subdominio.
=== Arranque ===
Tras instalar la app hay que levantar el interfaz web de Home Assistant. Con ello se crea una cuenta de administrador. Home Assistant mantiene su propias cuentas de usuario diferentes de las de la !FreedomBox.
@ -52,10 +57,14 @@ Home Assistant proporciona unas aplicaciones para web y movil totalmente functio
{{attachment:FreedomBox/Manual/HomeAssistant/homeassistant-app.png|Mobile App}}
=== Configuración Manual Avanzada ===
Siéntete libre de editar los ficheros de configuración de Home Assistant si quieres personalizarlo. La configuración, las escenas, las automatizaciones, los scripts, los secretos, la base de datos, y los registros de ejecución se almacenan todos en el directorio `/var/lib/home-assistant-freedombox/config`. Necesitarás deshabilitar y volver a habilitar la aplicación tras los cambios de configuración para que surtan efecto. Nota que cuando !FreedomBox modifica estos ficheros, no conservará comentarios ni formatos manuales.
=== Enlaces externos ===
* Sitio web: https://www.home-assistant.io
* Código fuente de Home Assistant: https://github.com/home-assistant/core
* Código fuente de Home Assistant: https://github.com/home-assistant/cori
* Código fuente de la imágen del contenedor Home: https://github.com/home-assistant/docker
## END_INCLUDE

View File

@ -8,6 +8,30 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 25.12 (2025-09-22) ==
=== Highlights ===
* views: Add a menu entry and view for showing logs of an app
* zoph: Fix cases when CLI user is set to "autodetect"
=== Other Changes ===
* api: Fix showing icons for custom shortcuts
* app: Add ability to retrieve logs from all systemd units of an app
* bepasty: tests: Fix functional test failure to missing / in URL
* bepasty: tests: Override backup/restore test properly
* ci: Don't include defunct extract-source job
* ci: Update container for functional tests from bookworm to trixie
* ci: functional: Provision the privileged daemon properly
* diagnostics, help: Link to diagnostics page logs in 500 error page
* index: Generalize showing custom shortcut icons
* locale: Update translations for Chinese (Simplified Han script), Czech, Dutch, German, Italian, Russian, Turkish, Ukrainian
* torproxy: When disabling apt over tor fails, report error properly
* upgrades: Multiple fixes for parsing Apt's Deb822 style sources
* upgrades: Overwrite apt sources lens with bug fixes
* views: Fix 'internal server error' when showing 404 page
== FreedomBox 25.11 (2025-09-08) ==
=== Highlights ===

View File

@ -20,7 +20,9 @@ Nota que una vez comiencen las actualizaciones podría llevarles mucho tiempo co
Aunque las actualizaciones se efectúan a diario por razones de seguridad, las últimas funcionalidades no se propagan a todos los usuarios. A continuación se explica cómo llegan las novedades a los usuarios de las diferentes versiones de Debian:
* '''Usuarios de versiones estables''': Esta categoria de usuarios incluye a los usuarios que compraron la [[es/FreedomBox/Hardware/PioneerEdition|FreedomBox Pioneer Edition]], a los que instalaron !FreedomBox sobre una distribución estable de [[es/FreedomBox/Hardware/Debian|Debian]] y a los que descargaron las imágenes ''estables'' desde [[https://freedombox.org|freedombox.org]]. Como regla general a estos usuarios solo se les proporciona actualizaciones de seguridad de determinados paquetes. Cuando una ''release'' obtiene la confianza de los desarrolladores el propio servicio !FreedomBox se actualiza, lo que supone una excepción a esta regla. Esto implica que las últimas funcionalidades de !FreedomBox estarán disponibles para estos usuarios con algunos días de retardo respecto los usuarios de las versiones en pruebas (''testing''). Si una ''app'' sólo está disponible en la distribución en pruebas (''testing'') pero no en la ''estable'' la ''app'' aparecerá en el interfaz web pero no será instalable para los usuarios de la distribución ''estable''. Algunas ''apps'' se actualizan en excepción a la regla de "solo actualizaciones de seguridad" cuando la ''app'' esté seriamente ''rota'' por algún motivo. Debian libera cada bienio una entrega (''release'') con las últimas versiones estables de cada paquete de software y los desarrolladores de !FreedomBox intentarán actualizar a estos usuarios a la nueva entrega (''release'') sin necesidad de intervención manual. Ver las secciones acerca de las actualizaciones a la siguiente publicación estable.
* '''Usuarios de versiones estables''': Esta categoria de usuarios incluye a los usuarios que compraron la [[es/FreedomBox/Hardware/PioneerEdition|FreedomBox Pioneer Edition]], a los que instalaron !FreedomBox sobre una distribución estable de [[es/FreedomBox/Hardware/Debian|Debian]] y a los que descargaron las imágenes ''estables'' desde [[https://freedombox.org|freedombox.org]]. Si una aplicación solo está disponible en la distribución ''en pruebas'' pero no en la ''estable'', se mostrará en el interfaz web pero para los usuarios de la versión ''estable'' no será instalable. Cada dos años se publica una versión de Debian estable con las últimas versiones de todos los paquetes de software y los desarrolladores de !FreedomBox intentarán actualizar a estos usuarios a esta publicación sin necesidad de intervención manual. Consulta más abajo las secciones acerca de la actualización a la nueva publicación estable.
Como regla general a estos usuarios solo se les proporciona actualizaciones de seguridad de determinados paquetes. Cuando una ''release'' obtiene la confianza de los desarrolladores el propio servicio !FreedomBox se actualiza, lo que supone una excepción a esta regla. Esto implica que las últimas funcionalidades de !FreedomBox estarán disponibles para estos usuarios con algunos días de retardo respecto los usuarios de las versiones en pruebas (''testing''). Si una ''app'' sólo está disponible en la distribución en pruebas (''testing'') pero no en la ''estable'' la ''app'' aparecerá en el interfaz web pero no será instalable para los usuarios de la distribución ''estable''. Algunas ''apps'' (actualmente solo Matrix Synapse) se actualizan en excepción a la regla de "solo actualizaciones de seguridad" cuando la ''app'' esté indisponible o seriamente ''rota'' por algún motivo. Técnicamente, y después de pruebas exhaustivas, con esta opción habilitada se puede instalar una lista selecta de paquetes desde los repositorios de Debian ''backports'' o ''inestable''.
* '''Usuarios de versiones en pruebas''': Esta categoria de usuarios incluye a los usuarios que instalaron !FreedomBox sobre una distribución en pruebas (''testing'') y a los que descargaron las imágenes en pruebas (''testing'') desde [[https://freedombox.org|freedombox.org]]. Estos usuarios asumen la posibilidad de afrontar disrupciones ocasionales en los servicios e incluso tener que intervenir manualmente para arreglarlas. Como regla general estos usuarios reciben las últimas funcionalidades y actualizaciones de seguridad para todos los paquetes instalados. Cada quincena se libera una nueva versión de !FreedomBox con todas las últimas funcionalidades y correcciones. Estas versiones llegan a los usuarios de la distribución en pruebas (''testing'') aproximadamente 2 o 3 días después de la liberación.

View File

@ -57,7 +57,7 @@ Si tu !FreedomBox está detrás de un router tendrás que configurar en él la r
* !FreedomBox proporciona un cliente web: [[es/FreedomBox/Manual/JSXC|JSXC]].
* Hay [[https://xmpp.org/software/clients.html|clientes XMPP]] disponibles para varias plataformas de escritorio y móviles. !FreedomBox enlaza a las fuentes de descarga de algunos. Eres libre de incluir más [[https://wiki.debian.org/FreedomBox/Manual/ejabberd?action=edit&editor=text|aquí]] (requiere registro libre). Nosotros lo notaremos y quizá lo listemos en !FreedomBox.
{{attachment:FreedomBox/Manual/ejabberd/xmpp-clients_en_V02.png|clientes XMPP}}
{{attachment:xmpp-clients_es_V02.png|clientes XMPP}}
==== Cliente Web de FreedomBox ====

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB