Update documentation to 26.01 with: make clean extract

Author: badlop

content/CHANGELOG.md

@@ -5,6 +5,95 @@ search:
 
 # ChangeLog
 
+## Version 26.01
+
+#### Compile and Start
+
+- Remove dependencies, macros and code for Erlang/OTP older than 25
+- Require Elixir 1.14 or higher, that's the lowest we can test automatically
+- `ejabberdctl`: Support NetBSD and OpenBSD `su` ([#4320](https://github.com/processone/ejabberd/issues/4320))
+- `ejabberdctl.template`: Show meaningful error when `ERL_DIST_PORT` is in use
+- `ejabberd_app`: Print address and port where listens for erlang node connections
+- `Makefile.in`: Add `make relivectl` similar to `relive` but using `ejabberdctl`
+
+#### Databases
+
+- Add db_serialize support in mnesia modules
+- Add db serialization to `mod_muc_sql`
+- New database export/import infrastructure
+- Add commands for new database export/import
+- Apply timestamp pass in `?SQL_INSERT` queries
+- Update p1_mysql to bring fix for timestamp decoding
+- Extend timestamp type handling in sql macros
+- Revert changes to conversion of pgsql `int` types
+
+#### Installer and Container
+
+- `make-binaries`: Bump Erlang/OTP 28.3.1 and Elixir 1.19.5
+- `Dockerfile`: Bump Erlang/OTP 28.3.1 and Elixir 1.19.5
+- `Dockerfile`: Expose also port 7777 for SOCKS5
+- `Dockerfile`: Configure TURN ports and expose 5478 50000-50099
+- `Dockerfile`: Try to fix error with recent `freetds` Alpine package
+- Container: Setup new macro `STARTTLS_REQUIRED` to allow easy disabling
+
+#### MUC
+
+- Add `muc_online_rooms_count` API command
+- Set `enable_hats` room option `true` by default
+- Allow vcard queries even when IQ queries are disabled ([#4489](https://github.com/processone/ejabberd/issues/4489))
+- Announce `stable-id` feature from XEP-0045 1.31, supported since long ago
+- Fix `preload_rooms` in case of SQL database ([#4476](https://github.com/processone/ejabberd/issues/4476))
+- Run new hooks: `registering_nickmuc` and `registered_nickmuc` ([#4478](https://github.com/processone/ejabberd/issues/4478))
+- When deleting account, unregister account's nicks in all MUC hosts ([#4478](https://github.com/processone/ejabberd/issues/4478))
+- `mod_muc_log`: Crash in `terminate/2` when stopping module ([#4486](https://github.com/processone/ejabberd/issues/4486))
+- `mod_muc_occupantid`: Keep salt per MUC service, not individual rooms
+- `mod_muc_room`: Rewrite hats code that gets xdata values
+- `mod_muc_room`: Handle hats without definition ([#4503](https://github.com/processone/ejabberd/issues/4503))
+- `mod_muc_room`: When user has no hats, don't store in hats_users
+
+#### WebAdmin
+
+- `ejabberd_http`: Run new `http_request_handlers_init` fold hook
+- `ejabberd_http`: Add helper `get_auto_urls/2` that returns all URLs and TLS
+- `ejabberd_web_admin`: Add helper functions `make_menu_system`
+- `ejabberd_web_admin`: Show menu system only when can view vhosts
+- `ejabberd_web_admin`: Pass Level in `webadmin_menu_system_post` and `inside` hooks
+- `mod_conversejs`: Improve link to conversejs in WebAdmin ([#4495](https://github.com/processone/ejabberd/issues/4495))
+- When epmd isn't running show explanation in Clustering WebAdmin page
+- Use improved WebAdmin menu system in more modules
+- When building WebAdmin menu system, `{URLPATH}` in link text is substituted
+
+#### Web Services
+
+- `rest`: Use separate `httpc` profile
+- `ejabberd_captcha`: Use `mod_host_meta:get_auto_url/2`
+- `ejabberd_http`: Support repeated module in request_handlers
+- `ejabberd_http`: Get back handling when BOSH or WS are disabled
+- `mod_host_meta`: Move `get_url` functions from `mod_host_meta` to `ejabberd_http`
+- `mod_host_meta`: Allow calling `get_url/2` for other modules, not only WebSocket
+- `mod_host_meta`: Cosmetic rename Module to Handler
+- `mod_http_upload`: New `content_type` option similar to `mod_http_fileserver` ([#4488](https://github.com/processone/ejabberd/issues/4488))
+- `mod_http_upload`: Pass ServerHost, not Host which may be `"upload.HOST"`
+- `mod_http_upload`: Amend the fix for #4450 to support IDNA correctly ([#3519](https://github.com/processone/ejabberd/issues/3519))
+- `mod_http_fileserver`: Support map of paths in `docroot` option
+- `mod_conversejs`: Add new Conversejs Paths and ContentTypes ([#4511](https://github.com/processone/ejabberd/issues/4511))
+- `mod_conversejs`: Use ContentType functions from `mod_http_fileserver` ([#4511](https://github.com/processone/ejabberd/issues/4511))
+- Use `/websocket` URL in default configuration like `mod_conversejs`, it's more meaningful
+
+#### Core and Modules
+
+- Add `replaced_connection_timeout` toplevel option
+- Fix nasty SSL warnings ([#4475](https://github.com/processon4475e/ejabberd/issues/))
+- `ejabberd_commands`: Show meaningul error message when problem executing command ([#4506](https://github.com/processone/ejabberd/issues/4506))
+- `ejabberd_logger`: Append "color clean" only in console template, not file
+- `ejabberd_oauth`: Log error if `oauth_list_tokens` executed with unsupported DB ([#4506](https://github.com/processone/ejabberd/issues/4506))
+- `misc`: Get back functions and mark them as deprecated
+- `mod_adhoc_api`: Show nice command name, as WebAdmin already does
+- `mod_pubsub`: Deliver pubsub notifications to remote servers for nodes with presence based delivery
+- `mod_scram_update`: Don't hard-code iteration count
+- Bump many XEPs versions that are already supported
+- Improve documentation of `install_contrib_modules` ([#4487](https://github.com/processone/ejabberd/issues/4487))
+
 ## Version 25.10
 
 #### Ad-hoc Commands

content/CONTAINER.md

@@ -105,7 +105,7 @@ Next steps
 
 ### Register admin account
 
-#### [![ejabberd Container](https://img.shields.io/badge/ejabberd-grey?logo=opencontainersinitiative&logoColor=2094f3)](https://github.com/processone/ejabberd/pkgs/container/ejabberd) [:orange_circle:](#images-comparison)
+#### [![ejabberd Container](https://img.shields.io/badge/ejabberd-grey?logo=opencontainersinitiative&logoColor=2094f3)](https://github.com/processone/ejabberd/pkgs/container/ejabberd) [🔅](#images-comparison)
 
 If you set the `REGISTER_ADMIN_PASSWORD` environment variable,
 an account is automatically registered with that password,
@@ -118,11 +118,20 @@ The account created depends on what variables you have set:
 
 The account registration is shown in the container log:
 
-```
-:> ejabberdctl register admin example.org somePassw0rd
-User admin@example.org successfully registered
+```bash
+$ podman run -it \
+  --env EJABBERD_MACRO_HOST=example.org \
+  --env EJABBERD_MACRO_ADMIN=juliet@example.org \
+  --env REGISTER_ADMIN_PASSWORD=somePassw0rd \
+  ghcr.io/processone/ejabberd
+
+:> ejabberdctl register juliet example.org somePassw0rd
+User juliet@example.org successfully registered
 ```
 
+This is implemented internally by using
+[Commands on start](#commands-on-start).
+
 Alternatively, you can register the account manually yourself
 and edit `conf/ejabberd.yml` and add the ACL as explained in
 [ejabberd Docs: Administration Account](https://docs.ejabberd.im/admin/install/next-steps/#administration-account).
@@ -207,20 +216,21 @@ documentation section.
 Advanced
 --------
 
-### Ports
-
+### Ports 🟠
 The container image exposes several ports
 (check also [Docs: Firewall Settings](https://docs.ejabberd.im/admin/guide/security/#firewall-settings)):
 
 - `5222`: The default port for XMPP clients.
 - `5269`: For XMPP federation. Only needed if you want to communicate with users on other servers.
 - `5280`: For admin interface (URL is `admin/`).
-- `1880`: For admin interface (URL is `/`, useful for [podman-desktop](https://podman-desktop.io/) and [docker-desktop](https://www.docker.com/products/docker-desktop/)) [:orange_circle:](#images-comparison)
 - `5443`: With encryption, used for admin interface, API, CAPTCHA, OAuth, Websockets and XMPP BOSH.
+- `1880`: For admin interface (URL is `/`, useful for [podman-desktop](https://podman-desktop.io/) and [docker-desktop](https://www.docker.com/products/docker-desktop/)) [🔅](#images-comparison)
 - `1883`: Used for MQTT
+- `5478` UDP: STUN service 🟠
+- `50000-50099` UDP: TURN service 🟠
+- `7777`: SOCKS5 file transfer proxy 🟠
+- `5210`: Erlang connectivity when `ERL_DIST_PORT` is set, alternative to EPMD [🔅](#images-comparison)
 - `4369-4399`: EPMD and Erlang connectivity, used for `ejabberdctl` and clustering
-- `5210`: Erlang connectivity when `ERL_DIST_PORT` is set, alternative to EPMD [:orange_circle:](#images-comparison)
-
 
 ### Volumes
 
@@ -270,7 +280,10 @@ If any of those commands returns a failure, the container starting gets aborted.
 If there is a command with a result that can be ignored,
 prefix that command with `!`
 
-This example, registers an `admin@localhost` account when the container is first created.
+All this works when starting ejabberd with the default method `foreground`,
+not when using `live`, `iexlive`, ...
+
+This example registers an `admin@localhost` account when the container is first created.
 Everytime the container starts, it shows the list of registered accounts,
 checks that the admin account exists and password is valid,
 changes the password of an account if it exists (ignoring any failure),
@@ -284,8 +297,37 @@ and shows the ejabberd starts (check also the [full example](#customized-example
                      status
 ```
 
+Same example using Podman:
+```bash
+$ podman run -it \
+  --env CTL_ON_CREATE="register admin localhost asd" \
+  --env CTL_ON_START="stats registeredusers ; \
+                      check_password admin localhost asd ; \
+                      ! change_password bot123 localhost qqq ; \
+                      status" \
+  ghcr.io/processone/ejabberd
+
+...
+
+:> ejabberdctl register admin localhost asd
+User admin@localhost successfully registered
+
+:> ejabberdctl stats registeredusers
+1
+
+:> ejabberdctl check_password admin localhost asd
+
+:> ejabberdctl change_password bot123 localhost qqq
+{not_found,"unknown_user"}
+:> FAILURE in command 'change_password bot123 localhost qqq' !!! Ignoring result
+
+:> ejabberdctl status
+The node ejabberd@localhost is started. Status: started
+ejabberd 25.10.0 is running in that node
+```
+
 
-### Macros in environment [:high_brightness:](#images-comparison)
+### Macros in environment
 
 ejabberd reads `EJABBERD_MACRO_*` environment variables
 and uses them to define the corresponding
@@ -721,11 +763,10 @@ docker buildx build \
 
 #### Podman build
 
-To build the image using Podman, please notice:
+Some minor remarks:
 
-- `EXPOSE 4369-4399` port range is not supported, remove that in Dockerfile
-- It mentions that `healthcheck` is not supported by the Open Container Initiative image format
-- to start with command `live`, you may want to add environment variable `EJABBERD_BYPASS_WARNINGS=true`
+- When building, it mentions that `healthcheck` is not supported by the Open Container Initiative image format
+- To start with command `live`, you may want to add environment variable `EJABBERD_BYPASS_WARNINGS=true`
 
 ```bash
 podman build \
@@ -1061,35 +1102,35 @@ Images Comparison
 
 Let's summarize the differences between both container images. Legend:
 
-- :sparkle: is the recommended alternative
-- :orange_circle: added in the latest release (ejabberd 25.03)
-- :high_brightness: added in the previous release (ejabberd 24.12)
-- :low_brightness: added in the pre-previous release (ejabberd 24.10)
+- ❇️:  is the recommended alternative
+- 🟠: changed in ejabberd 26.01
+- 🔆: changed in ...
+- 🔅: changed in ejabberd 25.03
 
 |                       | [![ejabberd Container](https://img.shields.io/badge/ejabberd-grey?logo=opencontainersinitiative&logoColor=2094f3)](https://github.com/processone/ejabberd/pkgs/container/ejabberd) | [![ecs Container](https://img.shields.io/badge/ecs-grey?logo=docker&logoColor=2094f3)](https://hub.docker.com/r/ejabberd/ecs/) |
 |:----------------------|:------------------|:-----------------------|
 | Source code           | [ejabberd/.github/container](https://github.com/processone/ejabberd/tree/master/.github/container) | [docker-ejabberd/ecs](https://github.com/processone/docker-ejabberd/tree/master/ecs) |
 | 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) |
 | Built for             | stable releases <br /> `master` branch | stable releases <br /> [`master` branch zip](https://github.com/processone/docker-ejabberd/actions/workflows/tests.yml) |
 | Architectures         | `linux/amd64` <br /> `linux/arm64` | `linux/amd64` |
-| Software              | Erlang/OTP 27.3.4.3-alpine <br /> Elixir 1.18.4 | Alpine 3.22 <br /> Erlang/OTP 26.2 <br /> Elixir 1.18.3 |
+| Software              | Erlang/OTP 28.3.1.0-alpine 🟠 <br /> Elixir 1.19.5 🟠 | Alpine 3.22 <br /> Erlang/OTP 26.2 <br /> Elixir 1.18.3 |
 | 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) |
 | :black_square_button: **Additional content** |
 | [ejabberd-contrib](#ejabberd-contrib) | included | not included |
-| [ejabberdapi](#ejabberdapi) | included :orange_circle: | included |
+| [ejabberdapi](#ejabberdapi) | included 🔅 | included |
 | :black_square_button: **Ports** |
-| [1880](#ports) for WebAdmin     | yes :orange_circle: | yes :orange_circle: |
-| [5210](#ports) for `ERL_DIST_PORT` | supported | supported :orange_circle: |
+| [1880](#ports) for WebAdmin     | yes 🔅 | yes 🔅 |
+| [5210](#ports) for `ERL_DIST_PORT` | supported | supported 🔅 |
 | :black_square_button: **Paths** |
 | `$HOME`               | `/opt/ejabberd/` | `/home/ejabberd/` |
-| User data             | `$HOME` :sparkle: <br /> `/home/ejabberd/` :orange_circle: | `$HOME` <br /> `/opt/ejabberd/` :sparkle: :low_brightness: |
-| `ejabberdctl`         | `ejabberdctl` :sparkle: <br /> `bin/ejabberdctl` :orange_circle:  | `bin/ejabberdctl` <br /> `ejabberdctl` :sparkle: :low_brightness: |
-| [`captcha.sh`](#captcha)         | `$HOME/bin/captcha.sh` :orange_circle:  | `$HOME/bin/captcha.sh` :orange_circle: |
-| `*.sql` files | `$HOME/sql/*.sql` :sparkle: :orange_circle: <br />  `$HOME/database/*.sql` :orange_circle: | `$HOME/database/*.sql` <br /> `$HOME/sql/*.sql` :sparkle: :orange_circle: |
-| Mnesia spool files | `$HOME/database/` :sparkle: <br /> `$HOME/database/NODENAME/` :orange_circle:  | `$HOME/database/NODENAME/` <br /> `$HOME/database/` :sparkle: :orange_circle: |
+| User data             | `$HOME` ❇️  <br /> `/home/ejabberd/` 🔅 | `$HOME` <br /> `/opt/ejabberd/` ❇️  |
+| `ejabberdctl`         | `ejabberdctl` ❇️  <br /> `bin/ejabberdctl` 🔅  | `bin/ejabberdctl` <br /> `ejabberdctl` ❇️  |
+| [`captcha.sh`](#captcha)         | `$HOME/bin/captcha.sh` 🔅  | `$HOME/bin/captcha.sh` 🔅 |
+| `*.sql` files | `$HOME/sql/*.sql` ❇️  🔅 <br />  `$HOME/database/*.sql` 🔅 | `$HOME/database/*.sql` <br /> `$HOME/sql/*.sql` ❇️  🔅 |
+| Mnesia spool files | `$HOME/database/` ❇️  <br /> `$HOME/database/NODENAME/` 🔅  | `$HOME/database/NODENAME/` <br /> `$HOME/database/` ❇️  🔅 |
 | :black_square_button: **Variables** |
-| [`EJABBERD_MACRO_*`](#macros-in-environment)      | supported :high_brightness: | supported :high_brightness: |
-| Macros used in `ejabberd.yml` | yes :orange_circle: | yes :orange_circle: |
-| [`EJABBERD_MACRO_ADMIN`](#register-admin-account) | Grant admin rights :orange_circle: <br /> (default `admin@localhost`) <br /> | Hardcoded `admin@localhost` |
-| [`REGISTER_ADMIN_PASSWORD`](#register-admin-account) | Register admin account :orange_circle: | unsupported |
-| `CTL_OVER_HTTP`       | enabled :orange_circle: | unsupported |
+| [`EJABBERD_MACRO_*`](#macros-in-environment)      | supported | supported |
+| Macros used in `ejabberd.yml` | yes 🔅 | yes 🔅 |
+| [`EJABBERD_MACRO_ADMIN`](#register-admin-account) | Grant admin rights 🔅 <br /> (default `admin@localhost`) <br /> | Hardcoded `admin@localhost` |
+| [`REGISTER_ADMIN_PASSWORD`](#register-admin-account) | Register admin account 🔅 | unsupported |
+| `CTL_OVER_HTTP`       | enabled 🔅 | unsupported |