ZNC
From SHellium Wiki
| This page needs attention. Please make proper updates and then remove this template. Reason: Update to include detailed explanations of each of the settings of ZNC |
This howto shows users how to access their ZNC account hosted on SHellium or any other ZNC account.
Contents |
What is ZNC?
ZNC is a dream IRC bouncer with lots of features. ZNC keeps you continuously connected to IRC to guard your nickname, even when you are offline. Installing a ZNC on your shell allows you to have multiple users/clients connected at one time but only uses one background process. The program also allows SSL connections, and includes a user-friendly Web admin interface and various optional modules for advanced users. Modules can extend the functionality of ZNC, accepting tcl, perl and even C++.
ZNC is just the BNC; drop the B and add the Z instead.
Please remember!
A znc running on a SHellium shell is allowed a maximum of 4 users - 3 users and the owner. Running more than 4 users in one ZNC will result in your shell account being locked.
Also remember to run the 'myports' command when using any process requiring ports. This command will show you your two (2) assigned ports, and if you are running any ports that do not belong to you. Running any port or ports other than the two assigned to you will lock your account.
Install and configure ZNC
Warning
IPv4 vhosts can work only with IPv4 servers, and IPv6 vhosts can work only with IPv6 servers. Run vhosts and v6hosts on shell to look to both lists of vhosts.
Preinstalled ZNC
Every SHellium-user can use a preinstalled ZNC. Using this ZNC will not count as a background-process.
All you have to do, is configure the ZNC.
- On IRC do /msg bot|shellium zncaddr yourusername
- Attention!
- This is how you know your port number. In the next lines, 7010 is used just as an example.
- Log in to your ZNC account using your shell username and password with your favourite web browser to host/port from bot|shellium, for example: https://znc1.shellium.org:7010
If you see a prompt that says the certificate is invalid just select accept.
- Add an irc server for the bouncer to connect to.
The default port is 6667 but you must specify the port after the server ONLY if you'd like to connect to a different port.
Please note that 1 user of preinstalled ZNC can only connect to one server at a time
- Below you can choose which modules you wish to use on your BNC.
- You can also add channels below that the bouncer will join on connect.
Once you finish the steps above, the bouncer will automatically connect to server you have listed and join any channels that entered.
Installing ZNC on your Shell
You can also install ZNC on your shell.
PLEASE NOTE: Running a ZNC on your own shell will count as one of your two allowed background processes.
- How to Install
- Login to your shell
- Run myports to see what ports you can use, and select one.
- Start your ZNC in config-creation mode:
znc --makeconf
or
znc -c
and answer questions.
What port do you like ZNC to listen on: Here you type the listening port for ZNC. Run myports to see the available ports.
Would you like ZNC to listen using SSl: Type yes if you want to use SSl, or type no if you don't
Listen Host: Leave it blank
Username:Here you type the username that you will use to login to the bouncer and to the webpanel
Password:Here you type the password that you will use to login to the bouncer and to the webpanel
Would you like this user to be an admin: If it is your account, type yes, if this is not or you will use you bnc alone, type no.
Number of lines to buffer per channel: Here you type the maximum lines of the log/buffer of a channel. I recommend 100 .
Would you like to keep the buffer after reply: If you don't want to use much disk space, type no
Default channel modes: I recommand you just press enter here
Now you are ready to go. Have fun using ZNC.
If you encounter any problems while installing ZNC, join #SHellium on Freenode and we will try to help you.
Connecting to ZNC
This assumes that you use preinstalled ZNC. If you want to connect to ZNC running on your shell, use your port instead of 7010.
Text Clients
Clients like irssi, irc, bitchx, and others should connect to the bouncer in the manner described below. Graphical clients can also use the same commands below to connect.
Irssi
Launch irssi.
- The command below will allow you to connect to the bouncer with SSL on port 7010
/connect -ssl znc.shellium.org 7010 yourshellusername:yourshellpass
The -ssl option after /connect allows secure connection via SSL.
Other text IRC clients
Launch your IRC client.
- The command below will allow you to connect to the bouncer with SSL on port 7010
/server znc.shellium.org +7010 yourshellusername:yourshellpass
The + sign before the port number allows secure connection via SSL.
Once you are connected you may control your bouncer by issuing it commands. Read the External Links section below for a list of all the commands.
Graphical Clients
Graphical clients usually allow the same solution as text clients. It's up to you which method to choose.
Konversation
Konversation users should follow next simple steps:
- Launch Konversation then press F2 to see the Network List dialogue box.
- Press New button and then type desired name for your connection in Network name field.
- Click Edit next to Identity, change Default Identity or add a new. Fill in Real name field and add a Nickname.
- Move to Advanced tab and change Ident field to your shell username. Without it Konversation would not connect! Press Ok.
- Click Add , than type
znc.shellium.orgin Server field , change port to7010
- Fill in your shell password and select Secure connection(SSL) checkbox , than Ok.
Xchat
Xchat users should simply add a new network and insert their shell name and password to connect to the bouncer without issuing commands.
- Launch Xchat then press Ctrl+S to see the Network List dialogue box
- Click add then name the network something that you will remember such as shelliumznc
- Change the section that says
nameserver/6667to this below
znc.shellium.org/7010
- Deselect the box that says User global user information
- Enter your shell login name in the Username section and your password on the Server Password section
- Select the following boxes:
- Use SSL for all the servers in this network
- Accept Invalid SSL Certificate
mIRC
mIRC users can connect manually using the commands listed above or add the bouncer into their server list.
- Launch mIRC and press Ctrl+O (sometimes Alt+O) to see the Options window.
- Choose Servers under Connect and Click Add.
- Enter a description you would like to use. Set the IRC server to:
znc.shellium.org
- In the Ports field enter +7010
- Set the Group to something to keep it separate from the other networks.
- In the password box, enter your shell username and shell password in this fashion:
yourshellusername:yourshellpass
- Click Add and Select your new entry in the list and click Select. This will allow you to just click the Connect icon on the toolbar to connect in the future.
Note: mIRC supports SSL since v6.14. If you are using an older version or it simply doesn't work, upgrade to the latest mIRC version (Download).
Note: To connect to ipv6 with mIRC you will need to install the mircv6 dll (mircv6)
SSL-error
It's possible you will get the following error when trying to connect with mIRC:
[9:26:00 AM] * SSL error: ssl not available - [9:26:00 AM] * Connect cancelled - * /server: ssl not available
To solve this, all you have to do is close mIRC and then download and install OpenSSL.
You will need install this either in the mIRC folder (typically C:\Program Files\mIRC) or in the Windows System folder (typically C:\Windows\System32).
After that, restart your mIRC and you're good to go.
IMAP-error
Sometimes if you try to connect with with mIRC using the connect button, you will get the following error:
[20:02] Invalid User - Halting IMAP Lookup - [20:02] * [10101] Host disconnected
To solve this, you will have to type /server znc.shellium.org:port username:pass into the status box.
Colloquy
Colloquy users should add a new network with shell name and password to connect via the GUI.
- Launch Colloquy and press Option+1 to see the connections window.
- Click New and expand the dialog using the arrow next to 'Details'.
- Set the IRC server to:
znc.shellium.org
- Check 'Remember this connection'
- Set 'Chat Server Port' to
7010and check 'SSL Connection'.
- Enter your shell username and password in the corresponding fields.
- Click 'Connect'.
NetTalk
- Launch NetTalk and click on "New"
- On IP or server name put:
znc.shellium.org
- On Server port put your znc port.
- Select the nickname, leave password empty and put your shell user as the User-ID
- Put your shell password in Server Password
- Leave commands after login empty
- Click on 'Complete' and your all done.
Once you are connected you may control your bouncer by issuing it commands. Read the External Links section below for a list of all the commands.