1
0
forked from bip/bip
Reviews and pull-requests of the Bip IRC proxy project take place here.
Go to file
Arnaud Cornet 909fe5e1c1 Lots of structural changes.
Move backlog options to user statment.
Drop ircise, to go towards real SIGHUP support.
2007-09-02 14:59:19 +02:00
samples Lots of structural changes. 2007-09-02 14:59:19 +02:00
scripts Add configuration directive to be able not to log bip information (not irc related, that is) 2007-07-01 12:43:09 +00:00
src Lots of structural changes. 2007-09-02 14:59:19 +02:00
aclocal.m4 Update build system. 2007-01-05 21:22:30 +00: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 Add configuration directive to be able not to log bip information (not irc related, that is) 2007-07-01 12:43:09 +00:00
bipmkpw.1 man fixe, author fixes 2005-10-18 08:00:55 +00:00
BUGS Add comment in sample. 2007-05-23 19:29:56 +00:00
ChangeLog Lot's of cleanups. 2007-05-26 10:31:44 +00:00
config.guess Initial import 2005-04-28 08:26:44 +00:00
config.sub Initial import 2005-04-28 08:26:44 +00:00
configure Lots of structural changes. 2007-09-02 14:59:19 +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
depcomp this file is for automake 2006-01-29 21:16:34 +00:00
INSTALL Initial import 2005-04-28 08:26:44 +00:00
install-sh Initial import 2005-04-28 08:26:44 +00:00
Makefile.am Initial import 2005-04-28 08:26:44 +00:00
Makefile.in Update build system. 2007-01-05 21:22:30 +00:00
missing new missing file and autoheader 2006-01-31 17:24:53 +00:00
mkinstalldirs Initial import 2005-04-28 08:26:44 +00:00
NEWS Lots of structural changes. 2007-09-02 14:59:19 +02:00
README YAY! a readme file ! 2006-11-16 13:36:24 +00:00
README.floodcontrol add new options to bip.vim syntax file 2007-01-27 20:53:03 +00:00
stamp-h.in Initial import 2005-04-28 08:26:44 +00:00
TODO some stuff TODO 2007-05-31 22:09:24 +00:00
ylwrap Update build sys, try 3 2007-01-05 21:27:35 +00: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 *hash* of
the password you entered in the "password" field of the same user section (the
hash is 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!