IM Gateway Plugin's Openfire Properties

VERSION 11 Published

Created on: Aug 9, 2007 12:56 PM by jadestorm - Last Modified:  Dec 20, 2007 2:07 PM by jadestorm

Below is a list of all of the system properties that the IM Gateway plugin uses. Most of them are set via the Openfire admin console, under Gateways : Settings. There are a few "special" or "advanced" settings here that can only be set manually, however. You can set them by visiting the System Properties screen in your Openfire admin console.

Property Description Default Since
plugin.gateway.aim.connecthost What OSCAR host are we connecting to for AIM? login.oscar.aol.com 1.0Beta5
plugin.gateway.aim.connectport What port on the OSCAR host are we connecting to for AIM? 5190 1.0Beta5
plugin.gateway.aim.crosschat Enable communication between AIM and ICQ accounts. false 1.1.3
plugin.gateway.aim.enabled Is the AIM transport enabled? false 1.0Beta1
plugin.gateway.aim.mailnotifications Are mail notifications enabled? true 1.1.3
plugin.gateway.aim.reconnect Enable auto-reconnection on disconnect. true 1.0.2
plugin.gateway.aim.reconnectattempts Number of times to attempt auto-reconnect. 3 1.0.2
plugin.gateway.aim.registration Who can register directly: 1: all, 2: some, 3: none 1 1.0Beta6
plugin.gateway.aim.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.aim.subdomain Subdomain of the AIM transport. (Advanced) aim 1.0Beta1
plugin.gateway.gadugadu.connecthost What Gadu-Gadu host are we connecting to? appmsg.gadu-gadu.pl 1.1.0
plugin.gateway.gadugadu.connectport What Gadu-Gadu port are we connecting to? 80 1.1.0
plugin.gateway.gadugadu.enabled Is the Gadu-Gadu transport enabled? false 1.1.0
plugin.gateway.gadugadu.reconnect Enable auto-reconnection on disconnect. true 1.1.0
plugin.gateway.gadugadu.reconnectattempts Number of times to attempt auto-reconnect. 3 1.1.0
plugin.gateway.gadugadu.subdomain Subdomain of the Gadu-Gadu transport. (Advanced) gadugadu 1.1.0
plugin.gateway.gtalk.connecthost What Google Talk host are we connecting to? talk.google.com 1.1.0
plugin.gateway.gtalk.connectport What Google Talk port are we connecting to? 5222 1.1.0
plugin.gateway.gtalk.enabled Is the Google Talk transport enabled? false 1.1.0
plugin.gateway.gtalk.mailnotifications Are mail notifications enabled? true 1.1.3
plugin.gateway.gtalk.reconnect Enable auto-reconnection on disconnect. true 1.1.0
plugin.gateway.gtalk.reconnectattempts Number of times to attempt auto-reconnect. 3 1.1.0
plugin.gateway.gtalk.registration Who can register directly: 1: all, 2: some, 3: none 1 1.1.0
plugin.gateway.gtalk.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.gtalk.subdomain Subdomain of the Google Talk transport. (Advanced) gtalk 1.1.0
plugin.gateway.gtalk.usecompression Enable compression when talking to remote host. false 1.1.3
plugin.gateway.icq.connecthost What OSCAR host are we connecting to for ICQ? login.oscar.aol.com 1.0Beta5
plugin.gateway.icq.connectport What port on the OSCAR host are we connecting to for ICQ? 5190 1.0Beta5
plugin.gateway.icq.crosschat Enable communication between AIM and ICQ accounts. false 1.1.3
plugin.gateway.icq.enabled Is the ICQ transport enabled? false 1.0Beta1
plugin.gateway.icq.mailnotifications Are mail notifications enabled? true 1.1.3
plugin.gateway.icq.reconnect Enable auto-reconnection on disconnect. true 1.0.2
plugin.gateway.icq.reconnectattempts Number of times to attempt auto-reconnect. 3 1.0.2
plugin.gateway.icq.registration Who can register directly: 1: all, 2: some, 3: none 1 1.0Beta6
plugin.gateway.icq.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.icq.encoding Default encoding for ICQ. iso-8859-1 1.0Beta6
plugin.gateway.icq.subdomain Subdomain of the ICQ transport. (Advanced) icq 1.0Beta1
plugin.gateway.irc.connecthost What IRC host are we connecting to? irc.freenode.net 1.0Beta5
plugin.gateway.irc.connectport What IRC port are we connecting to? 7000 1.0Beta5
plugin.gateway.irc.enabled Is the IRC transport enabled? false 1.0Beta1
plugin.gateway.irc.reconnect Enable auto-reconnection on disconnect. true 1.0.2
plugin.gateway.irc.reconnectattempts Number of times to attempt auto-reconnect. 3 1.0.2
plugin.gateway.irc.registration Who can register directly: 1: all, 2: some, 3: none 1 1.0Beta6
plugin.gateway.irc.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.irc.roomlist Whether to permit retrieval of MUC room list false 1.1.0
plugin.gateway.irc.subdomain Subdomain of the IRC transport. (Advanced) irc 1.0Beta1
plugin.gateway.msn.connecthost What MSN host are we connecting to? messenger.hotmail.com 1.0Beta5
plugin.gateway.msn.connectport What MSN port are we connecting to? 1863 1.0Beta5
plugin.gateway.msn.enabled Is the MSN transport enabled? false 1.0Beta1
plugin.gateway.msn.mailnotifications Are mail notifications enabled? true 1.1.3
plugin.gateway.msn.reconnect Enable auto-reconnection on disconnect. true 1.0.2
plugin.gateway.msn.reconnectattempts Number of times to attempt auto-reconnect. 3 1.0.2
plugin.gateway.msn.registration Who can register directly: 1: all, 2: some, 3: none 1 1.0Beta6
plugin.gateway.msn.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.msn.subdomain Subdomain of the MSN transport. (Advanced) msn 1.0Beta1
plugin.gateway.sip.connecthost What SIP host are we connecting to? localhost 1.1.0
plugin.gateway.sip.connectport What SIP port are we connecting to? 5060 1.1.0
plugin.gateway.sip.enabled Is the SIP transport enabled? false 1.1.0
plugin.gateway.sip.reconnect Enable auto-reconnection on disconnect. true 1.1.0
plugin.gateway.sip.reconnectattempts Number of times to attempt auto-reconnect. 3 1.1.0
plugin.gateway.sip.registration Who can register directly: 1: all, 2: some, 3: none 1 1.1.0
plugin.gateway.sip.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.sip.subdomain Subdomain of the SIP transport. (Advanced) sip 1.1.0
plugin.gateway.tweak.noprobeonstart Prevents presence probes on transport startup false 1.1.2
plugin.gateway.tweak.percenthack Use % instead of \40 to replace @ in JIDs false 1.0Beta7
plugin.gateway.tweak.persistentroster Makes legacy contacts really be in user rosters false 1.1.2
plugin.gateway.xmlrpc.password Auth password required for XML-RPC (null = disabled) null 1.1.0
plugin.gateway.xmpp.connecthost What XMPP host are we connecting to? jabber.org 1.1.0
plugin.gateway.xmpp.connectport What XMPP port are we connecting to? 5222 1.1.0
plugin.gateway.xmpp.enabled Is the XMPP transport enabled? false 1.1.0
plugin.gateway.xmpp.overrideservice Override the service name used in gateway settings XMPP 1.1.2
plugin.gateway.xmpp.overridename Override the service name returned via disco and in user rosters XMPP Transport 1.1.2
plugin.gateway.xmpp.reconnect Enable auto-reconnection on disconnect. true 1.1.0
plugin.gateway.xmpp.reconnectattempts Number of times to attempt auto-reconnect. 3 1.1.0
plugin.gateway.xmpp.registration Who can register directly: 1: all, 2: some, 3: none 1 1.1.0
plugin.gateway.xmpp.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.xmpp.subdomain Subdomain of the XMPP transport. (Advanced) xmpp 1.1.0
plugin.gateway.xmpp.usecompression Enable compression when talking to remote host. false 1.1.3
plugin.gateway.yahoo.connecthost What Yahoo host are we connecting to? scs.msg.yahoo.com 1.0Beta5
plugin.gateway.yahoo.connectport What Yahoo port are we connecting to? 5050 1.0Beta5
plugin.gateway.yahoo.enabled Is the Yahoo transport enabled? false 1.0Beta1
plugin.gateway.yahoo.mailnotifications Are mail notifications enabled? true 1.1.2
plugin.gateway.yahoo.reconnect Enable auto-reconnection on disconnect. true 1.0.2
plugin.gateway.yahoo.reconnectattempts Number of times to attempt auto-reconnect. 3 1.0.2
plugin.gateway.yahoo.registration Who can register directly: 1: all, 2: some, 3: none 1 1.0Beta6
plugin.gateway.yahoo.registrationstrict Do registration restrictions apply to logins as well? false 1.1.3
plugin.gateway.yahoo.subdomain Subdomain of the Yahoo transport. (Advanced) yahoo 1.0Beta1

