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