ejabberd-contrib/mod_logsession
Badlop a95e657a21 Add simple mod_doc/0 to prevent warnings; they won't be used anyway 2021-07-06 21:02:29 +02:00
..
conf Cleanup for module packaging support in ejabberd 2015-03-11 14:19:35 +01:00
src Add simple mod_doc/0 to prevent warnings; they won't be used anyway 2021-07-06 21:02:29 +02:00
COPYING Update FSF address (solves #73) 2015-02-25 15:17:31 +01:00
ChangeLog Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
README.txt Update some modules to work with ejabberd 19.08 (#277) 2019-08-19 20:42:03 +02:00
mod_logsession.spec Cleanup for module packaging support in ejabberd 2015-03-11 14:19:35 +01:00

README.txt

	mod_logsession - Log session connections to file

	Requirements: ejabberd 19.08 or higher
	Homepage: http://www.ejabberd.im/mod_logsession
	Author: Badlop


	DESCRIPTION
	-----------

This module is intended to log in a text file the session connections.
Right now it only logs the forbidden connection attempts and the
failed authentication attempts.
Each vhost is logged in a different file.

Note: to log the failed authentication attempts, you need to patch ejabberd.


	INSTALL
	-------

1 Copy this file to ejabberd/src/mod_logsession.erl
2 Recompile ejabberd
3 Add to ejabberd.yml, 'modules' section the basic configuration:
    mod_logsession: {}
4 With this configuration, the log files are:
    /tmp/ejabberd_logsession_@HOST@.log


	CONFIGURABLE PARAMETERS
	-----------------------

sessionlog: 
  Define the name of log files.
  The keyword @HOST@ will be substituted with the name of each vhost.
  Default value: "/tmp/ejabberd_logsession_@HOST@.log"


	EXAMPLE CONFIGURATION
	---------------------

modules:
  ...
  mod_logsession:
    sessionlog: "/var/log/ejabberd/session_@HOST@.log"
  ...

With that configuration, if the server has three vhosts:
  "localhost", "example.org" and "example.net",
then the forbidden accesses will be logged in the files:
  /var/log/ejabberd/session_localhost.log
  /var/log/ejabberd/session_example.org.log
  /var/log/ejabberd/session_example.net.log


	FORMAT OF LOG
	-------------

The content of the file is the date and time of the attempted login
and the JID of the denied user.

For example:
2008-01-08 12:20:50 Forbidden session for tron@localhost/teeest
2008-01-08 12:36:01 Forbidden session for baduser@localhost/aaa22
2010-04-02 17:21:37 Failed authentication for someuser@localhost from 127.0.0.1 port 58973
2010-04-02 17:25:20 Failed authentication for badlop@localhost from 127.0.0.1 port 45842


	REOPEN LOG FILES
	----------------

This module provides an ejabberd command to reopen the log file
of a host where the module is enabled.

Example usage:
  ejabberdctl reopen-seslog localhost
  ejabberdctl reopen-seslog jabber.example.org