PyICQt-config.xml

   1 <pyicqt>
   2         <!-- The JabberID of the transport. -->
   3         <jid>icq.example.org</jid>
   4
   5         <!-- The component JID of the transport. Unless you're doing clustering, leave this alone -->
   6         <!-- <compjid>icq1</compjid> -->
   7
   8         <!-- The location of the spool directory.. if relative, relative to -->
   9         <!-- this directory.  Do not include the jid of the transport. -->
  10         <spooldir>/var/spool/pyicqt/</spooldir>
  11
  12         <!-- The location of the PID file.. if relative, relative to this dir. -->
  13         <!-- Comment out if you do not want a pid file -->
  14         <pid>/var/run/PyICQt.pid</pid>
  15
  16         <!-- The IP address of the main Jabberd server -->
  17         <mainServer>your_ip_address_of_jabber_server</mainServer>
  18
  19         <!-- The JID of the main Jabber server -->
  20         <mainServerJID>jabber.localhost</mainServerJID>
  21
  22         <!-- The website of the Jabber service -->
  23         <website>http://jabber.localhost/</website>
  24
  25         <!-- The TCP port to connect to the Jabber server on -->
  26         <!-- (this is the default for Jabberd2) -->
  27         <port>5347</port>
  28
  29         <!-- The TCP port that the web admin interface will answer on -->
  30         <!-- (uncomment to enable) -->
  31         <!-- <webport>12345</webport> -->
  32
  33         <!-- The authentication token to use when connecting to the Jabber server -->
  34         <secret>secret</secret>
  35
  36         <!-- The default language to use (for error/status messages) -->
  37         <lang>en</lang>
  38
  39         <!-- Default message encoding to use -->
  40         <encoding>iso-8859-1</encoding>
  41
  42         <!-- The hostname of the ICQ server you wish to connect to -->
  43         <icqServer>login.icq.com</icqServer>
  44
  45         <!-- The port of the ICQ server you wish to connect to -->
  46         <icqPort>5190</icqPort>
  47
  48         <!-- The name of Socks Proxy if connecting thru a proxy -->
  49         <!-- <socksProxyServer>im-proxy2</socksProxyServer> -->
  50
  51         <!-- The Socks Proxy port to use when connecting thru a proxy -->
  52         <!-- <socksProxyPort>1080</socksProxyPort> -->
  53
  54         <!-- Send greeting on login (enter text to be sent to users here) -->
  55         <!-- <sessionGreeting>enter message here</sessionGreeting> -->
  56
  57         <!-- Send message on successful registration -->
  58         <!-- <registerMessage>You have successfully registered with PyICQt</registerMessage> -->
  59
  60         <!-- Allow users of ICQ gateway to chat with AIM users -->
  61         <!-- (uncomment to enable) -->
  62         <!-- <crossChat/> -->
  63
  64         <!-- Disable registration with the transport -->
  65         <!-- (uncomment to disable) -->
  66         <!-- <disableRegister/> -->
  67
  68         <!-- Enable automatic invitation to reconnect on restart -->
  69         <!-- (uncomment to enable) -->
  70         <!-- <enableAutoInvite/> -->
  71
  72         <!-- Disable xhtml support (messages with fonts and colors) -->
  73         <!-- (uncomment to disable) -->
  74         <!-- <disableXHTML/> -->
  75
  76         <!-- Disable mail notifications -->
  77         <!-- (uncomment to disable) -->
  78         <!-- <disableMailNotifications/> -->
  79
  80         <!-- Disable use of default avatar if none is specified -->
  81         <!-- (uncomment to disable) -->
  82         <!-- <disableDefaultAvatar/> -->
  83
  84         <!-- Disable use of iq-based avatars (JEP-0008) -->
  85         <!-- (uncomment to disable) -->
  86         <!-- <disableIQAvatars/> -->
  87
  88         <!-- Disable use of vcard-based avatars (JEP-0153) -->
  89         <!-- (uncomment to disable) -->
  90         <!-- <disableVCardAvatars/> -->
  91
  92         <!-- Disable use of PEP-based avatars (JEP-0084) -->
  93         <!-- (uncomment to disable) -->
  94         <!-- NOT IMPLEMENTED YET -->
  95         <!-- <disablePEPAvatars/> -->
  96
  97         <!-- You can choose which users you wish to have as administrators. These users can perform some tasks with Ad-Hoc commands that others cannot -->
  98         <admins>
  99         <!--<jid>admin@host.com</jid>-->
 100         </admins>
 101
 102         <!-- You can select which event loop PyAIMt will use. It's probably safe to leave this as the default -->
 103
 104         <!-- Use epoll for high-load Linux servers running kernel 2.6 or above -->
 105         <!--<reactor>epoll</reactor>-->
 106
 107         <!-- Use kqueue for high-load FreeBSD servers -->
 108         <!--<reactor>kqueue</reactor>-->
 109
 110         <!-- Use poll for high-load Unix servers -->
 111         <!--<reactor>poll</reactor>-->
 112
 113         <!-- You can select which spool storage method you wish to use -->
 114         <!-- Available methods are: -->
 115         <!-- xmlfiles: single xml files in the spool directory in hashed dirs (default)-->
 116         <!-- legacyaimtransport: compatible with c-based aim transport, less functionality -->
 117         <!-- legacyjittransport: compatible with JIT transport, less functionality -->
 118         <!-- mysql: registration information stored in a MySQL database -->
 119         <!--<xdbDriver>xmlfiles</xdbDriver>-->
 120
 121         <!-- For MySQL -->
 122         <!--<xdbDriver>mysql</xdbDriver>-->
 123         <!--<xdbDriver_mysql>-->
 124         <!--<username>pyicqt</username>-->
 125         <!--<password>pyicqt</password>-->
 126         <!--<database>pyicqt</database>-->
 127         <!--<server>localhost</server>-->
 128         <!--<format>encrypted</format>--> <!-- Enable encryption of passwords -->
 129         <!--</xdbDriver_mysql>-->
 130
 131         <!-- For XMLFiles -->
 132         <!--<xdbDriver>xmlfiles</xdbDriver>-->
 133         <!--<xdbDriver_xmlfiles>-->
 134         <!--<format>encrypted</format>--> <!-- Enable encryption of passwords -->
 135         <!--</xdbDriver_xmlfiles>-->
 136
 137         <!-- Only grab avatars when a chat is initiated. -->
 138         <!-- <avatarsOnlyOnChat/> -->
 139
 140         <!-- Disable all avatar functionality. Might be necessary if you -->
 141         <!-- do not have PIL installed. -->
 142         <!-- <disableAvatars/> -->
 143
 144         <!-- Enable web presence indicator.  This can increase ICQ spam. -->
 145         <!-- <enableWebPresence/> -->
 146
 147         <!-- Disable automatic send (via im) of away message when away set. -->
 148         <!-- Note that away messages are -in addition to- the away status -->
 149         <!-- message. -->
 150         <!-- <disableAwayMessage/> -->
 151
 152         <!-- Use Jabber.com's XCP component protocol extensions. -->
 153         <!-- <useXCP/> -->
 154
 155         <!-- SASL username used to bind to Jabber server. -->
 156         <!-- secret, above, is used for sasl password -->
 157         <!-- NOTE: This does not work with Twisted > 2.2.0. -->
 158         <!-- <saslUsername>username</saslUsername> -->
 159
 160         <!-- Use external component binding. -->
 161         <!-- This dodges the need to manually configure all jids that talk to this transport. -->
 162         <!-- Jabberd2 requires saslUsername and useRouteWrap for this to work. -->
 163         <!-- Wildfire as of 2.6.0 requires just this. -->
 164         <!-- <useComponentBinding/> -->
 165
 166         <!-- Wrap stanzas in <route> stanza. -->
 167         <!-- Jabberd2 requires this for useComponentBinding. -->
 168         <!-- <useRouteWrap/> -->
 169
 170         <!-- JID of message archive service -->
 171         <!-- <messageArchiveJID>datasink.example.org</messageArchiveJID> -->
 172
 173         <!-- If registration authentication is used, enter the method -->
 174         <!-- Auth configs often require additional options to be specified. -->
 175         <!-- See associated config entries per authRegister example. -->
 176         <!-- NOTE: limited to LDAP for now -->
 177
 178         <!-- THIS IS UNTESTED AS OF YET -->
 179         <!-- <authRegister>LDAP</authRegister> -->
 180         <!-- For LDAP auth, make sure to uncomment <authRegister_LDAP> -->
 181         <!-- and </authRegister_LDAP> and fill out the options in between. -->
 182         <!-- <authRegister_LDAP> -->
 183         <!-- The fqdn or ip address of the LDAP server -->
 184         <!-- <server>ldap.example.org</server> -->
 185         <!-- The Root DN to be used to perform LDAP searches -->
 186         <!-- <rootDN>CN=Administrator,CN=Users,DC=example,DC=org</rootDN> -->
 187         <!-- The password for the Root DN -->
 188         <!-- <password>SECRET</password> -->
 189         <!-- The Base DN to search for users -->
 190         <!-- <baseDN>DC=example,DC=org</baseDN> -->
 191         <!-- The attribute to search for the user ID. -->
 192         <!-- 'samAccountname' in Windows, 'uid' on most other systems -->
 193         <!-- <uidAttr>samAccountname</uidAttr> -->
 194         <!-- </authRegister_LDAP> -->
 195 </pyicqt>