From 5ee377308dc5b22acb03bcc0de7ebc1f5eb2c0b0 Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 20 Feb 2023 12:55:15 -0500
Subject: sudo: add docs

---
 roles/sudo/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 roles/sudo/README.md

(limited to 'roles/sudo')

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
+````
-- 
cgit