source: doc/user-guide/Installation.xml @ 37ef2cb

Last change on this file since 37ef2cb was 53cd518, checked in by Wilmer van der Gaast <github@…>, at 2023-06-12T10:55:32Z

Modernize texts

...there is no more ICQ, MSN or AIM support in BitlBee

  • Property mode set to 100644
File size: 4.4 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="https://www.bitlbee.org/">https://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. 3.6).
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>jabber, twitter - By default, support for all these IM-protocols
39will be compiled in. To make the binary a bit smaller, you can use these options
40to leave out support for protocols you're not planning to use.</para></listitem>
41<listitem><para>debug - Generate an unoptimized binary with debugging symbols,
42mainly useful if you want to do some debugging or help us to track down a
43problem.</para></listitem>
44<listitem><para>strip - By default, unnecessary parts of the generated binary
45will be stripped out to make it as small as possible. If you don't want this
46(because it might cause problems on some platforms), set this to 0.
47</para></listitem>
48<listitem><para>flood - To secure your BitlBee server against flooding attacks,
49you can use this option. It's not compiled in by default because it needs
50more testing first.</para></listitem>
51<listitem><para>ssl - BitlBee can use three different SSL libraries: GnuTLS,
52mozilla-nss and OpenSSL. (OpenSSL is, however, a bit troublesome because of
53licensing issues, so don't forget to read the information configure will
54give you when you try to use OpenSSL!) By default, configure will try to
55detect GnuTLS or mozilla-nss. If none of them can be found, it'll give up.
56If you want BitlBee to use OpenSSL, you have to explicitly specify that.
57</para></listitem>
58</itemizedlist>
59
60<para>
61After running <filename>configure</filename>, you should run
62<command>make</command>. After that, run <command>make install</command> as
63root.
64</para>
65
66</sect1>
67
68<sect1>
69<title>Configuration</title>
70
71<para>
72By default, BitlBee runs as the user nobody. You might want
73to run it as a separate user (some computers run named or apache as nobody).
74</para>
75
76<para>
77Since BitlBee uses inetd, you should add the following line to <filename>/etc/inetd.conf</filename>:
78</para>
79
80<para>
81<programlisting>
826667    stream  tcp     nowait nobody /usr/local/sbin/bitlbee bitlbee
83</programlisting>
84</para>
85
86<para>
87Inetd has to be restarted after changing the configuration. Either
88<command>killall -HUP inetd</command> or
89<command>/etc/init.d/inetd restart</command> should do the job on most systems.
90</para>
91
92<para>
93You might be one of the.. ehr, lucky people running an xinetd-powered distro.
94<command>xinetd</command> is quite different and they seem to be proud of that.. ;-)
95Anyway, if you want BitlBee to work with <command>xinetd</command>, just copy the
96bitlbee.xinetd file to your /etc/xinetd.d/ directory (and probably edit it to suit
97your needs).
98</para>
99
100<para>
101You should create a directory where BitlBee can store it's data files. This
102should be the directory named after the value 'CONFIG' in Makefile.settings.
103The default is <filename>/var/lib/bitlbee</filename>, which can be created
104with the command <command>mkdir -p /var/lib/bitlbee</command>. This
105directory has to be owned by the user that runs bitlbee. To make
106'nobody' owner of this directory, run <command>chown nobody /var/lib/bitlbee</command>.
107Because things like passwords are saved in this directory, it's probably
108a good idea to make this directory owner-read-/writable only.
109</para>
110</sect1>
111
112</chapter>
Note: See TracBrowser for help on using the repository browser.