Difference between revisions of "Znc"

From ArchWiki
Jump to: navigation, search
m (Init script)
m (Installation: no need to give znc a login shell and increase the attack vector.)
 
(14 intermediate revisions by 8 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.
+
{{Related articles start}}
 +
{{Related|PsyBNC}}
 +
{{Related articles end}}
 +
'''ZNC''' is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without losing the chat session.
  
== Init script ==
+
== Installation ==
  
By default, ZNC does not include an daemon init script (like those usually found in {{ic|/etc/rc.d/}}). It maybe preferable to run ZNC as a daemon:
+
[[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}}.
  
1. Install {{pkg|znc}} from the [[Official Repositories]].
+
Generate ZNC config as user '''znc'''.
 +
$ sudo -u znc znc --makeconf
 +
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.}}
  
2. Create a znc group and user
+
[[Enable]] {{ic|znc.service}} to make it start on boot. Start and stop the ZNC daemon as usual with [[systemd]].
  
groupadd -r znc
+
== Configuration ==
useradd -r -g znc -d /var/lib/znc -s /bin/false -c znc znc
+
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'''.
mkdir -p /var/lib/znc
+
chown znc:znc /var/lib/znc
+
  
{{Out of date|Arch Linux has moved to systemd, so rc.conf is no longer used.}}
+
=== Webadmin Module ===
3. Install rc.d and conf.d script:
+
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.
  
wget -O /etc/rc.d/znc https://raw.github.com/kylef/ark/master/znc-system-wide/znc.rcd
+
=== Control Panel Module ===
chmod a+x /etc/rc.d/znc
+
If you enabled the control panel module, {{ic|/msg *controlpanel help}} for a list of settings while you are connected to the server.
wget -O /etc/conf.d/znc https://raw.github.com/kylef/ark/master/znc-system-wide/znc.conf
+
 
+
4. Generate ZNC config:
+
 
+
rc.d makeconf znc
+
 
+
To make ZNC start on boot, add ZNC to <code>DAEMONS</code> in <code>/etc/rc.conf</code>.
+
 
+
Start and stop the ZNC daemon as usual by running:
+
 
+
rc.d {start|stop|restart} znc
+
  
 
== See also ==
 
== See also ==
 
 
* [http://wiki.znc.in/ZNC ZNC's website]
 
* [http://wiki.znc.in/ZNC ZNC's website]

Latest revision as of 02:41, 23 August 2016

Related articles

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.

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.

Enable znc.service to make it start on boot. Start and stop the ZNC daemon as usual with systemd.

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.

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