ZNC: Difference between revisions

Revision as of 03:59, 17 December 2011

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 EFNet.

The latest stable release is 1.9.1 (ChangeLog).

Download ZNC 1.9.1

You can find the latest stable release here!

How does it work?

Install ZNC on your server.
Generate an initial configuration via znc --makeconf.
- 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.
- 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.
- It's a good idea to use username:password as the password in your client, so that (even for broken clients) ZNC can figure out which user you are connecting as.
Read the FAQ if you run into any problems. Feel free to ask on IRC if you need more help.
Enjoy! (Profit?)

Main Features

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. Each user can connect to one IRC network.
Multiple Clients: Connect to the same user 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.
DCC Bouncing: Transparent bouncing for DCC anonymity.
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.
Screenshot of the Webadmin module in action

Getting started

Further Info

Writing modules

External Links

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

@@ Line 1: / Line 1: @@
-'''MediaWiki has been successfully installed.'''
+__NOTOC__ {{Languages}}
-Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
+Welcome to the '''ZNC wiki''' where you may find and publish information about '''ZNC''', an advanced [http://en.wikipedia.org/wiki/BNC_%28software%29#IRC 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.
+[[File:Znc-0.99-black.png|right]]
+You can find us in [irc://irc.efnet.org/znc #znc on EFNet].
+The latest stable release is '''{{ZNC-Version}}''' ([[ChangeLog]]).
+== Download ZNC {{ZNC-Version}} ==
+You can find the latest stable release '''[http://znc.in/releases/znc-{{ZNC-Version}}.tar.gz <span style="color:#FF0000">here</span>]'''!
+== How does it work? ==
+* Install ZNC on your server.
+* Generate an initial [[configuration]] via <code>znc --makeconf</code>.
+** '''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.
+** You can later change settings (add more users, tune existing ones, etc.) via the [[webadmin|web interface]] or from [[admin|IRC]].
+* Configure your IRC client to connect to your ZNC server.
+** It's a good idea to use <code>username:password</code> as the '''password''' in your client, so that ''(even for broken clients)'' ZNC can figure out which user you are connecting as.
+* Read the [[FAQ]] if you run into any problems. Feel free to ask on IRC if you need more help.
+* Enjoy! (Profit?)
+== Main Features ==
+; [[Modules|Modules]] : ZNC supports dynamic loading of [[Writing modules|C++]], [[modperl|Perl]], [[modpython|Python]] and [[modtcl|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. Each user can connect to one IRC network.
+; Multiple Clients : Connect to the same user 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.
+; DCC Bouncing : Transparent bouncing for DCC anonymity.
+; 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. [[Image:Webadmin-settings-dark-clouds.png|thumb|Screenshot of the [[Webadmin]] module in action]]
 == Getting started ==
-* [//www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
+* [[Portability]]
-* [//www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
+* [[Installation|Download and Installation]]
-* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
+* [[Configuration]]
+* [[FAQ]]
+* [[Using commands|Using ZNC]]
+=== Further Info ===
+* [[Using ident spoofs|Setting up ident spoofs via oidentd]]
+* [[Chroot]]
+* [[ZNC Backup]]
+* [[ExternalTools]]
+* [[StartSSL|Using signed SSL cert]]
+=== Writing modules ===
+* [[Writing modules|Writing C++ modules]]
+* [[modperl|Writing Perl modules]]
+* [[modtcl|Writing Tcl modules]]
+* [[modpython|Writing Python modules]]
+* [[Debugging]]
+== External Links ==
+'''Please note that as of February 2011 we have abandoned SourceForge and moved to GitHub.'''
+* [https://github.com/znc/znc ZNC project page on GitHub]
+* [http://freshmeat.net/projects/znc ZNC on FreshMeat]
+* [http://www.ohloh.net/p/znc ZNC on Ohloh]
+[[Category:ZNC]]