Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revisionBoth sides next revision
docs:guide-user:services:znc [2018/03/03 20:55] – ↷ Page moved from docs:user-guide:services:znc to docs:guide-user:services:znc bobafetthotmaildocs:guide-user:services:proxy:znc [2020/05/14 21:32] – [User Definition] broadcomfail
Line 1: Line 1:
-====== 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 =====
Line 12: Line 11:
  
 ==== 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. |
Line 36: Line 36:
  
 ==== 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. |
Line 60: Line 61:
 | ''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. |
 +<code bash>
 + znc /etc/config/znc
 +[ ** ] Unrecognized command line arguments.
 +[ ** ] Did you mean to run `/znc /etc/config/znc' in IRC client instead?
 +[ ** ] Hint: `/znc /etc/config/znc' is an alias for `/msg *status /etc/config/znc'
 +</code>
 +
 +
  • Last modified: 2020/05/28 16:36
  • by broadcomfail