aboutsummaryrefslogtreecommitdiffstats
path: root/roles/motd
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:59:54 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:59:54 -0500
commitb083f57a1809c334d4c7bad7be0a228aaba650dd (patch)
tree9d1a3a9eebbf735b4c0b37704d615e6ec7e6caa1 /roles/motd
parent9f79e53c5b6dfae5875f0d082679b41ab405ed4c (diff)
downloadselfhosted-b083f57a1809c334d4c7bad7be0a228aaba650dd.tar.gz
selfhosted-b083f57a1809c334d4c7bad7be0a228aaba650dd.zip
motd: add docs
Diffstat (limited to 'roles/motd')
-rw-r--r--roles/motd/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/roles/motd/README.md b/roles/motd/README.md
new file mode 100644
index 0000000..d80239a
--- /dev/null
+++ b/roles/motd/README.md
@@ -0,0 +1,20 @@
+motd
+====
+
+Description
+-----------
+
+This role disables the default `cockpit` message from being displayed on login.
+
+This role does not accept any variables.
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+ roles:
+ - role: motd
+````