From 74e152dcd0e2bf04c37d30ac1e2bb3c3564b27a6 Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Tue, 21 Feb 2023 22:05:56 -0500
Subject: unifi: add docs

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

(limited to 'roles/unifi')

diff --git a/roles/unifi/README.md b/roles/unifi/README.md
new file mode 100644
index 0000000..18e128a
--- /dev/null
+++ b/roles/unifi/README.md
@@ -0,0 +1,35 @@
+Unifi
+=====
+
+Description
+-----------
+
+The `unifi` role installs the [UniFi](https://www.ui.com/wi-fi) controller, a
+web application used to manage Ubiquiti's UniFi line of wireless access points.
+
+This role currently requires Rocky Linux 8 due to unavailability of packages
+in EPEL 9.
+
+
+Variables
+---------
+
+This role does not accept any variables.
+
+This role **exports** the following variables:
+
+Variable              | Description
+----------------------|------------
+`unifi_archive_shell` | Shell command to backup UniFi configuration data
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure unifi controller
+  hosts: unifi_controllers
+  roles:
+    - role: unifi
+````
-- 
cgit