mkhomedir

Welcome to your new module. A short overview of the generated parts can be found in the [PDK documentation][1].

The README template below provides a starting point with details about what information to include in your README.

Description

mkhomedir will enable mkhomedir using oddjob. If you want to have your hoemdir created when logging in to a system the first time, just include this class

Usage

Normally you just include the module to enable pam_oddjob_mkhomedir.so as so:

  include mkhomedir

Limitations

The module is limited to RedHat and Debian-family systems. It might well work with other OS's that I don't know of, or have the possibility to test.

Development

Pull requests are welcome. Issues as well.

2020-10-07: bahner

Reference

Table of Contents

Classes

Public Classes

• mkhomedir: Install and enable pam_oddjob_mkhomedir

Private Classes

• mkhomedir::debian: Install and configures mkhomedir or vice versa
• mkhomedir::redhat: Install and configures mkhomedir or vice versa

Classes

mkhomedir

A description of what this class does

Examples

include mkhomedir

Parameters

The following parameters are available in the mkhomedir class.

enable

Data type: Boolean

Whether to enable or disable the oddjob-mkhomedir module in pam.

Default value: true

package_ensure

Data type: String

Whether or not to install the oddjob-mkhomedir package, or to remove or purge it. This should prolly be correlated with pam_module_name setting it to something else, if you don't want to installed the package.

Default value: 'installed'

package_name

Data type: String

Name of the package to install.

Default value: 'oddjob-mkhomedir'

pam_module_name

Data type: String

If you just want to use the standard pam_mkhomedir.so instead of the default pam_oddjob_mkhomedir.so than set this value here. Debian only. Authconfig uses pam_oddjob_mkhomedir.so if available. To make use of pam_mkhomedir.so set package_ensure to "purged"

Default value: 'pam_oddjob_mkhomedir.so'

pam_service_name

Data type: String

The name of the pam.d/FILE to modify Debian only. RedHat modules uses authconfig which handles this.

Default value: 'common-session'

pam_module_args

Data type: Array[String]

Arguments to pass to the module, eg. umask=0007 or umask=0077 Debian only. RedHat modules uses authconfig.

Default value: ['umask=0077']

Changelog

All notable changes to this project will be documented in this file.

Release 0.1.0

Features

Bugfixes

Known Issues