summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2008-02-20 19:07:19 +0000
committerBadlop <badlop@process-one.net>2008-02-20 19:07:19 +0000
commitde433ef4c129e31be3cee69c3314dac3a16cec72 (patch)
tree89315ef15a44db7985978705b1e8e5d4231f1b47 /README
parent* doc/release_notes_2.0.0.txt: Updated version number and date (diff)
* README: Updated to match the content of the ejabberd Guide
SVN Revision: 1206
Diffstat (limited to 'README')
-rw-r--r--README55
1 files changed, 33 insertions, 22 deletions
diff --git a/README b/README
index 8712de6f..e4940246 100644
--- a/README
+++ b/README
@@ -2,37 +2,48 @@ ejabberd - High-Performance Enterprise Instant Messaging Server
Quickstart guide
-0. Dependancies
-To build ejabberd, you need:
+0. Requirements
+
+To compile ejabberd you need:
- GNU Make
- GCC
- libexpat 1.95 or higher
- - Erlang/OTP R9C-2 or higher
- - OpenSSL 0.9.6 or higher (optional)
- - Zlib 1.2.3 or higher (optional)
- - GNU Iconv 1.8 or higher (optional, not needed on systems with GNU libc)
+ - Erlang/OTP R10B-9 up to R11B-5. Erlang R12 releases are not yet
+ officially supported, and are not recommended for production
+ servers
+ - OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL
+ encryption. Optional, highly recommended.
+ - Zlib 1.2.3 or higher, for Stream Compression support
+ (XEP-0138). Optional.
+ - GNU Iconv 1.8 or higher, for the IRC Transport
+ (mod_irc). Optional. Not needed on systems with GNU Libc.
+
+
+1. Compile and install on *nix systems
-1. Build and install on *nix systems
+To compile ejabberd, go to the directory src/ and execute the commands:
+ ./configure
+ make
-To build ejabberd, please go into the src directory and type the
-following commands:
- ./configure && make
- sudo make install
+To install ejabberd, run this command with system administrator rights
+(root user):
+
+ sudo make install
These commands will:
- - install a startup script into the directory /usr/sbin,
- - install ejabberd into the directory /var/lib/ejabberd,
- - install the configuration file into /etc/ejabberd,
- - create a directory called /var/log/ejabberd to store log files.
+ - Install a startup script: /sbin/ejabberdctl
+ - Install ejabberd in /var/lib/ejabberd/
+ - Install the configuration files in /etc/ejabberd/
+ - Create a directory for log files: /var/log/ejabberd/
+
-Note: "sudo make install" means that the "make install" command should
- be run with system administrator rights (root).
+2. Start ejabberd
-2. Run
+You can use the ejabberdctl command line administration script to
+start and stop ejabberd. For example:
+ ejabberdctl start
-To run ejabberd, type the following command:
- erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
-For detailled informations, please refer to:
-http://www.process-one.net/en/projects/ejabberd/docs/guide_en.html
+For detailed information please refer to the
+ejabberd Installation and Operation Guide