diff options
author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-21 22:05:56 -0500 |
---|---|---|
committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-21 22:05:56 -0500 |
commit | 74e152dcd0e2bf04c37d30ac1e2bb3c3564b27a6 (patch) | |
tree | 5289e0246f518a06dc654522bb7c39d9530a0f3e /roles/unifi | |
parent | 51d4b0bd8430d31d2bfeb08222cc2168d126612f (diff) | |
download | selfhosted-74e152dcd0e2bf04c37d30ac1e2bb3c3564b27a6.tar.gz selfhosted-74e152dcd0e2bf04c37d30ac1e2bb3c3564b27a6.zip |
unifi: add docs
Diffstat (limited to 'roles/unifi')
-rw-r--r-- | roles/unifi/README.md | 35 |
1 files changed, 35 insertions, 0 deletions
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 +```` |