EJABBERD MANUAL PDF
Getting started with ejabberd. Overview; Options to use ejabberd; Architecture. However, the guide is believed to help you understanding ejabberd’s code. These tutorials assume installation on localhost for development purposes.
|Published (Last):||7 December 2015|
|PDF File Size:||10.51 Mb|
|ePub File Size:||15.57 Mb|
|Price:||Free* [*Free Regsitration Required]|
The Binary Installer will deploy and configure a full featured ejabberd server and does not require any extra dependencies.
ejabberd Installation and Operation Guide
It includes a stripped down version of Erlang. As such, when using ejabberd installer, you do not need to install Erlang separately. These tutorials assume installation on localhost for development purposes. In this document, when mentioning ejabberd-YY. MMwe assume YY. MM is the release number, for example Also note that the installer scripts support many options useful for production or unattended, scripted installation.
You can read more on installer options on unattended installation. Now you are able to double-click the file to execute it and start the installer. You can also set the installer as executable and start it using the command line:. Select the installer language you prefer, then click “Forward” to go through necessary installation steps:.
After successful installation, let’s launch ejabberd using the Terminal. In the command line, go to the installation folder and execute. This will start ejabberd in an interactive live mode with some useful messages printed in the Terminal. Now you can go to the web dashboard at http: The next step is to get to know how to configure ejabberd.
If something goes wrong during the installation, and you would like to start from scratch, you will find the ejabberd uninstall in the directory where it was installed. Before you begin installing ejabberd, make sure your Mac allows apps from identified developers.
App Store and identified developers”. Then you can download ejabberd and proceed with installation:. Binary Installers of ejabberd prior to version If macOS complains when you try to install ejabberd older than Homebrew installation is simple and the instruction is available on its website.
The canonical form for distribution of ejabberd stable releases is the source code package. Released versions of ejabberd are available on ProcessOne ejabberd official download page. Alternatively, the latest development source code can be retrieved from the Git repository using the commands:. This tells the configuration to prepare the installed program to run with a user called ejabberd, so please create that user or tell to use another local user.
It isn’t recommended to run ejabberd with root user. To build ejabberd, you will need Internet access, as dependencies will be downloaded depending on the selected options. Specify the path to the user executables where epmd and iex are available.
Specify the path prefix where the files will be copied when running the make install command. Allow this normal system user to execute the ejabberdctl script see section ejabberdctlread the configuration files, read and write in the spool directory, read and write in the log directory.
The account user and group must exist in the machine before running make install. Enable the PAM authentication method see section pam. Enable MySQL support see section databases. Enable PostgreSQL support see section databases.
Enable SQLite support see section databases. Enable Riak database support see section databases. Enable Redis support to use for external session storage.
Use lager Erlang logging tool instead of standard error logger. Makes rebar use latest versions of dependences developed alongside ejabberd instead of version specified in rebar.
Should be only used when developing ejabberd. Administration script see section ejabberdctl. The best approach is to use Homebrew to install your dependencies, then exports your custom path to let configure and make be aware of them. Mmanual need to have GNU installbut it isn’t included in Solaris.
If that program is called ginstallmodify the ejabberd Makefile script to suit your system, for example:.
Some Operating Systems provide a specific ejabberd package adapted to the system architecture and libraries. It usually also checks dependencies and performs basic configuration tasks like creating the initial administrator account.
Ejabberd Installation and Operation Guide
Some examples are Debian and Gentoo. Consult the resources provided by your Operating System for more information.
This is self-sufficient packages also containing a minimal Erlang distribution. It ensures that it does not interfere with your existing Erlang version. This is also a good way to make sure ejabberd will run with the latest Erlang version.
You can download the packages from ejabberd eabberd download page. To start and stop ejabberd manually, use the desktop shortcuts created by the installer. You can also use the ejabberdctl command line administration script to start and stop ejabberd. If ejabberd doesn’t start correctly and a crash dump file is generated, there was a severe problem. This way you see the error message provided by Erlang and can identify what is exactly the problem. The ejabberdctl administration script is included in the bin directory.
Please refer to the section ejabberdctl for details about ejabberdctland configurable options manuall fine tune the Erlang runtime system. If you want ejabberd to be started as daemon at boot time with that user, copy mabual. When ejabberd is started, the processes that are started in the system are beam or beam.
For more information regarding epmd consult the section relating to epmd. The Windows installer also adds ejabberd as a system service, and a shortcut to a debug console for experienced administrators. If you want ejabberd to be started automatically at boot time, go eiabberd the Windows service settings and set ejabberd to be automatically started. Note that the Windows service is a feature still in development, and for example it manuall read the file ejabberdctl.
On Microsoft Windows, the Erlang processes for ejabberd are named erl. However, if you use another way of installing ejabberd you may need to create an admin XMPP account. Here are the steps to create it:. Register an XMPP account on your ejabberd server, for example admin1 example.
There are two ways manusl register an XMPP account:. Edit the ejabberd configuration file to give administration rights to the XMPP account you created:. Open the Web Admin usually http: Make sure to enter the full JID as username in this example: You can manage several XMPP domains on a single instance. By default, ejabberd uses its own database to store runtime data. In many cases you may need to let ejabberd use an external SQL database.
When using external database backend, ejabberd does not create schema and tables by itself. You must manhal the schema before you run ejabberd. If installing ejabberd from sources, you will find sql script for your backend in the installation directory. See Step-by-step Ejabberf Configuration Guides for detailed setup instructions. Quick Start with Binary Ejaberd — recommended when starting development on localhost Install on Windows Install on Linux Install on macOS Install from Source Code — recommended for advanced users Ejagberd with Operating System specific packages — recommended for sysops Post-install operations — for example, register users and create admin accounts Quick Start The Binary Installer manjal deploy and configure a full featured ejabberd server and does not require any extra dependencies.
Install on Windows Go to ejabberd official download page on ProcessOne website. Download the “Windows bits Installer”. On the Windows Security dialog, Allow this application to install. Select the installer language you prefer, then click “Next” to go through necessary installation steps: To start or stop ejabberd, righ-click on each shortcut and select “Run as Administrator”, then confirm the Windows dialog by clicking “Yes”.
After starting ejabberd, a welcome screen should open in your default browser. You can go to the web dashboard at http: If something goes wrong during the installation, and you would like to start ejjabberd scratch, you will find the ejabberd uninstall.
The uninstaller will stop your ejabberd server and remove all its files. Log files may be left behind, so to completely remove ejabberd, just delete its main folder.
Install on Linux Go to ejabberd official download page on ProcessOne website. Download the “Linux x86 bits Intel Installer”. Right-click on the downloaded file and select “Properties”.
Click on the “Permissions” tab and tick the box that says “Allow executing file as program”. You can also set the installer as executable and start it using the command line: Install on macOS Using Binary Installer Before you begin installing ejabberd, make sure your Mac allows apps from identified developers.