-------------------------------------------------------------------------- WorldClient Pro 2.03 Readme File -------------------------------------------------------------------------- SYSTEM REQUIREMENTS ------------------- WorldClient Pro is a multi-threaded Win32 application that runs as a system service on Windows 95/98 and NT 4 or later and requires an SMTP server for outgoing mail. The amount of required system resources is contingent upon your particular needs: your number of WorldClient Pro users, the level of email traffic you wish to support, the speed of your connection, and so forth. However, we recommend at least a Pentium class computer with 16 MB RAM as a starting point. INSTALLATION ------------ There are three things that you will need to know during the installation process: o Your Name and Company, and e-mail address. o The host name or IP address of the SMTP server that will be used for outgoing mail. o The host name of the POP server that you wish to display by default in the "POP Server" box seen by users when creating new mailboxes. GENERAL ------- The WorldClient mail system is comprised of several distinct componants. These include the WorldClient Server which runs as a system service and is the actual web server agent performing all the web and email i/o with browsers and mail servers. Also, the WorldClient Admin Server runs as a service as well and manages connections by browsers wishing to remotely configure the WorldClient mail system. Additionally, an Administration GUI application is included that can start and stop either service. You may also start and stop either service via the services applet from the Windows control panel or via the command line with the NET util. DEFAULTS -------- o The WorldClient Server listens on port 2000 for all local IP's. o The WorldClient Admin Server listens on port 2001 for all local IP's. o Both services bind their listening sockets to all local IP addresses by default. o The default logon and password for gaining access to the WorldClient Admin Server are 'Admin' and 'WorldClient' respectively. These parameters are case sensitive, and are contained in the WorldClient.ini file. They can also be changed from within the WorldClient Admin GUI after you have logged in. You should change these credentials ASAP. If you wish to change the ports or bind to a specific IP address, you can do so by editing the WorldClient.ini located in the WorldClient directory. To bind to a specific IP address, change the BindAddress key in the WebServer section to the IP address to which you wish to bind WorldClient. The default value of 0.0.0.0 will bind to all local interfaces. You will have to stop & restart the WorldClient Server service in order for these changes to take effect. NOTE: The port and binding settings (and all other *.ini settings) can also be edited by accessing the WorldClient Admin Server. DIRECTORIES & FILES ------------------- \WorldClient\ Besides WorldClient's main application files, the base directory contains several files that you may need to work with: o WorldClient.ini - All non user-specific settings for the WorldClient Server and the WorldClient Admin Server are stored in this file. This file also contains the default settings for new users. User specific settings are found in the USER.INI files located within a particular user's mail directory. The name of this directory is the same as the user's login name, and is located in the \Users\ subdirectory. o AddrBook.txt - This is the file used for building WorldClient's Global Address Book. Personal Address Book entries are built from the AddrBook.txt file that is located in each user's personal mail directory. NOTE: These files are TAB delimited. To add an Address Book entry, type: Full Name[Tab]email address[Tab][Return]. The entry will not be recognized unless there are tabs before and after the email address. \Admin-CGI\ This subdirectory is where you should store CGI's that you wish to use with the WorldClient Admin Server. \HTML\ The HTML subdirectory is where any image files that are referred to by WorldClient are stored. Here, you should also store any HTML files that you have created and wish to incorporate into your WorldClient site. These can be referenced as relative links with or without a leading "/" within WorldClient's template files. \Logs\ The Logs subdirectory contains five log files that WorldClient maintains: o HTTP.LOG - This log is a CLF (Common Log Format) compliant http request log use by the WorldClient Server. You can parse this log with any popular web statistics software to see access statistics to your WorldClient site. In the future, this we will also support ELF (Extended Log Format), which includes the agent & referrer information. o HTTP-ADMIN.LOG - This log file is the same as the HTTP.LOG except that it is used for the WorldClient Admin Service. o WDAEMON.LOG - This file contains low-level human readable logging of transactions made thru the WorldClient Server's web-server engine. o WDAEMON-ADMIN.LOG - This is the same as the WDAEMON.LOG except that it is for WorldClient Admin Server's web-server engine. o WORLDCLIENT.LOG - This file contains detailed logging of all WorldClient activity. In the WorldClient.ini you can specify the level of log file verbosity by designating a value of 1 through 4; 1 being the most verbose and 4 being the least. \Users\ The USERS directory servers as the root from which each account's mail dir stems. A user's mail directory may contain: o The user's mail folders, which contain the user's messages. o The user's personal AddrBook.txt. o One or more .SIG files which contain signatures on a per mailbox basis. o Dictionary.txt - Contains user added words that the spell checker should skip over during spell checking. o USER.INI - This file contains the user's personalized settings. \Utils\ The utils directory contains several utilities we have provided for use with WorldClient. These include: o ImportMD.exe - for importing MDaemon user accounts into WorldClient. o ImportNT.exe - for importing your NT SAM database into WorldClient. o ImportTXT.exe - for importing accounts from a text file. o MDAddUser.zip - for automatically creating MDaemon user accounts when a WorldClient account is created. \Templates\ The Templates subdirectory is where all of the html templates used by the WorldClient parsing engine are stored. These templates are read in and all variables, denoted by <$varname$>, are replaced by WorldClient on the fly and then sent to the browser. Templates also contain references to language specific data stored in the LANGUAGES.INI file which is located here. Language strings are denoted within the templates as [$Text$] and are always provided in English within the templates. When another language is being used the english text within the template is replaced with a match taken from the LANGUAGES.INI file. Different templates can be grouped together as a "theme" if needed to embrace a wider range of browser support. WorldClient ships with one theme: jsFrames (Frames with JaveScript). If you wish to create another theme for your users to choose from then you should place it in the same subdirectory as the jsFrames directory - "...\WorldClient\Templates\[yourTheme dir]". If you wish to customize WorldClient's look, the HTML files in the themes directories are what you must edit. NOTE: Make sure that you backup the templates before you experiment, and be careful not to remove any mandatory tags or you will get unexpected results. See the Administrator's Help for a information regarding customizing WorldClient, and for a list of Template Tags and their functions. WORLDCLIENT ADMIN SERVER ------------------------ To access the WorldClient Admin Server go to port 2001 (default) of your WorldClient Server. Example: http://www.mycompany.com:2001 When you connect to the Admin Server interface from a remote location, you will be asked to login. The case-sensitive default parameters for login are: User Name - Admin Password - WorldClient You can use the Remote Administration interface to: o Restart the WorldClient service. o Monitor and/or Kill the active sessions. o Monitor session statistics. o Edit the WorldClient.ini settings. o Edit individual user settings. o Delete users. o Disable/Enable a user's account. o View the WorldClient log. WORLDCLIENT ADMINISTRATION GUI APPLICATION ------------------------------------------ This GUI application can be used to: o Start and stop the WorldClient service o Monitor the active sessions. o View individual user statistics. o View, Print, Save, or Delete the most recent WorldClient log activity. o Open the Remote Administration interface locally for editing WorldClient and/or user settings.