| Both sides previous revision Previous revision Next revision | Previous revision |
| docs:user-guide:services:znc [2018/02/17 21:59] – ↷ Page moved from doc:uci:znc to docs:user-guide:services:znc bobafetthotmail | docs:guide-user:services:proxy:znc [2020/05/28 16:36] (current) – important broadcomfail |
|---|
| ====== ZNC configuration ====== | ====== ZNC IRC network bouncer ====== |
| [[wp>ZNC|ZNC's]] configuration is located in ''/etc/config/znc''. You can use it to configure most common aspects of ZNC. Supplying your own configuration is supported as of 0.998-2. | [[wp>ZNC|ZNC's]] configuration is located in ''/etc/config/znc''. You can use it to configure most common aspects of ZNC. Supplying your own configuration is supported as of 0.998-2. |
| |
| **Note:** This configuration is only for ZNC 0.094 or later. | Notes: |
| | * This configuration is only for ZNC 0.094 or later. |
| **Note:** 10.03.1-rc4's ZNC 0.094 has a hidden dependency to ''libstdcpp''. This is fixed in trunk and recent Backfire builds. | * 10.03.1-rc4's ZNC 0.094 has a hidden dependency to ''libstdcpp''. This is fixed in trunk and recent Backfire builds. |
| | * 10.03.1-rc4's ZNC 0.094 takes 30 seconds until it actually works after starting it. This wait time is removed in trunk. |
| **Note:** 10.03.1-rc4's ZNC 0.094 takes 30 seconds until it actually works after starting it. This wait time is removed in trunk. | |
| |
| ===== Sections ===== | ===== Sections ===== |
| |
| ==== Common Options ==== | ==== Common Options ==== |
| |
| The common section defines where ZNC is supposed to listen, which global modules should be loaded and some other global options. | The common section defines where ZNC is supposed to listen, which global modules should be loaded and some other global options. |
| A minimum configuration looks like this: | A minimum configuration looks like this: |
| | ''config 'znc' | |
| list 'listener' '192.168.1.1 1234''' | | |
| |
| === Valid Options === | <code bash> |
| | config 'znc' |
| | list 'listener' '192.168.1.1 1234' |
| | </code> |
| |
| | === Valid Options === |
| ^ Name ^ Type ^ Required ^ Default ^ Description ^ | ^ Name ^ Type ^ Required ^ Default ^ Description ^ |
| | ''anoniplimit'' | integer | no | ''10'' | Number of anonymous connections allowed. | | | ''anoniplimit'' | integer | no | ''10'' | Number of anonymous connections allowed. | |
| |
| ==== User Definition ==== | ==== User Definition ==== |
| |
| For each connection you want to use you need to create a separate user. Each user section corresponds to one user in ZNC. The section name is the user name for authentication to ZNC itself. | For each connection you want to use you need to create a separate user. Each user section corresponds to one user in ZNC. The section name is the user name for authentication to ZNC itself. |
| |
| A minimal user configuration looks like this: | A minimal user configuration looks like this: |
| |
| | ''config 'user' 'sampleUser' | <code bash> |
| | config 'user' 'sampleUser' |
| option 'password' 'changeme' | option 'password' 'changeme' |
| option 'nick' 'sampleUser''' | | option 'nick' 'sampleUser' |
| | </code> |
| This would create a user with the login ''sampleUser'', the password ''changeme'' and the nick ''sampleUser''. | This would create a user with the login ''sampleUser'', the password ''changeme'' and the nick ''sampleUser''. |
| |
| === Valid Options === | === Valid Options === |
| |
| ^ Name ^ Type ^ Required ^ Default ^ Description ^ | ^ Name ^ Type ^ Required ^ Default ^ Description ^ |
| | ''altnick'' | string | no | //none// | The Alternative Nickname, if the first one is occupied. | | | ''altnick'' | string | no | //none// | The Alternative Nickname, if the first one is occupied. | |
| | ''nick'' | string | Yes | //none// | The Nickname of this user. | | | ''nick'' | string | Yes | //none// | The Nickname of this user. | |
| | ''realname'' | string | no | //<nick>// | The real name of this user. | | | ''realname'' | string | no | //<nick>// | The real name of this user. | |
| | ''password'' | string | Yes | //none// | Password for this user. Can be either a plain text password, or a generated password hash through ''znc -s''. **Note:** ZNC 0.094 supports only plain text. | | | ''password'' | string | Yes | //none// | Password for this user. Can be either a plain text password, or a generated password hash through ''znc -s''. **Note:** ZNC 0.094 supports only plain text.| |
| | Example code for crypted |
| | <code bash> |
| | option 'password' 'sha256#...' |
| | |
| | <Pass password> |
| | Method = sha256 |
| | Hash = 746a8a22b32f22c9dd92e9918b084ac8bcf1c94361d71fd5ee4a7154f86371d4 |
| | Salt = 8+1Isl8ewZ+Bai;tx2ML |
| | </Pass> |
| | </code> |
| | ''quitmsg'' | string | no | //<ZNC default>// | Specifies the quit message used when closing the connection to the server. | | | ''quitmsg'' | string | no | //<ZNC default>// | Specifies the quit message used when closing the connection to the server. | |
| | ''server'' | list of strings | no | //none// | Specifies the list of servers to connect to. The required format "<IP/Host> [+]<Port> [<Password>]", where the "+" indicates that SSL should be used. Both IPv4 and IPv6 addresses are valid. | | | ''server'' | list of strings | no | //none// | Specifies the list of servers to connect to. The required format "<IP/Host> [+]<Port> [<Password>]", where the "+" indicates that SSL should be used. Both IPv4 and IPv6 addresses are valid. | |
| | |
| | |
| | |
| | |