ZNC: Difference between revisions

Revision as of 14:08, 5 July 2015

Languages:

Welcome to the ZNC wiki where you may find and publish information about ZNC, an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without losing the chat session. Feel free to update pages which you think are improvable and don't hesitate to ask for help.

You can find us in #znc on freenode.

The latest stable release is 1.9.1 (ChangeLog).

Download ZNC 1.9.1

You can find the latest stable release here!

Or you can try testing version, using nightly tarball or Git!

Older versions can be found here.

How does it work?

Install ZNC on your server.
Generate an initial configuration via znc --makeconf.
- (0.206 and earlier)
  - For each IRC network, you need to create a ZNC user.
  - For example, use one user for Freenode, one user for EFnet, one user for Quakenet, etc.
- (1.0)
  - Each ZNC user can connect to several IRC networks, though you'll need to connect your IRC client to ZNC several times.
- You can later change settings (add more users, tune existing ones, etc.) via the web interface or from IRC.
Configure your IRC client to connect to your ZNC server.
- If your client has separate username and password fields, that works fine.
  - You can set username as username@clientid/network to connect to a specific network. The network needs to be configured already. Without /network client will be connected to some random network.
- If your client is broken and doesn't support specifying username in well... username, you can use username@clientid/network:password as the password.
- The clientid is included with ZNC starting from 1.6.0. It's optional and is name that you give to your client to recognize it in /msg *status listclients. It's also used by some modules such as chanfilter.
Read the FAQ if you run into any problems. Feel free to ask on IRC if you need more help.
Enjoy! (Profit?)

Main Features

Screenshot of the Webadmin module in action

Modules: ZNC supports dynamic loading of C++, Perl, Python and Tcl modules. To get a list of the available modules and more information follow the link.
Detaching: ZNC will remain connected to IRC even while you are offline. You can then reattach later and catch up with what happened while you were gone, and your nick (and operator status) will have been kept for you.
Multiple Users: You can add additional users under one running process. Useful for public shells that limit background processes.
Multiple Networks: Each user can connect to several IRC networks at once, with an optional limit configured by ZNC admin.
Multiple Clients: Connect to the same user/network with as many clients as you want.
Playback Buffers: Stay up-to-date with what happened and when it happened while you were detached, timestamps are also printed and can be manually configured.
SSL Support: Encryption for both the listen port and connecting to IRC servers. If your system has OpenSSL, ZNC automatically supports SSL connections.
IPv6 Support: Both IPv4 and IPv6 address families just work, if your system supports them.
Partyline: Using the global partyline module, you can join channels and query users on the internal ZNC network
Web Administration: Using the global webadmin module, admins can add/remove/edit users and global settings and non admins can edit their own user settings.

Getting started

Further Info

Writing modules

External Links

Please note that as of February 2011 we have abandoned SourceForge and moved to GitHub.

ZNC project page on GitHub - report bugs/issues here
ZNC on FreshMeat
ZNC on OpenHUB

@@ Line 64: / Line 64: @@
 * [[Configuration|Configuration parameters]]
 * [https://github.com/znc/znc/releases.atom Subscribe to new releases]
-* [[ZNC:Site support|Donate to ZNC]]
 === Writing modules ===