All Projects → znc → Znc

znc / Znc

Licence: apache-2.0
Official repository for the ZNC IRC bouncer

Programming Languages

C++
36643 projects - #6 most used programming language
javascript
184084 projects - #8 most used programming language
CMake
9771 projects
CSS
56736 projects
perl
6916 projects
python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to Znc

Thelounge
💬 ‎ Modern, responsive, cross-platform, self-hosted web IRC client
Stars: ✭ 4,618 (+149.49%)
Mutual labels:  hacktoberfest, irc
Go Twitch Irc
go irc client for twitch.tv
Stars: ✭ 155 (-91.63%)
Mutual labels:  hacktoberfest, irc
Kittehircclientlib
An IRC client library in Java
Stars: ✭ 116 (-93.73%)
Mutual labels:  hacktoberfest, irc
Eggdrop
The Eggdrop IRC Bot
Stars: ✭ 314 (-83.04%)
Mutual labels:  hacktoberfest, irc
Sopel
🤖💬 An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
Stars: ✭ 894 (-51.7%)
Mutual labels:  hacktoberfest, irc
Lax
IRC client built with Electron & React
Stars: ✭ 95 (-94.87%)
Mutual labels:  hacktoberfest, irc
Irslackd
Self-hosted IRC gateway to Slack
Stars: ✭ 128 (-93.08%)
Mutual labels:  hacktoberfest, irc
Materialdrawer
The flexible, easy to use, all in one drawer library for your Android project. Now brand new with material 2 design.
Stars: ✭ 11,498 (+521.18%)
Mutual labels:  hacktoberfest
Rom Rails
Rails integration for Ruby Object Mapper
Stars: ✭ 146 (-92.11%)
Mutual labels:  hacktoberfest
Laravel Ide Helper
Laravel IDE Helper
Stars: ✭ 11,893 (+542.52%)
Mutual labels:  hacktoberfest
Hedgedoc
HedgeDoc - The best platform to write and share markdown.
Stars: ✭ 2,498 (+34.95%)
Mutual labels:  hacktoberfest
100daysofmlcode
My journey to learn and grow in the domain of Machine Learning and Artificial Intelligence by performing the #100DaysofMLCode Challenge.
Stars: ✭ 146 (-92.11%)
Mutual labels:  hacktoberfest
Django Sql Explorer
Easily share data across your company via SQL queries. From Grove Collab.
Stars: ✭ 1,958 (+5.78%)
Mutual labels:  hacktoberfest
Photoprism
Photos App powered by Go and Google TensorFlow 🌈
Stars: ✭ 17,946 (+869.53%)
Mutual labels:  hacktoberfest
Hacktoberfest2020
Make your first PR! ~ A beginner-friendly repository. Add your profile, a blog, or any program under any language (it can be anything from a hello-world program to a complex data structure algorithm) or update the existing one. Just make sure to add the file under the correct directory. Happy hacking!
Stars: ✭ 147 (-92.06%)
Mutual labels:  hacktoberfest
Eureka
Elegant iOS form builder in Swift
Stars: ✭ 11,345 (+512.91%)
Mutual labels:  hacktoberfest
Documentation
The source for Datadog's documentation site.
Stars: ✭ 147 (-92.06%)
Mutual labels:  hacktoberfest
Handwritten.js
Convert typed text to realistic handwriting!
Stars: ✭ 1,806 (-2.43%)
Mutual labels:  hacktoberfest
Crafttweaker
Tweak your minecraft experience
Stars: ✭ 146 (-92.11%)
Mutual labels:  hacktoberfest
Voctoweb
voctoweb – the frontend and backend software behind media.ccc.de
Stars: ✭ 146 (-92.11%)
Mutual labels:  hacktoberfest

ZNC - An advanced IRC bouncer

GitHub Workflow Status Jenkins Build Status AppVeyor Build status Bountysource Coverage Status Coverity Scan Build 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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].