dataset/seed/znc/README.md

---
gitea: none
include_toc: true
---

# znc

## Synopsis

ZNC, a bouncer IRC.

[More informations about this software.](https://wiki.znc.in/)

## Basic variables

### Général

#### IRC Bouncer ZNC

| Parameter                                                                                                                                                                                                                | Comments                                                        |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| **[general.znc.external_domain_name](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine externe de ZNC.<br/>**Example:** irc.example.net |
| **[general.znc.user_name](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)             | Utilisateur IRC et ZNC.<br/>**Example:** jdoe                   |
| **[general.znc.user_password](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)          | Mot de passe de l'utilisateur ZNC.<br/>**Example:** JD0eP@ss    |
| **[general.znc.real_name](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)                | Nom d'utilisateur réel.<br/>**Example:** John Doe               |

##### Serveurs IRC

This a family is a leadership.

| Parameter                                                                                                                                                                                                                          | Comments                                                                    |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| **[general.znc.servers.server_names](dictionaries/40_znc.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse du serveur IRC.<br/>**Example:** irc.oftc.net                       |
| **[general.znc.servers.password](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)                 | Mot de passe de l'utilisateur sur le serveur IRC.<br/>**Example:** p@ssw0rd |
| **[general.znc.servers.channels](dictionaries/40_znc.xml)**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)         | Nom des salons du serveur IRC.<br/>**Example:** example                     |

## Variables

### Général

#### IRC Bouncer ZNC

| Parameter                                                                                                                                                                                                        | Comments                                                                                                                                   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.znc.znc_crt_provider](dictionaries/40_znc.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant le certificat du domaine extérieur.<br/>**Choices:**<br/>- `self-signed` ← (default)<br/>- `letsencrypt` |




## Requirements services

- **ExternalDNS**
- Journald

**bold**: provider is mandatory

## Example

Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.

```
znc:
  applicationservice: znc
  zones_name:
    - localdns
  values:
    general.znc.external_domain_name: irc.example.net
    general.znc.user_name: jdoe
    general.znc.user_password: JD0eP@ss
    general.znc.real_name: John Doe
    general.znc.servers.server_names:
      - irc.oftc.net
    general.znc.servers.password:
      '0': p@ssw0rd
    general.znc.servers.channels:
      '0': example
```

## Dependances

- [base-fedora-36](../base-fedora-36/README.md)
  - [base-fedora](../base-fedora/README.md)
    - [systemd](../systemd/README.md)
      - [base-machine](../base-machine/README.md)
        - [base](../base/README.md)
        - [dns-local](../dns-local/README.md)
        - [pki-tls](../pki-tls/README.md)
      - [journald](../journald/README.md)
      - [resolved](../resolved/README.md)
- [dns-external](../dns-external/README.md)

[All applications services for this dataset.](../README.md)