From 4b03751056ebaa82e47aad0512780fe511702070 Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 27 Feb 2023 21:04:18 -0500
Subject: znc: add docs

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

diff --git a/roles/znc/README.md b/roles/znc/README.md
new file mode 100644
index 0000000..232d669
--- /dev/null
+++ b/roles/znc/README.md
@@ -0,0 +1,41 @@
+ZNC
+===
+
+Description
+-----------
+
+The `znc` role installs and configures the [ZNC](https://znc.in/) IRC bouncer.
+The ZNC application provides both an IRC server and web GUI for configuration.
+User authentication is performed using FreeIPA.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable           | Default          | Description
+-------------------|------------------|------------
+`znc_irc_port`     | 6697             | IRC port
+`znc_https_port`   | 8443             | Local listening port for web interface
+`znc_max_networks` | 10               | Maximum IRC networks per user
+`znc_access_group` |`role-znc-access` | FreeIPA group for ZNC users (will be created)
+
+This role **exports** the following variables:
+
+Variable            | Description
+--------------------|------------
+`znc_archive_shell` | Shell command to create ZNC backup tarball
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure znc
+  hosts: znc_servers
+  roles:
+    - role: znc
+      vars:
+        znc_access_group: znc-users
+````
-- 
cgit