diff --git a/doc/manual/en/APU.raw.wiki b/doc/manual/en/APU.raw.wiki index f0ea04232..66ae1c861 100644 --- a/doc/manual/en/APU.raw.wiki +++ b/doc/manual/en/APU.raw.wiki @@ -24,16 +24,6 @@ Although untested, the following similar hardware is also likely to work well wi * [[http://www.pcengines.ch/apu3b2.htm|apu3b2]] * [[http://www.pcengines.ch/apu3b4.htm|apu3b4]] - * Using i386 image: - * [[http://www.pcengines.ch/alix1d.htm|alix1d]] - * [[http://www.pcengines.ch/alix1e.htm|alix1e]] - * [[http://www.pcengines.ch/alix2d2.htm|alix2d2]] - * [[http://www.pcengines.ch/alix2d3.htm|alix2d3]] - * [[http://www.pcengines.ch/alix2d13.htm|alix2d13]] - * [[http://www.pcengines.ch/alix3d2.htm|alix3d2]] - * [[http://www.pcengines.ch/alix3d3.htm|alix3d3]] - * [[http://www.pcengines.ch/alix6f2.htm|alix6f2]] - === Download === !FreedomBox disk [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card, USB disk, SSD or hard drive and boot into !FreedomBox. Pick the image meant for all amd64 machines. diff --git a/doc/manual/en/Customization.raw.wiki b/doc/manual/en/Customization.raw.wiki new file mode 100644 index 000000000..be72f0199 --- /dev/null +++ b/doc/manual/en/Customization.raw.wiki @@ -0,0 +1,80 @@ +== FreedomBox Customization == + +<> + +## BEGIN_INCLUDE +Though !FreedomBox's philosophy is to have the user make as few decisions as possible about the !FreedomBox itself, a few options for customization have been provided to facilitate some advanced use cases. + + +=== Change Default App === + +''Available since version:'' 0.36.0 <
> +''Skill level:'' Basic + +''Use Case'': A !FreedomBox that primarily runs only one public-facing application whose web application is set as the landing page when someone visits the domain name of the !FreedomBox over the internet. <
> +e.g. A university using !MediaWiki running on !FreedomBox as a course wiki wants its students typing in the domain name into their browser to directly go to the wiki bypassing the !FreedomBox home page. + +''Configuration:'' Change the [[FreedomBox/Manual/Configure#Default_App|Default App]] in the configure page to whichever app you want to be served as default. + +=== Custom Shortcuts === + +''Available since version:'' 0.40.0 <
> +''Skill level:'' Advanced + +''Use Case:'' The administrator of a community deployment of !FreedomBox manually installs a few additional unsupported applications on the !FreedomBox and wants users to be able to transparently access them through the web and mobile applications of !FreedomBox. + +''Note:'' This feature is meant to be used with applications that are end-user facing, i.e have a web or mobile client. + +'''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:///plinth/api/1/shortcuts. + +An example file adding one additional shortcut for [[https://nextcloud.com|NextCloud]]. + +{{{#!highlight json +{ + "shortcuts": [{ + "name": "NextCloud", + "description": ["Nextcloud is a suite of client-server software for creating and using file hosting services."], + "icon_url": "/plinth/custom/static/icons/nextcloud.png", + "clients": [{ + "name": "nextcloud", + "platforms": [{ + "type": "web", + "url": "/nextcloud" + }] + }], + "tags" : ["Groupware", "File sync"] + }] +} +}}} + +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`. + +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 restart the Plinth home page will display an additional shortcut for !NextCloud as shown below: <
> +{{attachment:nextcloud-frontpage-shortcut.png|NextCloud custom shortcut on the Plinth home page}} + +The same shortcut will also be displayed in any Android apps connected to the !FreedomBox. <
> + +{{attachment:android-app-custom-shortcut.jpg|NextCloud custom shortcut in the Android app}} + +=== Custom Styling === + +''Available since version:'' 24.25 <
> +''Skill level:'' Advanced + +''Use Case:'' The administrator of a community or home deployment of !FreedomBox wants to customize the web page styling of !FreedomBox. + +''Configuration'': Create a file in the path `/var/www/plinth/custom/static/css/user.css` and write [[https://developer.mozilla.org/en-US/docs/Web/CSS|CSS]] styling rules. This +file has the highest priority as per the [[https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade|cascading rules]]. Use the web browser's developer console to understand which rules to override and how much [[https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity|specificity]] is needed. + +{{attachment:customization_styling.png|Home page with customized styling}} + +## END_INCLUDE + +<> + +---- +CategoryFreedomBox diff --git a/doc/manual/en/Hardware.raw.wiki b/doc/manual/en/Hardware.raw.wiki index 101a61679..fa91d668d 100644 --- a/doc/manual/en/Hardware.raw.wiki +++ b/doc/manual/en/Hardware.raw.wiki @@ -160,7 +160,6 @@ All !FreedomBox disk images for different hardware is built by the project using || '''Image''' || '''Includes main?''' || '''Includes non-free-firmware?''' || '''Non-free firmware included''' || || 32-bit ARM (armhf) || (./) || || || -|| 32-bit x86 (i386) || (./) || (./) || DebianPkg:amd64-microcode, DebianPkg:intel-microcode (see [[Microcode]]) || || 64-bit ARM (arm64) || (./) || || || || 64-bit x86 (amd64) || (./) || (./) || DebianPkg:amd64-microcode, DebianPkg:intel-microcode (see [[Microcode]]) || || A20 OLinuXino Lime || (./) || || || @@ -178,7 +177,6 @@ All !FreedomBox disk images for different hardware is built by the project using || Pine A64+ || (./) || || || || Pioneer Edition !FreedomBox || (./) || || || || QEMU/KVM amd64 || (./) || || || -|| QEMU/KVM i386 || (./) || || || || Raspberry Pi 2 || (./) || (./) || DebianPkg:raspi-firmware || || Raspberry Pi 3 Model B || (./) || (./) || DebianPkg:raspi-firmware, DebianPkg:firmware-brcm80211 || || Raspberry Pi 3 Model B+ || (./) || (./) || DebianPkg:raspi-firmware, DebianPkg:firmware-brcm80211 || @@ -186,7 +184,6 @@ All !FreedomBox disk images for different hardware is built by the project using || Rock64 || (./) || || || || !RockPro64 || (./) || || || || !VirtualBox for amd64 || (./) || || || -|| !VirtualBox for i386 || (./) || || || ## END_INCLUDE diff --git a/doc/manual/en/ReleaseNotes.raw.wiki b/doc/manual/en/ReleaseNotes.raw.wiki index b2aa43f5f..4543c759e 100644 --- a/doc/manual/en/ReleaseNotes.raw.wiki +++ b/doc/manual/en/ReleaseNotes.raw.wiki @@ -8,6 +8,41 @@ 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.1 (2025-01-13) == + +=== Highlights === + + * email: Show DNS entries for all domains instead of just primary + * privacy: Add option in UI to set lookup URL for public IPs + +=== Other Changes === + + * app: Add tags to menu and frontpage components + * app: Allow apps to instantiate without Django initialization + * app: Stop showing short description on installation page + * apps: Only show app tags all the tags in apps page search box + * backups: Add warning that services may become unavailable + * backups: Handle error when there is not enough space on disk + * backups: Make all generated archive names consistent + * backups: Properly cleanup after downloading an archive + * deluge: tests: functional: Fix deluge client logged in detection + * doc: dev: Remove short description and add tags to all components + * dynamicdns: Use the public IP lookup URL from privacy app + * email: Create DKIM keys for all known domains + * email: Fix regression error when installing/operation app + * email: Show reverse DNS entries to be configured + * locale: Translated using Weblate (German, Russian) + * miniflux: Ignore an type check error with pexpect library + * privacy: Introduce utility to lookup external IP address + * privacy: Show notification for privacy settings again + * ui: Don't place JS file at the bottom of the page + * ui: Drop remnants of already removed background images + * ui: Fix missing variables in Bootstrap 5.2/Debian stable + * ui: Update section header style to increase size, remove underline + * ui: js: Load all JS files in deferred mode to speed up page load + * views: Use tags from menu or shortcut instead of the app + * web_framework: Disable caching templates files in development mode + == FreedomBox 24.26.1 (2025-01-05) == === Highlights === diff --git a/doc/manual/en/VirtualBox.raw.wiki b/doc/manual/en/VirtualBox.raw.wiki index f79b51b17..fec534a68 100644 --- a/doc/manual/en/VirtualBox.raw.wiki +++ b/doc/manual/en/VirtualBox.raw.wiki @@ -175,7 +175,7 @@ If you want to mount images locally, use the following to copy built images off {{{ $ mkdir /tmp/vbox-img1 /tmp/vbox-root1 -$ vdfuse -f freedombox-unstable_2013.0519_virtualbox-i386-hdd.vdi /tmp/vbox-img1/ +$ vdfuse -f freedombox-unstable_2013.0519_virtualbox-amd64-hdd.vdi /tmp/vbox-img1/ $ sudo mount -o loop /tmp/vbox-img1/Partition1 /tmp/vbox-root1 $ cp /tmp/vbox-root1/home/fbx/freedom-maker/build/freedom*vdi ~/ $ sudo umount /tmp/vbox-root1 diff --git a/doc/manual/en/freedombox-manual.raw.wiki b/doc/manual/en/freedombox-manual.raw.wiki index f5cba0611..aed5ca859 100644 --- a/doc/manual/en/freedombox-manual.raw.wiki +++ b/doc/manual/en/freedombox-manual.raw.wiki @@ -107,6 +107,10 @@ <> += Customizing = + +<> + = Contributing = <> diff --git a/doc/manual/en/images/android-app-custom-shortcut.jpg b/doc/manual/en/images/android-app-custom-shortcut.jpg new file mode 100644 index 000000000..9d570fc9f Binary files /dev/null and b/doc/manual/en/images/android-app-custom-shortcut.jpg differ diff --git a/doc/manual/en/images/customization_styling.png b/doc/manual/en/images/customization_styling.png new file mode 100644 index 000000000..59293e4ca Binary files /dev/null and b/doc/manual/en/images/customization_styling.png differ diff --git a/doc/manual/en/images/nextcloud-frontpage-shortcut.png b/doc/manual/en/images/nextcloud-frontpage-shortcut.png new file mode 100644 index 000000000..7b8fd9544 Binary files /dev/null and b/doc/manual/en/images/nextcloud-frontpage-shortcut.png differ diff --git a/doc/manual/es/APU.raw.wiki b/doc/manual/es/APU.raw.wiki index f0ea04232..66ae1c861 100644 --- a/doc/manual/es/APU.raw.wiki +++ b/doc/manual/es/APU.raw.wiki @@ -24,16 +24,6 @@ Although untested, the following similar hardware is also likely to work well wi * [[http://www.pcengines.ch/apu3b2.htm|apu3b2]] * [[http://www.pcengines.ch/apu3b4.htm|apu3b4]] - * Using i386 image: - * [[http://www.pcengines.ch/alix1d.htm|alix1d]] - * [[http://www.pcengines.ch/alix1e.htm|alix1e]] - * [[http://www.pcengines.ch/alix2d2.htm|alix2d2]] - * [[http://www.pcengines.ch/alix2d3.htm|alix2d3]] - * [[http://www.pcengines.ch/alix2d13.htm|alix2d13]] - * [[http://www.pcengines.ch/alix3d2.htm|alix3d2]] - * [[http://www.pcengines.ch/alix3d3.htm|alix3d3]] - * [[http://www.pcengines.ch/alix6f2.htm|alix6f2]] - === Download === !FreedomBox disk [[FreedomBox/Download|images]] for this hardware are available. Follow the instructions on the [[FreedomBox/Download|download]] page to create a !FreedomBox SD card, USB disk, SSD or hard drive and boot into !FreedomBox. Pick the image meant for all amd64 machines. diff --git a/doc/manual/es/Hardware.raw.wiki b/doc/manual/es/Hardware.raw.wiki index c7af38b51..03b398cb8 100644 --- a/doc/manual/es/Hardware.raw.wiki +++ b/doc/manual/es/Hardware.raw.wiki @@ -166,7 +166,6 @@ Todas las imágenes de disco de !FreedomBox para hardware diferente las compila || '''Imagen''' || '''¿Incluye ''main''?''' || '''¿Incluye ''non-free-firmware''?''' || '''Firmware privativo incluído''' || || 32-bit ARM (armhf) || (./) || || || -|| 32-bit x86 (i386) || (./) || (./) || DebianPkg:amd64-microcode, DebianPkg:intel-microcode (Ver [[Microcode|Microcódigo]]) || || 64-bit ARM (arm64) || (./) || || || || 64-bit x86 (amd64) || (./) || (./) || DebianPkg:amd64-microcode, DebianPkg:intel-microcode (Ver [[Microcode|Microcódigo]]) || || A20 OLinuXino Lime || (./) || || || @@ -184,7 +183,6 @@ Todas las imágenes de disco de !FreedomBox para hardware diferente las compila || Pine A64+ || (./) || || || || Pioneer Edition !FreedomBox || (./) || || || || QEMU/KVM amd64 || (./) || || || -|| QEMU/KVM i386 || (./) || || || || Raspberry Pi 2 || (./) || (./) || DebianPkg:raspi-firmware || || Raspberry Pi 3 Model B || (./) || (./) || DebianPkg:raspi-firmware , DebianPkg:firmware-brcm80211 || || Raspberry Pi 3 Model B+ || (./) || (./) || DebianPkg:raspi-firmware , DebianPkg:firmware-brcm80211 || @@ -192,7 +190,6 @@ Todas las imágenes de disco de !FreedomBox para hardware diferente las compila || Rock64 || (./) || || || || !RockPro64 || (./) || || || || !VirtualBox for amd64 || (./) || || || -|| !VirtualBox for i386 || (./) || || || ## END_INCLUDE diff --git a/doc/manual/es/Manual.raw.wiki b/doc/manual/es/Manual.raw.wiki index f5cba0611..aed5ca859 100644 --- a/doc/manual/es/Manual.raw.wiki +++ b/doc/manual/es/Manual.raw.wiki @@ -107,6 +107,10 @@ <> += Customizing = + +<> + = Contributing = <> diff --git a/doc/manual/es/ReleaseNotes.raw.wiki b/doc/manual/es/ReleaseNotes.raw.wiki index b2aa43f5f..4543c759e 100644 --- a/doc/manual/es/ReleaseNotes.raw.wiki +++ b/doc/manual/es/ReleaseNotes.raw.wiki @@ -8,6 +8,41 @@ 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.1 (2025-01-13) == + +=== Highlights === + + * email: Show DNS entries for all domains instead of just primary + * privacy: Add option in UI to set lookup URL for public IPs + +=== Other Changes === + + * app: Add tags to menu and frontpage components + * app: Allow apps to instantiate without Django initialization + * app: Stop showing short description on installation page + * apps: Only show app tags all the tags in apps page search box + * backups: Add warning that services may become unavailable + * backups: Handle error when there is not enough space on disk + * backups: Make all generated archive names consistent + * backups: Properly cleanup after downloading an archive + * deluge: tests: functional: Fix deluge client logged in detection + * doc: dev: Remove short description and add tags to all components + * dynamicdns: Use the public IP lookup URL from privacy app + * email: Create DKIM keys for all known domains + * email: Fix regression error when installing/operation app + * email: Show reverse DNS entries to be configured + * locale: Translated using Weblate (German, Russian) + * miniflux: Ignore an type check error with pexpect library + * privacy: Introduce utility to lookup external IP address + * privacy: Show notification for privacy settings again + * ui: Don't place JS file at the bottom of the page + * ui: Drop remnants of already removed background images + * ui: Fix missing variables in Bootstrap 5.2/Debian stable + * ui: Update section header style to increase size, remove underline + * ui: js: Load all JS files in deferred mode to speed up page load + * views: Use tags from menu or shortcut instead of the app + * web_framework: Disable caching templates files in development mode + == FreedomBox 24.26.1 (2025-01-05) == === Highlights === diff --git a/doc/manual/es/VirtualBox.raw.wiki b/doc/manual/es/VirtualBox.raw.wiki index f79b51b17..fec534a68 100644 --- a/doc/manual/es/VirtualBox.raw.wiki +++ b/doc/manual/es/VirtualBox.raw.wiki @@ -175,7 +175,7 @@ If you want to mount images locally, use the following to copy built images off {{{ $ mkdir /tmp/vbox-img1 /tmp/vbox-root1 -$ vdfuse -f freedombox-unstable_2013.0519_virtualbox-i386-hdd.vdi /tmp/vbox-img1/ +$ vdfuse -f freedombox-unstable_2013.0519_virtualbox-amd64-hdd.vdi /tmp/vbox-img1/ $ sudo mount -o loop /tmp/vbox-img1/Partition1 /tmp/vbox-root1 $ cp /tmp/vbox-root1/home/fbx/freedom-maker/build/freedom*vdi ~/ $ sudo umount /tmp/vbox-root1