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: Difference between revisions

From ZNC
Jump to navigation Jump to search
← Older edit
>Yann.soubeyrand
No edit summary
 
(95 intermediate revisions by 25 users not shown)
Line 1: Line 1:
{{Languages}}
{{Languages|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.
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.
A [[:Category:ChangeLog|ChangeLog]] is available in the wiki.
You can also read more about [[Portability|ZNC's portability]].
You can also read more about [[Portability|ZNC's portability]].


;Which way should I choose for installing ZNC?
;Which way should I choose for installing ZNC?
:If you don't have root access, the only way is to use [[#Source Tarball|source tarball]]. You'll need to use <code>./configure --prefix=$HOME/znc</code> as described.  
:If you don't have root access, the only way is to use [[#Source Tarball|source tarball]]. You'll need to use <code>cmake .. -DCMAKE_INSTALL_PREFIX="$HOME/.local"</code> as described.  
:If you have root access, you can use either [[#Source Tarball|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!
:If you have root access, you can use either [[#Source Tarball|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!


Line 12: Line 12:


== Development Versions ==
== 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!
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 ==
== Source Tarball ==
Official source tarballs can be found [http://znc.in/releases/ here].
Official source tarballs can be found [https://znc.in/releases/ 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'''.
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 (<code>apt-get build-dep</code> / <code>yum-builddep</code> / <code>zypper source-install --build-deps-only</code>).


# Download the latest [http://znc.in/releases/znc-{{ZNC-Version}}.tar.gz source tarball]
# Download the latest [https://znc.in/releases/znc-{{ZNC-Version}}.tar.gz source tarball]
# <code>tar -xzvf znc*.*gz</code>
# <code>tar -xzvf znc-{{ZNC-Version}}.tar.gz</code>
# <code>cd znc*</code>
# <code>cd znc-{{ZNC-Version}}</code>
# <code>./configure</code><br />(use <code>--prefix=$HOME/znc</code> if you don't want a system wide installation or simply don't have root; use <code>--with-openssl=/path/to/openssl</code> if you have a non-standard SSL path)<br />(use <code>--enable-extra</code> to configure (and additionally <code>--enable-tcl</code> for modtcl) to include the whole extra package)
# <code>mkdir build</code>
# <code>cd build</code>
# <code>cmake ..</code><br />(use <code>cmake .. -DCMAKE_INSTALL_PREFIX="$HOME/.local"</code> if you don't want a system wide installation or simply don't have root access; use <code>cmake -DOPENSSL_ROOT_DIR=/path/to/openssl</code> if you have a non-standard SSL path)<br />(use <code>ccmake</code> or <code>cmake-gui</code> to see other configure options)
# <code>make</code><br />(if you are on a dedicated server and your CPU has more than one core, you can use <code>make -jX</code> where X is the number of CPU cores to speed up compilation)
# <code>make</code><br />(if you are on a dedicated server and your CPU has more than one core, you can use <code>make -jX</code> where X is the number of CPU cores to speed up compilation)
# <code>make install</code>
# <code>make install</code>


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


Once you have installed znc, you can use <code>znc --makeconf</code> to make a configuration file for ZNC.
Once you have installed znc, you can use <code>znc --makeconf</code> 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 <code>znc</code> under the dedicated znc user, at which stage it goes to background. It does not automatically 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|FAQ page]] if you encounter problems.
;See the [[FAQ|FAQ page]] if you encounter problems.


== Linux ==
== Linux ==
=== Docker ===
ZNC is available as an image in [https://hub.docker.com/_/znc/ Docker Hub], and can be downloaded with:
<code>docker pull znc</code>
Follow the link above for additional instructions.
If you want to test great new features (and bugs!), unstable ZNC image is [https://hub.docker.com/r/zncbouncer/znc-git/ here].


=== Debian ===
=== Debian ===
Debian provides [http://packages.debian.org/znc ZNC packages] which may be installed using:
{{ambox | type = delete | text = Prior to Debian Sid (Unstable) including Wheezy the ZNC packages included in the repositories for those older releases are '''extremely old'''. There could be '''security issues and even bugs in the code'''. If you are having issues with ZNC from your Debian package manager (prior to Sid), it is recommended to uninstall that package and build from source, or use the third-party repository (noted below).}}
  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.''
Debian provides [http://packages.debian.org/znc ZNC packages] which may be installed using (stretch/stable, buster/testing, sid)
  apt install znc
 
Debian Jessie LTS [https://wiki.debian.org/Backports#Using_the_command_line backports]
apt -t jessie-backports install znc


If you want to build znc from source to get a newer version than Debian provides, you may need the following packages:
If you want to build znc from source to get a newer version than Debian provides, you may need the following packages:
Line 43: Line 61:
  libssl-dev
  libssl-dev
  libperl-dev
  libperl-dev
To include c-ares support, also install:
  pkg-config
  pkg-config
  libc-ares-dev
  libicu-dev


You can use the command
You can use the command
Line 52: Line 68:
to install build dependencies automatically. Note that sometimes these build-depedencies are outdated and won't work with the current version of ZNC.
to install build dependencies automatically. Note that sometimes these build-depedencies are outdated and won't work with the current version of ZNC.


If you want to run ZNC as a system service you need to (the following commands are to be executed as root):
=== Fedora/CentOS/Red Hat Enterprise Linux ===
* create a new system user:
Fedora has znc packaged in it's main repository and their Extra Packages for Enterprise Linux (EPEL) repository provides them for CentOS/RHEL.
adduser --system --home /var/lib/znc --group znc
* install an init file:
# create a file <code>/etc/init.d/znc</code> with the following content:
#! /bin/sh
### BEGIN INIT INFO
# Provides:          znc
# Required-Start:    $remote_fs $syslog
# Required-Stop:    $remote_fs $syslog
# Default-Start:    2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: ZNC IRC bouncer
# Description:      ZNC is an IRC bouncer
### END INIT INFO
 
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="ZNC daemon"
NAME=znc
DAEMON=/usr/bin/$NAME
DATADIR=/var/lib/znc
DAEMON_ARGS="--datadir=$DATADIR"
PIDDIR=/var/run/znc
PIDFILE=$PIDDIR/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
USER=znc
GROUP=znc
# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0
# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh
# Define LSB log_* functions.
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
# and status_of_proc is working.
. /lib/lsb/init-functions
#
# Function that starts the daemon/service
#
do_start()
{
# Return
#  0 if daemon has been started
#  1 if daemon was already running
#  2 if daemon could not be started
if [ ! -d $PIDDIR ]
then
mkdir $PIDDIR
fi
chown $USER:$GROUP $PIDDIR
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test --chuid $USER > /dev/null || return 1
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --chuid $USER -- $DAEMON_ARGS > /dev/null || return 2
}
#
# Function that stops the daemon/service
#
do_stop()
{
# Return
#  0 if daemon has been stopped
#  1 if daemon was already stopped
#  2 if daemon could not be stopped
#  other if a failure occurred
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME --chuid $USER
RETVAL="$?"
[ "$RETVAL" = 2 ] && return 2
# Wait for children to finish too if this is a daemon that forks
# and if the daemon is only ever run from this initscript.
# If the above conditions are not satisfied then add some other code
# that waits for the process to drop all resources that could be
# needed by services started subsequently.  A last resort is to
# sleep for some time.
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON --chuid $USER
[ "$?" = 2 ] && return 2
# Many daemons don't delete their pidfiles when they exit.
rm -f $PIDFILE
return "$RETVAL"
}
#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME --chuid $USER
return 0
}
case "$1" in
  start)
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
do_start
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
  stop)
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
do_stop
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
  status)
status_of_proc -p $PIDFILE "$DAEMON" "$NAME" && exit 0 || exit $?
;;
  reload)
log_daemon_msg "Reloading $DESC" "$NAME"
do_reload
log_end_msg $?
;;
  restart)
log_daemon_msg "Restarting $DESC" "$NAME"
do_stop
case "$?" in
  0|1)
do_start
case "$?" in
0) log_end_msg 0 ;;
1) log_end_msg 1 ;; # Old process is still running
*) log_end_msg 1 ;; # Failed to start
esac
;;
  *)
# Failed to stop
log_end_msg 1
;;
esac
;;
  *)
echo "Usage: $SCRIPTNAME {status|start|stop|reload|restart}" >&2
exit 3
;;
esac
:
# give the right permissions to this file:
chmod 755 /etc/init.d/znc
# execute:
update-rc.d znc defaults
* configure ZNC (I didn't find how to do this a better way…):
start-stop-daemon --start --quiet --exec /usr/bin/znc --chuid znc -- --datadir=/var/lib/znc --makeconf
* add the line
PidFile = /var/run/znc/znc.pid
to the global section of the configuration file <code>/var/lib/znc/configs/znc.conf</code>
* start the service:
service znc start
* verify that the service is running:
service znc status


=== Fedora ===
If using RHEL install the EPEL repository by downloading the appropriate package linked on [https://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F EPEL's website].
Fedora provides [http://kojipkgs.fedoraproject.org/packages/znc ZNC packages] which may be installed using
yum install znc
and
yum install znc-extra


=== CentOS/Red Hat Enterprise Linux ===
Once you have EPEL installed (or are on Fedora), execute:
ZNC packages are available in the Extra Packages for Enterprise Linux repository (EPEL).
sudo yum install znc
or dnf
sudo dnf install znc


To install the EPEL repository, lookup the appropriate EPEL package at [http://mirrors.fedoraproject.org/publiclist/EPEL/ http://mirrors.fedoraproject.org/publiclist/EPEL/] then execute the following commands:
Once installed you can configure znc by running:
  rpm -Uvh <link to your package name/architecture>/epel-release-5-4.noarch.rpm
  sudo -u znc znc --makeconf # this creates ''/var/lib/znc/.znc''
yum update


Once you have EPEL installed, execute:
Then finally to start it you can run:
  yum install znc znc-extra
  sudo systemctl start znc # or ''enable'' if you want it to autostart
 
==== Build from Source: CentOS 7+ only ====
 
If you really wish to build from source, then please follow the instructions [https://wiki.znc.in/User:Teward/ZNC_From_Source:_CentOS_7 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.  CentOS 7 or newer is needed because of the C++ standards being used, and older CentOS not having the required compilers for those standards.


=== Ubuntu ===
=== Ubuntu ===
[http://packages.ubuntu.com/search?keywords=znc&searchon=names&exact=1&suite=all&section=all Ubuntu's ZNC packages]
[http://packages.ubuntu.com/search?keywords=znc&searchon=names&exact=1&suite=all&section=all 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 [[User:Resistance/Ubuntu_PPA_for_ZNC_-_Supported_Versons_of_Ubuntu|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 =====
{{ambox | type = notice | text = If you are building from a source tarball for a stable release, '''skip this section'''''.  It is only needed for those building the development release (the master branch) on [[Git]].}}
 
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


If you want to build znc from source to get a newer version than Ubuntu provides, you need the following packages:
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 =====
 
{{ambox | type = delete | text = '''DO NOT''' add these dependency sources or PPAs if you are only trying to install from the ZNC PPA; instead skip this section and go to the [[Installation#Install_via_PPA|Install via PPA]] second instead.  This section is only for those intending to compile themselves from-source.}}
 
====== 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
  build-essential
  libssl-dev
  libssl-dev
  libperl-dev
  libperl-dev
  pkg-config
  pkg-config
  libc-ares-dev
  swig3.0
libicu-dev


You can also run the command
After you have done this, you can follow the instructions on this page for compiling from the source tarball.
sudo apt-get build-dep znc
if you want to get the build depedencies installed automatically.


=== (Open)SuSE ===
=== (open)SUSE ===
ZNC is part of the [http://software.opensuse.org/search?q=znc official repositories]. To install, use the YaST GUI or install via commandline by typing
ZNC is part of the [https://software.opensuse.org/package/znc official repositories]. To install, use the YaST GUI or install via commandline by typing
  yast -i znc
  zypper install znc


=== Gentoo ===
=== Gentoo ===
Gentoo provides [http://packages.gentoo.org/package/net-irc/znc ZNC packages] which may be installed using:
Gentoo provides [http://packages.gentoo.org/package/net-irc/znc ZNC packages] which may be installed using:
  emerge -av net-irc/znc
  emerge -av net-irc/znc
To install [[ZNC-Extra]] and [[modtcl]] you need to install znc using:
<pre>
USE="extras tcl" emerge znc
</pre>


Several USE Flags can be used for znc:
Several USE Flags can be used for znc:


* ares: (global/local): enables using the c-ares libary
* argon2: store password hashes using Argon2id instead of SHA-256
* debug: (global): enable debug
* icu: character encodings support
* extras: (global/local): enable additional modules
* perl: adds support for writing [[modperl|perl modules]]
* ipv6: global): adds support for ipv6
* python: adds support for writing [[modpython|python 3 modules]]
* perl (global): adds support writing perl modules
** python_single_target_python3_NN: use the specific python version
* ssl (global): enable secure socket layer connections
* ssl: enable secure socket layer connections
* sasl (global): sasl support
* sasl: build [[cyrusauth]] module
* tcl (global): adds support for writing tcl modules
* tcl: adds support for writing [[modtcl|tcl modules]]
* zlib: compression for HTML in [[webadmin|web UI]]


<pre>equery uses znc -a</pre> Will print you a list of USE flags that will be used for znc
<pre>equery uses znc -a</pre> Will print you a list of USE flags that will be used for znc
Line 268: Line 155:
=== Slackware ===
=== Slackware ===
[http://slackbuilds.org/result/?search=znc&sv= Latest Slackware SBo Slackbuild]
[http://slackbuilds.org/result/?search=znc&sv= Latest Slackware SBo Slackbuild]
=== Alpine Linux ===
To install znc from the package manager, enter the following command:
<!--- Some modules exist in znc-extra. This is by design on this OS. --->
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]], [[modperl|perl]], (requires swig), [[modpython|python]], (requires swig), [[modtcl|tcl]], or [[cyrusauth|cyrus]] then install the packages that correspond:
sudo apk add git gdb perl-dev python3-dev swig tcl-dev cyrus-sasl-dev


=== Archlinux ===
=== Archlinux ===
Line 282: Line 181:
* '''tcl''' - modtcl module
* '''tcl''' - modtcl module


==== rc.d scripts ====
==== Unstable/Testing ====
 
You can install the latest git snapshot from the [https://aur.archlinux.org/packages/znc-git/ Arch User Repository].
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 [https://github.com/kylef/znc-arch here]


== FreeBSD ==
== FreeBSD ==
Line 296: Line 190:
  make install clean
  make install clean


or  
or pkg_add


  pkg_add -r znc
  pkg_add -r znc
or pkgng
pkg install znc


== Mac OS X ==
== Mac OS X ==
Line 306: Line 204:
* 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:
* 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''
# 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 ===
=== Homebrew ===
Line 312: Line 209:
==== Installing Homebrew ====
==== Installing Homebrew ====


For more information about Homebrew see [http://mxcl.github.com/homebrew/ here]. The following command will install Homebrew to /usr/local
For more information about Homebrew see [https://brew.sh/ here]. The following command will install Homebrew to /usr/local


   ruby -e "$(curl -fsSLk https://gist.github.com/raw/323731/install_homebrew.rb)"
   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"


Homebrew requires Xcode and Mac OS X >= 10.5
Homebrew requires Xcode and Mac OS X >= 10.5
Line 326: Line 223:
   port install znc
   port install znc


== Unofficial, user contributed binaries ==
The following installation sources are created and maintained by users!


=== RPM ===
== Microsoft Windows ==
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
 
'''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) that is connected to internet and runs 24/7.'''
 
=== Cygwin ===
 
ZNC is available in list of cygwin packages.
 
Download [http://www.cygwin.com/ Cygwin], install it. When choosing list of packages to install, search for "znc".
 
ZNC is run by just executing <code>znc</code>, at which stage it goes to background. It does not automatically make a service by itself (which can be done by following the instructions in [[running ZNC as a system daemon#Windows]]) nor does it need to be run in screen or something similar.
 
==== Building from source on Cygwin ====
If you don't want to use the provided packages, you can compile ZNC from source; for that you'll need the dependencies installed, which you can see in BUILD_REQUIRES in [https://cygwin.com/cgit/cygwin-packages/znc/tree/znc.cygport znc.cygport] which is used to build the cygwin ZNC package. After installing these packages proceed to [[#Source Tarball|source tarball]] section (or [[git]])
 
=== MSYS2 ===
 
ZNC is available in the msys pacman repository provided by MSYS2
 
Download [https://www.msys2.org/ MSYS2] and install it. Open any of the msys2 shells from the start menu and run <code>pacman -S znc</code> to install the package.
 
Once done you can launch <code>znc</code> from either the MSYS2 shells or Windows Command Prompt provided you either added it to PATH or navigated to the directory where znc.exe is located.
 
Note: that due to bugs ZNC may not be able to fork into the background so you'll have to start it with <code> znc -f</code> (foreground)
 
=== WSL ===
 
After ensuring that WSL (Windows Subsystem for Linux) itself works, follow the [[#Linux|Linux]] instructions above.


=== Microsoft Windows ===
However note that it is not suitable for services unless you enable a currently experimental option/setting which you can then follow the [[Running ZNC as a system daemon#Linux]] instructions
[http://code.google.com/p/znc-msvc/ ZNC as a native Windows program, compiled with Microsoft Visual C++]
Includes the main program and around 40 modules. Supports SSL and IPv6.


[[Category:ZNC]]
[[Category:ZNC]]

Latest revision as of 18:26, 25 November 2024

Languages Languages: 

English  • Deutsch  • русский  • français  • Bahasa Indonesia  • italiano  • 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 cmake .. -DCMAKE_INSTALL_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. mkdir build
  5. cd build
  6. cmake ..
    (use cmake .. -DCMAKE_INSTALL_PREFIX="$HOME/.local" if you don't want a system wide installation or simply don't have root access; use cmake -DOPENSSL_ROOT_DIR=/path/to/openssl if you have a non-standard SSL path)
    (use ccmake or cmake-gui to see other configure options)
  7. 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)
  8. 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 not automatically 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.

If you want to test great new features (and bugs!), unstable ZNC image is here.

Debian

 Prior to Debian Sid (Unstable) including Wheezy the ZNC packages included in the repositories for those older releases are extremely old. There could be security issues and even bugs in the code. If you are having issues with ZNC from your Debian package manager (prior to Sid), it is recommended to uninstall that package and build from source, or use the third-party repository (noted below).

Debian provides ZNC packages which may be installed using (stretch/stable, buster/testing, sid) 

apt install znc

Debian Jessie LTS backports 

apt -t jessie-backports 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

or dnf 

sudo dnf 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+ only

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. CentOS 7 or newer is needed because of the C++ standards being used, and older CentOS not having the required compilers for those standards.

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 building from a source tarball for a stable release, skip this section. It is only needed for those building the development release (the master branch) on Git.

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
 DO NOT add these dependency sources or PPAs if you are only trying to install from the ZNC PPA; instead skip this section and go to the Install via PPA second instead. This section is only for those intending to compile themselves from-source.
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

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

(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:

  • argon2: store password hashes using Argon2id instead of SHA-256
  • icu: character encodings support
  • perl: adds support for writing perl modules
  • python: adds support for writing python 3 modules
    • python_single_target_python3_NN: use the specific python version
  • ssl: enable secure socket layer connections
  • sasl: build cyrusauth module
  • tcl: adds support for writing tcl modules
  • zlib: compression for HTML in web UI
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

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 

pkg_add -r znc

or pkgng 

pkg install 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 

 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

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) that is connected to internet and runs 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".

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

Building from source on Cygwin

If you don't want to use the provided packages, you can compile ZNC from source; for that you'll need the dependencies installed, which you can see in BUILD_REQUIRES in znc.cygport which is used to build the cygwin ZNC package. After installing these packages proceed to source tarball section (or git)

MSYS2

ZNC is available in the msys pacman repository provided by MSYS2

Download MSYS2 and install it. Open any of the msys2 shells from the start menu and run pacman -S znc to install the package.

Once done you can launch znc from either the MSYS2 shells or Windows Command Prompt provided you either added it to PATH or navigated to the directory where znc.exe is located.

Note: that due to bugs ZNC may not be able to fork into the background so you'll have to start it with znc -f (foreground)

WSL

After ensuring that WSL (Windows Subsystem for Linux) itself works, follow the Linux instructions above.

However note that it is not suitable for services unless you enable a currently experimental option/setting which you can then follow the Running ZNC as a system daemon#Linux instructions

Retrieved from "https://wiki.znc.in/index.php?title=Installation&oldid=3174"