mod_default_bookmarks/README.markdown
author Kim Alvefur <zash@zash.se>
Sun, 26 Mar 2023 14:39:34 +0200
changeset 5281 a1055024b94e
parent 3241 420ebea00cf3
child 5610 39bb7232326d
permissions -rw-r--r--
mod_http_oauth2: Stricten check of urlencoded form data Because type(formdecode("string without equals sign")) == "string", so best avoid continuing in that case, even if strings mostly behave as tables as long as you don't hit one of the __index methods.

---
labels:
summary: Default bookmarked chatrooms
...

Introduction
============

This module allows you to add default bookmarks for users. It only kicks
in when the user has no existing bookmarks, so users are free to add,
change or remove them.

Details
=======

Most clients support storing a private list of room "bookmarks" on the
server. When they log in, they fetch this list and join any that are
marked as "autojoin". If this list is empty, as it would be for new
users, this module would return the list supplied in the config.

Configuration
=============

Add "default\_bookmarks" to your modules\_enabled list:

        modules_enabled = {
                   -- ...other modules here... --
                   "default_bookmarks";
                   -- ...maybe some more here... --
        }

Then add a list of the default rooms you want:

    default_bookmarks = {
        { jid = "room@conference.example.com", name = "The Room" };
        -- Specifying a password is supported:
        { jid = "secret-room@conference.example.com", name = "A Secret Room", password = "secret" };
        -- You can also use this compact syntax:
        "yetanother@conference.example.com"; -- this will get "yetanother" as name
    };

Compatibility
-------------

  ------- ---------------
  trunk   Works
  0.10    Should work
  0.9     Should work
  ------- ---------------