1
0
forked from bip/bip
Reviews and pull-requests of the Bip IRC proxy project take place here.
Go to file
Loïc Gomez 8eda1ace0e bipgenconfig script :
- add missing options
- generate options before sub-blocks (for example in user block)
- fix loadConfig not loading networks and users as arrays
- add compatibility process to rename old options to their new names
  when loading config from bipgenconfig store
2008-01-07 15:22:28 +01:00
samples Merge branch 'master' of http://bip.t1r.net/bip 2007-11-25 16:12:36 +01:00
scripts bipgenconfig script : 2008-01-07 15:22:28 +01:00
src fix misleading fatal() message (pidfile error) 2008-01-07 14:00:25 +01:00
AUTHORS Fix AUTHORS 2007-02-01 22:07:10 +00:00
bip.1 add -s option to set bip homedir 2006-07-02 13:24:43 +00:00
bip.conf.1 Merge branch 'master' of http://bip.t1r.net/bip 2008-01-07 13:47:12 +01:00
bipmkpw.1 man fixe, author fixes 2005-10-18 08:00:55 +00:00
bootstrap Drop autostuff noise. Add boostrap to regenerate it. 2007-09-02 18:26:27 +02:00
BUGS Add comment in sample. 2007-05-23 19:29:56 +00:00
ChangeLog add backlog option to channels. 2007-09-27 01:08:10 +02:00
configure.in Lots of structural changes. 2007-09-02 14:59:19 +02:00
COPYING typos 2005-11-17 15:36:19 +00:00
INSTALL Initial import 2005-04-28 08:26:44 +00:00
Makefile.am Initial import 2005-04-28 08:26:44 +00:00
NEWS Update news file. 2007-12-09 14:10:33 +01:00
README Fix README (thanks to Brian Evans). 2008-01-01 13:59:48 +01:00
README.floodcontrol add new options to bip.vim syntax file 2007-01-27 20:53:03 +00:00
TODO Merge branch 'master' of http://bip.t1r.net/bip 2007-11-25 16:12:36 +01:00

Bip can be used in two different way:
- Old school bnc user style: easy and straightforward.
- Unix service style with and init.d scripts and the logs in /var/log

This small README file explains the usage "Old school" with which : 
 - you do not need the root privileges.
 - gives easy access to the logs of the users of this bip to the one owning the
   shell.

Install bip on the machine that will be running bip (which is likely to be your
personnal or shared server) either compiling the package or using your distro's
package. Then create a configuration file:

If you are using a distribution package, the bip.conf sample configuration file
is likely to be shipped in /usr/share/doc/bip/examples/bip.conf.gz or something
similar.

Create your bip configuration an log directory:

# mkdir -p ~/.bip/logs

Put the uncompressed configuration file in your ~/.bip directory (it's path
should be ~/.bip/bip.conf), and edit it, most importantly the "user" section
that contains information about you and the servers you will want to connect
to. The "name" field in the "user" section is your login to connect to bip.
The "password" field is a hash of the password you will use to connect to bip.
To generate a hash value from a password, use bipmkpw, program which comes in
the bip package and source.
The "name" field of the "connection" subsections are the server identifier for
when you connect to bip.

Once all this is configured, start bip as you regular user:

# bip

Once bip starts, it connects to the different servers your defined in
"connection". Then you want to use your regular irc client and connect to bip.
Point your client to the machine bip is running and set the proper port number
(defined in your bip.conf). You should then configure the client to use a
specific irc server password constructed this way:

user:password:network

The user is the name field of the "user" section, the password is the password
(*not* the hash) corresponding to the "password" field of the same user section
(which is the hash generated with bipmkpw) and the network is the "name" field
of the "connection" subsection. This is how bip authenticates you and puts your
client to the correct network.

Using the default (or sample file) configuration, logs are in ~/.bip/logs/

Happy ircing!