|
|
| Line 1: |
Line 1: |
| {{Languages|Configuration}} | | {{DISPLAYTITLE:fix_lagchk}} |
| | {{External Module}} |
|
| |
|
| == Creating a config file ==
| | This user module fixes NoNameScript's and other clients' LAGCHK stuff by sending it to the correct client only. Use it if you are getting spammed with LAGCHK messages when you have two or more clients connected. |
| To generate a basic configuration file, run <code>znc --makeconf</code> after installation.
| |
| It is NOT a good idea to create a new config file manually, please use <code>znc --makeconf</code>!
| |
|
| |
|
| == File locations == | | == Getting the Code == |
| | The code for this module can be found [http://znc-msvc.googlecode.com/svn/trunk/flakes/fix_lagchk.cpp here]. Read here to learn how to compile it: [[Compiling modules]] |
|
| |
|
| * '''Configuration''' - ZNC gets its configuration by reading the file <code>~/.znc/configs/znc.conf</code>.
| | == Usage == |
| * '''Misc''' - Other files are also stored in the <code>~/.znc</code> directory, such as the SSL certificate (znc.pem) and the PidFile (znc.pid).
| | {{Module arguments}} |
| * '''Local Modules''' - Stored in <code>~/.znc/modules</code>. ZNC will look in the local module directory first when trying to load a module.
| |
| * '''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.
| |
| * '''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>.
| |
|
| |
|
| == Editing config == | | == Configuration == |
| In most cases you '''should NOT''' edit znc.conf directly.
| | No further configuration is required. |
| Use [[webadmin]] instead.
| |
|
| |
|
| If you ''really'' need to edit znc.conf by hand, do the following:
| | [[Category:External Modules]] |
| # pkill -SIGUSR1 znc
| |
| #: to save current runtime configuration to znc.conf
| |
| # pkill znc
| |
| #: to shutdown running ZNC instance
| |
| # Edit znc.conf
| |
| # znc
| |
| #: to start it again with new configuration
| |
| | |
| == Config file structure ==
| |
| | |
| <span style="font-size:xx-large">This is outdated!</span>
| |
| | |
| Basically, a configuration file consists of the following settings:
| |
| | |
| <!-- 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. -->
| |
| <!-- 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.
| |
| * '''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.
| |
| * '''MaxBufferSize''' - Sets the global Max Buffer Size a user can have.
| |
| * '''ProtectedWebSessions''' - ...
| |
| * '''SSLCertFile''' - It's the TLS/SSL certificate file from which ZNC reads its server certificate.
| |
| * '''ServerThrottle''' - The time between two connect attempts to the same hostname.
| |
| * '''Skin''' - ...
| |
| * '''Motd''' - ...
| |
| * '''TrustedProxy''' - ...
| |
| * '''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.
| |
| <!-- No clue what order the rest of these go.. sort these later -->
| |
| * '''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.
| |
| * '''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.
| |
| * '''MOTD''' - The "message of the day" which is sent to clients on connect via notice from *status. Can be specified multiple times.
| |
| * '''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)
| |
| * '''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)
| |
| * '''Listener4''' or '''Listener6''' - Exactly the same as '''Listener''', but will use only IPv4 or IPv6.
| |
| | |
| <!-- The above Listener is outdated, instead ZNC now generates a Listener section -->
| |
| <!-- LISTENER SETTINGS -->
| |
| * '''Listener''' - Definition of a port that znc should listen on.
| |
| ** '''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.
| |
| ** '''Port''' - The port number used.
| |
| ** '''IPv4''' - If this port is listening using IPv4.
| |
| ** '''IPv6''' - If this port is listening using IPv6.
| |
| ** '''SSL''' - If this port is listening using SSL.
| |
| ** '''AllowIRC''' - If IRC connections are allowed on this listener.
| |
| ** '''AllowWeb''' - If web connections are allowed on this listener.
| |
| | |
| <!-- USER SETTINGS -->
| |
| * '''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)
| |
| ** '''Admin''' - If set to <code>true</code>, the user has admin rights (e.g. in the [[webadmin]] module).
| |
| <!-- So, this is at the end of the user, just stick it up here. -->
| |
| ** '''Pass''' - Used by the client to connect to ZNC. A hash may be generated using <code>znc --makepass</code>.
| |
| *** '''Salt''' - ...
| |
| *** '''Method''' - ...
| |
| *** '''Hash''' - ...
| |
| ** '''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.
| |
| ** '''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''' - ...
| |
| ** '''Bindhost''' - ...
| |
| ** '''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.
| |
| ** '''Buffer''' - ...
| |
| ** '''CTCPReply''' - A request-reply-pair for CTCP-requests. Format: <code><request> <reply></code>, e.g. <code>VERSION unknown v1.0</code>
| |
| ** '''ChanModes''' - Default modes ZNC will set when you join an empty channel.
| |
| ** '''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.
| |
| ** '''DCCBindHost''' - ...
| |
| ** '''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''' - ...
| |
| ** '''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.
| |
| ** '''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.
| |
| ** '''MaxNetworks''' - Maximum number of networks a user is allowed to have.
| |
| ** '''MaxQueryBuffers''' - Maximum number of query buffers that are stored. <code>0</code> is unlimited.
| |
| ** '''MultiClients''' - Set this to <code>true</code>, if you want to be able to connect with multiple clients at once.
| |
| ** '''Nick''' - Your primary nick.
| |
| ** '''PrependTimestamp''' - Whether to prepend the [[timestamps]] to the message or not
| |
| ** '''QuitMsg''' - The default quit message ZNC will use when you jump servers or call shutdown.
| |
| ** '''RealName''' - ...
| |
| ** '''Skin''' - ...
| |
| ** '''StatusPrefix''' - The prefix for the status and module queries.
| |
| ** '''TimestampFormat''' - The format for the [[timestamps]] used in buffers, for example <code>[%H:%M:%S]</code>
| |
| <!-- Sort these later ... -->
| |
| ** '''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.
| |
| ** '''ClientEncoding''' - ...
| |
| <!-- End of sort later -->
| |
| | |
| <!-- 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 ===
| |
| TODO:
| |
| ** '''DCCVHost''' - This is the IP address used for DCC bouncing.
| |
| ** '''BounceDCCs''' - If set to <code>true</code>, the DCCs will be bounced by ZNC.
| |
| ** '''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.
| |
| 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]]
| |
