Merge pull request #854 from abucodonosor/modules

Document users.conf

src/modules/users/UsersViewStep.cpp

@@ -2,6 +2,7 @@
  *
  *   Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
  *   Copyright 2017, Adriaan de Groot <groot@kde.org>
+ *   Copyright 2017, Gabriel Craciunescu <crazy@frugalware.org>
  *
  *   Calamares is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -131,6 +132,7 @@ UsersViewStep::setConfigurationMap( const QVariantMap& configurationMap )
     }
     else
     {
+        cDebug() << "WARNING: Using fallback groups. Please check defaultGroups in users.conf";
         m_defaultGroups = QStringList{ "lp", "video", "network", "storage", "wheel", "audio" };
     }
 

src/modules/users/users.conf

@@ -11,6 +11,8 @@
 # These globalconfig keys are set when the jobs for this module
 # are created.
 ---
+# Used as default groups for the created user.
+# Adjust to your Distribution defaults.
 defaultGroups:
     - users
     - lp
@@ -19,13 +21,32 @@ defaultGroups:
     - storage
     - wheel
     - audio
+
+# Some Distributions require a 'autologin' group for the user.
+# Autologin causes a user to become automatically logged in to
+# the desktop environment on boot.
+# Disable when your Distribution does not require such a group.
 autologinGroup:  autologin
+# You can control the initial state for the 'autologin checkbox' in UsersViewStep here.
+# Possible values are: true to enable or false to disable the checkbox by default
 doAutologin:     true
 
-# remove the following line to avoid creating /etc/sudoers.d/10-installer
+# When set to a non-empty string, Calamares creates a sudoers file for the user.
+#  /etc/sudoers.d/10-installer
+# Remember to add sudoersGroup to defaultGroups.
+#
+# If your Distribution already sets up a group of sudoers in its packaging,
+# remove this setting (delete or comment out the line below). Otherwise,
+# the setting will be duplicated in the /etc/sudoers.d/10-installer file,
+# potentially confusing users.
 sudoersGroup:    wheel
 
+# Setting this to false , causes the root account to be disabled.
 setRootPassword: true
+# You can control the initial state for the 'root password checkbox' in UsersViewStep here.
+# Possible values are: true to enable or false to disable the checkbox by default.
+# When enabled the user password is used for the root account too.
+# NOTE: doReusePassword requires setRootPassword to be enabled.
 doReusePassword: true
 
 # These are optional password-requirements that a distro can enforce