Official repository for the ZNC IRC bouncer
C++ JavaScript CMake M4 CSS Python Other
Permalink
Failed to load latest commit information.
cmake Enable i18n in CI Jan 31, 2016
include Merge pull request #1277 from xnrand/master Aug 20, 2016
m4 configure: Fix C++11 test with -Werror=missing-declarations Feb 23, 2015
man Update man page: znc-config doesn't exist anymore Jun 11, 2013
modules Improve accessibility of add/edit channel Aug 24, 2016
src Merge pull request #1277 from xnrand/master Aug 20, 2016
test Add more debug output to test which often hangs on cygwin Jul 30, 2016
third_party Update Csocket to the latest revision (b3c574c) Feb 8, 2016
webskins Improve accessibility of login form Aug 24, 2016
zz_msg Yet another attempt to use CMake Jan 15, 2016
.appveyor.yml Enable i18n in CI Jan 31, 2016
.clang-format clang-format: switch tabs to spaces Dec 7, 2015
.gitignore Reorder lines in .gitignore Aug 25, 2016
.gitmodules Import latest gtest to third_party to be able to use gmock Sep 6, 2015
.travis-coverity-scan.py Setup Coverity scan. Oct 28, 2015
.travis-coverity.yml Travis: don't build twice for coverity (again) Oct 30, 2015
.travis-generate-docs.sh Setup Coverity scan. Oct 28, 2015
.travis-github.enc Replace travis keys and don't download travis_after_all.py Apr 30, 2014
.travis.ssh Setup Coverity scan. Oct 28, 2015
.travis.yml Merge branch '1.6.x' Apr 1, 2016
.travis_after_all.py Replace travis keys and don't download travis_after_all.py Apr 30, 2014
AUTHORS Change ZNC license to Apache 2.0 Jun 13, 2013
CMakeLists.txt Fix cmake build with broken sasl Feb 14, 2016
CONTRIBUTING.md CONTRIBUTING.md: ask -D with issues in connection Sep 13, 2015
ChangeLog.md Add network-specific config for cert validation May 19, 2016
Doxyfile Fixed few misspellings Jan 5, 2016
LICENSE Change ZNC license to Apache 2.0 Jun 13, 2013
Makefile.in Add framework for translating ZNC to different languages Jan 31, 2016
NOTICE Yet another attempt to use CMake Jan 15, 2016
README.md Use any available python version in configure cmake wrapper Jan 16, 2016
ZNCConfig.cmake.in Yet another attempt to use CMake Jan 15, 2016
autogen.sh Make error message from ./bootstrap.sh less confusing. Aug 11, 2015
bootstrap.sh Add bootstrap.sh as symlink to autogen.sh May 8, 2011
configure.ac Yet another attempt to use CMake Jan 15, 2016
configure.sh Add framework for translating ZNC to different languages Jan 31, 2016
make-tarball.sh Yet another attempt to use CMake Jan 15, 2016
translation_pot.py Fix couple of bugs in i18n when source string contains non-ASCII char… Feb 24, 2016
version.sh Fix -DVERSION_EXTRA="foo" Jul 21, 2015
znc-buildmod.cmake.in Bump CMake requirement to 3.1 and fix code which requires 3.2+ Jan 17, 2016
znc-buildmod.in Merge branch '1.6.x' Jan 7, 2016
znc-uninstalled.pc.in Fix znc-buildmod on cygwin when installed to not /usr Aug 22, 2015
znc.pc.cmake.in Yet another attempt to use CMake Jan 15, 2016
znc.pc.in Fix znc-buildmod on cygwin when installed to not /usr Aug 22, 2015
znc.service.in Yet another attempt to use CMake Jan 15, 2016

README.md

ZNC - An advanced IRC bouncer

Travis Build Status AppVeyor Build status Bountysource Coverage Status Coverity Scan Build Status

Table of contents

  • Minimal Requirements
  • Optional Requirements
  • Installing ZNC
  • Setting up znc.conf
  • Special config options
  • Using ZNC
  • File Locations
  • ZNC's config file
  • Writing own modules
  • Further infos

Minimal Requirements

