ZNC logo

ZNC

  •  0 ratings
In category: Communication / IRC

About ZNC

Advanced IRC bouncer.

  •   356  
  •   0  
  •   0  
  •   0  
Github stats:
  •  Commits: 5,536  
  •   19,000  
  •   392  
  •  Latest commit: Jan 19, 2023  

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:
Lincenses:

More about ZNC

ZNC - An advanced IRC bouncer

GitHub Workflow Status Jenkins Build Status AppVeyor Build status Coverage Status

Table of contents

Minimal Requirements

Core:

  • GNU make
  • pkg-config
  • GCC 4.8 or clang 3.2
  • CMake

Optional Requirements

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 * gettext is a build dependency

Installing ZNC

Installation from source code is performed using the CMake toolchain.

mkdir build
cd build
cmake ..
make
make install

You can use cmake-gui or ccmake for more interactiveness.

There is also configure.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.

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

Setting up znc.conf

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

If you are using SSL you should do znc --makepem

Special config options

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

Using ZNC

Once you have started ZNC you can connect with your favorite IRC-client to ZNC. You should use username: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 additionally provide /msg *modulename help

File Locations

In its data dir (~/.znc is default) ZNC saves most of its data. The only exception 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 is created with znc --makepem.

These directories are also in there:

  • configs - Contains znc.conf (ZNC's config file) and backups of older configs.
  • 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 moddata directory.

ZNC's config file

This file shouldn't be too hard too understand. An explanation of all the items can be found on the Configuration page. Warning: it is better not to edit config while ZNC is running. Use the webadmin and controlpanel modules instead.

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

Writing own modules

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

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

For additional info look in the wiki:

Perl modules are loaded through the global module ModPerl.

Python modules are loaded through the global module ModPython.

Further information

Please visit https://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

Comments (0)

Please login to join the discussion on this project.

ZNC Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Popular Projects

FluxBB

in Social Networks and Forums
 31k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 18k    1    1    0  

Libreddit

in Social Networks and Forums
 6k    0    1    0  

CasaOS

in Self-hosting Solutions
 5k    0    0    0  

Audiobookshelf

in Audio Streaming
 4k    0    1    0  

Mediagoblin

in Photo and Video Galleries
 4k    0    0    0  

Dashboard

in Personal Dashboards
 3k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 18k    1    1    0  

Tube Archivist

in Automation
 3k    0    1    0  

OneDev

in Project Management
 2k    0    0    0  

iodine

in Proxy
 2k    0    0    0  

Alf.io

in Booking and Scheduling
 2k    0    0    0  

sysPass

in Password Managers
 886    0    0    0  

Misskey

in Social Networks and Forums
 2k    0    0    0  
pCloud Lifetime

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Categories

You May Also Be Interested In

Weechat logo
Weechat cover

Weechat

Fast, light and extensible chat client.

Dispatch logo
Dispatch cover

Dispatch

Self-hosted web IRC client written in Go.

Robust IRC logo
Robust IRC cover

Robust IRC

RobustIRC is IRC without netsplits. Distributed IRC server,…