diff options
| author | Badlop <badlop@process-one.net> | 2020-06-09 13:23:17 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2020-06-09 13:23:17 +0200 |
| commit | 16645a3c0ad76ca09e3f18626efe51e0ecfd2244 (patch) | |
| tree | 18520444bd4a84fda991a2f10f47bfa75b3130ce | |
| parent | Update example config to include mod_http_upload custom headers (#3288) (diff) | |
Document that only ejabberdctl can join and leave a local node (#3049)
| -rw-r--r-- | src/ejabberd_admin.erl | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index 879374da0..0a789c9d6 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -208,6 +208,9 @@ get_commands_spec() -> #ejabberd_commands{name = join_cluster, tags = [cluster], desc = "Join this node into the cluster handled by Node", + longdesc = "This command works only with ejabberdctl, " + "not mod_http_api or other code that runs inside the " + "same ejabberd node that will be joined.", module = ?MODULE, function = join_cluster, args_desc = ["Nodename of the node to join"], args_example = [<<"ejabberd1@machine7">>], @@ -215,8 +218,11 @@ get_commands_spec() -> result = {res, rescode}}, #ejabberd_commands{name = leave_cluster, tags = [cluster], desc = "Remove and shutdown Node from the running cluster", - longdesc = "This command can be run from any running node of the cluster, " - "even the node to be removed.", + longdesc = "This command can be run from any running " + "node of the cluster, even the node to be removed. " + "In the removed node, this command works only when " + "using ejabberdctl, not mod_http_api or other code that " + "runs inside the same ejabberd node that will leave.", module = ?MODULE, function = leave_cluster, args_desc = ["Nodename of the node to kick from the cluster"], args_example = [<<"ejabberd1@machine8">>], |