INSTALL

   1 (This file was created from
   2 http://prosody.im/doc/installing_from_source on 2012-05-12)
   3
   4 ===== Building =====
   5 ==== Dependencies ====
   6 There are a couple of libraries which Prosody needs installed before
   7 you can build it. These are:
   8
   9   * lua5.1: The interpreter
  10   * liblua5.1: Lua 5.1 library
  11   * libssl 0.9.8: OpenSSL
  12   * libidn11: GNU libidn library, version 1.1
  13
  14 These can be installed on Debian/Ubuntu with the packages:
  15 lua5.1 liblua5.1-dev libidn11-dev libssl-dev
  16
  17 On Mandriva try: urpmi lua liblua-devel libidn-devel libopenssl-devel
  18
  19 On other systems... good luck, but please let me know of the best way
  20 of getting the dependencies for your system and I can add it here.
  21
  22 ==== configure ====
  23 The first step of building is to run the configure script. This
  24 creates a file called 'config.unix' which is used by the next step to
  25 control aspects of the build process.
  26
  27 All options to configure can be seen by running ./configure --help.
  28 Sometimes you won't need to pass any parameters to configure, but on
  29 most systems you shall.
  30
  31 To make this a little easier, there are a few presets which configure
  32 accepts. You can load a preset using:
  33
  34    ./configure --ostype=PRESET
  35
  36 Where PRESET can currently be one of: debian, macosx or freebsd
  37
  38 ==== make ====
  39 Once you have run configure successfully, then you can simply run:
  40
  41    make
  42
  43 Simple? :-)
  44
  45 If you do happen to have problems at this stage, it is most likely
  46 due to the build process not finding the dependencies. Ensure you
  47 have them installed, and in the standard library paths for your
  48 system.
  49
  50 For more help, just ask ;-)
  51
  52 ==== install ====
  53 At this stage you should be able to run Prosody simply with:
  54
  55    ./prosody
  56
  57 There is no problem with this, it is actually the easiest way to do
  58 development, as it doesn't spread parts around your system, and you
  59 can keep multiple versions around in their own directories without
  60 conflict.
  61
  62 Should you wish to install it system-wide however, simply run:
  63
  64    sudo make install
  65
  66 ...it will install into /usr/local/ by default. To change this you
  67 can pass to the initial ./configure using the 'prefix' option, or
  68 edit config.unix directly. If the new path doesn't require root
  69 permission to write to, you also won't need (or want) to use 'sudo'
  70 in front of the 'make install'.
  71
  72 Have fun, and see you on Jabber!