File: README.md

package info (click to toggle)
ejabberd-contrib 0.2025.01.11~dfsg0-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 3,680 kB
  • sloc: erlang: 11,870; sh: 150; sql: 92; makefile: 56
file content (69 lines) | stat: -rw-r--r-- 1,662 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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: {}
```