Difference between revisions of "Znc"

From ArchWiki
Jump to: navigation, search
m (Spelling)
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Daemons and system services (English)]]
+
[[Category:Internet Relay Chat]]
[[Category:Internet Relay Chat (English)]]
+
'''ZNC''' is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without losing the chat session.
{{i18n|Znc}}
+
  
 +
== 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}}.
  
'''ZNC''' is an advanced IRC bouncer that is left connected so an IRC client can disconnect/reconnect without loosing the chat session.
+
{{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}}}}
  
== Init script ==
+
2. Generate ZNC config as user '''znc'''.
 +
# su - 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.}}
  
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:
+
3. To make ZNC start on boot:
 +
# systemctl enable znc
  
1. Install and create a config as normal:
+
Start and stop the ZNC daemon as usual by running:
  
  pacman -S znc
+
# systemctl {start|stop|restart} znc
  znc --makeconf
+
  
2. Move the generated config to a global directory:
+
== 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'''.
  
  mkdir /etc/znc
+
=== Webadmin Module ===
  mv /home/$USER/.znc/* /etc/znc/
+
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.
  rm -rf /home/$USER/.znc
+
 
+
3. Create a new system user account
+
 
+
  useradd --system --no-create-home --user-group znc
+
 
+
4. Apply the correct permissions to the configuration directory
+
 
+
  chown -R znc:znc /etc/znc
+
 
+
5. Copy the prepared [https://gist.github.com/1266098 init script] to {{ic|/etc/rc.d/znc}} and make it executable
+
 
+
  cd /etc/rc.d
+
  wget https://raw.github.com/gist/1266098/b5530ead3f797ef344fb0e0cba16d270281d087b/znc
+
  chmod +x znc
+
 
+
6. Add znc to the [daemons] section in '''/etc/rc.conf'''.
+
 
+
Start and stop the ZNC daemon as usual by running:
+
  rc.d {start|stop|restart} znc
+
  
== External links ==
+
=== Control Panel Module ===
 +
If you enabled the control panel module, {{ic|/msg *controlpanel help}} for a list of settings while you are connected to the server.
  
* [http://wiki.znc.in/ZNC ZNC (website)]
+
== See also ==
* [http://doomclaw.de/index.php/2009/08/18/run-znc-at-boot-with-an-init-script/ Init script guide]
+
* [http://wiki.znc.in/ZNC ZNC's website]

Revision as of 20:40, 4 January 2013

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

Installation

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

Note: A bug in znc.install (znc 1.0-2) sets the znc user's home directory as /var/empty. /var/lib/znc is still created and owned by the correct user/group. You should change znc's home directory to /var/lib/znc

2. Generate ZNC config as user znc.

# su - 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.

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

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:znc 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