To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Configuration and Template:Providers/table: Difference between pages

From ZNC
(Difference between pages)
Jump to navigation Jump to search
>Jpnurmi
m remove duplicate User/TimestampFormat
 
m updated connectivity, name, URL, and IRC support links for QZ -> TechnoFAQZNC
 
Line 1: Line 1:
{{Languages|Configuration}}
<noinclude>
 
<!--
== Creating a config file ==
======================================================================
To generate a basic configuration file, run <code>znc --makeconf</code> after installation.
For location codes, please refer to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
It is NOT a good idea to create a new config file manually, please use <code>znc --makeconf</code>!
Use exceptions, most notably UK instead of GB, listed here https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Exceptional_reservations
 
======================================================================  
== File locations ==
Providers are sorted by "Date Started", which is either the date in which the provider officially started delivering services, the date
 
their domain was registered (if reliable information), or the date added to the ZNC table list.
* '''Configuration''' - ZNC gets its configuration by reading the file <code>~/.znc/configs/znc.conf</code>.
-->
* '''Misc''' - Other files are also stored in the <code>~/.znc</code> directory, such as the SSL certificate (znc.pem) and the PidFile (znc.pid).
</noinclude>[<span class="plain links">[{{fullurl:Template:Providers/table|action=edit}} Edit data]</span>]
* '''Local Modules''' - Stored in <code>~/.znc/modules</code>. ZNC will look in the local module directory first when trying to load a module.
{| class="wikitable sortable" border="1"
* '''Global Modules''' - Stored in <code>/usr/local/lib/znc</code> by default (where <code>/usr/local</code> is the prefix you chose). This is <code>/usr/lib/znc</code> if you used the Debian package.
! rowspan="2" | Provider
* '''Binaries''' - <code>znc</code>, <code>znc-config</code>, and <code>znc-buildmod</code> are all stored in <code>/usr/local/bin</code> (or in <code>/usr/bin</code>) by default. You can change this when you configure by using <code>./configure --prefix=/whatever/path/you/want</code>.
! colspan="2" | Max Networks per User
 
! rowspan="2" | ZNC Version
== Editing config ==
! rowspan="2" | Language
In most cases you '''should NOT''' edit znc.conf directly.
! rowspan="2" | Connectivity<br><small style="font-weight:normal">(to destination networks)</small>
Use [[webadmin]] instead.
! rowspan="2" class="unsortable" | IRC Support
 
! rowspan="2" | Date Started
If you ''really'' need to edit znc.conf by hand, do the following:
! rowspan="2" class="unsortable" | ZNC locations<br><small style="font-weight:normal">([[wikipedia:ISO 3166-1 alpha-2#Officially_assigned_code_elements|country codes]], using [[wikipedia:ISO 3166-1 alpha-2#Exceptional_reservations|exceptions]])</small>
# pkill -SIGUSR1 znc
! rowspan="2" class="unsortable" | Notes
#: to save current runtime configuration to znc.conf
|-
# pkill znc
! Default
#: to shutdown running ZNC instance
! Premium
# Edit znc.conf
|-
# znc
|-
#: to start it again with new configuration
|[https://bnc4free.com BNC4FREE]
 
| 3
== Config file structure ==
|
 
| 1.8.1*
<span style="font-size:xx-large">This is outdated!</span>
| English
 
| both
Basically, a configuration file consists of the following settings:
| {{irc|chat.freenode.net|bnc4free}}
 
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2009-01-05
<!-- Please keep this in the order it is inside the znc.conf. Sorry, but no idea what that order is. I just used the order that is used inside the source code, but if you want me to guess: The file is written with alphabetical order. -->
| <abbr title="United Kingdom">UK</abbr>
<!-- This will in theory make it simpler to check/verify against a znc.conf -->
|
<!-- GLOBAL SETTINGS -->
|-
* '''AnonIPLimit''' - Limits the number of unidentified connections per IP.
|[https://www.xshellz.com xShellz]
* '''ConnectDelay''' - The time every connection will be delayed, in seconds. Some servers refuse your connection if you reconnect too fast. This affects the connection between ZNC and the IRC server; not the connection between your IRC client and ZNC.
| 2
* '''MaxBufferSize''' - Sets the global Max Buffer Size a user can have.
| data-sort-value="30" | 12, 20, or 30
* '''ProtectedWebSessions''' - ...
| 1.6.1
* '''SSLCertFile''' - It's the TLS/SSL certificate file from which ZNC reads its server certificate.
| English
* '''ServerThrottle''' - The time between two connect attempts to the same hostname.
| both
* '''Skin''' - ...
| {{irc|chat.freenode.net|xShellz}}
* '''Motd''' - ...
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2009-03-01
* '''TrustedProxy''' - ...
| <abbr title="United States of America">US</abbr>, <abbr title="United Kingdom">UK</abbr>
* '''LoadModule''' - ...
|
* '''StatusPrefix''' - The prefix for the status and module queries. This setting may be overwritten by users.
|-
* '''Version''' - The ZNC version that wrote this file.
|[https://lunarbnc.net LunarBNC]
<!-- No clue what order the rest of these go.. sort these later -->
| unlimited
* '''ISpoofFile''' - ZNC will write the ident of the user trying to connect to this file. Very useful if your shell supports oidentd.
|
* '''ISpoofFormat''' - The format of the ISpoofFile.
| 1.8.0*
* '''PidFile''' - Make ZNC write a pid file. ZNC does not need this itself. See [[FAQ#How_can_I_restart_ZNC_automatically_.28in_case_of_a_machine_reboot.2C_crash.2C_etc..29.3F|the FAQ]] on info how to crontab ZNC.
| English
* '''MOTD''' - The "message of the day" which is sent to clients on connect via notice from *status. Can be specified multiple times.
| IPv6 <small>(IPv4 requires Premium)</small>
* '''BindHost''' - This is a list of allowed bindhosts. It is used by the [[webadmin]] module for users to select one. (Set different bindhosts in "Settings" on your Webadmin-Interface first - one per line - to make them appear in users configs afterwards)
| {{irc|irc.lunarirc.net|lunarbnc}}
* '''Listener''' = ''[web_only|irc_only] [host or IP] [+]port'' - Configuration of listening port. Use ''web_only'' or ''irc_only'', if you don't want port to be universal. Put host/IP before the port with a space between to bind to a specific IP ''(notice that in this case the listener can't listen on both ipv4 and ipv6)''. Then goes the port ZNC will listen on. If the port is prepended with a '+' (without space) then ZNC listens using SSL. You can have several listeners in one ZNC. (Introduced in [[ChangeLog/0.090|0.090]], see next chapter for older versions)
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2014-09-03
* '''Listener4''' or '''Listener6''' - Exactly the same as '''Listener''', but will use only IPv4 or IPv6.
| <abbr title="Germany">DE</abbr>
 
|
<!-- The above Listener is outdated, instead ZNC now generates a Listener section -->
|-
<!-- LISTENER SETTINGS -->
|[https://znc.bg ZNC.BG]
* '''Listener''' - Definition of a port that znc should listen on.
| 1
** '''Host''' - The host or IP on which ZNC listens.
|
** '''URIPrefix''' - Prefix that ZNC should make the web interface available under. This can be used to make ZNC available behind a reverse proxy.
| 1.6.3*  
** '''Port''' - The port number used.
| English
** '''IPv4''' - If this port is listening using IPv4.
| both
** '''IPv6''' - If this port is listening using IPv6.
| {{irc|irc.v.bg|znc}}
** '''SSL''' - If this port is listening using SSL.
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2016-01-25
** '''AllowIRC''' - If IRC connections are allowed on this listener.
| <abbr title="Bulgaria">BG</abbr>, <abbr title="Czech Republic">CZ</abbr>, <abbr title="Germany">DE</abbr>, <abbr title="Italy">IT</abbr>
** '''AllowWeb''' - If web connections are allowed on this listener.
|
 
|-
<!-- USER SETTINGS -->
|[https://technofaq.org TechnoFAQZNC]
* '''User''' - The user definition, you can have more than one. Each user may only connect to one network, so you need a separate user for each network. This is intended behavior! (See the [[FAQ]] about multiple networks)
| 3 (more upon request)
** '''Admin''' - If set to <code>true</code>, the user has admin rights (e.g. in the [[webadmin]] module).
| 10 (more upon request)
<!-- So, this is at the end of the user, just stick it up here. -->
| 1.8.1
** '''Pass''' - Used by the client to connect to ZNC. A hash may be generated using <code>znc --makepass</code>.
| English
*** '''Salt''' - ...
| IPv6 <small>(IPv4 requires Premium)</small>
*** '''Method''' - ...
| {{irc|chat.freenode.net|TechnoFAQZNC}}
*** '''Hash''' - ...
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2017-11-02
** '''Allow''' - By default everyone is able to connect to ZNC as this user. With an ''Allow'' line you can restrict access to the specified IPs. Wildcards (*) are supported and multiple ''Allow'' lines can be set up.
| <abbr title="France">FR</abbr>, <abbr title="Norway">NO</abbr>
** '''AltNick''' - The alternate nick ZNC will use if your main nick is in use.
|
** '''AppendTimestamp''' - Whether to append the [[timestamps]] to the message or not
|-
** '''RealName''' - ...
|[https://pastebin.com/raw/eDaeLZhn bnc4you]
** '''Bindhost''' - ...
| 4 (freenode + 3 choices)
** '''AutoClearChanBuffer''' - If set to <code>false</code>, it will buffer channels even while you are attached, and play the whole buffer back to you each time you connect. If set to <code>true</code>, it won't buffer channels while you are attached, and the buffer will be reset upon each playback.
|  
** '''AutoClearQueryBuffer''' - If set to <code>false</code>, it will buffer queries even while you are attached, and play the whole buffer back to you each time you connect. If set to <code>true</code>, it won't buffer queries while you are attached, and the buffer will be reset upon each playback.
| 1.8.1
** '''Buffer''' - ...
| English
** '''CTCPReply''' - A request-reply-pair for CTCP-requests. Format: <code><request> <reply></code>, e.g. <code>VERSION unknown v1.0</code>
| IPv4-only
** '''ChanModes''' - Default modes ZNC will set when you join an empty channel.
| {{irc|chat.freenode.net|#bnc4you}}
** '''Buffer''' - This is the amount of lines that the playback buffer will store before dropping off the oldest line. The buffers are stored in the memory by default.
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2018-03-03
** '''DCCBindHost''' - ...
| <abbr title="Turkey">TR</abbr>
** '''DenyLoadMod''' - If set to <code>true</code>, the user isn't able to load modules.
|
** '''DenySetBindHost''' - If set to <code>true</code>, the user isn't able to change his vhost.
|-
** '''Ident''' - ...
|[https://ircnow.org IRCNow]
** '''JoinTries''' - How often should ZNC try to join if the first join failed, e.g. due to channel mode +i/+k or if you're banned.
| 100 (more upon request)
** '''LoadModule''' - Load a [[Modules|module]] for this user on startup.
|
** '''MaxJoins''' - How many channels should ZNC join at once. Lower this if you get disconnected for 'Excess flood.
| 1.7.4
** '''MaxNetworks''' - Maximum number of networks a user is allowed to have.
| English / Chinese / Urdu / Tamil / Spanish
** '''MultiClients''' - Set this to <code>true</code>, if you want to be able to connect with multiple clients at once.
| both
** '''Nick''' - Your primary nick.
| {{irc|irc.ircnow.org|ircnow}}
** '''PrependTimestamp''' - Whether to prepend the [[timestamps]] to the message or not
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2019-08-26
** '''QuitMsg''' - The default quit message ZNC will use when you jump servers or call shutdown.
| <abbr title="Luxembourg">LU</abbr>, <abbr title="United States of America">US</abbr>
** '''RealName''' - ...
| <small>hostile to LGBT</small>
** '''Skin''' - ...
|-
** '''StatusPrefix''' - The prefix for the status and module queries.
|[https://pastebin.com/raw/tqTixMFS QualityZNC]
** '''TimestampFormat''' - The format for the [[timestamps]] used in buffers, for example <code>[%H:%M:%S]</code>
| 2 (freenode + 1 choice)
<!-- Sort these later ... -->
|
** '''DCCVHost''' - This is the IP address used for DCC bouncing.
| 1.8.0
** '''BounceDCCs''' - If set to <code>true</code>, the DCCs will be bounced by ZNC.
| English
** '''DCCLookupMethod''' - If set to <code>default</code>, ZNC will use the IP the clients sends for the DCC connections; if set to <code>client</code>, ZNC will use the IP the client connects from.
| both
** '''Timezone''' - Set this to your local setting, so you'll get correct times in your [[timestamps]]. Format is Europe/Berlin, and is case sensitive, dropdown box will not work in IE.
| {{irc|chat.freenode.net|#QualityZNC}}
** '''ClientEncoding''' - ...
| <span style="display:none">&{{#expr:3e11+{{#time:U|..}}}}</span>2020-02-09
<!-- End of sort later -->
| <abbr title="Germany">DE</abbr>
 
|
<!-- NETWORK SETTINGS -->
|}
* '''Network'''
** '''FloodBurst''' - How many lines ZNC sends at once.
** '''FloodRate''' - How many lines per second ZNC sends after the FloodBurst
** '''IRCConnectEnabled''' - If set to <code>false</code>, user doesn't connect to IRC servers.
** '''LoadModule''' - Load a [[Modules|module]] for this network on startup.
** '''Server''' - Adds a server to the list of servers this user will be able to connect to. If you want ZNC to connect to the IRC server using SSL, put '+' in front of the port number. The IP can be IPv6. If the server requires a password, just add it as the third argument. Format: <code>Server = <IP-Address/Host> [+]<Port> [<Password>]</code>
<!-- check to sort these later ... -->
** '''Nick''' - ...
** '''AltNick''' - ...
** '''Ident''' - ...
** '''RealName''' - ...
** '''BindHost''' - ...
** '''Encoding''' - ...
** '''JoinDelay''' - Defines the delay in seconds, until channels are joined after getting connected.
** '''QuitMsg''' - A network specific quit message ZNC will use when you jump servers or call shutdown.
** '''Chan''' - Channels you want ZNC to join when connecting.
<!-- check to sort these later ... -->
*** '''Key''' - Key for the channel.
*** '''Modes''' - Use this to override the '''ChanModes''' setting set in the User section.
*** '''Buffer''' - Use this to override the '''Buffer''' setting set in the User section.
*** '''AutoClearChanBuffer''' - Use this to override the '''AutoClearChanBuffer''' setting set in the User section.
*** '''Detached''' - If <code>true</code>, ZNC will join this channel as [[Detaching|detached]] so that the IRC client will not be bothered by it.
*** '''Disabled''' - If <code>true</code>, ZNC will not join this channel at all.
 
=== Old versions ===
Before 0.096
* '''BindHost''' was named '''vHost'''
Before 0.090:
* '''Listen''' was similar to '''Listener4''' from last version, without ''irc_only''/''web_only'' support.
* '''Listen6''' was similar to '''Listener''' or '''Listener6''' (depending on your OS) from last version, without ''irc_only''/''web_only'' support.
* TODO: When did Listeners become their own substructure?
 
[[Category:ZNC]]

Revision as of 20:27, 19 July 2020

[Edit data]

Provider Max Networks per User ZNC Version Language Connectivity
(to destination networks)
IRC Support Date Started ZNC locations
(country codes, using exceptions)
Notes
Default Premium
BNC4FREE 3 1.8.1* English both #bnc4free@chat.freenode.net &3017117040952009-01-05 UK
xShellz 2 12, 20, or 30 1.6.1 English both #xShellz@chat.freenode.net &3017117040952009-03-01 US, UK
LunarBNC unlimited 1.8.0* English IPv6 (IPv4 requires Premium) #lunarbnc@irc.lunarirc.net &3017117040952014-09-03 DE
ZNC.BG 1 1.6.3* English both #znc@irc.v.bg &3017117040952016-01-25 BG, CZ, DE, IT
TechnoFAQZNC 3 (more upon request) 10 (more upon request) 1.8.1 English IPv6 (IPv4 requires Premium) #TechnoFAQZNC@chat.freenode.net &3017117040952017-11-02 FR, NO
bnc4you 4 (freenode + 3 choices) 1.8.1 English IPv4-only ##bnc4you@chat.freenode.net &3017117040952018-03-03 TR
IRCNow 100 (more upon request) 1.7.4 English / Chinese / Urdu / Tamil / Spanish both #ircnow@irc.ircnow.org &3017117040952019-08-26 LU, US hostile to LGBT
QualityZNC 2 (freenode + 1 choice) 1.8.0 English both ##QualityZNC@chat.freenode.net &3017117040952020-02-09 DE