Average User Rating
(2 ratings)




Sep 2, 2007 3:02 AM Click to view SmilingJ's profile SmilingJ says:

what does

plugin.gateway.icq.mailnotifications
mean? what effects has it if i change it to false?

Sep 2, 2007 8:25 AM Click to view jadestorm's profile jadestorm says: in response to: SmilingJ

Nothing yet. Note that it's listed for version 1.1.3. ;)

(It will turn off mail notifications from ICQ)

Dec 20, 2007 1:34 PM Click to view OFnoob's profile OFnoob says:

Having problems editing the values of gateway.jar. I would like to enable the gateway from Jabber to MSN, Yahoo, etc...but I have no idea how to access the properties. Double clicking gateway.jar and I get a message "Failed to load Main-Class manifest attribute from c:/...gateway.jar"

From there, I converted gateway.jar to a .zip file, extracted it and went to the manifest file. Can you please tell me what the Main-Class is supposed to be? Or how I should go about in order to change these properties? Thanks.

Dec 20, 2007 1:57 PM Click to view jadestorm's profile jadestorm says: in response to: OFnoob

Oh that's a good point, I should write that at the top of this document. You don't edit anything in gateway.jar directly. Instead install it under Openfire like other plugins and go to your admin console under "System Properties" and make the settings there. That said, most of it you won't have to edit anything directly. Look towards the bottom of the admin console screen and you'll see a Gateway section with Settings and Registrations. Settings is what you are looking for. =) There's just a few of these properties above that can only be set via system properties directly.

