Installation

Languages:

[[::Installation|English]]  • [[::Installation/de|Deutsch]]  • [[::Installation/ru|русский]]  • [[::Installation/fr|français]]  • [[::Installation/id|Bahasa Indonesia]]  • [[::Installation/it|italiano]]  • [[::Installation/pt|português]]

There are several possibilities to install ZNC on your machine. The latest version is always available using the source tarball from https://znc.in/releases.

A ChangeLog is available in the wiki. You can also read more about ZNC's portability.

Which way should I choose for installing ZNC?

If you don't have root access, the only way is to use source tarball. You'll need to use ./configure --prefix="$HOME/.local" as described.

If you have root access, you can use either source tarball or the convenient way for your distro. Check section about your distro for details, but be aware that these may contain old versions of ZNC!

Once you have installed ZNC, you can create a config file with znc --makeconf.

Development Versions

Read the git page if you want to get the current development version. Beware that this might have more bugs, more features, be a little unstable and eat your first born. You have been warned!

Source Tarball

Official source tarballs can be found here.

If you want to compile ZNC with OpenSSL support, you need the OpenSSL development package. On Debian/Ubuntu this is called libssl-dev, on CentOS/Fedora/Red Hat it's openssl-devel, and on openSUSE it's libopenssl-devel. A good way to install this and other dependencies is the build dependency feature of package managers (apt-get build-dep / yum-builddep / zypper source-install --build-deps-only).

1. Download the latest source tarball
2. tar -xzvf znc-1.9.1.tar.gz
3. cd znc-1.9.1
4. ./configure
   (use --prefix="$HOME/.local" if you don't want a system wide installation or simply don't have root access; use --with-openssl=/path/to/openssl if you have a non-standard SSL path)
   (use --help to see other configure options)
5. make
   (if you are on a dedicated server and your CPU has more than one core, you can use make -jX where X is the number of CPU cores to speed up compilation)
6. make install

Please note that compiling can take 5-10 minutes or more.

Once you have installed znc, you can use znc --makeconf to make a configuration file for ZNC. This config is stored in ~/.znc under the user you run it as. You should create a dedicated non root user to run znc under.

ZNC is run by just executing znc under the dedicated znc user, at which stage it goes to background. It does automatically not make an init.d service for itself (which can be done by following the instructions to running ZNC as a system daemon) nor does it need to be run in screen or something similar.

See the FAQ page if you encounter problems.

Linux

Docker

ZNC is available as an image in Docker Hub, and can be downloaded with:

docker pull znc

Follow the link above for additional instructions.

Debian

Debian provides ZNC packages which may be installed using:

aptitude install znc

If you want to build znc from source to get a newer version than Debian provides, you may need the following packages:

build-essential
libssl-dev
libperl-dev
pkg-config
libicu-dev

You can use the command

aptitude build-dep znc

to install build dependencies automatically. Note that sometimes these build-depedencies are outdated and won't work with the current version of ZNC.

Fedora/CentOS/Red Hat Enterprise Linux

Fedora has znc packaged in it's main repository and their Extra Packages for Enterprise Linux (EPEL) repository provides them for CentOS/RHEL.

If using RHEL install the EPEL repository by downloading the appropriate package linked on EPEL's website.

Once you have EPEL installed (or are on Fedora), execute:

sudo yum install znc

Once installed you can configure znc by running:

sudo -u znc znc --makeconf # this creates /var/lib/znc/.znc

Then finally to start it you can run:

sudo systemctl start znc # or enable if you want it to autostart

Build from Source: CentOS 7

