Kerio WebStar 1.0 Installation Guide

Add to my manuals
28 Pages

advertisement

Kerio WebStar 1.0 Installation Guide | Manualzz

Installation Guide

Kerio Technologies

C

1997-2006 Kerio Technologies. All rights reserved.

Release Date: June 12, 2006

This guide provides detailed description on Kerio WebSTAR 5, version 5.4. Any additional modifications and up-dates reserved.

For current product version, check http://www.kerio.com/

.

Contents

1

2

3

6

7

8

4

5

Installing Kerio WebSTAR 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.1

Server Machine Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.2

Client Machine Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

New installs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.1

Running the Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3.2

3.3

3.4

3.5

Server Suite Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Checking that the Installation was Successful

Entering Your Serial Number

Publishing your Web Site

. . . . . . . . . . . . . . . . . . . . . . . 13

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Resetting Web Server File Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

Upgrading from 4D WebSTAR 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24

Upgrading from 4D WebSTAR 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

Custom Install Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

Running the Kerio WebSTAR 5 from Log In or Startup . . . . . . . . . . . . . . . . . . .

28

3

Chapter 1

Installing Kerio WebSTAR 5

The Kerio WebSTAR 5 consists of a group of servers, plug-ins, and utility applications.

Your Kerio WebSTAR 5 Installer installs everything you need in a master folder called

KerioWebSTAR in your Mac OS X Applications folder. This is the default location and you should not try to move it to another location on your hard disk.

The installer automatically manages Mac OS X permissions issues so that your web server will run on port 80 (the default port for web service). It also sets up default values for both your web and mail servers, making it easy to get both services up and running quickly.

4

Chapter 2

System Requirements

You can use one or more computers to administer and run Kerio WebSTAR 5. The computer you use to run the servers is referred to as the server machine. The server machine must be a Macintosh that runs Mac OS X. You install the product onto the server machine.

The user interface to the server suite is provided by a separate application called the

Admin Client . The Admin Client application can be run on the server machine or any

Mac OS X or Windows computer that is connected via a TCP/IP connection to the server machine.

A computer you use to run the Admin Client application is referred to as the client machine . The installer places copies of the Mac OS X and Windows Admin Client applications in the KerioWebSTAR folder.

You can use more than one computer as client machines and two or more client machines can connect simultaneously.

2.1 Server Machine Requirements

The server machine must be a Macintosh that is capable of running Mac OS X. A

Macintosh that uses a G4 processor is recommended for optimal performance. Multiple processors are fully supported.

• Mac OS X 10.0.3 or later (10.1.2 or later is recommended).

• At least 128MB of RAM (256MB or more recommended).

• At least 130MB of free hard disk space for Kerio WebSTAR.

A permanent high-speed TCP/IP connection to the internet. A DSL connection or faster is recommended.

5

Chapter 2 System Requirements

In a production environment, make sure that your Energy Saver sleep settings are set to

Never. If the machine goes to sleep and then is reactivated, you may need to quit and relaunch Kerio WebSTAR since networking must be reinitialized.

2.2 Client Machine Requirements

The Macintosh version of the Admin Client application requires Mac OS X version 10.0.3

or later; the Windows version requires Windows 95 or later.

The Admin Client application is written in Java; therefore it requires the Java runtime environment. This is included by default with Mac OS X; for Windows, you may need to install it yourself. It is available at: http://java.sun.com/products/jdk/1.2/jre/download-windows.html.

If you want to run the Admin Client application from another computer, simply copy the appropriate version to the other computer after installation.

6

Chapter 3

New installs

Before you install Kerio WebSTAR 5, you should check to see that other network processes that may conflict with the web server are disabled. During the install process, the installer runs a script that configures the web server to run under a special user called webstar. You must create this user before running the installer application. Also, you log in as the webstar user when you want to use the Finder to add documents that the web server must have access to, such as .html files that are part of your web site.

If the server machine is dedicated to running Kerio WebSTAR, you can leave it running under the special webstar user all the time. If you need to perform tasks that require admin privileges, you must switch to an admin-level user to perform those tasks.

1.

Open the Sharing panel in Mac OS X System Preferences and verify that Web Sharing and FTP access are turned off.

Under Mac OS X 10.1.x, these two options should look like this:

The Internet tab also has a setting for web sharing. It should also be Off .

