Mirror of the official znc repository https://znc.in
 
 
 
 
 
 
Go to file
ZNC-Jenkins 448246c22f Update translations from Crowdin for 2023-10-01 00:33:49 +00:00
.ci CI: update crowdin contributors file in utf-8 2022-03-18 15:39:09 +00:00
cmake Update copyright in files which were missing in the previous update 2020-01-05 11:37:51 +00:00
docker@95e45def73 Re-enable IPv6 in the bleeding edge docker image 2019-10-17 22:20:15 +01:00
include Use 1.8.x again 2020-09-08 00:01:10 +01:00
m4 Bump GCC requirements to 4.8. Close #1442 2017-12-17 15:09:52 +00:00
man Add a SEE ALSO section to znc(1) man page. 2017-08-26 21:39:39 +01:00
modules Update translations from Crowdin for fr_FR pt_BR tr_TR 2023-09-23 21:09:17 +00:00
src Update translations from Crowdin for fr_FR pt_BR tr_TR 2023-09-23 21:09:17 +00:00
test Fix null pointer dereference in echo-message 2020-05-31 11:45:40 +01:00
third_party Update googletest to latest version and cleanup integration test. 2018-02-09 20:40:28 +00:00
translations Create pl-PL 2020-06-21 23:46:40 +01:00
webskins Web: fix small css errors after #1711 2020-04-05 23:38:26 +02:00
zz_msg Welcome to 2020 2020-01-02 00:36:05 +01:00
.appveyor.yml Appveyor: try to fix build 2019-04-19 18:09:32 +01:00
.clang-format clang-format: switch tabs to spaces 2015-12-07 00:53:30 +00:00
.codecov.yml Improve codecov config 2017-12-17 11:32:29 +00:00
.dockerignore Build Docker image from git on Travis 2018-05-11 09:04:15 +01:00
.gitignore Add /install_manifest.txt and /install_manifest_*.txt to .gitignore. 2017-02-14 22:58:27 +00:00
.gitmodules Build Docker image from git on Travis 2018-05-11 09:04:15 +01:00
.travis-coverity-scan.py Setup Coverity scan. 2015-10-28 00:02:19 +00:00
.travis-coverity.yml Travis: don't build twice for coverity (again) 2015-10-30 01:52:44 +00:00
.travis-generate-docs.sh Setup Coverity scan. 2015-10-28 00:02:19 +00:00
.travis-github.enc Update travis github ssh key 2019-11-07 09:04:37 +00:00
.travis.ssh Setup Coverity scan. 2015-10-28 00:02:19 +00:00
.travis.yml Travis: remove stale workaround for arm file permissions 2020-05-31 12:42:36 +01:00
CMakeLists.txt Use 1.8.x again 2020-09-08 00:01:10 +01:00
CONTRIBUTING.md Switch znc.in URLs to https 2017-05-30 22:32:01 +01:00
ChangeLog.md Increase the version number to 1.8.2 2020-09-07 23:57:31 +01:00
Dockerfile Dockerfile: upgrade Alpine to 3.12 2020-09-08 19:45:57 +01:00
Doxyfile Fix spelling in documentation 2016-11-07 20:53:31 +00:00
Jenkinsfile Update jenkins config 2017-05-12 00:15:50 +01:00
LICENSE Change ZNC license to Apache 2.0 2013-06-14 00:43:34 +04:00
Makefile.in Fix latest changes in integration test in autoconf mode 2018-02-14 08:39:58 +00:00
NOTICE Yet another attempt to use CMake 2016-01-15 10:50:33 +00:00
README.md Support python 3.9 2020-01-05 11:18:44 +00:00
TRANSLATORS.md Update translations from Crowdin for 2023-10-01 00:33:49 +00:00
ZNCConfig.cmake.in Update copyright in files which were missing in the previous update 2020-01-05 11:37:51 +00:00
autogen.sh Make error message from ./bootstrap.sh less confusing. 2015-08-11 20:57:41 +01:00
bootstrap.sh Add bootstrap.sh as symlink to autogen.sh 2011-05-08 15:14:13 +07:00
configure.ac Use 1.8.x again 2020-09-08 00:01:10 +01:00
configure.sh Update copyright in files which were missing in the previous update 2020-01-05 11:37:51 +00:00
make-tarball.sh Stop doing version names like -alpha1-alpha1 2020-03-29 15:38:00 +01:00
translation_pot.py Update copyright in files which were missing in the previous update 2020-01-05 11:37:51 +00:00
version.sh Fix version.sh for ancient git 2016-11-16 15:49:47 +00:00
znc-buildmod.cmake.in znc-buildmod: output where the module was written to 2020-12-25 16:05:04 +00:00
znc-buildmod.in Merge branch '1.6.x' 2016-01-07 20:59:50 +00:00
znc-uninstalled.pc.in Switch znc.in URLs to https 2017-05-30 22:32:01 +01:00
znc.pc.cmake.in Switch znc.in URLs to https 2017-05-30 22:32:01 +01:00
znc.pc.in Switch znc.in URLs to https 2017-05-30 22:32:01 +01:00
znc.service.in Fix path in systemd service (which shouldn't be here at all) 2020-09-22 10:20:47 +01:00

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:

  • python 3.3+ 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