aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 25 insertions, 14 deletions
diff --git a/README b/README
index d6b95bcda..6fa746b0f 100644
--- a/README
+++ b/README
@@ -1,13 +1,18 @@
ejabberd - High-Performance Enterprise Instant Messaging Server
+---------------------------------------------------------------
Quickstart guide
+================
0. Requirements
+---------------
To compile ejabberd you need:
+
- GNU Make
- GCC
+ - pkg-config
- Libexpat 1.95 or higher
- Libyaml 1.4 or higher
- Erlang/OTP R15B or higher.
@@ -18,35 +23,41 @@ To compile ejabberd you need:
- GNU Iconv 1.8 or higher, for the IRC Transport
(mod_irc). Optional. Not needed on systems with GNU Libc.
- ImageMagick's Convert program. Optional. For CAPTCHA challenges.
- - exmpp 0.9.6 or higher. Optional. For import/export XEP-0227 files.
1. Compile and install on *nix systems
+--------------------------------------
To compile ejabberd execute the commands:
- ./configure
- make
+
+ ./configure
+ make
To install ejabberd, run this command with system administrator rights
(root user):
- sudo make install
+ sudo make install
These commands will:
- - Install the configuration files in /etc/ejabberd/
- - Install ejabberd binary, header and runtime files in /lib/ejabberd/
- - Install the administration script: /sbin/ejabberdctl
- - Install ejabberd documentation in /share/doc/ejabberd/
- - Create a spool directory: /var/lib/ejabberd/
- - Create a directory for log files: /var/log/ejabberd/
+
+ - Install the configuration files in `/etc/ejabberd/`
+ - Install ejabberd binary, header and runtime files in `/lib/ejabberd/`
+ - Install the administration script: `/sbin/ejabberdctl`
+ - Install ejabberd documentation in `/share/doc/ejabberd/`
+ - Create a spool directory: `/var/lib/ejabberd/`
+ - Create a directory for log files: `/var/log/ejabberd/`
2. Start ejabberd
+-----------------
-You can use the ejabberdctl command line administration script to
+You can use the `ejabberdctl` command line administration script to
start and stop ejabberd. For example:
- ejabberdctl start
+ ejabberdctl start
+
+
+For detailed information please refer to the [ejabberd Installation and
+Operation Guide][1].
-For detailed information please refer to the
-ejabberd Installation and Operation Guide
+[1]: http://www.process-one.net/docs/ejabberd/guide_en.html