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
>Silverleo Remove inaccurate statement. Security issues with CVE links are listed on the ChangeLog pages of old versions. |
→Install via PPA: PPA is dead, and unsupported. Removing from install instructions. |
||
(54 intermediate revisions by 17 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 | 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>. | :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 15: | Line 15: | ||
== Source Tarball == | == Source Tarball == | ||
Official source tarballs can be found [ | 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 [ | # Download the latest [https://znc.in/releases/znc-{{ZNC-Version}}.tar.gz source tarball] | ||
# <code>tar -xzvf znc | # <code>tar -xzvf znc-{{ZNC-Version}}.tar.gz</code> | ||
# <code>cd znc | # <code>cd znc-{{ZNC-Version}}</code> | ||
# <code>. | # <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- | ''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. 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. | 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 znc under the dedicated znc user, at which stage it goes to background. It does not make an init.d service for itself nor does it need to be run in screen or something similar. | 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).}} | ||
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 44: | Line 61: | ||
libssl-dev | libssl-dev | ||
libperl-dev | libperl-dev | ||
pkg-config | |||
libicu-dev | |||
You can use the command | You can use the command | ||
Line 49: | 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. | ||
=== Fedora === | === Fedora/CentOS/Red Hat Enterprise Linux === | ||
Fedora provides [ | Fedora has znc packaged in it's main repository and their Extra Packages for Enterprise Linux (EPEL) repository provides them for CentOS/RHEL. | ||
yum install znc | |||
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]. | |||
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 [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§ion=all Ubuntu' | [http://packages.ubuntu.com/search?keywords=znc&searchon=names&exact=1&suite=all§ion=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 | |||
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 | ||
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 [ | 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 | ||
zypper install znc | |||
=== Gentoo === | === Gentoo === | ||
Line 94: | Line 141: | ||
Several USE Flags can be used for 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 | * debug (global): enable debug | ||
* ipv6 (global): adds support for ipv6 | * ipv6 (global): adds support for ipv6 | ||
* perl (global): adds support for writing perl modules | * perl (global): adds support for writing perl modules | ||
Line 113: | Line 158: | ||
To install znc from the package manager, enter the following command: | To install znc from the package manager, enter the following command: | ||
sudo apk add znc znc-modperl znc-modtcl | <!--- 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: | 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 | 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), [[modtcl|tcl]], or [[cyrusauth|cyrus]] then install the packages that correspond: | 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 swig tcl-dev cyrus-sasl-dev | sudo apk add git gdb perl-dev python3-dev swig tcl-dev cyrus-sasl-dev | ||
=== Archlinux === | === Archlinux === | ||
Line 135: | Line 179: | ||
* '''python''' - modpython module | * '''python''' - modpython module | ||
* '''tcl''' - modtcl module | * '''tcl''' - modtcl module | ||
==== Unstable/Testing ==== | ==== Unstable/Testing ==== | ||
Line 153: | Line 189: | ||
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 170: | Line 210: | ||
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 [http://mxcl.github.com/homebrew/ here]. The following command will install Homebrew to /usr/local | ||
ruby -e "$(curl - | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
Homebrew requires Xcode and Mac OS X >= 10.5 | Homebrew requires Xcode and Mac OS X >= 10.5 | ||
Line 182: | Line 222: | ||
port install znc | 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 [http://www.cygwin.com/ 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|source tarball]] section (or [[git]]) | |||
=== | === WSL === | ||
After ensuring that WSL (Windows Subsystem for Linux) itself works, follow the [[#Linux|Linux]] instructions above. | |||
[[Category:ZNC]] | [[Category:ZNC]] |
Revision as of 23:46, 28 October 2023
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
).
- Download the latest source tarball
tar -xzvf znc-1.9.0.tar.gz
cd znc-1.9.0
mkdir build
cd build
cmake ..
(usecmake .. -DCMAKE_INSTALL_PREFIX="$HOME/.local"
if you don't want a system wide installation or simply don't have root access; usecmake -DOPENSSL_ROOT_DIR=/path/to/openssl
if you have a non-standard SSL path)
(useccmake
orcmake-gui
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-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:
- 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
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:
- 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)
WSL
After ensuring that WSL (Windows Subsystem for Linux) itself works, follow the Linux instructions above.