ejabberd-contrib/mod_shcommands
Badlop b3c8d25104 Reword modules documentation to reflect the usage of local configuration files 2022-08-12 10:52:20 +02:00
..
conf Add default configuration to mod_shcommands 2021-05-21 13:12:20 +02:00
src Add mod_status/0 to show its current status in WebAdmin 2022-07-26 15:41:23 +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.md Reword modules documentation to reflect the usage of local configuration files 2022-08-12 10:52:20 +02:00
mod_shcommands.spec Cleanup for module packaging support in ejabberd 2015-03-11 14:19:35 +01:00

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: {}