summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHolger Weiss <holger@zedat.fu-berlin.de>2014-04-29 23:54:14 +0200
committerHolger Weiss <holger@zedat.fu-berlin.de>2014-04-29 23:54:14 +0200
commit375a1dd75944a71da8cfd0a854fdf3f8820df8fe (patch)
tree84c14ce23db6ec570cb3dffe9ce5e09c6271b987 /README
parentMerge pull request #177 from weiss/log-tls-sasl-external (diff)
Convert README to Markdown
Use Markdown syntax for the README file and add a README.md symlink, so that a certain popular Git hosting site renders it nicely.
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 24 insertions, 13 deletions
diff --git a/README b/README
index c0946ee7..50208955 100644
--- a/README
+++ b/README
@@ -1,11 +1,15 @@
ejabberd - High-Performance Enterprise Instant Messaging Server
+---------------------------------------------------------------
Quickstart guide
+================
0. Requirements
+---------------
To compile ejabberd you need:
+
- GNU Make
- GCC
- Libexpat 1.95 or higher
@@ -21,31 +25,38 @@ To compile ejabberd you need:
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