source: doc/user-guide/Installation.xml @ 1999fe5

Last change on this file since 1999fe5 was 1999fe5, checked in by dequis <dx@…>, at 2016-12-26T00:18:55Z

Misc documentation updates

  • Remove a bunch of mentions of yahoo
  • Remove 'smileys' topic from help index
  • Add 'identify_methods' help topic
  • Mention new commands like 'chat list' or 'plugins'
  • Property mode set to 100644
File size: 4.6 KB
Line 
1<chapter id="Installation">
2
3<title>Installation</title>
4
5<sect1>
6<title>Downloading the package</title>
7
8<para>
9The latest BitlBee release is always available from <ulink
10url="http://www.bitlbee.org/">http://www.bitlbee.org/</ulink>.
11Download the package with your favorite program and unpack it: <command>tar
12xvfz bitlbee-&lt;version&gt;.tar.gz</command> where &lt;version&gt; is to be
13replaced by the version number of the BitlBee you downloaded (e.g. 0.91).
14</para>
15
16</sect1>
17
18<sect1>
19<title>Compiling</title>
20<para>
21BitlBee's build system has to be configured before compiling. The
22<filename>configure</filename> script will do this for you. Just run
23it, it'll set up with nice and hopefully well-working defaults. If you
24want to change some settings, just try
25<command>./configure --help</command> and see what you can do.
26</para>
27
28<para>Some variables that might be of interest to the normal user:</para>
29
30<itemizedlist>
31<listitem><para>prefix, bindir, etcdir, mandir, datadir - The place where
32all the BitlBee program files will be put. There's usually no reason to
33specify them all separately, just specifying prefix (or keeping the default
34<filename>/usr/local/</filename>) should be okay.</para></listitem>
35<listitem><para>config - The place where BitlBee will save all the per-user
36settings and buddy information. <filename>/var/lib/bitlbee/</filename>
37is the default value.</para></listitem>
38<listitem><para>msn, jabber, oscar, twitter - By default, support for all
39these IM-protocols (OSCAR is the protocol used by both ICQ and AIM) will
40be compiled in. To make the binary a bit smaller, you can use these options
41to leave out support for protocols you're not planning to use.</para></listitem>
42<listitem><para>debug - Generate an unoptimized binary with debugging symbols,
43mainly useful if you want to do some debugging or help us to track down a
44problem.</para></listitem>
45<listitem><para>strip - By default, unnecessary parts of the generated binary
46will be stripped out to make it as small as possible. If you don't want this
47(because it might cause problems on some platforms), set this to 0.
48</para></listitem>
49<listitem><para>flood - To secure your BitlBee server against flooding attacks,
50you can use this option. It's not compiled in by default because it needs
51more testing first.</para></listitem>
52<listitem><para>ssl - The MSN and Jabber modules require an SSL library for
53some of their tasks. BitlBee can use three different SSL libraries: GnuTLS,
54mozilla-nss and OpenSSL. (OpenSSL is, however, a bit troublesome because of
55licensing issues, so don't forget to read the information configure will
56give you when you try to use OpenSSL!) By default, configure will try to
57detect GnuTLS or mozilla-nss. If none of them can be found, it'll give up.
58If you want BitlBee to use OpenSSL, you have to explicitly specify that.
59</para></listitem>
60</itemizedlist>
61
62<para>
63After running <filename>configure</filename>, you should run
64<command>make</command>. After that, run <command>make install</command> as
65root.
66</para>
67
68</sect1>
69
70<sect1>
71<title>Configuration</title>
72
73<para>
74By default, BitlBee runs as the user nobody. You might want
75to run it as a separate user (some computers run named or apache as nobody).
76</para>
77
78<para>
79Since BitlBee uses inetd, you should add the following line to <filename>/etc/inetd.conf</filename>:
80</para>
81
82<para>
83<programlisting>
846667    stream  tcp     nowait nobody /usr/local/sbin/bitlbee bitlbee
85</programlisting>
86</para>
87
88<para>
89Inetd has to be restarted after changing the configuration. Either
90<command>killall -HUP inetd</command> or
91<command>/etc/init.d/inetd restart</command> should do the job on most systems.
92</para>
93
94<para>
95You might be one of the.. ehr, lucky people running an xinetd-powered distro.
96<command>xinetd</command> is quite different and they seem to be proud of that.. ;-)
97Anyway, if you want BitlBee to work with <command>xinetd</command>, just copy the
98bitlbee.xinetd file to your /etc/xinetd.d/ directory (and probably edit it to suit
99your needs).
100</para>
101
102<para>
103You should create a directory where BitlBee can store it's data files. This
104should be the directory named after the value 'CONFIG' in Makefile.settings.
105The default is <filename>/var/lib/bitlbee</filename>, which can be created
106with the command <command>mkdir -p /var/lib/bitlbee</command>. This
107directory has to be owned by the user that runs bitlbee. To make
108'nobody' owner of this directory, run <command>chown nobody /var/lib/bitlbee</command>.
109Because things like passwords are saved in this directory, it's probably
110a good idea to make this directory owner-read-/writable only.
111</para>
112</sect1>
113
114</chapter>
Note: See TracBrowser for help on using the repository browser.