diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-27 21:04:18 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-27 21:04:18 -0500 |
| commit | 4b03751056ebaa82e47aad0512780fe511702070 (patch) | |
| tree | 87168c73661b4ac84a9bad07870974956dd2da2e | |
| parent | e5e660c6ed74c31ed1e79c5f5cd7e75e1adfdb92 (diff) | |
| download | selfhosted-4b03751056ebaa82e47aad0512780fe511702070.tar.gz selfhosted-4b03751056ebaa82e47aad0512780fe511702070.zip | |
znc: add docs
| -rw-r--r-- | roles/znc/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
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 +```` |