Sonork Instant Messaging
Enterprise Installation Guide
|  |
February 2003
Product Version: Sonork Server V 1.7
This manual describes the different installation procedures that can be
used to install or update Sonork IM Server to Version 1.7 .
Enterprise Installation Guide
Copyright Notice
© Copyright GTV Solutions, Inc. 1996, 2003. All rights reserved. May only be used pursuant to a Sonork Messaging Systems Software License Agreement. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without prior written permission of GTV Solutions, Inc. GTV Solutions, Inc. grants you limited permission to make hardcopy or other reproductions of any machine-readable documentation for your own use, provided that each such reproduction shall carry the GTV Solutions, Inc. notice. No other rights under copyright are granted without prior written permission of GTV Solutions, Inc. The document is not intended for production and is furnished “as is” without warranty of any kind. All warranties on this document are hereby disclaimed, including the warranties of merchantability and fitness for a particular purpose.
U.S. Government Users Restricted Rights—Use, duplication or disclosure restricted, contact GTV Solutions. Inc.
Trademarks
Sonork Messaging System, and the Sonork logo are trademarks or registered trademarks of GTV Solutions, Inc. in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other company, product, or service names may be trademarks or service marks of others.
Notices
References in this publication to Sonork systems, products, programs, or services do not imply that they will be available in all countries in which GTV Solutions, Inc. operates. Any reference to these products, programs, or services is not intended to imply that only Sonork systems, products, programs, or services can be used.
Subject to valid intellectual property or other legally protectable right of Sonork, any functionally equivalent product, program, or service can be used instead of the referenced product, program, or service. The evaluation and verification of operation in conjunction with other products, except those expressly designated by GTV Solutions, Inc., are the responsibility of the user. GTV Solutions, Inc. may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to the Sonork Director of Licensing, GTV Solutions, Inc., 49E. 21st. Street, 9th Floor, New York, NY 10010, United States of America.
© Copyright GTV Solutions, Inc. 2003. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted, contact GTV Solutions, Inc.
About This Manual
This Manual describes the different installation procedures that can be used to install or upgrade Sonork Instant Messaging System to Version 1.7
I. Audience
The target audience for this guide is system administrators responsible for the installation of Sonork products and patches. Users of this guide should have knowledge of the following:
PC operating Systems
Database architecture and concepts
Networking
Graphical User Interface
II. Organization
This manual is organized as follows:
Chapter 1: Overview of Installation
Chapter 2: Installing the Sonork Server in a Windows Operating System
Chapter 3: Initial Configuration of the Sonork Server
Chapter 4: Upgrading the Sonork Server in a Windows Operating System
Chapter 5: Installing the Sonork Client in a Windows Operating System
Appendix
III. Related Documents
Sonork provides the following related documentation:
Sonork User's Guide: may contain important information about anything related to Sonork Server that may affect your installation.
Sonork Release Notes: may contain important undocumented information about anything related to Sonork Server that may affect your installation.
You can also view the Sonork Version 1.7 Technical Update for any additional information not included in this manual. You can access the Technical Update from the following URL: http://www.sonork.com/eng/support.html
IV. Reader’s Comments
Sonork welcomes any comments and suggestions you have on this and other Sonork manuals.
You can send your comments in the following ways:
Fax: 1-212-228-9600 Attn: SLD Publications
Internet electronic mail: readers_comment@sonork.com
Postal Address:
GTV Solutions
Attn: SLD Publications
49 East 21st Street
New York, NY 10010
USA
A Reader’s Comment form is located on your system in the following location:
$SONORK/doc/readers_comment.txt
Please include the following information along with your comments:
The full title of the manual and the order numberof the section numbers and page numbers of the information on which you are commenting.
The version of Sonork that you are using.
If known, the type of processor that is running the Sonork Messaging System software.
The Sonork Library Department ( SLD) cannot respond to system problems or technical support inquiries. Please address technical questions to your local system vendor or to the appropriate Sonork technical support office. Information provided with the software media explains how to send problem reports to Sonork.
V. Conventions
This guide uses several typeface conventions for special terms and actions. These conventions have the following meaning:
BOLD Commands, keywords, file names, authorization roles URLs, names of windows and dialogs, other controls, or other information that you must use literally is in bold.
Italics Variables and values that you must provide, new terms, and words and phrases that are emphasized are in italics.
This Guide uses the UNIX convention for specifying environment variables and directory notation:
When using the windows command line, replace $variable with %variable% for environment variables and replace each forward slash (/) with a backslash (\) in directory paths.
VI. Publications On-line
Publications in the product libraries are included in PDF on the product CD.
When GTV published an update version of one or more online or hardcopy publications, they are posted to the Sonork Information Center. You can access updated publications in the Sonork Information Center from the following Sonork Customer Support Web Site: http://www.sonork.com/eng/support.html
The Sonork Information Center contains the most recent version of the books in the product library in PDF or HTML formats, or both. Translated documents are also available for some publications.
VII. Ordering Publications
You can order many Sonork publications online at the following Web site.
http://www.sonork.com /sonork.html
In other countries, for a list of telephone numbers, see the following Web site:
http://www.sonork.com/eng/contact.html
VIII. Customer support
If you have a problem with any Sonork product, you can contact Sonork Customer Support. See the Sonork Customer Support Handbook at the following Web Site:
http://www.sonork.com/eng/support.html
Or visit
http://www.sonork.com
Server support
server-support@sonork.com
Client support
client-support@sonork.com
Developer support
developer@sonork.com
 | Overview of Installation
