[users] Polish the documentation for the various checkboxes

This commit is contained in:
Adriaan de Groot 2019-10-22 15:32:42 +02:00
parent c030cc41cd
commit 3e4e492305

View File

@ -27,26 +27,34 @@ defaultGroups:
# the desktop environment on boot. # the desktop environment on boot.
# Disable when your Distribution does not require such a group. # Disable when your Distribution does not require such a group.
autologinGroup: autologin autologinGroup: autologin
# You can control the initial state for the 'autologin checkbox' in UsersViewStep here. # You can control the initial state for the 'autologin checkbox' here.
# Possible values are: true to enable or false to disable the checkbox by default. # Possible values are:
# - true to check or
# - false to uncheck
# These set the **initial** state of the checkbox.
doAutologin: true doAutologin: true
# When set to a non-empty string, Calamares creates a sudoers file for the user. # When *sudoersGroup* is set to a non-empty string, Calamares creates a
# /etc/sudoers.d/10-installer # sudoers file for the user. This file is located at:
# Remember to add sudoersGroup to defaultGroups. # `/etc/sudoers.d/10-installer`
# Remember to add the (value of) *sudoersGroup* to *defaultGroups*.
# #
# If your Distribution already sets up a group of sudoers in its packaging, # If your Distribution already sets up a group of sudoers in its packaging,
# remove this setting (delete or comment out the line below). Otherwise, # remove this setting (delete or comment out the line below). Otherwise,
# the setting will be duplicated in the /etc/sudoers.d/10-installer file, # the setting will be duplicated in the `/etc/sudoers.d/10-installer` file,
# potentially confusing users. # potentially confusing users.
sudoersGroup: wheel sudoersGroup: wheel
# Setting this to false , causes the root account to be disabled. # Setting this to false , causes the root account to be disabled.
setRootPassword: true setRootPassword: true
# You can control the initial state for the 'root password checkbox' in UsersViewStep here. # You can control the initial state for the 'reuse password for root'
# Possible values are: true to enable or false to disable the checkbox by default. # checkbox here. Possible values are:
# When enabled the user password is used for the root account too. # - true to check or
# NOTE: doReusePassword requires setRootPassword to be enabled. # - false to uncheck
#
# When checked, the user password is used for the root account too.
#
# NOTE: *doReusePassword* requires *setRootPassword* to be enabled.
doReusePassword: true doReusePassword: true
# These are optional password-requirements that a distro can enforce # These are optional password-requirements that a distro can enforce
@ -69,21 +77,31 @@ doReusePassword: true
# (additional checks may be implemented in CheckPWQuality.cpp and # (additional checks may be implemented in CheckPWQuality.cpp and
# wired into UsersPage.cpp) # wired into UsersPage.cpp)
# #
# To disable specific password validations, # - To disable specific password validations:
# comment out the relevant 'passwordRequirements' keys below. # comment out the relevant 'passwordRequirements' keys below.
# To disable all password validations, # - To disable all password validations:
# set both 'allowWeakPasswords' and 'doPasswordChecks' to false. # set both 'allowWeakPasswords' and 'allowWeakPasswordsDefault' to true.
# (This will show the box *Allow weak passwords* in the user-
# interface, and check it by default).
passwordRequirements: passwordRequirements:
minLength: -1 # Password at least this many characters minLength: -1 # Password at least this many characters
maxLength: -1 # Password at most this many characters maxLength: -1 # Password at most this many characters
libpwquality: libpwquality:
- minlen=0 - minlen=0
- minclass=0 - minclass=0
# You can control the visibility of the 'strong passwords' checkbox in UsersViewStep here.
# Possible values are: true to show or false to hide the checkbox. # You can control the visibility of the 'weak passwords' checkbox here.
# Possible values are:
# - true to show or
# - false to hide
# the checkbox. This checkbox allows the user to choose to disable
# password-strength-checks.
allowWeakPasswords: true allowWeakPasswords: true
# You can control the initial state for the 'strong passwords' checkbox in UsersViewStep here. # You can control the initial state for the 'weak passwords' checkbox here.
# Possible values are: true to enable or false to disable the checkbox by default. # Possible values are:
# - true to check or
# - false to uncheck
# the checkbox by default.
doPasswordChecks: true doPasswordChecks: true
# Shell to be used for the regular user of the target system. # Shell to be used for the regular user of the target system.