» Documentation


Big thanks goes out to Sander "Nakebod" Rutten from The Netherlands for making this awsome documentation

Logging in for the first time

Start your favorite IRC client.
Connect to your phpbnc server, mostly done with:
/server IP:port - Default portnumbers: (TCP) 31337, (SSL) 31338.
* Connecting to 127.0.0.1 (31337)
-

          _               ___      __   ___  
    _ __  | |__   _ __    / __\  /\ \ \ / __\ 
   | '_ \ | '_ \ | '_ \  /__\// /  \/ // /   
   | |_) || | | || |_) |/ \/  \/ /\  // /___  
   | .__/ |_| |_|| .__/ \_____/\_\ \/ \____/  
   |_|           |_|                          
                      By Daniel "blodan" Ylitalo 

    www.phpBNC.se / .com / .org / .eu / .net / .nu

   There are 1 client(s) connected to the BNC server.

    Please login using /login <username> <password>

Note for IRSSI users: You need to use /quote in front of every command. So you need to type /quote login <username> <password>

After loging in, you will automatically join phpbnc's system channel, in most clients shown as: &system.
In the status window of your IRC client, you can read that you are not connected to any IRC network.
-phpBNC- You are now logged in as admin.
-
-phpBNC- For list of commands use /bhelp
-
* Your nick is now admin
-
001 admin Welcome to the IRC Network admin
-
-phpBNC- You are NOT connected to a IRC server yet, use /bconnect to connect.

Before we continue, we are going to add a new user, and delete the excisting admin user for security reasons.
Remember to always configure your bnc in the query window, that way no "miss-pastes" can happen!

We are now going to add a new user, and give this new user admin rights.
/pb adduser user_name pass_word
/pb admin user_name 2
/pb aset user_name password pass_word
The last command is only due to a bug in the adduser command in 0.17-beta, versions after that doesnt need to run the /pb aset command

&system channel: Results of the above commands.
<@phpBNC> ADMIN: admin added user user_name.
<@phpBNC> ADMIN: admin changed adminlevel on user_name from 0 to 2.

We are now going to disconnect from phpbnc, and reconnect to it again.
Now, instead of using the default admin user, login in with your new user and password.

After we are logged in you will join phpbnc's system channel again.
If this isn't the case, your phpbnc account doesn't have admin priveleges!
But don't worry! You can't delete the admin user without admin priveleges, so no mistakes can happen. Just login again with the default admin account and try again.
/pb deluser admin

&system channel: The admin user is deleted.
<@phpBNC> ADMIN: user_name deleted admin

Before we can start, we need to setup a v-host, and add that vhost to an user.
Your v-host is most likely your domainname, otherwise use your external IP address.
Only Super-Admins can add vhosts.

The default syntax is: /pb addhost <number> <hostname> - adds a v-host
The <number> value is used for the amount of users who are able to use this v-host.
Depending on your needs, this amount can change.

Please note that most IRC servers only allow 3-5 connections from 1 host at the same time.
If you need more connections, you need to have multiple external IP addresses with different v-hosts for each IP address.
Or in some cases, you can contact the server owners, to raise your connection limit.
/pb addhost 10 your_domainname.tld

&system channel: v-host added, limited for 10 users.
<@phpBNC> ADMIN: user_name added the v-host your_domainname.tld with a limit of 10 user(s).

Now we have added a v-host. This host can be used by 10 users.
At this point you need to assign this v-host to your useraccount.
/pb set host your_domainname.tld

In your status window of your IRC client, you can now see the result of this command.
-phpBNC- V-host changed to your_domainname.tld, please do a /breconnect for it to change.

Since we aren't connected to a server, yet, we don't need to reconnect.

It is possible that your username, awaynick and realname are already setup with default values after adding your user.
Mostlikely you want to change this default values.
/pb set nick username
/pb set awaynick username`Away
/pb set awaymsg I'm gone for a while!
/pb set realname Your_Name
/pb set server irc.some_irc_net.tld

The results of this commands are displayed in your status window (Not your system channel) of your IRC client.
* Your nick is now username
-
-phpBNC- Your nick has been updated.
-
-phpBNC- Your away-nick has been updated.
-
-phpBNC- Your away-msg has been updated.
-
-phpBNC- Your realname has been updated.
-
-phpBNC- Your server has been updated.

After you have configured your settings, we are ready to connect to the server!
/bconnect
-phpBNC- Trying to connect you to irc.somenet.tld..

You should now be able to see the Message Of The Day (MOTD), if you didn't disable this in your client.
This means you are connected to the IRC server, via phpbnc!
Index:
[+] installing
-windows
-linux/freebsd
-configuration
-ssl certificate

[+] running
-starting the software
-logging in for the first time
-different ways of logging in
-updating users settings

[+] commands
-bconnect
-breconnect
-bquit
-brestore
-bclear
-readlog
-dellog
-pb set
-pb list
-pb del
-pb myinfo
-pb uptime

-pb aset
-pb stats
-pb kick
-pb banchan
-pb unbanchan
-pb find
-pb check
-pb info
-pb ban
-pb unban
-pb addhost
-pb delhost
-pb allmsg
-pb trail
-pb untrail
-pb admin
-pb adduser
-pb deluser

© 2007-2010 phpBNC.se