| |
After you have created your deployment plan as described in the Sonork Planning for Deployment Guide, you are ready to install Sonork IM on the machines in your distributed environment. The Sonork IM software that you install on these machines is known as your Sonork environment. If you already have Sonork software installed, you should follow your update deployment plan to perform the following:
1.1 Installing a Sonork Server
This chapter contains instructions for installing Sonork Server on a Windows operating System in your distributed environment.
For information about upgrading a Sonork Server, refer to “Upgrading Sonork Server”
1.2 Installing a Windows Sonork Server
To install a Sonork server on a Windows operating system, you need to perform the following steps:
Examine all the prerequisites (the hardware, the operating system software and the RDBMS)
Install the Sonork server as described in “Installing the Sonork Server in a Windows Operating System” section in this manual
If you plan to use the Sonork Configuration Utility in the same machine install it as described in “ Installing the Sonork Configuration Utility”, otherwise refer to “ Sonork Configuration Utility as remote console”.
Perform a backup
If you are upgrading your Sonork Server, you can refer to “Upgrading the Sonork Server in a Windows Operating System” section in this manual.
1.3 Considerations
Before installing a Sonork Server, consider the following:
The names of the client’s nodes must be in the LMHOSTS file (Windows), the Network Information Services (NIS) host map, or the name server (named).
All Sonork Administrators must have full access to the Sonork directories.
If you are using Dynamic Host Configuration Protocol (DHCP) on your Windows clients, the Sonork Server must have a static IP addresses.
If you want a Sonork Configuration Utility as a remote console, the system where you want to install could use DHCP.
If you are planning to use a RDBMS you can have the Sonork DB on a separate system, connecting it via ODBC, read the “Database engine/server” section in this manual. This RDBMS could be on a different platform supported by the RDBMS. Contact your RDBMS vendor of any prerequisite if you have question about its current support.
1.4 System Requirements
This section describes the operating system software and hardware requirements for Sonork Server.
Sonork Server has specific software and hardware prerequisites that must be met before it can be installed and considered functional. These requirements include operating systems, hardware platforms, and relational data base management systems. The prerequisites listed in this document are the recommended environment for Sonork Server at the time of publication.
> Many vendors unilaterally withdraw support for their products on a regular basis. GTV Solutions, Inc. reserves the right to unilaterally withdraw support for its software based on the availability of support from a vendor for any prerequisite software. Contact the vendor of any prerequisite software if you have questions about its current support.
1.4.1. Hardware
This section contains information about the supported hardware platforms supported.
The only platform supported is Intel based computer or compatible. The minimum CPU prerequisite is a 486 or better.
1.4.2. Operating System
This section contains information about the supported operating system versions for each supported hardware platform. Sonork does not distribute or maintain operating system patches from hardware vendors. Contact your hardware vendor for information about obtaining and installing the most current operating system patches.
Windows 95
Windows 98
Windows ME
Windows XP
Windows NT 3.51
Windows NT 4.0
Windows 2000
NOTE: If you plan to have 50 or more users connected concurrently, Windows NT 4.0 or Windows 2000 is recommended.
|
1.4.3. Network
This section contains information about the Network Protocols supported.
The machine that will run the server must be wired with TCP/IP (IPv4) to the LAN (Local Area Network) it will be serving. If you plan to allow Internet users connect to your server, it must also be connected to the Internet.
1.4.4. Database engine/server
This information is intended for database administrator and others responsible for installing and configuring the RDBMS. Refer to the database vendor documentation to understand the implication of these tasks and for complete instructions about performing these tasks.
The Sonork Server needs an ODBC complaint database engine/server to store its data.
Currently, the following products are supported:
MS-Access
MySQL
MS-SQL
Informix
Sybase Anywhere
NOTE: For all RDBMS, except for MS-Access, the database could be in one dedicated system independent where the Sonork Server runs. The RDBMS could be on a different platform supported by the RDBMS. Contact your RDBMS vendor of any prerequisite if you have question about its current support.
|
1.4.5. Memory (RAM)
This section provides information about the RAM needed by the Sonork Server.
The requirements depend on the amount of users that may connect concurrently:
Estimate 8MB for the Sonork Server program, plus 16MB per each 100 users. The basic 5-user server runs well on a 24MB Windows 98 machine.
Total Memory for Sonork Server = 8 + (16*ehU)
ehU = each 100 users (Example, less than 100, this variable value is 1, for 450 users, this variable value is 5)
For the RDBMS memory requirement refer to the database vendor documentation.
1.4.6. Storage Space (Hard drive space)
This section provides information about the storage space needed by Sonork Server.
The storage space needed for the application files is approx. 4MB.
To this space needed, you have to add the space occupied by the database you should plan to use.
To this you must add the space you want to reserve for the file repository where files exchanged between users are temporarily stored. The allocation depends on how large the files will be and how long they must remain until downloaded. The server deletes the files after they are downloaded or until a pre-configured amount of time has elapsed. The size of the repository may be limited using the server configuration utility, refers to “Administrator Guide”.
NOTE: Do not place files for Sonork Server on a remote file system or share Sonork Server files among systems in your environment. (unless specified)
|
 | Installing the Sonork Server in a Windows Operating System
