aboutsummaryrefslogtreecommitdiffstats
path: root/roles/znc/README.md
blob: 232d669e2f4cb6b79c5aeb67283fe854b56f5764 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
````