If you really wish to build from source, then please follow the instructions here, written by Thomas Ward. Note that these instructions do utilize the EPEL repository in order to get all the necessary build dependencies (and there's a lot of them). These instructions work properly to create a basic ZNC installation.

Ubuntu

This page lists all of the ZNC packages in the Ubuntu repositories.

You can either build ZNC from source, or use a PPA that was made by a community member to contain pre-built ZNC packages for all supported Ubuntu releases. Note that the PPA does not contain packages for every Ubuntu release, and the support dates for various Ubuntu versions is detailed here. If the release of Ubuntu you are on is not supported on the PPA, you will have to compile it from source yourself.

Build From Source

If you want to build znc from source to get a newer version than Ubuntu provides, you may need to determine capability of your system to build ZNC 1.6.0 (and newer) based on the version of Ubuntu.

Building from Git Master

If you are trying to use the Git master version of the source code, then you will also need to ensure the following packages are also installed. You will not need to install these if you are using a stable release tarball, only if you are using Git master:

aclocal
pkg-config
automake
autoconf

After you have installed these packages, then continue onward for the additional dependencies you will need.

After installing dependencies, you will have to run autogen.sh to generate the configure script.

Add Build Dependency Sources

Older than Ubuntu 12.04

If you have any version of Ubuntu older than 12.04, you are incapable of building ZNC 1.6 or newer, due to the inability to install or build the ZNC build dependencies.

Ubuntu 12.04

If you are on Ubuntu 12.04, you will need to add three PPAs to your system, with the following commands:

sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
sudo add-apt-repository -y ppa:teward/swig3.0
sudo add-apt-repository -y ppa:teward/icu-backports

Ubuntu 14.04

If you are on Ubuntu 14.04, you will need to add one PPA to your system, with the following command:

sudo add-apt-repository -y ppa:teward/swig3.0

Newer than Ubuntu 14.04

You will not need any additional PPAs or sources for build dependencies.

Other Build Dependencies

After verifying you have the required build dependency sources, you will need to install the following packages:

build-essential
libssl-dev
libperl-dev
pkg-config
swig3.0
libicu-dev

If you are on Ubuntu 12.04, you will also need to install the following package:

g++-4.7

After you have done this, you can follow the instructions on this page for compiling from the source tarball.

Install via PPA

A Personal Package Archive (PPA) has been created by Thomas W., and contains the latest stable ZNC release as exists in Debian. It contains packages for all releases of Ubuntu that are currently supported. It does not contain packages for versions of Ubuntu that are past their end of life dates. Click here if you wish to see the details of the packages in the PPA. NOTE: This PPA contains packages for only certain Ubuntu releases, as detailed here.

The versions of ZNC currently available in the PPA are detailed on this page.

First, make sure you have the python-software-properties package installed:

sudo apt-get install python-software-properties software-properties-common

Then, add the PPA to your sources, and update the apt information:

sudo add-apt-repository ppa:teward/znc
sudo apt-get update

Then, install the znc packages:

sudo apt-get install znc znc-dbg znc-dev znc-perl znc-python znc-tcl

ZNC is now installed. You can create the configuration normally with this, when run on the user that you want to run ZNC as:

znc --makeconf

(open)SUSE

ZNC is part of the official repositories. To install, use the YaST GUI or install via commandline by typing

zypper install znc

Gentoo

Gentoo provides ZNC packages which may be installed using:

emerge -av net-irc/znc

Several USE Flags can be used for znc:

• daemon (local): (not offically supported) Allow znc to run as a system-wide service. Installs an init script and creates a znc user:group.
• debug (global): enable debug
• ipv6 (global): adds support for ipv6
• perl (global): adds support for writing perl modules
• python (global): adds support for writing python 3 modules
• ssl (global): enable secure socket layer connections
• sasl (global): sasl support
• tcl (global): adds support for writing tcl modules

equery uses znc -a

Will print you a list of USE flags that will be used for znc

Slackware

Latest Slackware SBo Slackbuild

Alpine Linux

To install znc from the package manager, enter the following command:

sudo apk add znc znc-extra znc-modperl znc-modpython znc-modtcl ca-certificates

If you want to build znc from source to get a newer version than Alpine provides, you need to install packages with the following command:

sudo apk add autoconf automake gettext-dev g++ make openssl-dev pkgconfig zlib-dev 

If you want to run git, Debugging, perl, (requires swig), python, (requires swig), tcl, or cyrus then install the packages that correspond:

sudo apk add git gdb perl-dev python3-dev swig tcl-dev cyrus-sasl-dev

Archlinux

ZNC is part of the archlinux package repository, and can be installed with the following:

pacman -S znc

Additionally you can install the following optional dependencies to add support for additional modules.

• cyrus-sasl - saslauth module
• perl - modperl module
• python - modpython module
• tcl - modtcl module

rc.d scripts (deprecated)

You may also be interested in rc.d scripts for znc which can be installed with:

pacman -U https://github.com/downloads/kylef/znc-arch/znc-system-wide-1.0-1-any.pkg.tar.xz

You can read more about these scripts here. As of November 2012, initscripts support is being phased-out and expected to be totally deprecated in early 2013. Systemd scripts are already distributed in the package. The Archlinux wiki has some helpful information for new users who are getting started with znc.

Unstable/Testing

You can install the latest git snapshot from the Arch User Repository.

FreeBSD

ZNC is in FreeBSD ports, just do:

cd /usr/ports/irc/znc
make config
make install clean

or

pkg_add -r znc

Mac OS X

There are two ways to install ZNC on OS X, either using a package manager such as Homebrew or installing it yourself from source. See this blog post for a tutorial on how to compile ZNC from source.

• NOTE: If you are running on PPC architecture and cannot make the ./configure && make && sudo make install dance work, you'll want to do the following:

1. Make sure that you're using the --disable-perl switch for configure. Hence: ./configure --prefix=/usr/local --disable-perl

Homebrew

Installing Homebrew

For more information about Homebrew see here. The following command will install Homebrew to /usr/local

 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Homebrew requires Xcode and Mac OS X >= 10.5

Installing znc with Homebrew

 brew install znc

Installing znc with MacPorts

 port install znc

Microsoft Windows

Warning: If you're going to install ZNC on your local Windows machine, it will probably be useless. You should run it on some machine (Windows or not), which is connected to internet 24/7.

Cygwin

ZNC is available in list of cygwin packages.

Download Cygwin, install it. When choosing list of packages to install, search for "znc".

If you don't want to use the provided packages, you can compile ZNC from source; for that you'll need the following packages installed: automake, gcc-g++, libicu-devel, make, mpfr, pkg-config, openssl-devel, zlib-devel. After installing these packages proceed to source tarball section (or git)