napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[welcome] Update .conf documentation

Browse Source 
- fix typo
- don't suggest google as internetCheckUrl
- mark TODOs for #1384
This commit is contained in:
Adriaan de Groot 2021-02-16 16:32:34 +01:00
parent d0a65641e2
commit 6bf82e9c65
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/modules/welcome/welcome.conf
View File

@ -10,14 +10,19 @@
# can check requirements for installation. # can check requirements for installation.
--- ---
# Display settings for various buttons on the welcome page. # Display settings for various buttons on the welcome page.
# The URLs themselves come from branding.desc is the setting # The URLs themselves come from `branding.desc`. Each button
# here is "true". If the setting is false, the button is hidden. # is show if the corresponding *show<buttonname>* setting
# here is "true". If the setting is "false", the button is hidden.
# Empty or not-set is interpreted as "false".
#
# TODO:3.3 Remove the URL fallback here; URLs only in `branding.desc`
#
# The setting can also be a full URL which will then be used # The setting can also be a full URL which will then be used
# instead of the one from the branding file, or empty or not-set # instead of the one from the branding file.
# which will hide the button.
showSupportUrl: true showSupportUrl: true
showKnownIssuesUrl: true showKnownIssuesUrl: true
showReleaseNotesUrl: false showReleaseNotesUrl: false
# TODO:3.3 Move to branding, keep only a bool here
showDonateUrl: https://kde.org/community/donations/ showDonateUrl: https://kde.org/community/donations/
# Requirements checking. These are general, generic, things # Requirements checking. These are general, generic, things
@ -26,7 +31,7 @@ showDonateUrl: https://kde.org/community/donations/
requirements: requirements:
# Amount of available disk, in GiB. Floating-point is allowed here. # Amount of available disk, in GiB. Floating-point is allowed here.
# Note that this does not account for *usable* disk, so it is possible # Note that this does not account for *usable* disk, so it is possible
# to pass this requirement, yet have no space to install to. # to satisfy this requirement, yet have no space to install to.
requiredStorage: 5.5 requiredStorage: 5.5
# Amount of available RAM, in GiB. Floating-point is allowed here. # Amount of available RAM, in GiB. Floating-point is allowed here.
@ -34,7 +39,10 @@ requirements:
# To check for internet connectivity, Calamares does a HTTP GET # To check for internet connectivity, Calamares does a HTTP GET
# on this URL; on success (e.g. HTTP code 200) internet is OK. # on this URL; on success (e.g. HTTP code 200) internet is OK.
internetCheckUrl: http://google.com # Use a privacy-respecting URL here, preferably in your distro's domain.
#
# The URL is only used if "internet" is in the *check* list below.
internetCheckUrl: http://example.com
# List conditions to check. Each listed condition will be # List conditions to check. Each listed condition will be
# probed in some way, and yields true or false according to # probed in some way, and yields true or false according to