aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2022-01-28 11:57:58 +0100
committerKim Alvefur <zash@zash.se>2022-01-28 11:57:58 +0100
commitf5d2ee89b16edaf5c7064487d7612ecd439575f0 (patch)
tree39f88e93a886af1ad394827d3b774f0f9a6b5cd5 /INSTALL
parentdccab4e10ff17dbf87aa95a68d49db3adc235b78 (diff)
downloadprosody-f5d2ee89b16edaf5c7064487d7612ecd439575f0.tar.gz
prosody-f5d2ee89b16edaf5c7064487d7612ecd439575f0.zip
INSTALL: Update from site version
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL82
1 files changed, 44 insertions, 38 deletions
diff --git a/INSTALL b/INSTALL
index 66e1df76..da520327 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,73 +1,79 @@
(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:
+# Installing from source
- * 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
+## Dependencies
-These can be installed on Debian/Ubuntu with the packages: lua5.1
-liblua5.1-dev libidn11-dev libssl-dev
+There are a couple of development packages which Prosody needs installed
+before you can build it. These are:
-On Mandriva try: urpmi lua liblua-devel libidn-devel libopenssl-devel
+- The [Lua](http://lua.org/) library, version 5.4 recommended
+- [OpenSSL](http://openssl.org/)
+- String processing library, one of
+ - [ICU](https://icu.unicode.org/) (recommended)
+ - [GNU libidn](http://www.gnu.org/software/libidn/)
-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.
+These can be installed on Debian/Ubuntu by running
+`apt-get build-dep prosody` or by installing the packages
+`liblua5.4-dev`, `libicu-dev` and `libssl-dev`.
-==== 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.
+On Mandriva try:
-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.
+ urpmi lua liblua-devel libidn-devel libopenssl-devel
-To make this a little easier, there are a few presets which configure
-accepts. You can load a preset using:
+On Mac OS X, if you have MacPorts installed, you can try:
- ./configure --ostype=PRESET
+ sudo port install lua lua-luasocket lua-luasec lua-luaexpat
-Where PRESET can currently be one of: 'debian', 'macosx' or (in 0.8
-and later) 'freebsd'
+On other systems... good luck, but please let us know of the best way of
+getting the dependencies for your system and we 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.
+
+ ./configure
+
+All options to configure can be seen by running
+
+ ./configure --help
+
+## make
-==== 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.
+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
+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'.
+...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!