Documentation for Room Owners

Room listing criteria applies the following criteria when deciding whether to include a room in the public listing. All criteria must be met:

  1. The room must be set to be persistent, that is, to continue existing even if nobody is currently in it. Temporary rooms are often used for ad-hoc purposes and it does not make sense to list them publicly.
  2. The room must be set to allow public listing.
  3. The room must not have a password set.
  4. The room must be open to the general public, that is, the "Members only" option must not be set.
  5. The room and the domain it is hosted on must not be on our service-maintained blocklist.

To even be able to consider a room, it must be known to the service. Rooms are discovered by the following means:

When inviting the service to your room, note that it will not join the room. Your room will be considered at latest during the next crawl (see below for update frequencies).

Join / History actions

To get join/history actions on your room, support by your MUC operator is needed. Please check the room configuration options available to you, and if you do not find any related option, contact your operator. You may want to point your operator at the documentation for operators which contains more technical information on what is required.

Avatar criteria

Avatars are only shown if the room is on a service-maintained allowlist. The allowlist is managed fully at the discretion of the service provider. There is no transparency whatsoever about list membership. The reason for that is the potential for abuse and the complexity of image processing and the load it may cause on the server.

If you want your room to get on the list, please get in touch.

In addition to requiring a allowlist entry, avatars must also fulfill the following criteria:

  • They must be PNG, JPEG or SVG images.
  • Raster images (PNG or JPEG) must not exceed 1 MiB in size.
  • Vector images (SVG) must not exceed 64 kiB in size.
  • They must be published using the vcard-temp protocol (yeah... I know).

Room delisting

Note that if your room is listed here, it has been configured to be listed publicly (see above). The preferred way to remove your room from the list would be to disable that configuration option (and wait for the crawler to pick up on it, see below for the update frequency).

If the crawler does not seem to pick up on your configuration change or you want your room to be excluded from this listing only but want it included in other listings, please get in touch.

Rooms which have been unreachable for more than two days will be delisted automatically.

Meta-information about rooms collects the following meta-information about rooms:

  • Address (obviously)
  • (Average) number of users
  • Name
  • Description
  • Primary language
  • Subject/topic (if available; currently not shown)
  • Web chat and logs URLs (if available)
  • Avatar (if allowlisted)

The name, description and primary language can be configured using the standard room configuration options offered by your Jabber client.

Note: Not all clients offer (all) configuration options. In general, mobile clients offer fewer options than desktop clients. Gajim is an example of a desktop client which offers all room options.

Note: The room language option, albeit specified years ago, has only recently been added to servers. If the option is not offered to you while name and description are offered, please get in touch with your server operator. Point them at the documentation for service operators.

Note: Due to the complexity of handling avatars on the server side, your room or domain needs to be allowlisted to be allowed to use avatars. The allowlisting happens at the discretion of the service provider. Please contact us to have your room allowlisted for avatar use.

Update frequency

As there is no way for our service to be notified of changes to your room metadata, updates can take a while. It may thus take a few hours for your update to be applied to the public listing.

You may or may not be able to speed up the update process by re-inviting the service (see above) to your room.

Like all other room stats, the number of occupants is queried in a dynamic interval depending on the load (unless is joined in a room). In addition, we perform a moving average on (up to, again, depending on the load) hourly samples. This helps to avoid having the listing fluctuate too much due to the usual in and out flux of occupants.

In any case, the number of occupants should at most be used as a rough hint to the popularity of the room. It is used as the primary sorting criterium because we don’t have any better.