jacob.eva
/
ejabberd-contrib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update mod_rest documentation to reflect module_install (#177))

This commit is contained in:
Badlop 2016-08-01 21:18:20 +02:00
parent 065ab08592
commit 41371cf7fe
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
mod_rest/README.txt
View File

@ -17,16 +17,16 @@ This module can also be used as a frontend to execute ejabberd commands.
CONFIGURATION CONFIGURATION
============= =============
To use this module, follow the general build instructions, and configure To use this module, follow the general build instructions.
in ejabberd.yml as described. You can modify the default module configuration file like this:
Enable the module: To enable the module:
modules: modules:
mod_rest: mod_rest:
allowed_ips: allowed_ips:
- "127.0.0.1" - "127.0.0.1"
And enable the HTTP request handler in the listen section: To enable the HTTP request handler in the listen section:
listen: listen:
- -
port: 5285 port: 5285
@ -40,7 +40,7 @@ With that configuration, you can send HTTP POST requests to the URL:
Configurable options: Configurable options:
allowed_ips: IP addresses that can use the rest service. allowed_ips: IP addresses that can use the rest service.
Allowed values: 'all' or a list of Erlang tuples. Allowed values: 'all' or a list of Erlang strings.
Default value: all Default value: all
Notice that the IP address is checked after the connection is established. Notice that the IP address is checked after the connection is established.
If you want to restrict the IP address that listens connections, and If you want to restrict the IP address that listens connections, and