7

Chapter 3 New installs

Figure 3.1

Sharing

2.

Open the Accounts panel in Mac OS X System Preferences.

3.

Click the New User button in Mac OS X 10.2 or the plus sign (+) button in Mac OS X

10.3 and create a new user with a Name of webstar and a Short Name of webstar.

Enter a password of your choice. Do NOT click the Allow user to administer this

machine checkbox.

Giving the webstar user admin privileges creates a potential security risk, so it is

NOT recommended.

Under Mac OS X 10.2, the user creation options are presented in a dialog box that looks like this:

If you are using Mac OS X 10.2, do not select the option, Allow user to log in from

Windows.

Click OK to complete the creation of the new user.

8

Figure 3.2

Adding new user webstar on Mac OS X 10.2

Under Mac OS X 10.3, the user creation settings should look like this:

The Allow user to administer this computer checkbox is located under the Security

tab, and should remain off .

9

Chapter 3 New installs

Figure 3.3

Adding new user webstar on Mac OS X 10.3

4.

To verify that Mac OS X successfully created the new account, close and reopen

System Preferences, and check the Accounts panel again.

If you used the default options when you installed Mac OS X and haven’t modified the

Accounts panel settings, the current user should have admin privileges.

If you do not have at least one Mac OS X user with admin privileges, use the Accounts panel in Mac OS X System Preferences and create a user with admin privileges. This should not be the webstar user.

3.1

Running the Installer

When your server machine is properly configured, you are ready to install Kerio

WebSTAR 5.

Note: If you are upgrading from an earlier version of WebSTAR, please see the sections

5

or

6 .

1.

Insert the CD or open the download package folder and double-click the Kerio

WebSTAR 5 Installer icon.

2.

When you see the Authenticate dialog box, enter a valid admin-level username and password and click OK.

10

Figure 3.4

Kerio WebSTAR 5 Installer icon

3.1 Running the Installer

Figure 3.5

Authenticate

3.

When the Installation dialog appears, choose the Easy Install option to install the complete server suite. Click Install to begin the process.

Figure 3.6

Kerio WebSTAR Installer

11

Chapter 3 New installs

The installer places all the Kerio WebSTAR 5 files in the KerioWebSTAR folder in your main Applications folder on the boot disk.

When the installer has finished, your KerioWebSTAR folder should look something like this:

Figure 3.7

Kerio WebSTAR folder

3.2

Server Suite Overview

Kerio WebSTAR 5 actually consists of a group of utilities, plug-ins, and applications that work together.

• The web and mail servers, WSWebServer , WSSMTPServer , and WSMailboxServer actually run in the background and have no user interfaces. You start the server suite by double-clicking the Kerio WebSTAR Launcher application. When you start the

Launcher, it automatically starts all the installed servers and plug-ins.

• The Admin Client application provides the user interface to the server suite. It can be run from either the Server machine or other Java-enabled Windows or Mac OS X machines on your network. The AdminClient folder contains copies of both the Mac

OS X and Windows versions of the Admin Client application. You can run the Mac OS

X version from its default location or copy it to another Macintosh computer on your network.

12

3.3 Checking that the Installation was Successful

• To run the Admin Client from the server machine, choose Launch Admin Client from the launcher File menu.

• The Admin Server application manages communication between the Admin Client and the servers. It is located in the AdminServer folder. It runs automatically when you double-click Kerio WebSTAR Launcher.

• The Monitor application enables you to monitor server activity from the server machine without using the Admin Client. It is located in the Monitor folder. You can run this application by choosing Launch Monitor from the Kerio WebSTAR Launcher

File menu. You can also monitor server activity from the Admin Client’s Windows menu. The Monitor application is optional and is only for use on the server machine.

3.3

Checking that the Installation was Successful

To check that Kerio WebSTAR 5 has been installed and configured properly, you should launch it and use Apple’s Process Viewer utility (Mac OS X 10.2) or Activity Monitor utility

(Mac OS X 10.3) to check that it is running as expected.

1.

Double-click the Kerio WebSTAR Launcher application.

The Launcher starts the web and mail servers as background processes and displays a window indicating that it is running.

Figure 3.8

Kerio WebSTAR Launcher

13

Chapter 3 New installs