Core:

  • GNU make
  • pkg-config
  • GCC 4.7 or clang 3.2
  • Either of:
    • autoconf and automake (but only if building from git, not from tarball)
    • CMake

Optional Requirements

SSL/TLS support:

  • openssl 0.9.7d or later
    • try installing openssl-dev, openssl-devel or libssl-dev
    • Mac OS X: OpenSSL from Homebrew is preferred over system

modperl:

  • perl and its bundled libperl
  • SWIG if building from git

modpython:

  • python and its bundled libpython
  • perl is required
  • Mac OS X: Python from Homebrew is preferred over system version
  • SWIG if building from git

cyrusauth:

  • This module needs cyrus-sasl2

Character Encodings:

  • To get proper character encoding and charsets install ICU (libicu4-dev)

Installing ZNC

Currently there are 2 build systems in place: CMake and ./configure. ./configure will eventually be removed. There is also configure.sh which should make migration to CMake easier: it accepts the same parameters as ./configure, but calls CMake with CMake-style parameters.

Installing with CMake

Installation from source code is performed using the CMake toolchain.

cmake .
make
make install

You can use cmake-gui or ccmake for more interactiveness.

Note for FreeBSD users: By default base OpenSSL is selected. If you want the one from ports, use -DOPENSSL_ROOT_DIR=/usr/local.

For troubleshooting, cmake --system-information will show you details.

Installing with ./configure

Installation from source code is performed using the automake toolchain. If you are building from git, you will need to run ./autogen.sh first to produce the configure script.

./configure
make
make install

You can use ./configure --help if you want to get a list of options, though the defaults should be suiting most needs.

Setting up znc.conf

For setting up a configuration file in ~/.znc you can simply do znc --makeconf or ./znc --makeconf for in-place execution.

If you are using SSL you should do znc --makepem

Special config options

When you create your ZNC configuration file via --makeconf, you are asked two questions which might not be easy to understand.

Number of lines to buffer per channel

How many messages should be buffered for each channel. When you connect to ZNC you get a buffer replay for each channel which shows what was said last. This option selects the number of lines this replay should consist of. Increasing this can greatly increase ZNC's memory usage if you are hosting many users. The default value should be fine for most setups.

Would you like to keep buffers after replay?

If this is disabled, you get the buffer playback only once and then it is deleted. If this is enabled, the buffer is not deleted. This may be useful if you regularly use more than one client to connect to ZNC.

Using ZNC

Once you have started ZNC you can connect with your favorite IRC-client to ZNC. You should use username:password as the server password (e.g. /pass user:pass).

Once you are connected you can do /msg *status help for some commands. Every module you have loaded (/msg *status listmods) should additionally provide /msg *modulename help

File Locations

In its data dir (~/.znc is default) ZNC saves most of its data. The only exception are modules and module data, which are saved in <prefix>/lib/znc and <prefix>/share/znc, and the znc binary itself. More modules (e.g. if you install some later) can be saved in <data dir>/modules (-> ~/.znc/modules).

In the datadir is only one file:

  • znc.pem - This is the server certificate ZNC uses for listening and is created with znc --makepem.

These directories are also in there:

  • configs - Contains znc.conf (ZNC's config file) and backups of older configs.
  • modules - ZNC also looks in here for a module.
  • moddata - Global modules save their settings here. (e.g. webadmin saves the current skin name in here)
  • users - This is per-user data and mainly contains just a moddata directory.

ZNC's config file

This file shouldn't be too hard too understand. An explanation of all the items can be found on the Configuration-Page. Warning: better not to edit config, while ZNC is running. Use the webadmin and controlpanel modules instead.

If you changed some settings while ZNC is running, a simple pkill -SIGUSR1 znc will make ZNC rewrite its config file. Alternatively you can use /msg *status saveconfig

Writing own modules

You can write your own modules in either C++, python or perl.

C++ modules are compiled by either saving them in the modules source dir and running make or with the znc-buildmod shell script.

For additional info look in the wiki:

Perl modules are loaded through the global module ModPerl.

Python modules are loaded through the global module ModPython.

Further infos

Please visit http://znc.in/ or #znc on freenode if you still have questions.

You can get the latest development version with git: git clone https://github.com/znc/znc.git --recursive