source: doc/README @ dcfa886

Last change on this file since dcfa886 was 04f0c10, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-10-03T02:50:20Z

At least for now, only enable OTR if the user specifically asks for it.
Distros can now ship a bitlbee-plugin-otr package (that should work with
both bitlbee and bitlbee-libpurple).

  • Property mode set to 100644
File size: 7.9 KB
Line 
1INSTALLATION
2============
3
4If you installed BitlBee from a .deb or .rpm you probably don't have to do
5anything anymore for installation. Just skip this section.
6
7If you want to compile BitlBee yourself, that's fine. Just run ./configure
8to set up the build system. If configure succeeds, run make to build BitlBee.
9make install will move all the files to the right places.
10
11--- (Fork)Daemon mode
12
13These days ForkDaemon mode is the recommended way of running BitlBee. The
14difference between Daemon and ForkDaemon mode is that in the latter, a
15separate process is spawned for every user. This costs a little bit more
16memory, but means that if one user hits a bug in the code, not all other
17users get disconnected with him/her.
18
19To use BitlBee in any daemon mode, just start it with the right flags or
20enable it in bitlbee.conf (see the RunMode option). You probably want to
21write an init script to start BitlBee automatically after a reboot. (This
22is where you realise using a package from your distro would've been a better
23idea. :-P)
24
25Please do make sure that the user BitlBee runs as (not root, please!) is
26able to read from and write to the /var/lib/bitlbee directory to save your
27settings!
28
29--- inetd installation (more or less deprecated)
30
31After installation you have to set up inetd (you got that one running,
32right? If not, just take a look at utils/bitlbeed.c) to start BitlBee. You
33need to add BitlBee to inetd.conf, like this:
34
356667 stream tcp nowait nobody /usr/sbin/tcpd /usr/local/sbin/bitlbee
36
37Creating a special BitlBee user and running BitlBee with that UID (instead
38of just 'nobody') might be a good idea.
39
40*BSD/Darwin/OSX NOTE: Most *BSD inetds are more scrict than the one that
41comes with Linux systems. Possibly all non-Linux inetds are like this. They
42don't allow you to specify a port number in the inetd.conf entry, instead
43you have to put a service name there (one that is also mentioned in
44/etc/services). So if there's no line in /services for 6667/tcp (or whatever
45you choose), add it and use that name in the inetd.conf entry.
46
47-- xinetd installation (equally deprecated)
48
49Most machines use xinetd instead of inetd these days. If your machine runs
50xinetd, you can copy the bitlbee.xinetd file from the doc/ directory to your
51xinetd.d/ directory. Most likely you'll have to change a thing or two before
52it'll work.
53
54After configuring your (x)inetd, send the daemon a SIGHUP and things should
55work. If not, see your syslogs, since both daemons will complain there when
56something's wrong.
57
58Also, don't forget to create the configuration directory (/var/lib/bitlbee/
59by default) and chown it to the UID BitlBee is running as. Make sure this
60directory is read-/writable by this user only.
61
62
63DEPENDENCIES
64============
65
66BitlBee's only real dependency is GLib. This is available on virtually every
67platform. Any recent version of GLib (2.4 or higher) will work.
68
69Off-the-Record encryption support can be included if libotr is available on
70your machine. Pass --otr=1 to configure to build it into BitlBee, or
71--otr=plugin to build it as a separate loadable plugin (mostly meant for
72distro packages).
73
74These days, many IM protocols use SSL/TLS connections (for authentication
75or for the whole session). BitlBee can use several SSL libraries for this:
76GnuTLS, NSS (which comes with Mozilla) and OpenSSL. OpenSSL is not GPL-
77compatible in some situations, so using GnuTLS is preferred. However,
78especially on *BSD, OpenSSL can be considered part of the operating system,
79which eliminates the GPL incompatibility.
80
81The incompatibility is also the reason why the SSL library detection code
82doesn't attempt to use OpenSSL. If you want to use OpenSSL, you have to
83force configure to use it using the --ssl=openssl parameter. For more
84information about this problem, see the URL's configure will write to stdout
85when you attempt to use OpenSSL.
86
87
88PORTABILITY ISSUES
89==================
90
91Cygwin NOTE: You'll need a glib installation to run BitlBee. However, Cygwin
92doesn't provide a glib package. You can download a binary tar.gz from:
93<http://my.dreamwiz.com/jbdoll/>. When you installed it, BitlBee should work
94fine. You'll probably like bitlbeed or xinetd to get it running on the
95network.
96
97On some non-Linux systems the program still suffers from some random bugs.
98Please do report them, we might be able to fix them if they're not too
99mysterious.
100
101Also, the configure script is known to not work very well with non-Bash
102shells, so if you experience problems, make sure you use bash to run the
103script. Same for the Makefile, it only works well with GNU make. (gmake on
104most BSD systems)
105
106If someone can tell us how to write Makefiles that work with both/all
107versions of make, we'd love to hear it, but it seems this just isn't
108possible.
109
110
111USAGE
112=====
113
114Not much to say here, it's all documented elsewhere already. Just connect to
115the new BitlBee IRC server and the bot (root) will tell you what to do.
116
117
118BACKGROUNDS
119===========
120
121We are both console lovers. But it is annoying to have a few tty's open with
122chat things in them. IRC, ICQ, MSN, AIM, Jabber... For X there is Gaim, which
123supports many chatprotocols. Why wasn't there such a thing for the console?
124
125The idea to port Gaim was easily thought of, of course. But we liked our IRC
126clients. And we used it the most, so we used it best. Importing it into the
127IRC client was a nice idea. But what if someone liked a different client.
128Then (s)he had to duplicate our work.
129
130That's a shame, we thought. Doing work twice is pointless. So when Wilmer
131got the ingenious thought in his mind while farming, to create an IRC to
132other chatnetworks gateway, we were both so excited, that we started working
133on it almost immediately. And the result is BitlBee.
134
135
136WEBSITE
137=======
138
139You can find new releases of BitlBee at:
140http://www.bitlbee.org/
141
142The bug tracking system:
143http://bugs.bitlbee.org/
144
145Our version control system is Bazaar. Our repository is at:
146http://code.bitlbee.org/
147
148More documentation on the Wiki:
149http://wiki.bitlbee.org/
150
151
152A NOTE ON PASSWORD ENCRYPTION
153=============================
154
155There used to be a note here about the simple obfuscation method used to
156make the passwords in the configuration files unreadable. However, BitlBee
157now uses a better format (and real encryption (salted MD5 and RC4)) to store
158the passwords. This means that people who somehow get their hands on your
159configuration files can't easily extract your passwords from them anymore.
160
161However, once you log into the BitlBee server and send your password, an
162intruder with tcpdump can still read your passwords. This can't really be
163avoided, of course. The new format is a lot more reliable (because it can't
164be cracked with just very basic crypto analysis anymore), but you still have
165to be careful. The main extra protection offered by the new format is that
166the files can only be cracked with some help from the user (by sending the
167password at login time).
168
169So if you run a public server, it's most important that you don't give root
170access to people who like to play with tcpdump. Also, it's a good idea to
171delete all *.nicks/*.accounts files as soon as BitlBee converted them to the
172new format (which happens as soon as the user logs in, it can't be done
173automatically because it needs the password for that account). You won't
174need them anymore (unless you want to switch back to an older BitlBee
175version) and they only make it easier for others to crack your passwords.
176
177
178LEGAL
179=====
180
181BitlBee is distributed under the GPL (GNU General Public License). See the
182file COPYING for this license.
183
184The MD5 algorithm code is licensed under the Aladdin license. This license
185can be found in the files, to which this applies. The SHA1 algorithm code
186is licensed under the Mozilla Public License, see http://www.mozilla.org/MPL/
187for details.
188
189The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>,
190also licensed under the GPL.
191
192
193        BitlBee - An IRC to other chat networks gateway
194                  <http://www.bitlbee.org/>
195        Copyright (C) 2002-2010  Wilmer van der Gaast <wilmer@gaast.net>
196                                 and others
Note: See TracBrowser for help on using the repository browser.