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 2023-06-19 20:44:24 -04:00
parent eae98da462
commit 6201d91b44
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
7 changed files with 65 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/manual/en/Download.raw.wiki
View File

@ -48,6 +48,8 @@ $ gpg --keyserver keyserver.ubuntu.com --recv-keys BCBEBD57A11F70B23782BC5736C36
$ gpg --keyserver keyserver.ubuntu.com --recv-keys 7D6ADB750F91085589484BE677C0C75E7B650808
# This is the FreedomBox CI server's key
$ gpg --keyserver keyserver.ubuntu.com --recv-keys 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
# This is the new FreedomBox CI server's key
$ gpg --keyserver keyserver.ubuntu.com --recv-keys D4B069124FCF43AA1FCD7FBC2ACFC1E15AF82D8C
}}}
* Next, verify the fingerprint of the public keys:
{{{
@ -71,17 +73,23 @@ pub rsa4096 2018-06-06 [SC]
013D 86D8 BA32 EAB4 A669 1BF8 5D41 53D6 FE18 8FC8
uid [ unknown] FreedomBox CI (Continuous Integration server) <admin@freedombox.org>
sub rsa4096 2018-06-06 [E]
$ gpg --fingerprint D4B069124FCF43AA1FCD7FBC2ACFC1E15AF82D8C
pub rsa4096 2022-03-09 [SC]
D4B0 6912 4FCF 43AA 1FCD 7FBC 2ACF C1E1 5AF8 2D8C
uid [ unknown] FreedomBox CI (Continuous Integration server) <admin@freedombox.org>
sub rsa4096 2022-03-09 [E]
}}}
* Finally, verify your downloaded image with its signature file `.sig`. For example:
{{{
$ gpg --verify freedombox-stable-free_buster_cubietruck-armhf.img.xz.sig
gpg: assuming signed data in 'freedombox-stable-free_buster_cubietruck-armhf.img.xz'
gpg: Signature made Sat 09 May 2020 11:54:01 AM EDT
gpg: using RSA key 013D86D8BA32EAB4A6691BF85D4153D6FE188FC8
gpg: Good signature from "FreedomBox CI (Continuous Integration server) <admin@freedombox.org>" [undefined]
$ $ gpg --verify freedombox-bookworm_all-amd64.img.xz.sig
gpg: assuming signed data in 'freedombox-bookworm_all-amd64.img.xz'
gpg: Signature made Wed 14 Jun 2023 03:22:04 PM PDT
gpg: using RSA key D4B069124FCF43AA1FCD7FBC2ACFC1E15AF82D8C
gpg: Good signature from "FreedomBox CI (Continuous Integration server) <admin@freedombox.org>" [unknown]
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 013D 86D8 BA32 EAB4 A669 1BF8 5D41 53D6 FE18 8FC8
Primary key fingerprint: D4B0 6912 4FCF 43AA 1FCD 7FBC 2ACF C1E1 5AF8 2D8C
}}}
=== Installation ===

9
doc/manual/en/QuickStart.raw.wiki
View File

@ -58,6 +58,15 @@ Alternatively you may choose to build it yourself, by gathering all the componen
. {{attachment:ui_insecure_connection.png|Self-signed certificate warning|width=600}}
. {{attachment:ui_add_security_exception.png|Add Security Exception|width=400}}
If the domain name you are using already has a valid certificate from a recognised Certificate Authority, such as from Let's Encrypt, you may not be able to access the web interface. This means that the option to continue will not be offered. This might occur, for example, if you are reinstalling your !FreedomBox or are otherwise reusing a domain name that has an associated certificate.
This is normal, because your browser has a record of having visited the site and knows about the valid official certificate. The browser will not subsequently accept a self-signed certificate and you will be blocked. There are two ways to get beyond this hurdle.
The first method is to access your !FreedomBox by its IP address instead of by its domain name. So, instead of using something https://example.com, you would use something like https://198.51.100.2 (substitute your own IP address).
The second method is to create a fresh profile for your browser and access your !FreedomBox from the new profile. The new profile will have no memory of having visited the site nor memory of an official certificate. Once your !FreedomBox has a new Let's Encrypt certificate, you can go back to using the old browser profile.
1. The first time you access the !FreedomBox web interface, you will see a welcome page. Click the "Start Setup" button to continue.
. {{attachment:ui_firstboot_welcome.png|Welcome|width=500}}

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

