diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 12:55:15 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 12:55:15 -0500 |
| commit | 5ee377308dc5b22acb03bcc0de7ebc1f5eb2c0b0 (patch) | |
| tree | 85708de80730e6df8aca818f9e959be73fcf70e3 /roles/sudo/README.md | |
| parent | 51554a734c481dad6bdc6515c5683a4a18f903b9 (diff) | |
| download | selfhosted-5ee377308dc5b22acb03bcc0de7ebc1f5eb2c0b0.tar.gz selfhosted-5ee377308dc5b22acb03bcc0de7ebc1f5eb2c0b0.zip | |
sudo: add docs
Diffstat (limited to 'roles/sudo/README.md')
| -rw-r--r-- | roles/sudo/README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/roles/sudo/README.md b/roles/sudo/README.md new file mode 100644 index 0000000..8597385 --- /dev/null +++ b/roles/sudo/README.md @@ -0,0 +1,35 @@ +Sudo +==== + +Description +----------- + +The `sudo` configures email alerts for failed sudo attempts. The sudo rules +themselves are configured within FreeIPA. + + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +-------------------|---------|------------ +`sudo_send_emails` | yes | Send email alerts for failed sudo attempts +`sudo_mailto` | `root` | Alert destination address + + +Usage +----- + +Example playbook: + +````yaml +- name: configure sudo logging + hosts: all + roles: + - role: sudo + vars: + sudo_send_emails: yes + sudo_mailto: sysadmins@example.com +```` |