Difference between revisions of "ZNC"

From ArchWiki
Jump to: navigation, search
m
(Configuration: Removed redundant information and made the language more precise to improve clarity)
 
(16 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
[[Category:Internet Relay Chat]]
 
[[Category:Internet Relay Chat]]
'''ZNC''' is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without loosing the chat session.
+
[[ja:Znc]]
 +
{{Related articles start}}
 +
{{Related|PsyBNC}}
 +
{{Related articles end}}
 +
[https://wiki.znc.in/ZNC ZNC] is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without losing the chat session.
  
 
== Installation ==
 
== Installation ==
1. Install {{pkg|znc}} from the [[Official Repositories]]. The installation script will create a group and user '''znc'''. The default home directory for this user is {{ic|/var/lib/znc}}.
 
  
{{Note| A bug in znc.install (znc 1.0-2) sets the znc user's home directory as {{ic|/var/empty}}. {{ic|/var/lib/znc}} is still created and owned by the correct user/group. You should change znc's home directory to {{ic|/var/lib/znc}}}}
+
[[Install]] the {{pkg|znc}} package. The installation script will create a group and user '''znc'''. The default home directory for this user is {{ic|/var/lib/znc}}.
  
2. Generate ZNC config as user '''znc'''.
+
Generate ZNC config as user '''znc'''.
  # su - znc
+
  $ sudo -u znc znc --makeconf
$ znc --makeconf
+
Go through the wizard and setup your preferences. [[Start/enable]] {{ic|znc.service}}.
Go through the wizard and setup your preferences.
 
{{warning|Do not edit configuration files manually in a text editor while ZNC is running. There is a very good chance you will lose your configuration. Use the webadmin or controlpanel modules to change settings on-the-fly. They are both included in the package.}}
 
 
 
3. To make ZNC start on boot:
 
# systemctl enable znc
 
 
 
Start and stop the ZNC daemon as usual by running:
 
 
 
# systemctl {start|stop|restart} znc
 
  
 
== Configuration ==
 
== Configuration ==
Though you can choose to modify your configuration files manually, this requires shutting down the server first. '''Do not edit configuration files while ZNC is running'''.
+
Though you can choose to modify your configuration files manually, this requires shutting down the server first. To load a module when {{ic|znc.service}} starts, add {{ic|LoadModule <nowiki>=</nowiki> <modulename>}} to the configuration file: {{ic|/var/lib/znc/.znc/configs/znc.conf}}.
 +
{{warning|'''Do not edit {{ic|/var/lib/znc/.znc/configs/znc.conf}} while ZNC is running'''. There is a very good chance you will lose your configuration. Use the webadmin or controlpanel modules to change settings on-the-fly. They are both included in the package.}}
  
 
=== Webadmin Module ===
 
=== Webadmin Module ===
If you enabled the web admin module, you can access it at {{ic|http://''yourhostname'':''znc port''}}, the znc port number is the same as you defined for connecting to the bouncer.
+
If you enabled the web admin module, you can access it at {{ic|http://''yourhostname'':port''}}, the znc port number is the same as you defined for connecting to the bouncer.
  
 
=== Control Panel Module ===
 
=== Control Panel Module ===

Latest revision as of 18:22, 23 January 2018

ZNC is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without losing the chat session.

Installation

Install the znc package. The installation script will create a group and user znc. The default home directory for this user is /var/lib/znc.

Generate ZNC config as user znc.

$ sudo -u znc znc --makeconf

Go through the wizard and setup your preferences. Start/enable znc.service.

Configuration

Though you can choose to modify your configuration files manually, this requires shutting down the server first. To load a module when znc.service starts, add LoadModule = <modulename> to the configuration file: /var/lib/znc/.znc/configs/znc.conf.

Warning: Do not edit /var/lib/znc/.znc/configs/znc.conf while ZNC is running. There is a very good chance you will lose your configuration. Use the webadmin or controlpanel modules to change settings on-the-fly. They are both included in the package.

Webadmin Module

If you enabled the web admin module, you can access it at http://yourhostname:port, the znc port number is the same as you defined for connecting to the bouncer.

Control Panel Module

If you enabled the control panel module, /msg *controlpanel help for a list of settings while you are connected to the server.

See also