| |
This section describes the options presented during the fresh installation process on Windows Operating System.
Once you run the installation program from a CD or your local hard disk you will see windows and dialog boxes. Those windows and dialog boxes step you through each phase of the installation setup process. This interface has a task-like design and lets you go backward and forward at any time. This interface is described as follow:
2.1 The welcome screen
| |
| Figure 2-1 Welcome window
|
This (Figure 2-1) is the first window that should appear once you execute the Sonork installation program.
You can click at the start button to start filling the information needed by the installer to start the installation process. See the next section ‘Choosing where and what to install’.
If you click at the exit button, you quit from this program and nothing is done on the system where you run the Sonork Installation program.
2.2 Choosing where and what to install
| |
| Figure 2-2 Where and what to install window
|
This dialog box (Figure 2-2) asks you where you want to install the product and what you want to install.
2.2.1. Where to Install
In this field you had to fill the complete path directory where you want to install the product. The path showed here is the default path suggested by the Sonork installation program.
This is the directory where the application and configuration files will be placed. It is referred to as the Installation folder or $SONORK
If you want to change this directory just click on the doted box, and find on the dialog box that will appears (Figure 2-3) where you want to install. Or just type the directory path you want to install to.
| |
| Figure 2-3 Browsing folders
|
On this dialog box (Figure 2-3) you can navigate and select on what directory will be the Installation Folder, once selected a directory click the OK button. The complete path should appear on what to install field at windows showed in Figure 2-2
2.2.2. What to install
Check the box on what to install to select the components you want to install.
NOTE: On one system you can install only the server, and on other system the Configuration utility to use it as a remote console.
|
2.3 Server address and ports
This dialog box (Figure 2-4) asks you the IP address that Sonork will, use the admin password and the ports to be used.
| |
| Figure 2-4 Server IP address and ports
|
2.3.1. Server Address
At Server address section you will see ‘Bind to’, ‘Export as’ and ‘Admin password’.
2.3.1.1. Bind to:
Complete the address of your server at ‘Bind to’. Default values will work. This must be your system IP address. You can leave blank the server will bind to the first IP it found.
2.3.1.2. Export as:
If you are going to use the Sonork server in your LAN only this field should be blank.
If you're going to allow Internet access to your server (Extranet support) you must set the 'export as' to a valid IP/DSN name (normally this IP should not be once of the RFC1918). This IP must be the IP address assigned to the Sonork server at the firewall configuration level if you will use Network Address Protocol (NAT). Ask your Firewall Administrator or the Network Administrator for this IP address.
2.3.1.3. Admin password
This is the main password to be used for Sonork Server administration access. Remember this password, DO NOT LOSE IT.
2.3.2. Ports
Choose the ports that the server will use for each channel. The main ports used for messaging (UDP/1503 – TCP/1504). The data channel is used for raw data (TCP/1505), such as file transfer. The text channel is used by text-based protocols such as HTTP (TCP/1506).
NOTE: If you are going to accept messages from clients out side your network those ports should be open as incoming at the firewall level, those ports are defaults value, and you can change it as your firewall configuration needs.
|
Once you complete this dialog click on next button.
2.4 The data folders
This dialog box (Figure 2-5) asks you the directory path of certain especial directories used by Sonork server.
2.4.1. Database and Scripts
The database scripts and the database file will be placed in this folder.
The database file will be copied only if you choose to use "Microsoft Access" or another file-based driver as your database engine.
You can change the location of this directory clicking on the ‘…’ button.
NOTE: If you will use a RDBMS Refer to the database vendor documentation to understand where and how they manage their own data folders.
|
2.4.2. Temporary files
Used by the Server to store temporary files. These files are normally small (less than 1MB) and are deleted as soon as the server does not need them.
You can change the location of this directory clicking on the ‘…’ button.
2.4.3. Client installer and configuration
A copy of the messenger/client installer (sonork-client-installer.exe) will be placed in this folder, along with a special "sonork.ini" file used by the client installer to determine the network settings of your server.
You can change the location of this directory clicking on the ‘…’ button.
NOTE: After installation ends, you can share this folder so that all users in your local network can access it to run the messenger installer.
|
2.4.4. File
repository
Folder where files exchanged between
users are temporarily stored: When a user sends a file to another, a copy of the
file will be placed here and deleted after it has been downloaded.
This repository should be on a disk with the sufficient
space you will use on your file transfers.
You can
change the location of this directory clicking on the ‘…’ button.
2.4.5. HTTP
published
Folder that the internal HTTP engine will
publish. The HTTP server is an optional component used to interact with web
browsers and publish Web Applications.
You can change
the location of this directory clicking on the ‘…’ button.
NOTE: The trial version has this feature off.
|
2.5 The ODBC
Data Source
This dialog box (Figure 2-6) ask you the
ODBC Data Source the will be used by Sonork server to store the server’s
data.
The installer can automatically create or use Microsoft
Access databases. It may also use existing ODBC data sources for other type of
RDBMS supported (refer to Database engine/server in this manual).
If you're installing Sonork for
the first time and choose "Access", the DSN will be created for you. If you
choose a non-Access data source, you must create the DSN using Window's "ODBC
Data sources" utility located in the Windows control panel.
If you choose to "Use existing/external ODBC Data Source",
the ODBC selector window will open (Figure 2-7), clicking on the "ODBC Admin"
will open Window's ODBC configuration utility.
|
|
|
Figure 2-7 Selecting external
ODBC data source
|
On the next step, the installer will
display information about the data source you selected under "This version's
ODBC Data Source" (Figure 2-8). If it does not exist, it will display "Will
create" otherwise it will display "Existing".
|
|
|
Figure 2-8 ODBC User and
Password
|
Complete the user and password needed
to log-on to the SQL server (which may be blank if you're creating an Access
DSN).
Under "Previous..." it will display the data
source used by the previous version. If you're installing Sonork for the first
time, these fields will be disabled.
You may choose not
to use the previous version's data by selecting "Ignore old data source": The
installer will not use the information from the previous version (it will
discard all existing users and configuration) and execute a clean
installation.
2.6 Server start up mode
This dialog box (Figure 2-9) asks you how the Sonork
server will start.
Choose how the servers should start:
2.6.1.
Manually
You must start the server using the icon in
Window's "Start" menu. Or calling the srksvr.exe from the Command Prompt. This
option should be used on Windows 95 and 98 Operating System.
2.6.2. Windows
Session
The server will automatically start once a
user logs on.
2.6.3. Service
Enabled only for Windows NT/2000. The server will
install itself as a service and execute in background. You must start and stop
it using the "Services" utility in the Windows control panel.
The additional options for this mode are:
2.6.3.1. Start
Automatically
The server will start automatically as
soon as Windows starts.
2.6.3.2. Service dependency
The server will wait for another service to start
before it does. If you're using an ODBC data source connected to an SQL Server,
make the server depend on the SQL service because Sonork Servers usually start
faster than SQL servers do.
Making it a dependant of
another service has another advantage: When you start the Sonork server, windows
will automatically start the services on which it depends.
2.7 Ready to
install
At this stage the installation program has
every thing it need to start the installation (Figure 2-10).
|
|
|
Figure 2-10 Ready to
install
|
In this dialog you have three check
box, those are:
2.7.1. Star Server after
installation completes
If you check this item, once
installation ends, the installation program will start the server.
2.7.2. Reset
Configuration
2.7.3. Run Client setup after
installation completes
If you check this item, once
the installation ends, the installation program will start the Sonork Client
Installation program.
2.8 Installation
On the next window (Figure 2-11) you will see what is
doing the installation program. If there surge an error, you will see the
messages in this window.
NOTE: If you have any problem with the
installation, copy/paste the messages appears on this windows and send to
your local system vendor or to the appropriate Sonork technical support
office
|
2.9 Installation Complete
Once you see the next Dialog (Figure 2-1) you have the
Sonork Server installed successfully.
Figure 2-12 Successful window
Just
click on the OK button. If you checked Run Client setup after installation
completes at Ready to install (Figure 2-10), the Sonork Client Installation will
start, if not the Sonork Server Installation program will exit.
At this point if you have a trial version you should use
the server up to 5 user, if you had purchased a License Key refer to Initial
Configuration of the Sonork Server
 |
