ZNC with some customizations
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tyler Sommer b5c2e67aaa
Add tokauth and webstatus modules
7 months ago
.ci crowdin: Use separate keys for pushing to znc and znc-jenkins 1 year ago
cmake Welcome to 2019 7 months ago
docker @ 0a6de9c970 Update docker submodule to make this directory less confusing 1 year ago
include Merge pull request #1628 from dgw/welcome-to-2019 7 months ago
m4 Bump GCC requirements to 4.8. Close #1442 1 year ago
man Add a SEE ALSO section to znc(1) man page. 2 years ago
modules Add tokauth and webstatus modules 6 months ago
src Update translations from Crowdin for pt_BR 7 months ago
test Merge pull request #1628 from dgw/welcome-to-2019 7 months ago
third_party Update googletest to latest version and cleanup integration test. 1 year ago
translations Create fr-FR translation 11 months ago
webskins Remove Guest string and user IP from web UI 1 year ago
zz_msg Welcome to 2019 7 months ago
.appveyor.yml AppVeyor: don't cache cygwin packages, they are over cache size limit 1 year ago
.clang-format clang-format: switch tabs to spaces 3 years ago
.codecov.yml Improve codecov config 1 year ago
.dockerignore Build Docker image from git on Travis 1 year ago
.gitignore Add /install_manifest.txt and /install_manifest_*.txt to .gitignore. 2 years ago
.gitmodules Build Docker image from git on Travis 1 year ago
.travis-coverity-scan.py Setup Coverity scan. 3 years ago
.travis-coverity.yml Travis: don't build twice for coverity (again) 3 years ago
.travis-generate-docs.sh Setup Coverity scan. 3 years ago
.travis-github.enc Replace travis keys and don't download travis_after_all.py 5 years ago
.travis.ssh Setup Coverity scan. 3 years ago
.travis.yml Travis: run parts of the Docker build even for pull requests 8 months ago
CMakeLists.txt Welcome to 2019 7 months ago
CONTRIBUTING.md Switch znc.in URLs to https 2 years ago
ChangeLog.md Increase the version number to 1.7.2 7 months ago
Dockerfile Update alpine to 3.8 in Dockerfile for nightlies 8 months ago
Doxyfile Fix spelling in documentation 2 years ago
Jenkinsfile Update jenkins config 2 years ago
LICENSE Change ZNC license to Apache 2.0 6 years ago
Makefile.in Fix latest changes in integration test in autoconf mode 1 year ago
NOTICE Yet another attempt to use CMake 3 years ago
README.md README: mention i18n 1 year ago
ZNCConfig.cmake.in Export CMake target more cleanly. 1 year ago
autogen.sh Make error message from ./bootstrap.sh less confusing. 4 years ago
bootstrap.sh Add bootstrap.sh as symlink to autogen.sh 8 years ago
configure.ac Merge branch '1.7.x' 9 months ago
configure.sh CMake: use pkg-config to find python. 2 years ago
make-tarball.sh Automatically discover DESC value in `make-tarball.sh` 7 months ago
translation_pot.py Crowdin doesn't require Project-Id-Version in .pot anymore. 1 year ago
version.sh Fix version.sh for ancient git 2 years ago
znc-buildmod.cmake.in Fix #1536 1 year ago
znc-buildmod.in Merge branch '1.6.x' 3 years ago
znc-uninstalled.pc.in Switch znc.in URLs to https 2 years ago
znc.pc.cmake.in Switch znc.in URLs to https 2 years ago
znc.pc.in Switch znc.in URLs to https 2 years ago
znc.service.in Yet another attempt to use CMake 3 years ago

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