From fdf8d34bade46e485b992983d92ed913e218a648 Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Sun, 8 Sep 2019 17:46:49 -0500 Subject: script: keys: Finish documenting all known keys --- devel/script/2_keys.xml | 206 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 205 insertions(+), 1 deletion(-) (limited to 'devel/script/2_keys.xml') diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml index 059c735..2e56067 100644 --- a/devel/script/2_keys.xml +++ b/devel/script/2_keys.xml @@ -82,7 +82,7 @@ hostname gwyn.foxkit.internal Format - The pkginstall is a space-separated list of APK packages. They must be available in the repositories used during the installation process. pkginstall must appear at least once in a HorizonScript. There is no limit to the number of times pkginstall may be specified; each one will append to the list of packages to install. + The pkginstall key is a space-separated list of APK packages. They must be available in the repositories used during the installation process. pkginstall must appear at least once in a HorizonScript. There is no limit to the number of times pkginstall may be specified; each one will append to the list of packages to install. Examples @@ -106,6 +106,33 @@ pkginstall claws-mail +
+ <literal>rootpw</literal> + + Name + rootpw + + + Purpose + The rootpw key provides the encrypted passphrase for the administrative root user on the machine. + + + Format + The rootpw key is a string value containing a crypt(3) style, SHA-512 hashed passphrase. It is invalid to provide a plaintext passphrase. + + + Example + + + The <literal>rootpw</literal> Key + +rootpw $6$gumtLGmHwOVIRpQR$2M9PUO24hy5mofzWWf9a.YLbzOgOlUby1g0hDj.wG67E2wrrvys59fq02PPdxBdbgkLZFtjfEx6MHZwMBamwu/ + + This sets the target computer's root passphrase to "Test Password". (Please do not use this passphrase.) + + + +
Optional Keys @@ -447,6 +474,183 @@ signingkey https://packages/builder@ourcompany.net.pub
+
+ <literal>username</literal> + + Name + username + + + Purpose + The username key specifies a user account to create on the target computer. + + + Format + The username key is a string value, describing the user account's name. This name must be a valid Linux account name. username may be specified up to 64,535 times. It is invalid to specify the same account name more than once. It is invalid to specify the name of a system account. + + + Default + If no username key is specified, no user accounts will be created on the system beyond the built-in system accounts. Only root will be able to log in. + + + Examples + + + The <literal>username</literal> Key — Simple Usage + +username awilfox + + This creates an account with name awilfox on the target computer. + + + The <literal>username</literal> Key — Advanced Usage + +username chris +username kayla +username meg +username steph +username amanada + + This creates five accounts on the target computer. + + + +
+
+ <literal>useralias</literal> + + Name + useralias + + + Purpose + The useralias key provides the friendly name or alias of a user account on the target computer. + + + Format + The useralias key is a space-separated tuple of two string values: the user account name, and the friendly name or alias to use. The friendly name is read to the end of the line and may contain spaces. useralias may appear up to once per username. It is invalid to specify more than one useralias for a given username. It is invalid to specify a useralias for an account that is not created by username. + + + Default + If no useralias key is specified for a username, the alias "Adélie User" will be used. + + + Examples + + + The <literal>useralias</literal> Key + +useralias awilfox A. Wilcox + + This sets the friendly name of the awilfox account to A. Wilcox. + + + +
+
+ <literal>userpw</literal> + + Name + userpw + + + Purpose + The userpw key specifies the passphrase to use for a given user account on the target computer. + + + Format + The userpw key is a space-separated tuple of two string elements: the user account name, and the encrypted, SHA-512 hashed passphrase. It is invalid to specify a plaintext passphrase. userpw may appear up to once per username. It is invalid to specify more than one userpw for a given username. It is invalid to specify a userpw for an account that is not created by username. + + + Default + If no userpw key is specified for a username, it will have no passphrase set. By default, this will prevent users from logging in to the account. + + + Example + + + The <literal>userpw</literal> Key + +userpw awilfox $6$UZJm/vBmVgyIdMZr$ppKEulz/HY0/e7RcXXujQbcqDXkUYgIqNEVPQJO6.le9kUpz8GvvRezY3ifqUUEwjhSo9tTOMG7lhqjn8gGpH0 + + This sets the passphrase of the awilfox account to My Passphrase. (Please do not use this passphrase.) + + + +
+
+ <literal>usericon</literal> + + Name + usericon + + + Purpose + The usericon key specifies a icon used to identify a given user account on the target computer. + + + Format + The usericon key is a space-separated tuple of two string elements: the user account name, and a path to the icon. The icon must be in JPEG, PNG, TGA, or TIFF format. The path must be an absolute path accessible from the installation environment, or a supported URL. usericon may appear up to once per username. It is invalid to specify more than one usericon for a given username. It is invalid to specify a usericon for an account that is not created by username. + + + Default + If no usericon key is specified for a username, a default silhouette icon will be used for that account. + + + Example + + + The <literal>usericon</literal> Key + +usericon awilfox /usr/share/user-manager/avatars/circles/Cat.png + + This sets the icon of the awilfox account to the default Cat avatar. + + + +
+
+ <literal>usergroups</literal> + + Name + usergroups + + + Purpose + The usergroups key specifies group membership for a given user account on the target computer. + + + Format + The usergroups key is a space-separated tuple of two string elements: the user account name, and a comma-separated list of groups of which the account should become a member. usergroups may appear at least once per username. Each usergroups key for a given username appends to an existing list, if any. It is invalid to specify the same group more than once for a given username. It is invalid to specify more than 16 groups for a given username across all usergroups specified for it. + + + Default + If no usergroups is specified for a given username, it will be added to the users group. If it is given, the users group must be explicitly specified if desired. + + + Examples + + + The <literal>usergroups</literal> Key — Simple Usage + +usergroups awilfox users,wheel + + This specifies that the awilfox account will become a member of the groups users and wheel on the target computer. + + + The <literal>usergroups</literal> Key — Advanced Usage + +usergroups chris disk,lp,wheel,floppy,audio,cdrom,video,games,cdrw,usb,users +usergroups kayla lp,audio,cdrom,video,games,users +usergroups meg lp,audio,cdrom,video,games,users +usergroups steph lp,audio,cdrom,video,games,users +usergroups amanda lp,audio,cdrom,video,games,users + + This specifies that the chris account will become an administrative account and have access to most peripherals of the system, while the rest will have access to printers, sound, optical storage, graphics, and the ability to play games. + + + +
Disk Partitioning Keys -- cgit v1.2.3-60-g2f50