Difference between revisions of "Prosody"

From SME Server
Jump to navigationJump to search
m (→‎Installation: update version)
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{WIP box}}
 
==About==
 
==About==
 
"[http://prosody.im '''Prosody'''] is a modern XMPP communication server (aka Jabber). It aims to be easy to set up and configure, and efficient with system resources. Additionally, for developers it aims to be easy to extend and give a flexible system on which to rapidly develop added functionality, or prototype new protocols."
 
"[http://prosody.im '''Prosody'''] is a modern XMPP communication server (aka Jabber). It aims to be easy to set up and configure, and efficient with system resources. Additionally, for developers it aims to be easy to extend and give a flexible system on which to rapidly develop added functionality, or prototype new protocols."
Line 4: Line 5:
  
 
==Installation==
 
==Installation==
These instructions are for SME Server '''9.0''' only.
+
These instructions are for SME Server '''9.0''' 64-bit only.
 
 
Prosody is available from the [[epel|'''epel''']] repository, so you have to enable the [[epel|'''epel''']] repository.
 
After enabling the [[epel|epel]] repository, prosody can be installed with:
 
yum install prosody lua-ldap --enablerepo=epel
 
  
 +
Prosody (v0.9.12-1) is available from the [[epel|'''epel''']] repository, so you have to enable the [[epel|'''epel''']] repository. After enabling the [[epel|epel]] repository, prosody can be installed with:
 +
yum install prosody lua-ldap lua-event --enablerepo=epel
  
 
==Configuration==
 
==Configuration==
Line 15: Line 14:
 
To automatically start Prosody at boot and configure the ports:
 
To automatically start Prosody at boot and configure the ports:
 
  ln -s /etc/rc.d/init.d/e-smith-service /etc/rc7.d/S99prosody
 
  ln -s /etc/rc.d/init.d/e-smith-service /etc/rc7.d/S99prosody
  config set prosody service
+
  config set prosody service  
  config setprop prosody status enabled access private TCPPort 5222 UDPport 5222
+
  config setprop prosody status enabled
 +
config setprop prosody access private
 +
config setprop prosody TCPPort 5222
 +
config setprop prosody UDPPort 5222
 +
You can toggle the ''access'' property to enable public/private access.
 +
 
 +
 
 +
 
 +
Then to apply the new service:
 
  signal-event remoteaccess-update
 
  signal-event remoteaccess-update
You can toggle the access property to enable public/private access.
+
 
  
 
===Configuration file===
 
===Configuration file===
 
Prosody's configuration file is located at:
 
Prosody's configuration file is located at:
 
  /etc/prosody/prosody.cfg.lua
 
  /etc/prosody/prosody.cfg.lua
The basic setting you have to change to run your prosody server on your domain (replace "example.com" with "yourdomain.com":
+
{{Note box|Please note that the latest version now has split configuration files. One for server wide settings and one for each virtual host. So the below example config file should be adjusted accordingly.}}
 +
 
 +
The basic settings you have to change to run your prosody server on your domain (replace "example.com" with "yourdomain.com"):
 
  admins = {"admin@yourdomain.com"}
 
  admins = {"admin@yourdomain.com"}
 
  allow_registration = true
 
  allow_registration = true
  VirtualHost "localhost
+
  VirtualHost "localhost"
 
  VirtualHost "yourdomain.com"
 
  VirtualHost "yourdomain.com"
 
  enabled = true
 
  enabled = true
Line 34: Line 43:
 
Any XMPP client can register itself on your server or you can use LDAP authentication so that your SME Server users automatically have access to your XMPP server.
 
Any XMPP client can register itself on your server or you can use LDAP authentication so that your SME Server users automatically have access to your XMPP server.
  
Register yourself as "admin" to be an administrator as defined in the configuration file.  
+
Register yourself as "admin" to be an administrator as defined in the configuration file.
  
 
+
===Modules configuration===
==Documentation==
+
TBA
For further and detailed configuration of the Prosody server and services, please see the [https://prosody.im/doc Prosody documentation]
 
  
  
 
==LDAP configuration==
 
==LDAP configuration==
 
TBA
 
TBA
 +
 +
 +
==Documentation==
 +
For further and detailed configuration of the Prosody server and services, please see the [https://prosody.im/doc Prosody documentation]
  
  
 
[[Category:Howto]]
 
[[Category:Howto]]

Latest revision as of 09:04, 30 August 2017

Warning.png Work in Progress:
This page is a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.


About

"Prosody is a modern XMPP communication server (aka Jabber). It aims to be easy to set up and configure, and efficient with system resources. Additionally, for developers it aims to be easy to extend and give a flexible system on which to rapidly develop added functionality, or prototype new protocols."


Installation

These instructions are for SME Server 9.0 64-bit only.

Prosody (v0.9.12-1) is available from the epel repository, so you have to enable the epel repository. After enabling the epel repository, prosody can be installed with:

yum install prosody lua-ldap lua-event --enablerepo=epel

Configuration

Adding service and open ports

To automatically start Prosody at boot and configure the ports:

ln -s /etc/rc.d/init.d/e-smith-service /etc/rc7.d/S99prosody
config set prosody service 
config setprop prosody status enabled
config setprop prosody access private
config setprop prosody TCPPort 5222
config setprop prosody UDPPort 5222

You can toggle the access property to enable public/private access.


Then to apply the new service:

signal-event remoteaccess-update


Configuration file

Prosody's configuration file is located at:

/etc/prosody/prosody.cfg.lua
Important.png Note:
Please note that the latest version now has split configuration files. One for server wide settings and one for each virtual host. So the below example config file should be adjusted accordingly.


The basic settings you have to change to run your prosody server on your domain (replace "example.com" with "yourdomain.com"):

admins = {"admin@yourdomain.com"}
allow_registration = true
VirtualHost "localhost"
VirtualHost "yourdomain.com"
enabled = true

You can now start prosody by entering:

service prosody start

Any XMPP client can register itself on your server or you can use LDAP authentication so that your SME Server users automatically have access to your XMPP server.

Register yourself as "admin" to be an administrator as defined in the configuration file.

Modules configuration

TBA


LDAP configuration

TBA


Documentation

For further and detailed configuration of the Prosody server and services, please see the Prosody documentation