mirror of
https://github.com/processone/ejabberd.git
synced 2024-12-16 17:15:55 +01:00
Explain that join_cluster returns immediately (since 5a34020
, 24.06)
This commit is contained in:
parent
7fce7d1049
commit
c021cf34be
@ -268,6 +268,16 @@ get_commands_spec() ->
|
|||||||
|
|
||||||
#ejabberd_commands{name = join_cluster, tags = [cluster],
|
#ejabberd_commands{name = join_cluster, tags = [cluster],
|
||||||
desc = "Join our local node into the cluster handled by Node",
|
desc = "Join our local node into the cluster handled by Node",
|
||||||
|
longdesc = "This command returns immediately,
|
||||||
|
even before the joining process has
|
||||||
|
completed. Consequently, if you are using
|
||||||
|
`ejabberdctl` (or some `CTL_ON_` container
|
||||||
|
environment variables) to run more commands
|
||||||
|
afterwards, you may want to precede them with
|
||||||
|
the _`started`_ command to ensure the
|
||||||
|
clustering process has completed before
|
||||||
|
proceeding. For example: `join_cluster
|
||||||
|
ejabberd@main` > `started` > `list_cluster`.",
|
||||||
note = "improved in 24.06",
|
note = "improved in 24.06",
|
||||||
module = ?MODULE, function = join_cluster,
|
module = ?MODULE, function = join_cluster,
|
||||||
args_desc = ["Nodename of the node to join"],
|
args_desc = ["Nodename of the node to join"],
|
||||||
|
Loading…
Reference in New Issue
Block a user