prosody
1dc49accb58e
INSTALL

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

File

INSTALL @ 11148:1dc49accb58e

core.moduleapi: Return resource path from module:get_directory() (API BC) :get_directory has so far returned the base directory of the current module source code. This has worked well so far to load resources which tend to be included in the same directory, but with the plugin installer using LuaRocks, extra resources (e.g. templates and other assets) these are saved in a completely different directory. In be73df6765b9 core.modulemanager gained some code for finding that directory and saving it in module.resource_path but now the question is how this should be reflected in the API. A survey of community modules suggest the vast majority use the :get_directory method for locating templates and other assets, rather than the code (which would use module:require instead). Therefore this commit changes :get_directory to return the resource_path when available. This should work for most modules.
author Kim Alvefur <zash@zash.se>
date Fri, 09 Oct 2020 16:37:15 +0200
parent 7359:a5a080c12c96
child 12222:61592927335b
line wrap: on
line source

(This file was created from
https://prosody.im/doc/installing_from_source on 2013-03-31)

====== Installing from source ======
==== Dependencies ====
There are a couple of libraries which Prosody needs installed before 
you can build it. These are:

  * lua5.1: The Lua 5.1 interpreter
  * liblua5.1: Lua 5.1 library
  * libssl 0.9.8: OpenSSL
  * libidn11: GNU libidn library, version 1.1

These can be installed on Debian/Ubuntu with the packages: lua5.1 
liblua5.1-dev libidn11-dev libssl-dev

On Mandriva try: urpmi lua liblua-devel libidn-devel libopenssl-devel

On other systems... good luck, but please let me know of the best way 
of getting the dependencies for your system and I can add it here.

==== configure ====
The first step of building is to run the configure script. This 
creates a file called 'config.unix' which is used by the next step to 
control aspects of the build process.

All options to configure can be seen by running ./configure --help. 
Sometimes you won't need to pass any parameters to configure, but on 
most systems you shall.

To make this a little easier, there are a few presets which configure 
accepts. You can load a preset using:

   ./configure --ostype=PRESET

Where PRESET can currently be one of: 'debian', 'macosx' or (in 0.8 
and later) 'freebsd'

==== make ====
Once you have run configure successfully, then you can simply run:

   make

Simple? :-)

If you do happen to have problems at this stage, it is most likely 
due to the build process not finding the dependencies. Ensure you 
have them installed, and in the standard library paths for your 
system.

For more help, just ask ;-)

==== install ====
At this stage you should be able to run Prosody simply with:

   ./prosody

There is no problem with this, it is actually the easiest way to do 
development, as it doesn't spread parts around your system, and you 
can keep multiple versions around in their own directories without 
conflict.

Should you wish to install it system-wide however, simply run:

   sudo make install

...it will install into /usr/local/ by default. To change this you 
can pass to the initial ./configure using the 'prefix' option, or 
edit config.unix directly. If the new path doesn't require root 
permission to write to, you also won't need (or want) to use 'sudo' 
in front of the 'make install'.

Have fun, and see you on Jabber!