Initial Configuration of the Sonork
Server
| |
This chapter describes how to use the
configuration utility for the initial configuration and set up services on a
system after a fresh installation.
The Server
Configuration Utility may be accessed from Windows “Start” menu or by pressing
the “Config” button on the server window.
Once you run
it you will see a window like Figure 3-1
|
|
Figure 3-1 Server Configuration Utility
|
The Configuration profiles represent a
Sonork Server instance. You must select one of the list and click on the connect
button in order to use the Server Configuration Utility.
Normally you will only have one profile named "default"
unless you administer several Sonork Server installations.
Select the profile and click "Connect". If the profile
cannot be open, a message will be displayed and you should click on "Edit" to
modify the settings that are wrong.
Note: Do not delete
the "default" profile
3.1 Server Profiles
Each server profile contains information about the
server folders and ODBC data source. Click on the "Edit" button to modify these
settings (Figure 3-2).
If the profile is checked as
"Remote installation", the configuration utility will ignore items that do not
exist on the local computer (such as folder directories) and use only the ODBC
data source.
If you're using a file-driven ODBC data
source (such as MS-Access), remote mode is not possible: Remote mode will only
work on client/server SQL systems
|
|
Figure 3-2 Server Profile
|
The "Host"
field should indicate the network address (name or IP) of the Sonork server and
is used by the Monitor when online functions (such as sending messages) are
required.
The purpose of each folder is explained under
The data folders
3.2 License
Displays the information about License key that the
installation is using. If you have the trial version up to 5 users can use the
Sonork Server.
3.2.1. Installing a new key
The first step to install a license key is to stop the
actual running server, then select the License option at the Server Menu and
click ‘Install new key’ to write on the new box the Activation Key (Figure 3-3),
once you had filled the Activation key click on the install button. If you
mistyped the license key you will see and error message box, just click the OK
button en retype again. If the license is valid, will show you the total amount
of concurrent users and a series of three windows messages warning you (Figure
3-4, Figure 3-5, Figure 3-6, refer to Activation Key Warning).
|
|
|
Figure 3-3 License Activation
Key
|
Note: The license key should never be
modified by directly accessing the Sonork database tables: It contains vital
configuration information, which is related to other tables. Doing so may leave
the installation in an inconsistent and unusable state.
3.2.2.
Activation Key Warning
When you install a Sonork
Server Trial the first time the user id prefix is 1000, once you install a valid
license key this user id prefix change to a number provided in the license
key.
GTV guarantee that this prefix is unique all over
the world.
When you change this prefix your whole user
id changes, this change is reflected in the database at the server side, but not
in your client.
Once you start the server again your
users will not be able to send any messages because they will have at their user
lists old user ids. They will have to delete all users and add them again.
|
|
|
Figure 3-4 Activation Key
Warning
|
The Sonork Configuration Utility will
notice you when is ready to migrate to the new prefix as shows in Figure 3-5.
|
|
|
Figure 3-5 Prefix
Migration
|
When the Migration process is complete,
the new Activation key is successfully installed (Figure 3-6). This window shows
you what is the new prefix.
Now you can delete the user
list at the client side, and start the server again. This changes in the client
side is a first time only process.
If you did not add
any user, you will not have to do anything.
|
|
|
Figure 3-6 Activation Key
Installed
|
 |
