To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.
Installation
There are several possibilities to install ZNC on your machine. The latest version is always available using the source tarball from http://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/znc
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, 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.
- Download the latest source tarball
tar -xzvf znc*.*gz
cd znc*
./configure
(use--prefix=$HOME/znc
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)make
(if you are on a dedicated server and your CPU has more than one core, you can usemake -jX
where X is the number of CPU cores to speed up compilation)make install
Please note that compiling can take 5-10mins or more.
Once you have installed znc, you can use znc --makeconf
to make a configuration file for ZNC.
- See the FAQ page if you encounter problems.
Linux
Debian
Debian provides ZNC packages which may be installed using:
aptitude install znc
Warning: Debian Stable has very old version by default. If you want newer version, use http://www.backports.org or compile znc from source.
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
To include c-ares support, also install:
pkg-config libc-ares-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
Fedora provides ZNC packages which may be installed using
yum install znc
and
yum install znc-extra
CentOS/Red Hat Enterprise Linux
ZNC packages are available in the Extra Packages for Enterprise Linux repository (EPEL).
To install the EPEL repository, lookup the appropriate EPEL package at http://mirrors.fedoraproject.org/publiclist/EPEL/ then execute the following commands:
rpm -Uvh <link to your package name/architecture>/epel-release-5-4.noarch.rpm yum update
Once you have EPEL installed, execute:
yum install znc znc-extra
Ubuntu
If you want to build znc from source to get a newer version than Ubuntu provides, you need the following packages:
build-essential libssl-dev libperl-dev pkg-config libc-ares-dev
You can also run the command
sudo apt-get build-dep znc
if you want to get the build depedencies installed automatically.
Ubuntu 12.04 & Ubuntu 12.10
To get znc 1.0, a PPA exists that contains ZNC 1.0. This PPA only works for Ubuntu 12.04 (Precise) and Ubuntu 12.10 (Quantal). It is currently maintained by Thomas Ward. To add it to your system so you can upgrade existing ZNC packages to ZNC 1.0, please run the following:
sudo apt-get install python-software-properties sudo add-apt-repository ppa:teward/znc-1.0 sudo apt-get update
From here, if you are already using the packages in Ubuntu (0.206), you can run
sudo apt-get upgrade
and the packages will be upgraded. Otherwise, if you have not yet installed the znc packages, then do:
sudo apt-get install znc
(Open)SuSE
ZNC is part of the official repositories. To install, use the YaST GUI or install via commandline by typing
yast -i znc
Gentoo
Gentoo provides ZNC packages which may be installed using:
emerge -av net-irc/znc
Several USE Flags can be used for znc:
- ares (global/local): enables using the c-ares library (for stable versions predating 1.0 only; deprecated in favor of dns-threads)
- debug (global): enable debug
- dns-threads (local): use threads for DNS resolving (for v1.0)
- extras (global/local): enable additional modules
- 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
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 (depreciated)
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 depreciated 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. Currently, there does not seem to be support for initscripts or systemd in the git version at this time.
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:
- Make sure that you're using the --disable-perl switch for configure. Hence: ./configure --prefix=/usr/local --disable-perl
- If this still doesn't work, fetch and compile c-ares from source.
Homebrew
Installing Homebrew
For more information about Homebrew see here. The following command will install Homebrew to /usr/local
ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
Homebrew requires Xcode and Mac OS X >= 10.5
Installing znc with Homebrew
brew install znc
Installing znc with MacPorts
port install znc
Unofficial, user contributed binaries
The following installation sources are created and maintained by users!
RPM
Veit Wahlich created RPM packages and yum repositories for RedHat-based Linux distributions (RHEL/CentOS and Fedora). Version 0.052 is available at http://home.ircnet.de/cru/znc
Microsoft Windows
ZNC as a native Windows program, compiled with Microsoft Visual C++ Includes the main program and around 40 modules. Supports SSL and IPv6.