Skip to content

Commit 9771b18

Browse files
committed
Update ecs documentation from upstream ejabberd
1 parent f379d4b commit 9771b18

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

ecs/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,15 +266,21 @@ and reads `CTL_ON_START` every time the container is started.
266266
Those variables can contain one ejabberdctl command,
267267
or several commands separated with the blankspace and `;` characters.
268268

269-
By default failure of any of commands executed that way would
270-
abort start, this can be disabled by prefixing commands with `!`
271-
272-
Example usage (or check the [full example](#customized-example)):
269+
If any of those commands returns a failure, the container starting gets aborted.
270+
If there is a command with a result that can be ignored,
271+
prefix that command with `!`
272+
273+
This example, registers an `admin@localhost` account when the container is first created.
274+
Everytime the container starts, it shows the list of registered accounts,
275+
checks that the admin account exists and password is valid,
276+
changes the password of an account if it exists (ignoring any failure),
277+
and shows the ejabberd starts (check also the [full example](#customized-example)):
273278
```yaml
274279
environment:
275-
- CTL_ON_CREATE=! register admin localhost asd
280+
- CTL_ON_CREATE=register admin localhost asd
276281
- CTL_ON_START=stats registeredusers ;
277282
check_password admin localhost asd ;
283+
! change_password bot123 localhost qqq ;
278284
status
279285
```
280286

@@ -920,7 +926,7 @@ Let's summarize the differences between both container images. Legend:
920926
| Generated by | [container.yml](https://github.com/processone/ejabberd/blob/master/.github/workflows/container.yml) | [tests.yml](https://github.com/processone/docker-ejabberd/blob/master/.github/workflows/tests.yml) |
921927
| Built for | stable releases <br /> `master` branch | stable releases <br /> [`master` branch zip](https://github.com/processone/docker-ejabberd/actions/workflows/tests.yml) |
922928
| Architectures | `linux/amd64` <br /> `linux/arm64` | `linux/amd64` |
923-
| Software | Erlang/OTP 27.3-alpine <br /> Elixir 1.18.3 | Alpine 3.19 <br /> Erlang/OTP 26.2 <br /> Elixir 1.15.7 |
929+
| Software | Erlang/OTP 27.3.2-alpine <br /> Elixir 1.18.3 | Alpine 3.19 <br /> Erlang/OTP 26.2 <br /> Elixir 1.15.7 |
924930
| Published in | [ghcr.io/processone/ejabberd](https://github.com/processone/ejabberd/pkgs/container/ejabberd) | [docker.io/ejabberd/ecs](https://hub.docker.com/r/ejabberd/ecs/) <br /> [ghcr.io/processone/ecs](https://github.com/processone/docker-ejabberd/pkgs/container/ecs) |
925931
| :black_square_button: **Additional content** |
926932
| [ejabberd-contrib](https://docs.ejabberd.im/admin/guide/modules/#ejabberd-contrib) | included | not included |

0 commit comments

Comments
 (0)