Upgrading the Sonork Server in a Windows
Operating System
| |
This section describes the options presented during the
upgrade installation process on Windows Operating System.
After you run the installation program you must stop the
Sonork Server.
Once you run the installation program
from a CD or your local hard disk you will see windows and dialog boxes. Those
windows and dialog boxes steps you through each phase of the installation setup
process. This interface has a task-like design and lets you go backward and
forward at any time. This interface is described as follow:
NOTE: Those steps are exactly the same as a fresh
installation, except for the Migration Option step (Figure 4-9), see
Migration options.
|
WARNING: Before the upgrading we recommend
to backup all of your files and data files, refer to the database vendor
documentation for this task.
|
4.1 The welcome screen
|
|
|
Figure 4-1 Welcome Window
|
This (Figure 4-1) is the first window
that should appear once you execute the Sonork installation program.
You can click at the start button to start filling the
information needed by the installer to start the upgrade installation process.
Once you click start the installer will detect the actual installed server and
will show a message box (Figure 4-2).
If you click at
the exit button, you quit from this program and nothing is done on the system
where you run the Sonork Installation program.
|
|
|
Figure 4-2 Upgrade warning
message
|
WARNING: This
messages box suggests that you do not have to change the installation
folders. The previous version of the server could have stored temporal
files (Example: a pending file transfer to a user) on those directories.
If you are using an ODBC SDN to an Access data files you must not change
the data folders, in case you are using other RDBMS this is not an issue
to be considered.
|
4.2 Choosing where and what to
install
|
|
|
Figure 4-3 Where and what to
install window
|
This dialog
box (Figure 4-3) ask you where you want to install the product and what you want
to install.
4.2.1. Where to Install
Is highly recommended that you DO NOT change the
Installation folder.
4.2.2. What to install
Check the box on What to install to select the
components you want to upgrade install.
NOTE: On one system you can upgrade only the
server, and on other system the Configuration utility to use it as a
remote console.
|
4.3 Server address and ports
This dialog box (Figure 4-4) asks you the IP address
that Sonork will, use the admin password and the ports to be used.
|
|
|
Figure 4-4 Server IP address
and ports
|
4.3.1. Server Address
At Server address section you will see ‘Bind to’,
‘Export as’ and ‘Admin password’.
4.3.1.1. Bind to:
Complete the address of your server at ‘Bind to’.
Default values will work. This must be your system IP address. You can leave it
blank, the server will bind to the first IP it found.
4.3.1.2. Export
as:
If you are going to use the Sonork server in
your LAN only this field should be blank.
If you're
going to allow Internet access to your server (Extranet support) you must set
the 'export as' to a valid IP/DSN name (normally this IP should not be once of
the RFC1918). This IP must be the IP address assigned to the Sonork server at
the firewall configuration level if you will use Network Address Protocol (NAT).
Ask your Firewall Administrator or the Network Administrator for this IP
address.
4.3.1.3. Admin password
This is the main password to be used for Sonork Server
administration access. Remember this password, DO NOT LOSE IT.
4.3.2. Ports
Choose the ports that the server will use for each
channel. The main ports used for messaging (UDP/1503 – TCP/1504). The data
channel is used for raw data (TCP/1505), such as file transfer. The text channel
is used by text-based protocols such as HTTP (TCP/1506).
NOTE: If you are going to accept messages from
clients out side your network those ports should be open as incoming at
the firewall level, those ports are defaults value, and you can change it
as your firewall configuration needs.
Once you
complete this dialog click on next button.
|
4.4 The data folders
This dialog box (Figure 4-5) asks you the directory
path of certain special directories used by Sonork server.
Is highly
recommended that you DO NOT change the Installation folder.
4.4.1. Database
and Scripts
The database scripts and the database
file will be placed in this folder.
NOTE: If you will
use a RDBMS Refer to the database vendor documentation to understand where and
how they manage their own data folders.
4.4.2. Temporary files
Used by the Server to store temporary files. These
files are normally small (less than 1MB) and are deleted as soon as the server
does not need them.
4.4.3. Client installer and
configuration
A copy of the messenger/client
installer (sonork-client-installer.exe) will be placed in this folder, along
with a special "sonork.ini" file used by the client installer to determine the
network settings of your server.
NOTE: After the upgrading installation ends, you
can share this folder so that all users in your local network can access
it to run the new version of the Sonork Client installer.
|
4.4.4. File repository
Folder where files exchanged between users are
temporarily stored: When a user sends a file to another, a copy of the file will
be placed here and deleted after it has been downloaded.
This repository should be on a disk with the sufficient
space you will use on your file transfers.
4.4.5. HTTP published
Folder that the internal HTTP engine will publish. The
HTTP server is an optional component used to interact with web browsers and
publish Web Applications.
NOTE: The trial version has this feature off.
|
4.5 The ODBC
Data Source
This dialog box (Figure 4-6) ask you the
ODBC Data Source the will be used by Sonork server to store the server’s
data.
|
|
|
Figure 4-6 ODBC System DSN
|
The installer can automatically create
or use Microsoft Access databases. It may also use existing ODBC data sources
for other type of RDBMS supported (refer to Database engine/server in this
manual).
If you're installing Sonork for the first time
and choose "Access", the DSN will be created for you. If you choose a non-Access
data source, you must create the DSN using Window's "ODBC Data sources" utility
located in the Windows control panel.
If you choose to "Use existing/external ODBC Data Source",
the ODBC selector window will open (Figure 4-7), clicking on the "ODBC Admin"
will open Window's ODBC configuration utility.
|
|
|
Figure 4-7 Selecting external
ODBC data source
|
On the next step, the installer will
display information about the data source you selected under "This version's
ODBC Data Source" (Figure 4-8). If it does not exist, it will display "Will
create" otherwise it will display "Existing".
|
|
|
Figure 4-8 ODBC User and
Password
|
Complete the user and password needed
to log-on to the SQL server (which may be blank if you're creating an Access
DSN).
Under "Previous..." it
will display the data source used by the previous version. If you're installing
Sonork for the first time, these fields will be disabled.
You may choose not to use the previous version's data by
selecting "Ignore old data source": The installer will not use the information
from the previous version (it will discard all existing users and configuration)
and execute a clean installation.
4.6 Migration options
This dialog box (Figure 4-9) asks you for the Migration
Options if you are upgrading your actual Sonork Server.
|
|
|
Figure 4-9 Migration
options
|
Select your Migration option.
(Depending on whether you're installing for the first time or not, some of these
options will be disabled).
4.6.1. New installation
The installer will ignore/delete all existing data. It
will create a new and clean database. This is the default option if you're
installing Sonork for the first time. You should NOT use this option if you're
upgrading an existing installation.
4.6.2. Upgrading
The installer will create the new database and migrate
all existing data to the new format. This is the default option if you're
upgrading the server from V1.4. Do not use this option if your current
installation is V1.5 or higher.
4.6.3. Partial
The installer will not create the new database but will
migrate existing data to the new format. This option should be selected if
you've created the database tables manually but have not migrated the data.
4.6.4.
Manual
The installer will not create the new
database and will not migrate existing data to the new format. This option
should be selected if you're re-installing or upgrading from V1.5 servers or if
you've manually created the database tables and migrated all data. The installer
expects to find configuration data already loaded in the DSN.
NOTE: When you click "Next", the program will
test the data source and will report any errors. If the data source is not
correctly configured, the tests may take longer than expected (approx. 1
minute) and the application may appear as "frozen". Please let the
application recover by itself.
|
4.7 Server start up mode
This dialog box (Figure 4-10) asks you to specify how
the Sonork server will start.
Choose how the servers should start:
4.7.1.
Manually
You must start the server using the icon in
Window's "Start" menu. Or calling the srksvr.exe from the Command Prompt. This
option should be used on Windows 95 and 98 Operating System.
4.7.2. Windows
Session
The server will automatically start once a
user logs on. This option should be used on Windows 95 and 98 Operating
System.
4.7.3. Service
Enabled only for Windows NT/2000. The server will
install itself as a service and execute in background. You must start and stop
it using the "Services" utility in the Windows control panel.
The additional options for this mode are:
4.7.3.1. Start
Automatically
The server will start automatically as
soon as Windows starts.
4.7.3.2. Service dependency
The server will wait for another service to start
before it does. If you're using an ODBC data source connected to an SQL Server,
make the server depend on the SQL service because Sonork Servers usually start
faster than SQL servers do.
Making it a dependant of
another service has another advantage: When you start the Sonork server, windows
will automatically start the services on which it depends.
4.8 Ready to
install
At this stage the installation program has
every thing it need to start the installation (Figure 4-11).
|
|
|
Figure 4-11 Ready to
install
|
In this dialog you have three check
boxes, those are:
4.8.1. Star Server after
installation completes
If you check this item, once
installation ends, the installation program will start the server.
4.8.2. Reset
Configuration
4.8.3. Run Client setup after
installation completes
If you check this item, once
the installation ends, the installation program will start the Sonork Client
Installation program.
4.9 Installation
On the next window (Figure 4-12) you will see what is
doing the installation program. If there surge an error, you will see the
messages in this window.
NOTE: If you have any problem with the
installation, copy/paste the messages appears on this windows and send to
your local system vendor or to the appropriate Sonork technical support
office
|
4.10 Installation Complete
Once you see the next Dialog (Figure 4-13) you have
installed the Sonork Server successfully.
|
|
|
Figure 4-13 Successful
window
|
Just click
on the OK button. If you checked Run Client setup after installation completes
at Ready to install (Figure 4-11), the Sonork Client Installation will start, if
not, the Sonork Server Installation program will exit.
Once the server is started you do not need any additional
configuration step.
 |
