A ZNC fork for advanced users and BNC providers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
S Stewart d0a56f5fbc Remove awaynick, not needed 3 years ago
cmake Enable i18n in CI 4 years ago
include Merge branch '1.6.x' 3 years ago
m4 configure: Fix C++11 test with -Werror=missing-declarations 5 years ago
man Fix spelling in documentation 3 years ago
modules Remove awaynick, not needed 3 years ago
src Merge branch 'master' of github.com:DreamBNC/znc 3 years ago
test Fix race condition by using ReadUntil per review 3 years ago
third_party Update Csocket submodule: fix openssl 1.1 3 years ago
webskins Merge branch 'master' of github.com:DreamBNC/znc 3 years ago
zz_msg Yet another attempt to use CMake 4 years ago
.appveyor.yml AppVeyor: cygwin's python3 package was split to -devel. Install it. 3 years ago
.clang-format clang-format: switch tabs to spaces 4 years ago
.codecov.yml Try Codecov. It has better GUI than Coveralls. 3 years ago
.gitignore Reorder lines in .gitignore 3 years ago
.gitmodules Import latest gtest to third_party to be able to use gmock 4 years ago
.travis-coverity-scan.py Setup Coverity scan. 4 years ago
.travis-coverity.yml Travis: don't build twice for coverity (again) 4 years ago
.travis-generate-docs.sh Setup Coverity scan. 4 years ago
.travis-github.enc Replace travis keys and don't download travis_after_all.py 6 years ago
.travis.ssh Setup Coverity scan. 4 years ago
.travis.yml Merge branch 'master' of github.com:DreamBNC/znc 3 years ago
.travis_after_all.py Replace travis keys and don't download travis_after_all.py 6 years ago
AUTHORS Change ZNC license to Apache 2.0 7 years ago
CMakeLists.txt Roll back! 4 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 4 years ago
ChangeLog.md Merge branch 'master' of github.com:DreamBNC/znc 3 years ago
Doxyfile Fix spelling in documentation 3 years ago
Jenkinsfile Add test results to Jenkins 3 years ago
LICENSE Change ZNC license to Apache 2.0 7 years ago
Makefile.in Add framework for translating ZNC to different languages 4 years ago
NOTICE Yet another attempt to use CMake 4 years ago
README.md Merge branch 'master' of github.com:DreamBNC/znc 3 years ago
ZNCConfig.cmake.in Yet another attempt to use CMake 4 years ago
autogen.sh A little touch 4 years ago
bootstrap.sh Add bootstrap.sh as symlink to autogen.sh 9 years ago
configure.ac Yet another attempt to use CMake 4 years ago
configure.sh Add framework for translating ZNC to different languages 4 years ago
make-tarball.sh Yet another attempt to use CMake 4 years ago
translation_pot.py Rename translation methods to be not one letter. 3 years ago
version.sh Fix version.sh for ancient git 3 years ago
znc-buildmod.cmake.in Bump CMake requirement to 3.1 and fix code which requires 3.2+ 4 years ago
znc-buildmod.in Merge branch '1.6.x' 4 years ago
znc-uninstalled.pc.in Update znc-uninstalled.pc.in 4 years ago
znc.pc.cmake.in Yet another attempt to use CMake 4 years ago
znc.pc.in Update znc.pc.in 4 years ago
znc.service.in Update znc.service.in 4 years ago

README.md

DreamZNC

[Upstream Travis Build Status Jenkins Build Status AppVeyor Build status Bountysource Coverage Status Coverity Scan Build Status

[WBNC WBNC Travis Status WBNC Coverity Scan

For people wondering, we're not gonna make Windows versions. Sorry about your luck :P

Table of contents

  • Minimal Requirements
  • Optional Requirements
  • Installing DreamZNC
  • Setting up znc.conf
  • Special config options
  • Using DreamZNC
  • File Locations
  • DreamZNC's config file
  • Writing own modules
  • Further infos

Minimal Requirements

Core:

  • GNU make
  • pkg-config
  • GCC 4.7 or clang 3.2
  • Either of:
    • autoconf and automake (but only if building from git, not from tarball)
    • CMake

Optional Requirements

SSL/TLS support:

  • openssl 0.9.7d or later
    • try installing openssl-dev, openssl-devel or libssl-dev
    • Mac OS X: OpenSSL from Homebrew is preferred over system

modperl:

  • perl and its bundled libperl
  • SWIG if building from git

modpython:

  • python and its bundled libpython
  • perl is required
  • Mac OS X: 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)

Installing DreamZNC

Currently there are 2 build systems in place: CMake and ./configure. ./configure will eventually be removed. There is also configure.sh which should make migration to CMake easier: it accepts the same parameters as ./configure, but calls CMake with CMake-style parameters.

Installing with CMake

Installation from source code is performed using the CMake toolchain.

cmake .
make
[sudo] make install

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

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.

Installing with ./configure

A alternate method of installation from source code is performed using the automake toolchain. If you are building from git, you will need to run ./autogen.sh first to produce the configure script.

./configure
make
[sudo] make install

You can use ./configure --help if you want to get a list of options, though the defaults should be suiting most needs.

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 DreamZNC 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 DreamZNC

Once you have started DreamZNC you can connect with your favorite IRC-client to it. 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) DreamZNC 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.

DreamZNC's config file

This file shouldn't be too hard too understand. An explanation of all the items can be found on the upstream wiki's Configuration-Page. Warning: better not to edit config, while DreamZNC 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 http://dreambnc.xyz/ or any one of out official channels below:

[#DreamBNC@irc.rizon.net] [#WBNC@irc.xerox.us.to] [#WBNC@irc.freenode.org] [#WBNC@irc.mindforge.org]

You can get the latest development version with git: git clone https://github.com/DreamBNC/znc --recursive