view mod_default_bookmarks.wiki @ 388:b9f7c8bd5648

Add list of supporting clients
author Kim Alvefur <zash@zash.se>
date Mon, 15 Jul 2013 01:46:43 +0200
parents f9b80a58366f
children
line wrap: on
line source

#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
};
}}}