The Kerio WebSTAR 5 is really a group of applications, servers, and plug-ins. It isn’t just one application. The Launcher window displays diagnostic information about the various components of the suite that were launched when you double-clicked the Launcher application. For example, the list of plug-ins that appears last (shown above) shows the web server plug-ins that are running.

You can hide the Launcher’s diagnostic informationpanel by clicking its green minimize button in its title bar. To redisplay the diagnostic information, click the green button again.

Note: The Launcher application may also start the Monitor utility, but you can’t log into the Monitor until you have created an admin user using the Admin Client application. Since you haven’t done this, close the Monitor login dialog box.

2.

Double-click the Process Viewer utility (Mac OS X 10.2) or the Activity Monitor utility

(Mac OS X 10.3). You can find this application in the /Applications/Utilities folder.

If the web server has been configured correctly, the process WSWeb- Server should be running under the webstar user.

You should also see two WSAdminServer processes, and the CGI Server (assuming the CGI plug-in is installed).

If not, you need to be sure that you have created the special webstar user as described in the chapter

3 .

14

3.3 Checking that the Installation was Successful

Figure 3.9

Process listing

3.

When you see this, you can open a web browser on the server machine and enter a

URL for the machine (e.g., http://localhost/).

You should see the default site in your web browser, as shown below.

Until you enter your registration information, Kerio WebSTAR 5 will run in two-hour demo mode. This is enough time to become familiar with the design of the server suite.

15

Chapter 3 New installs

Figure 3.10

Default site

3.4

Entering Your Serial Number

When you are ready to register your product, you need to locate the registration information found in your Kerio WebSTAR 5 package. Follow these instructions to obtain your serial number. You enter your serial number into a panel in the Admin Client application.

1.

With the Launcher running, choose Launch Admin Client from the launcher File menu.

In a few seconds, the Admin Client Connect dialog box appears. This is the dialog

16

3.4 Entering Your Serial Number box you use to connect to the Admin Server and administer all aspects of the server suite.

Figure 3.11

Connect

Warning: Your first Admin Client connection must be from the server machine, with

127.0.0.1

in the Server field of the Connect dialog.

2.

Enter 127.0.0.1 in the Server area (if it is not already entered for you) and leave

9494 in the Port area.

The first user name and password that you enter in the Connect dialog box will be used as the master username and password. The password should be a nonsense string that is unique and secure (e.g. Edw45Xpq — not the name of a person, place, or thing).

After you set the master username and password in this manner, you can connect to the server suite from the server computer by entering localhost in the Server area instead of 127.0.0.1.

3.

Choose a username and password for yourself and enter it into the entry areas.

The Connect dialog should look like this:

17

Chapter 3 New installs

Figure 3.12

Connect

4.

Click Connect to access the server suite.

In a few moments, the Settings Groups dialog box appears.

Figure 3.13

Settings groups

5.

Highlight DefaultSite and click Select.

This selection gives you access to the settings for the default web site you just viewed in your browser.

In a moment, the Admin Client window appears.

6.

In the browser area on the left, locate the Admin Server topic and highlight the

Licenses item.

18

3.4 Entering Your Serial Number

The following screen appears in the main panel area.

Figure 3.14

Server Licenses

You need to enter your serial number in the Server Licenses area at the top portion of the screen.

7.

Follow the instructions for entering your serial number and click the Save button.

Warning: To exit demo-mode after entering your serial number, you must quit Kerio

WebSTAR 5.

To quit the server suite:

1.

Choose Disconnect from the Admin Client’s File menu to close the Admin Client’s connection to the server suite.

2.

Click on the Kerio WebSTAR Launcher window and choose Quit Kerio WebSTAR

Launcher from the Kerio WebSTAR Launcher menu.

This shuts down the server suite itself. If you still have your Process Viewer or Ac-

tivity Monitor window open, you can observe the server suite processes terminating.

19

Chapter 3 New installs

3.5

Publishing your Web Site

In Kerio WebSTAR 5, the convention is that all the files that make up a web site are placed inside a folder within the WebServer folder, at the same level as the WSWebServer application. The installer creates a “placeholder” web site folder called DefaultSite. This is the web site whose home page you displayed when you first tested the web server.

You can publish your site simply by placing the documents that make up your site in this folder and replacing the default home page, index.html, with your home page.

Here is the DefaultSite folder:

Figure 3.15

DefaultSite folder

The index.html file is the home page and the examples and images folders contain documents that are used by the default site. (The other index files are for other languages; if you need to run a multilingual web site, Kerio WebSTAR enables you to serve pages in the correct languages automatically. For more information, see the section on the

Localization panel in the Technical Reference).

Whenever you modify the contents of the WebServer folder (or any folder that the web server must have access to), you should log into the server machine as the webstar user.

This ensures that Kerio WebSTAR 5 will have the proper file permissions.

20

3.5 Publishing your Web Site

To log in as the webstar user:

1.

If you are not currently logged in as the webstar user, choose Log Out from the Mac

OS X Apple menu.

2.

When prompted to log in, enter webstar as the username and enter the webstar user’s password.

3.

When the Mac OS X desktop appears, open the WebServer folder, which is in the

KerioWebSTAR folder in your main Applications folder.

To replace the DefaultSite with your own site:

1.

Open the DefaultSite folder, delete the index.html document and replace it with your home page. If your home page isn’t already named index.html give it this name.

2.

Place all the remaining files that make up your site inside the DefaultSite folder.

The errors folder contains default error .html files. You can use these error message files “as is” or replace them with your own. Any error files (e.g. error.html, noaccess.html

) should be renamed using the error number (e.g. 404.html for File not

found, 403.html for Access forbidden, 401.html for Authentication required, etc.).

Kerio WebSTAR 5 is preconfigured to serve the web site in the DefaultSite folder. You can add other folders/web sites to the WebServer folder and publish them, but you will need to use the Admin Client application to tell Kerio WebSTAR about folders other than

DefaultSite.

If you need to do other tasks on the server machine that require admin privileges, you need to log out and then log in as an Admin user. However, if you are using this computer only as your web server, it is more convenient to stay logged in as the special webstar user. In this manner, you can freely make changes to the contents of the WebServer folder without worrying about whether the files have the correct access privileges.

21

Chapter 4

Resetting Web Server File Permissions

If you inadvertently make changes to the WebServer folder via the Finder while you are not logged in as the special webstar user, and this results in permissions problems, you can use a custom install option to reset file permissions.

The installer includes an option that you can use to “clean up” file permissions in the

WebServer folder. The Configure File Permissions custom install option ensures that

WebSTAR will have read and write permissions for all files within the KerioWebSTAR folder, including new folders and files created since the initial install.

Warning:

This custom install option will not affect folder and files outside the

KerioWebSTAR folder. If you need to correct permissions on a web site stored outside the KerioWebSTAR folder, for example, you can use the Finder’s Get Info dialog to change the ownership of the folder and all enclosed items.

1.

Double-click the Kerio WebSTAR 5 Installer application.

When prompted, enter the user name and password of a Mac OS X admin-level user.

2.

When it displays the Install screen, choose Custom Install from the pop-up menu and then check the Configure File Permissions option on the Custom Install screen.

Figure 4.1

Kerio WebSTAR 5 Installer

22

3.

Click Install to run the Configure File Permissions option.

When it is finished, the installer will display the following Alert box, indicating that file permissions have been properly set.

Figure 4.2

Alert box

You may also see a dialog box that says that no installation was necessary. This is normal. Click OK to dismiss the dialog box.

4.

Click OK to put away the Alert and quit the installer.

23

Chapter 5

Upgrading from 4D WebSTAR 5

To upgrade from a previous version of 4D WebSTAR 5.x:

1.

Back up all 4D WebSTAR 5.x folders and files. You can make a copy of the 4DWeb-

STAR folder using the Finder (hold down the Option key and drag the folder to a backup location).

When you do this, there may be some warning about being able to copy some files.

You can ignore these warnings since the files in question are only the root-owned executables which you can reinstall after a restore. All of your preferences and data should be copied successfully. You should also back up any web site and mail storage folders located outside the 4DWebSTAR folder.

2.

If you have any files (e.g. CGIs) with custom ownership settings (i.e., files are not owned by the special webstar user), temporarily lock them via the Finder’s Get Info dialog box (select the file in the Finder and press Command-I).

3.

Launch the Kerio WebSTAR 5 Installer. When prompted, enter the user name and password of a Mac OS X admin-level user.

4.

Run the Easy Install option.

The installer will upgrade the existing 4DWebSTAR folder in Applications. None of your settings or web content will be overwritten.

5.

Quit the installer.

6.

Use the Finder to unlock any files locked in step 2.

7.

Launch Kerio WebSTAR 5 as you normally would (from the Launcher or from

Startup).

8.

Log in with the Admin Client and select the Installed Components panel in the Admin

Server group and confirm that all components have been upgraded.

9.

Test all services (e.g the web server) with appropriate clients (e.g., a web browser) to confirm that they are working properly.

24

Note: Kerio WebSTAR 5 does not include an email server component. If you were using your older version of 4D WebSTAR to host email, you will need to install another email server, such as Kerio MailServer, separately. More information on Kerio MailServer is available at www.kerio.com/kms_home.html

.

25

Chapter 6

Upgrading from 4D WebSTAR 4

For complete details on upgrading from 4D WebSTAR Server Suite 4, please see the About

Kerio WebSTAR 5 read me file, usually located in the same folder as the Kerio WebSTAR

5 installer.

Note: Kerio WebSTAR 5 does not include an email server component. If you were using your older version of 4D WebSTAR to host email, you will need to install another email server, such as Kerio MailServer, separately. More information on Kerio MailServer is available at www.kerio.com/kms_home.html

.

26

Chapter 7

Custom Install Options

The Custom Install screen contains the following options:

Kerio WebSTAR Admin Client — Installs the AdminClient folder. This folder is included as part of the Easy Installation. Therefore, there is no reason to run this option on the server machine unless you inadvertently trashed or corrupted the Ad-

minClient folder. You can use this option to install a copy of the Admin Client on a client machine. You can have several client machines and Kerio WebSTAR 5 supports multiple simultaneous connections to Admin Clients.

Developer Resources — Installs the Kerio WebSTAR SDK and the GUI Editor for the benefit of developers who wish to write plug-ins for Kerio WebSTAR 5. The GUI

Editor enables developers to develop their own interfaces for their plug-ins which will integrate seamlessly with the Admin Client. A panel created with the GUI Editor will display in the Admin Client just like a panel that is shipped with Kerio WebSTAR

5.

Documentation — Installs this Installation Guide, the User’s Guide, and the Technical

Reference. These files are in .pdf form and are installed in the Documentation folder in the KerioWebstar folder. They are installed automatically if you use the Easy Install option.

Create Startup Item — Creates a Mac OS X startup item which automatically launches

Kerio WebSTAR 5 when the computer is started. You would use this if the server machine is used as a dedicated web server and you need to have it running whenever the computer is on. Kerio WebSTAR 5 must be installed correctly in the Applications folder before running this option.

Remove Startup Item — Removes the Kerio WebSTAR 5 startup item that is installed by the previous option. When the startup item is removed, you must use the Kerio

WebSTAR Launcher utility to start the server suite.

Configure File Permissions — Runs a script that gives Kerio WebSTAR 5 read/write file permissions for all files in the master KerioWebSTAR folder. Run this option when you add files (such as .html and image files for a web site) when you are not logged in as the webstar user that you created in the installation process. This option does not actually install additional files.

27

Chapter 8

Running the Kerio WebSTAR 5 from Log In or

Startup

When you are ready to use Kerio WebSTAR 5 in a production environment, you may want to have it launch automatically.

If you wish to run Kerio WebSTAR 5 from Mac OS X Log In, and add the Kerio WebSTAR

Launcher application to the Login or Startup items for a specific user (preferably the

“webstar” user). In Mac OS X 10.2, this is done via Login Items in System Preferences while logged in as the appropriate user. In Mac OS X 10.3, this is done via Accounts in

System Preferences. Make sure that automatic log in is enabled for the appropriate user.

If, on the other hand, you wish to run Kerio WebSTAR 5 from Startup as a background process, run the Create Startup Item custom install option described above.

Warnings:

If you run Kerio WebSTAR 5 from Startup, it will run in the background with no interface. However, you can use the Kerio WebSTAR Admin Client and Monitor applications to view the server’s activity.

You should never configure Kerio WebSTAR 5 to run from both Log In and Startup.

28

advertisement

Was this manual useful for you? Yes No
Thank you for your participation!

* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project

Related manuals

Download PDF

advertisement