Difference between revisions of "Widget"

From Mibbit Wiki
Jump to: navigation, search
m (iframe Example: popup hint added)
(Use bold instead of *asterisks*)
Line 1: Line 1:
If you'd like to have webchat on your own website, then you could use a JAVA applet (slow, ugly, and not very accessible), or you could use Mibbit!
+
If you'd like to have webchat on your own website, then you could use a Java applet (slow, ugly, and not very accessible), or you could use Mibbit!
  
 
The first step, is to decide where you want your users to go.
 
The first step, is to decide where you want your users to go.
Line 11: Line 11:
  
 
* nick - If you do not specify this, a random one will be chosen eg mib_6d7s8euf
 
* nick - If you do not specify this, a random one will be chosen eg mib_6d7s8euf
* channel - A *single* channel that the user will be directed to.
+
* channel - A '''single''' channel that the user will be directed to.
 
* server - This defaults to irc.mibbit.com. You can avoid the connect-form if you have authorized your server (see [http://mibbit.blogspot.com/2008/03/widget-connects-to-any-server.html blog]).
 
* server - This defaults to irc.mibbit.com. You can avoid the connect-form if you have authorized your server (see [http://mibbit.blogspot.com/2008/03/widget-connects-to-any-server.html blog]).
 
* userListWidth - The width of the user list in pixels
 
* userListWidth - The width of the user list in pixels
Line 46: Line 46:
 
== Securing your widget ==
 
== Securing your widget ==
  
There is also a secure mode of operation, if you wish you channel to be slightly more secure, or do not want *anybody* able to have a widget pointing at your channel.
+
There is also a secure mode of operation, if you wish you channel to be slightly more secure, or do not want '''anybody''' able to have a widget pointing at your channel.
 
With this system, you tell us the channel/server, and a password.
 
With this system, you tell us the channel/server, and a password.
 
Then for each url you generate, you must specify a nick (Generate one yourself), and you send over 'key' as a param, equal to md5(nick + ":" + password). This means that unless you know the password, embedding to that channel/server is pretty hard.
 
Then for each url you generate, you must specify a nick (Generate one yourself), and you send over 'key' as a param, equal to md5(nick + ":" + password). This means that unless you know the password, embedding to that channel/server is pretty hard.

Revision as of 17:15, 27 April 2008

If you'd like to have webchat on your own website, then you could use a Java applet (slow, ugly, and not very accessible), or you could use Mibbit!

The first step, is to decide where you want your users to go. You can either create a channel on irc.mibbit.com or if you manage your own irc server, please contact Mibbit and ask for it to be authorized.

The basic URL for the Mibbit Widget is

http://embed.mibbit.com/

The parameters you can pass are:

  • nick - If you do not specify this, a random one will be chosen eg mib_6d7s8euf
  • channel - A single channel that the user will be directed to.
  • server - This defaults to irc.mibbit.com. You can avoid the connect-form if you have authorized your server (see blog).
  • userListWidth - The width of the user list in pixels
  • noServerTab - True by default, if you set this to false, you will get a server tab, and motd etc goes there.
  • noServerNotices - False by default. If true, then notices to the embed channel do not get displayed. (Only used if noServerTab==true)
  • noServerMotd - False by default. If true, then motd to the embed channel is not displayed. (Only used if noServerTab==true)
  • forcePrompt - False by default. If true, this forces the user to choose a nick and click connect.

Additionally you can specify any setting as shown in /dset. For the Widget there are a few default changes:

chatOutputShowTimes = false showJoinsParts = false showAwaysBacks = false chatOutputNickWidth = 90 focusNewJoins = false

Please note you must urlencode all parameters. So #foo becomes %23foo etc.


example

What can be set via uri: Preference parameters , link example:

<a href="http://embed.mibbit.com/
?server=irc.freenode.net
&nick=Guest...
&channel=%23mib_chat
&chatOutputShowTimes=true
&needSendButton=true" 
target="_blank">start chat on freenode</a>
 

Securing your widget

There is also a secure mode of operation, if you wish you channel to be slightly more secure, or do not want anybody able to have a widget pointing at your channel. With this system, you tell us the channel/server, and a password. Then for each url you generate, you must specify a nick (Generate one yourself), and you send over 'key' as a param, equal to md5(nick + ":" + password). This means that unless you know the password, embedding to that channel/server is pretty hard. Additionally you can also specify a channel key if the channel is keyed. Then only people using *your* widget on your site, or people you allow, can enter the channel.

iframe Example

Make sure your page has a DTD setup, otherwise IE will not work properly.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

... some header html...

<iframe width="600" height="380" scrolling="no" frameborder="0"
 src="http://embed.mibbit.com/?channel=%23my_chat&nick=choose_one">
</iframe>
type /nick to change your Nick name, /help, /cs help,
/ns help, /ms help, or /os help for available commands

... some footer html ...

see also Iframe and Popup