Official repository for the ZNC IRC bouncer
C++ JavaScript CMake M4 CSS Perl Other
Permalink
Failed to load latest commit information.
.ci crowdin: Use separate keys for pushing to znc and znc-jenkins Jun 19, 2018
cmake Welcome to 2018 Jan 19, 2018
docker @ 0a6de9c Update docker submodule to make this directory less confusing May 11, 2018
include Merge branch '1.7.x' Jun 4, 2018
m4 Bump GCC requirements to 4.8. Close #1442 Dec 17, 2017
man Add a SEE ALSO section to znc(1) man page. Aug 26, 2017
modules Update translations from Crowdin for ru_RU Aug 9, 2018
src Update translations from Crowdin for ru_RU Aug 9, 2018
test Fix a warning in integration test / gmake / znc-buildmod interaction. Jun 28, 2018
third_party Update googletest to latest version and cleanup integration test. Feb 9, 2018
translations Create nl_NL Jun 15, 2018
webskins Remove Guest string and user IP from web UI Nov 24, 2017
zz_msg Welcome to 2018 Jan 19, 2018
.appveyor.yml AppVeyor: don't cache cygwin packages, they are over cache size limit Oct 26, 2017
.clang-format clang-format: switch tabs to spaces Dec 7, 2015
.codecov.yml Improve codecov config Dec 17, 2017
.dockerignore Build Docker image from git on Travis May 11, 2018
.gitignore Add /install_manifest.txt and /install_manifest_*.txt to .gitignore. Feb 14, 2017
.gitmodules Build Docker image from git on Travis May 11, 2018
.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 Fix typo in previous commit May 13, 2018
CMakeLists.txt Merge branch '1.7.x' May 12, 2018
CONTRIBUTING.md Switch znc.in URLs to https May 30, 2017
ChangeLog.md Increase the version number to 1.7.1 Jul 17, 2018
Dockerfile Fix "git-unknown" in --version of unstable docker image May 12, 2018
Doxyfile Fix spelling in documentation Nov 7, 2016
Jenkinsfile Update jenkins config May 11, 2017
LICENSE Change ZNC license to Apache 2.0 Jun 13, 2013
Makefile.in Fix latest changes in integration test in autoconf mode Feb 14, 2018
NOTICE Yet another attempt to use CMake Jan 15, 2016
README.md README: mention i18n Mar 19, 2018
ZNCConfig.cmake.in Export CMake target more cleanly. Dec 13, 2017
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 Revert "Make version 1.7.x again for 1.7.x branch" May 5, 2018
configure.sh CMake: use pkg-config to find python. May 28, 2017
fr.zip Update translations from Crowdin for Aug 1, 2018
make-tarball.sh Don't put .ci/ into tarball May 1, 2018
translation_pot.py Crowdin doesn't require Project-Id-Version in .pot anymore. Dec 21, 2017
version.sh Fix version.sh for ancient git Nov 16, 2016
znc-buildmod.cmake.in Fix #1536 May 22, 2018
znc-buildmod.in Merge branch '1.6.x' Jan 7, 2016
znc-uninstalled.pc.in Switch znc.in URLs to https May 30, 2017
znc.pc.cmake.in Switch znc.in URLs to https May 30, 2017
znc.pc.in Switch znc.in URLs to https May 30, 2017
znc.service.in Yet another attempt to use CMake Jan 15, 2016

README.md

ZNC - An advanced IRC bouncer

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

Table of contents

Minimal Requirements

Core:

  • GNU make
  • pkg-config
  • GCC 4.8 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
    • macOS: OpenSSL from Homebrew is preferred over system

modperl:

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

modpython:

  • python3 and its bundled libpython
  • perl is a build dependency
  • macOS: 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)

I18N (UI translation)

  • CMake-based build only
  • Boost.Locale
  • gettext is a build dependency

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.

mkdir build
cd build
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.

mkdir build
cd build
../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: it is 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 information

Please visit https://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