Repository files navigation

• 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 information

Core:

• GNU make
• pkg-config
• GCC 8 or clang 5
• CMake 3.13

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.4+ 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):

• Boost.Locale 1.70 or later
• gettext is a build dependency

Argon2 password hash:

• libargon2

Installation from source code is performed using the CMake toolchain.

mkdir buildcd buildcmake ..makemake install

You can usecmake-gui orccmake for more interactiveness.

There is alsoconfigure.sh which should make migration to CMake easier:it accepts the same parameters as old./configure,but calls CMake with CMake-style parameters.

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

If you want to install ZNC in a custom path, runcmake with the-DCMAKE_INSTALL_PREFIX argument or./configure with--prefix argument.Example:cmake .. -DCMAKE_INSTALL_PREFIX=/home/user/znc

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

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

If you are using SSL you should doznc --makepem

When you create your ZNC configuration file via --makeconf, you are askedtwo 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 toZNC you get a buffer replay for each channel which shows what was saidlast. This option selects the number of lines this replay should consistof. Increasing this can greatly increase ZNC's memory usage if you arehosting 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 isdeleted. If this is enabled, the buffer is not deleted. This may be usefulif you regularly use more than one client to connect to ZNC.

Once you have started ZNC you can connect with your favorite IRC-client toZNC. You should useusername: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 additionallyprovide/msg *modulename help

In its data dir (~/.znc is default) ZNC saves most of its data. The onlyexception 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 iscreated withznc --makepem.

These directories are also in there:

• configs - Containsznc.conf (ZNC's config file) and backups of olderconfigs.
• 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 moddatadirectory and a directory for each network configured.

This file shouldn't be too hard too understand. An explanation of all theitems can be found on theConfiguration page.Warning: it is better not to edit config while ZNC is running. Use thewebadmin andcontrolpanel modules instead.

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

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

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

For additional info look in the wiki:

• Writing modules

Perl modules are loaded through the global moduleModPerl.

Python modules are loaded through the global moduleModPython.

Please visithttps://znc.in/ or #znc on Libera.Chat if you still have questions:

• ircs://irc.libera.chat:6697/#znc

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