view mod_default_bookmarks/README.markdown @ 2119:5f6c18fd0161

mod_firewall: Correct zone condition to check bare JID
author Kim Alvefur <zash@zash.se>
date Thu, 17 Mar 2016 14:45:08 +0100
parents 4d73a1a6ba68
children 73906187f964
line wrap: on
line source

---
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" };
        { jid = "another-room@conference.example.com", name = "The Other Room" };
        -- You can also use this compact syntax:
        "yetanother@conference.example.com"; -- this will get "yetanother" as name
    };