Dec 20, 2007 2:12 PM Click to view OFnoob's profile OFnoob says: in response to: jadestorm

Hey jadestorm,
Thanks for the fast reply, I didn't expect you to answer so quickly =)
Ok, well it's good to know I don't have to actually edit gateway.jar itself.

I looked in the IM gateway documentation and it says, "This plugin is configured via the "Gateways" sidebar item located in the Openfire Admin Console. You can enable individual transports via the "Settings" sidebar item, and add new registrations/view existing registrations from the "Registrations" sidebar item", which I assume is what you said in your comment as well ^^

The only problem is, I can't see Gateway with Settings and Registrations section at the bottom of the admin console. I mean, I have found the System Properties page, with several properties such as cache.GatewayRegistrationCache.min and cache.GatewaySessionLocationCache.type, but there's no Gateway section anywhere in the admin.

I've added the IM Gateway's properties for Openfire to communicate with MSN (copy and pasted the property name and value from here to Add new property in the System Properties page) but I can't add contacts from my Jabber client (Exodus).

I've become bald from scratching my head so much, will appreciate your response!

Dec 20, 2007 2:28 PM Click to view OFnoob's profile OFnoob says: in response to: OFnoob

Does the Gateway section not appear because I am not using Enterprise edition of Openfire?

Dec 20, 2007 2:47 PM Click to view OFnoob's profile OFnoob says: in response to: jadestorm

In the "server" tab of the Openfire admin console, the only sub-tabs that I can see that have the word "settings" are Email, Profile, Security, Compression, File Transfer, and STUN Settings...no Gateway Settings.

Dec 20, 2007 3:45 PM Click to view OFnoob's profile OFnoob says: in response to: OFnoob

Just one more thing, I remembered that OpenFire has lately been throwing a constant error:
Found old database version 5 for gateway...upgrading to version 6.
gateway - Database update failed. Please manually upgrade your database.

Does this mean because the MySQL version is not up to date, it is messing up the admin console, causing the Gateway Tab not to show up? I'm not sure because the error seems vague (unfamiliar with these terms)...

Dec 20, 2007 4:26 PM Click to view jadestorm's profile jadestorm says: in response to: OFnoob

We should move this conversation to a forum thread, not as comments to a document. =) Unfortunately I don't see a nifty administrative way to "just move it". =/

Jun 5, 2008 4:42 PM Click to view americancaesar2's profile americancaesar2 says: in response to: jadestorm

are these settings current for plugin version 1.2.3?

Jun 9, 2008 8:00 PM Click to view jadestorm's profile jadestorm says: in response to: americancaesar2

They should be. Is something missing that you expected to see?

Jun 10, 2008 1:49 PM Click to view americancaesar2's profile americancaesar2 says: in response to: jadestorm

just that plugin.gateway.msn.avatars is in my system properties and not in this list... plugin.gateway.msn.registrationstrict seems to have a setting in the gui that is similar but it is not configured by default in my system properties. having said that, i have had issues with my gateway plugin and will be removing it and re-installing it this evening. maybe it is my issue and the plugin.gateway.msn.avatars property no longer exists.

Jun 24, 2008 4:26 AM Click to view No.2's profile No.2 says: in response to: americancaesar2

plugin.gateway.msn.autonickname seems also to be missing

Jun 24, 2008 6:49 PM Click to view americancaesar2's profile americancaesar2 says: in response to: americancaesar2

Just as a follow up the property is still there after removal and reinstallation of the gateway plugin. It may just be an arbitrary artifact at this point and no longer recognized by the server (?) or a legit property...

Jun 26, 2008 8:56 AM Click to view jadestorm's profile jadestorm says: in response to: americancaesar2

Properties do not go away when you uninstall plugins. You may want to install them again later and pick up your own settings, and in general we try not to second guess the folk running the server. =)

Jun 26, 2008 12:38 PM Click to view americancaesar2's profile americancaesar2 says: in response to: jadestorm

Basically, then if it's not on the list it is an artifact of a previous instance and no longer relevant i.e. safe to remove?