@ -8,6 +8,25 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 23.12 (2023-06-19) ==
=== Highlights ===
* packages: Purge packages on uninstall
* gitweb: Fix issue with service startup when gitweb is not enabled
* mediawiki: Increment version to run update.php automatically
=== Other Changes ===
* deluge: Utilize purging of packages and don't remove explicitly
* locale: Update translations for Czech, Dutch, Spanish, Turkish, Ukrainian
* mediawiki: Utilize purging of packages and don't remove explicitly
* roundcube: Clarify description for local mail only option
* samba: Remove additional configuration files on uninstall
* searx: Fix typo in method name
* shaarli: Utilize purging of packages and don't remove explicitly
* uninstall: Remove experimental warning
== FreedomBox 23.11 (2023-06-05) ==
=== Highlights ===

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

@ -16,6 +16,8 @@
Roundcube is a browser-based multilingual email client with an application-like user interface. Roundcube is using the Internet Message Access Protocol (IMAP) to access e-mail on a remote mail server. It supports MIME to send files, and provides particularly address book, folder management, message searching and spell checking.
Roundcube app can be used in one of the two ways. First way to use Roundcube is as a mail client application for an email account you have elsewhere (other than !FreedomBox). For example, if you have a Riseup or Gmail account you can use Roundcube to read and send emails for those accounts. Second way to use to use Roundcube is as a mail client application for an email account on !FreedomBox. This is possible if an email server app, such as Postfix/Dovecot/Rspamd, is setup and enabled on !FreedomBox. Your mails reside on the !FreedomBox server and Roundcube (or other desktop/mobile mail clients) can be used to read and send mails. At present, Roundcube can only be setup for one of these two ways. This is controlled by the ''Use only the local mail server'' option in Roundcube app configuration page.
=== Using Roundcube ===
After Roundcube is installed, it can be accessed at {{{https://<your freedombox>/roundcube}}}. Enter your username and password. The username for many mail services will be the full email address such as ''exampleuser@example.org'' and not just the username like ''exampleuser''. Enter the address of your email service's IMAP server address in the ''Server'' field. You can try providing your domain name here such as ''example.org'' for email address ''exampleuser@example.org'' and if this does not work, consult your email provider's documentation for the address of the IMAP server. Using encrypted connection to your IMAP server is strongly recommended. To do this, prepend 'imaps://' at the beginning of your IMAP server address. For example, ''imaps://imap.example.org''.

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

@ -94,7 +94,7 @@ Once logged into a FreedomBox/XMPP account (2), the Conversation app provides a
===== Monal (iOS) =====
[[https://monal.im|Monal]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/us/app/monal-free-xmpp-chat/id317711500|App Store]].
[[https://monal-im.org|Monal]] is a free software XMPP client with videochat support available from the [[https://apps.apple.com/us/app/monal-free-xmpp-chat/id317711500|App Store]].
===== Siskin (iOS) =====

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

@ -8,6 +8,25 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
The following are the release notes for each !FreedomBox version.
== FreedomBox 23.12 (2023-06-19) ==
=== Highlights ===
* packages: Purge packages on uninstall
* gitweb: Fix issue with service startup when gitweb is not enabled
* mediawiki: Increment version to run update.php automatically
=== Other Changes ===
* deluge: Utilize purging of packages and don't remove explicitly
* locale: Update translations for Czech, Dutch, Spanish, Turkish, Ukrainian
* mediawiki: Utilize purging of packages and don't remove explicitly
* roundcube: Clarify description for local mail only option
* samba: Remove additional configuration files on uninstall
* searx: Fix typo in method name
* shaarli: Utilize purging of packages and don't remove explicitly
* uninstall: Remove experimental warning
== FreedomBox 23.11 (2023-06-05) ==
=== Highlights ===

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

@ -91,7 +91,7 @@ Una vez ingresado en tu cuenta !Freedombox/XMPP la app Conversations proporciona
===== Monal (iOS) =====
[[https://monal.im|Monal]] es un cliente XMPP libre con soporte a videollamadas disponible en [[https://apps.apple.com/us/app/monal-free-xmpp-chat/id317711500|App Store]].
[[https://monal-im.org|Monal]] es un cliente XMPP libre con soporte a videollamadas disponible en [[https://apps.apple.com/us/app/monal-free-xmpp-chat/id317711500|App Store]].
===== Siskin (iOS) =====