Installing the Sonork Client in a Windows
Operating System
| |
This section explains how to install
and configure the Sonork Client in a Windows Operating System.
Once you have installed or updated the Sonork Server, the
installer program places a copy of the client install program
(Sonork-client-installer.exe) in $SONORK/client folder you selected during the
installation. It also creates a special configuration file named Sonork.ini in
the same directory that contains the all data needed by client to connect up to
the server.
The latest version
of the client installer may also be downloaded at any time from
http://www.sonork.com/downloads/. This client is free of charge.
5.1 Running the
installation program.
Once you copy the
Sonork-client-installer.exe, to the desktop you want to install, say downloading
from internet, copying it from the folder you share at the server, or just
running from the folder you share.
When you execute the program you will see the next
window
|
|
|
Figure 5-1 Client Installer
Welcome Window
|
On these
windows you can select the language you want to install and the installation
folder. For the client we will name this root folder $SONORKCLNT.
Once you decide where you will put the client program you
can click on next button to continue.
If you click exit
the programs will quit and nothing will be installed.
5.2 Private
net/Extranet support
When prompted, check the
"Install Sonork for private networks" option and the installer will ask you for
the location of your configuration file: It is asking for the path to the
"sonork.ini" file mentioned above. (If you run the installer from the "client"
folder, setup will auto-detect the file)
|
|
|
Figure 5-2 Network Types
Window
|
If you are
going to connect to a public service, like server.Sonork.com, you must uncheck
the “install support for private networks (Intranet)”.
If you are going to connect to a corporate server (a
private one) this check box must be marked. If this is marked you must provide
the Sonork.ini configuration file mentioned in Client installer and
configuration.
5.2.1. Client startup mode
Once installed, the Sonork messenger will ask if it
must start in "Intranet (Private)" or "Internet (Public)" mode.
5.2.1.1.
Private (Intranet/Extranet) mode
In this mode,
Sonork will connect to the server specified in the "sonork.ini" file used during
installation. This should be the address of your server (See Network
configuration)
When in private mode, the messenger can
only connect to private servers.
NOTE: The server does not need to be in the same
network; you may connect over the Internet. For example: You can connect
to your company's Sonork Server from your house, using a dial-up
connection.
|
5.2.1.2. Internet (Public) mode
In this mode Sonork will connect to the Public Sonork
Server run by the Sonork Company located at "server.sonork.com".
When in "public" mode, the messenger will not be able to
connect to any other server, even if you change Sonork's network
configuration.
NOTE: You may disable this mode while installing
by clicking on the "Advanced" button or by configuring your firewall to
block connections to "server.sonork.com", ports 1503 and 1504.
|
5.3 Start
Options
The next window you will see (Figure 5-3)
you can select if you want to the Sonork client will start when you start a
windows session. The installer will put on your desktop a shortcut if you check
“Create Desktop shortcut”
5.3.1. Advanced Start Options
The "Advanced" button will show you Figure 5-4 and lets
you enable/disable:
If you whish to place the data
folder separate from the application folders, click on the "Advanced" button. It
will allow you to specify the folder where the temporary and data files will be
placed.
You may specify the same folders for all users,
Sonork names its files in such way the profiles don't mix even when the data
folder is the same for all users and profiles.
5.3.1.1. Disable “ini”
configuration file selection
Use this advanced
option if you want the user not to be able to select a different Sonork.ini
configuration file.
5.3.1.2. Disable “Internet” mode
Use this advanced option if you want the user not to be
able to connect to GTV Solutions, Inc. public server in the Internet.
5.3.1.3. Start
with windows, Override user preference
Use this
advanced option if you want the Sonork client to start when the user’s windows
session starts.
5.3.1.4. Skip copy of shared
files
Use this advanced option if you have installed
the application on a network-shared folder and you are making this installation
to point to that folder.
|
|
|
Figure 5-4 Start Options,
Advanced
|
Now you just
can click over the install button to start the installation process.
5.4 Client's
account/profile
Once the Sonork messenger has
started, it will ask for a user profile.
A profile is a
copy of a Sonork user account stored on the server: This means that the account
must exist on the server before it exists in the client.
Sonork allows you to create new
accounts from the messenger itself (unless the server administrator disables
this function using the configuration utility).
If Sonork finds profiles in the local computer (for
example, after re-installing), it will list them so that you can choose one. If
your account is listed, select it and choose "Accept". If none of them apply,
click on the "Add" button and proceed to the "Create/Recover profile" step (next
section).
If Sonork does not
find any profiles (for example, after installing for the first time), it will
automatically jump to the "Create/Recover profile " step (next section).
|
|
|
Figure 5-5 Profiles Window
|
5.4.1. Create/Recover profile
|
|
|
Figure 5-5 Profiles Window
|
Figure 5-6 Add
Profile Window
5.4.1.1. Create user
Will create a new account on the server and then create
the corresponding profile on the client.
5.4.1.2. Recover user
Will create a profile on the client based on an
existing account on the server. Allows you to search for an account by user id,
alias, name or email.
5.4.1.3. Use file
Will create a profile on the client based on the
configuration file of an existing account on the server. The server
administrator should have provided the user configuration file (or URL).
5.5 Network
configuration
To check the network configuration,
select "Configure Network" from the Messenger's Main menu.
The "Host"
item under "Sonork" should be the name or IP-number of the machine where the
server is running and the Ports should match the server's configuration.
Make sure the "Socks" is not
enabled unless you have a firewall in between the computer running the client
and the machine running the servers.
5.6 The Client
configuration file
The server installer creates the
"sonork.ini" configuration file and places a copy of the client set up program
(sonork-client-installer.exe) in the "client" folder selected during
installation.
If you choose to install "private mode",
the path to this file must be provided.
The "sonork.ini" file contains the following lines:
[SonorkSetup]
Version=1508
[Servers]
Default=1
[Server.Default]
Host=myserver
TcpPort=1504
UdpPort=1503
After the server installation
ends, we recommended you open this file with notepad or any plain text editor
and verify that the host entry points to the name or IP-address of the machine
running the Sonork Main Server.
A good practice is to
share the "client" folder as read-only because:
All users can install the client directly without having to
copy both configuration and installer files to their computers.
The server configuration utility automatically updates the
"sonork.ini" file if you change the server's settings.
5.6.1.
Difference with previous versions
In previous
versions, the messenger read this file every time it started. As from Version
1.5, the configuration file is used only during installation.
Appendix
Server Installation Log
File
Installation log files may provide valuable
information for troubleshooting problems. This appendix contains the following
information:
A sample of installation log file
Reviewing Installation Log
Files
The installation log files contain useful
information about problems that may have occurred during the installation
process, and they should be examined for errors after the installation
completes. All log files are located in the $SONORK directory. The file is
$SONORK/setup.log.
Read this file and search for any
problem you have, if you do not solve the problem send this file to your local
Sonork provider or to the Sonork support team, refer to Customer support at the
beginning of this manual.
Example of a Server
Installation log file
+ Building new data scheme
Connecting to 'Sonork-default'..
Connected.
No migration selected,
skipping
+ Configuring database..
- Preparing security records
-
Loading Data Server user
- Loading initial
configuration
+ Database ready
+
Copying files..
- Preparing root folder
- Messaging Components
Copying
Messaging Server
Creating database and scripts folder
Copying database and scripts
Creating temporary folder
Creating
HTTP publish folder
Creating File repository
Copying Messenger installer
-
Copying help files
- Configuring components
Creating profiles folders
Copying
configuration utility
Copy complete
+ Creating profile
- Creating
configuration profile
- Creating configuration file
Profile created
+ Configuring
startup
Startup configured
+
Creating icons
+ Starting Server
C:\Program Files\SonorkServer\srksvr.exe
Started ok!
+ Installation
COMPLETE!
--------- DON'T READ ------------
SILENT SERVER
The server is a
silent application, you will
only see an icon on the
tray bar, next to the
clock, showing its status. Use the
configuration
utility to set the options. (Nothing
can
be changed from the server window itself).
UNINSTALLING
A proper uninstaller
and a setup log file
have been placed in the
installation folder.
GETTING HELP
At http://www.sonork.com you will find the
FAQ and solution to common problems. In
most cases you will quickly find the
solution there, if not: support@sonork.com.
THANK YOU!
Your Sonork Team
(Ok then, read it)
Trouble shooting the client
Connection
Problems
99% of the times, connection problems are
encountered because:
The Sonork server is not running
The Messenger is not in "Private"
mode,
The network configuration is wrong.
Please go over the steps under "Network configuration" and
if everything is correct, but you still can't connect, try these two tests:
PING
PING is a TCP/IP utility that is installed by Windows
when you add TCP/IP as one of the network protocols. From the command prompt,
run:
PING name
Where name is the
name of the machine running the Sonork Server (exactly as it appears in the
messenger's network configuration).
If there is no reply
or the command returns an error such as "invalid IP number" or "network
unreachable", the name is incorrect or unreachable. If you are SURE that the
name is correct but PING fails, try
PING IP-number
This last command must work, if not: Either IP-number is
incorrect or the two computers are not connected with TCP/IP.
If "PING" is successful (returns "reply from IP-number")
but Sonork still does not connect, it means that the Ports don't match the
server's configuration. Please check which ports have been assigned to the
server.
Connecting by IP
If the Messenger is able to connect using the IP-number,
but not the name, there is a name resolution problem in your windows network
configuration: Please refer to the Windows help for further assistance.
Sonork will work fine with IP numbers, but in some networks
(using, for example DHCP), the IPs change every time the computer is started, so
this method is not an option.
Startup failure
Only starts with administrator account
In some cases (mainly on Windows 2000), the client may not
start with a normal account, but it will with an account with administrator
privileges.
This happens because installation is
normally done with an administrator account and when the Sonork folders and
files are created, they belong to the administrator and are inaccessible to
normal accounts.
To fix the
problem, log on with an administrator account and fix the permissions on all
folders and files (including the temporary folder) so that all users can access
it. (You can access the permissions from the folder/file's "Properties")
Users must be able to both read and write to the DATA and
TEMPORARY folders. The folder where the executables reside needs only READ
permissions.
