ejabberd-contrib/mod_shcommands/README.md

mod_shcommands - Execute shell commands
=======================================

* Requires: ejabberd 19.08 or higher
* Author: Badlop
* http://ejabberd.im/mod_shcommands


                     *****************

                       W A R N I N G

                     *****************


              USE THIS MODULE AT YOUR OWN RISK

         This module allows ejabberd administrators
             to remotely execute shell commands
                 which could compromise both
         the ejabberd server and the whole machine.


                     *****************

                       W A R N I N G

                     *****************




Description
-----------

This module provides the ejabberd server administrator a method to remotely
execute shell commands in the ejabberd server.

It provides a page in the ejabberd Web Admin.
Only the administrators of the whole server can access this page.

Three types of commands are possible:
* ejabberd_ctl: makes a call to ejabberd_ctl
* erlang shell: executes an erlang command
* system shell: executes a command on the system shell
The result of the execution will be shown.

In the system shell, only non-interactive commands will work correctly,
for example this will work:
```
ps -all
```
Don't use commands that start an interactive mode:
* DON'T TRY THIS: top
* DON'T TRY THIS: vim readme.txt

This module does not check if the commands are dangerous or problematic,
so this module is only recommended for experienced ejabberd and Erlang/OTP
administrators.


Configuration
-------------

This module has no configurable options, simply enable it:
```
modules:
  mod_shcommands: {}
```