IBM Lotus Foundations Branch Office

Administration Guide



Note

Before using this information and the product it supports, read the information in Notices.

This edition applies to version 1.1, release 1 of IBM Lotus Foundations (product number 5724-V16) and to all subsequent releases and modifications until otherwise indicated in new editions.

Copyright International Business Machines Corporation 2009. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

Chapter 1. Lotus Foundations Branch Office Administration Guide
Introduction
Configuring Lotus Foundations
What is WebConfig?
Accessing WebConfig
Configuring TCP/IP on your workstation
System status screen
Notices box
System status details
Take a snapshot
License information
Software update
Activation keys
Entering activation key to exit trial mode
Updating your activation key
Configuring Lotus Foundations Branch Office non-Domino settings
Changing the Lotus Foundations server host name and Internet domain name
Starting and stopping Lotus Foundations Branch Office
Uninstalling Lotus Foundations Branch Office
User & Team management
Introduction to users and teams
User accounts
Team accounts
Password policy
Disk quotas
Disk management
Disk configuration (idb and RAID)
Reconfiguring your disks
Disk status messages
Recovering from a backup disk failure
Recovering from a main hard disk failure
Installing a new hard drive
Backup & restore
Intelligent disk backup (idb)
Configuring idb
idb backup
idb restoration
Lotus Domino restoration procedures
idb hot swap
Networking
First-time Lotus Foundations setup on a Lotus Foundations Appliance
Configuring Lotus Foundations network settings
DoubleVision
Virtual private networks
IPsec
Remote access services
Workstation viewer
Domain Name Service
Fast/Port Forward
Firewall services
Client application add-ons
Lotus Notes
Lotus Symphony
Server applications and extensions
Lotus Foundations Run feature
MySQL server
File services
File sharing services
Configuring file services
Active server connections
Access control lists
Setting permissions in Windows
Network file system
FTP services
FTP Server
Anonymous FTP Server
Enabling the FTP server
User vs. Team FTP access
Enabling FTP access for a specific team or user
rsync
What is rsync?
Enabling rsync
rsync from a Telnet session
Print service
Configuring local print services
Configuring your workstation
Other network printing
Creating an aliased printer queue
Web services
Web server
Master Web server
Virtual Web servers
Hosting multiple Web sites
Secure Web services
SSL certificate
Web caching
Web filtering
Web and content filtering
Enabling the Web filter
Providing full internet access
Port exemptions
Adding permitted Websites
Adding denied Websites
Accepting access requests
Denying access requests
List management
Email reporting
Hardware components report
Log messages
Accessing log messages
Customizing message display
Firewall log
Virus scanner
Activating your file virus scanner license
Performance considerations
Minimum hardware requirements
Hardware sizing based on number of users
Email protocol choices affecting server performance
Other services running on the Lotus Foundations server
Backup scheduling
Future capacity planning
Glossary
Notices
Trademarks

Chapter 1. Lotus Foundations Branch Office Administration Guide

 

Introduction

Welcome to the Lotus(R) Foundations Branch Office Administration Guide. This document is intended for administrators and provides details on the capabilities and functions of a Lotus Foundations Branch Office server. See the Lotus Foundations Branch Office Getting Started Guide for information on the basic installation, configuration, and setup.

Lotus Foundations Branch Office is designed to be used by a branch office location connected into an existing primary Domino Enterprise server for the purpose of local replication and sending and receiving email and other Lotus Domino features. It is assumed that you already have a configured Domino Enterprise server capable of interacting with secondary Domino servers and that you have full administrative access to the infrastructure that you are working with. A strong understanding of the Domino software and administration is essential for ensuring a successful installation of the software.

Lotus Foundations Branch Office contains a Lotus Domino server that may be used like any other Lotus Domino server, but there are some Lotus Foundations Branch Office licensing differences:

References

See the following links for information on Lotus Foundations and Lotus Domino:

Configuring Lotus Foundations

There are two configuration consoles for Lotus Foundations Branch Office. The first, WebConfig, is used for the basic configuration of the system, services, network, etc. The second, Lotus Domino Administration client, is used to setup, configure, and manage the Lotus Domino server and users. This chapter focuses on WebConfig. See here for more detail on the Lotus Domino Administration client.

What is WebConfig?

WebConfig is the administrator console for configuring the native features of Lotus Foundations. Administrators access WebConfig through an Internet browser connected to the local network. This section provides user guidance for WebConfig.

Accessing WebConfig

WebConfig is accessed through a browser. Open a Web browser on a workstation and, using a secure Web connection (HTTPS), enter in the IP address for the server, appending port 8043. For example: https://192.168.0.1:8043. The Log in page displays. Enter the user ID and password and click the Submit. The main page displays as shown in the following figure.

Figure 1. The main screen of WebConfig
screen shot of webconfig

Lotus Foundations' WebConfig uses 128-bit encryption to protect administrator information and passwords. Most recent versions of Web browsers contain built-in support for this. Lotus Foundations WebConfig supports these Web browsers:

WedConfig is unreachable if there is a failure to support 128-bit encryption results.

Other Web browsers that might work but are not explicitly supported are:

Configuring TCP/IP on your workstation

Before you can access WebConfig, you have to configure your workstation to use TCP/IP. If TCP/IP is not configured, follow the appropriate steps for your operating system.

For Windows(R) 2000/XP:

  1. In Windows 2000, select Start -> Settings -> Control Panel. On Windows XP, click Start -> Control Panel. If Windows XP is in Classic mode, the control panel is under Start -> Settings -> Control panel.
  2. Select Network and Dial-up Connections from the list. The Network Connections screen is displayed. In Windows XP, select Network and Internet Connections, then click Network Connections.
  3. Double-click Local Area Connection and the Local Area Connection window is displayed.
  4. Click Properties and the Local Area Connection Properties window is displayed. If Internet Protocol (TCP/IP) is not in the Components checked that are used by this connection list, click Install.
  5. The Select Network Component Type is displayed. Select Protocol from the window. Click Add.
  6. The Select Protocol window is displayed.
  7. Select Internet Protocol (TCP/IP) from the list. Click OK. TCP/IP should now be displayed in the Local Area Connection Properties window.
  8. Select Internet Protocol (TCP/IP) from the list, and click Properties.
  9. The Internet Protocol (TCP/IP) Properties screen is displayed. Select Obtain IP Address automatically. Select Obtain DNS server address automatically.
  10. Click Advanced. The Advanced TCP/IP Settings window is displayed. Select any entries in the Default gateways section of the window, and click Remove.
  11. Click the DNS tab. Select any entries in the DNS server addresses section of the window, and click Remove. Select Append primary and connection specific DNS suffixes. Select Append parent suffixes and primary DNS suffixes.
  12. Click the WINS tab. Select any entries in the WINS addresses section of the window, and click Remove. Select the Default NetBios setting.
  13. Click OK. Click OK on the TCP/IP Properties screen.
  14. Reboot the computer.

System status screen

The system status screen displays the status of the services running on Lotus Foundations. The WebConfig menu helps you to access and configure various Lotus Foundations subsystems.

Table 1. Features of the system status screen
Item Description
CPU utilization Displays the use of the system's central processing unit (CPU) in numerical form and as a bar graph. During intensive operations (such as backups or very heavy file transfers), the CPU use bar might show 100%. This is normal. One hundred per cent use simply means that the CPU is being fully used and does not necessarily mean that your Lotus Foundations server is being overloaded or that performance suffers. However, if the CPU use is constantly at 100%, and you experience service slow-downs, you might want to contact support for a services review.
Ethernet 0, Ethernet 1, and Ethernet 2 Displays the speed of data transfer through Ethernet port 0, port 1, and port 2 (measured in kbps or Mbps). The bar graph displays the speed as a percentage of the highest transfer rate recorded since the last power-up.
PPP link Displays the speed of data transfer through the DSL PPPoE or dial-up Internet connection (measured in kbps). The bar graph displays the speed as a percentage of the maximum measured speed.
Disk load Displays the amount of data being transferred to and from the hard disk (measured in kbps or Mbps). The bar graph displays the amount as a percentage of the highest amount recorded since the last power-up.
Disk space used Displays how full your server hard disk is by displaying the usage and capacity of the drive.
System status details button Displays System Status resource information in a graphical representation, on a variable time basis, for example, half hour, 1 month, or 1 year. Also includes graphs for Physical Memory and Virtual Memory.
Internet status Displays the status of your internet connection(s). A green check mark displays when an internet connection is configured properly. The default route used to transfer data to destinations on the internet is also displayed. If a modem is configured, clicking dial modem initiates a connection to the internet. The administrator can choose to terminate the connection through this screen.
Firewall Displays the status of the firewall (enabled/disabled). Also displays the port for the firewall "eth1: Firewall enabled".
TunnelVision Displays the status of all TunnelVision connections.
IPsec connections Displays the status of all IPsec connections.
PPTP connections Displays the status of all PPTP connections and provides an option to disconnect active connections.
SoftUpdate Displays the status of the subsystem that automatically checks for available software updates. When the subsystem is active and retrieving a list of available software updates, the status light is green. When the subsystem is operational but idle, the status light is gray. A red status light indicates a problem with the subsystem (usually an inability to access the distribution server). Refer to Log messages for more information on download errors.
Disk status Displays the status of your disk configuration, provides disk reconfiguration options, displays the status of a rebuilding RAID array, and displays idb drive hotswap status.
Backup status Displays the status of the idb backup disk. It displays how much of the idb disk space is currently available for backups and when the next backup is scheduled to be done.
Quota status Displays if there are any users over their quota limit. See Setting individual user disk quotas for more information.
Scalable services status Displays the status of the Scalable Services Structure.
Add-ons Displays the status of any Lotus Foundations add-ons running on the Lotus Foundations server. In Lotus Foundations Branch Office, Domino specific information is displayed, such as the status of the Domino server's 'listener' and the status of the NDC support services (next and last backup time and the next and last database compression time).
User authentication method Displays the method of authentication currently enabled. For Lotus Foundations Branch Office, it displays "Pass-through Authentication." It also displays the number of Lotus Foundations user licenses available for use.
Virus definition updates If the Virus Scanner is licensed and if the File Virus Scanner and/or Mail Virus Scanner are enabled, it displays when the virus definitions were last updated, how many viruses you are protected against, and links to a report on how many viruses were detected since the last reboot.
File virus scanner If the Virus Scanner is licensed and File Virus Scanner is enabled, it displays:
  • How many files were scanned
  • How many viruses were found during the last scan once the scan has complete
  • How many viruses you are protected against
  • When the next virus definitions update will happen
Printing Service Displays the status of printing services.
MySQL server Displays the status of MySQL services. The number of sessions displayed represents the number of active users currently connected to Lotus Foundations and using MySQL database services. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
WWW server Displays the status of Web publishing services. The number of sessions displayed represents the number of active Web sessions currently open. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
Secure WWW server Displays the status of the secure Web server. The number of sessions displayed represents the number of active secure Web sessions currently open. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
DNS server Displays the status of the DNS server.
Windows file server Clients that are not Windows or Windows NT can connect to this service. The number of sessions displayed represents the number of active users currently connected to Lotus Foundations and using Windows file services. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
Apple file server Displays the status of file services for Apple Macintosh clients. The number of sessions displayed represents the number of users currently connected to Lotus Foundations and using Apple file services. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
NFS file server Displays the status of the NFS file server for UNIX(R) and similar systems. The number of sessions displayed represents the number of active users currently connected to Lotus Foundations and using NFS file services. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
FTP server Displays the status of FTP services. The number of sessions displayed represents the number of active FTP connections currently in progress. The CPU use bar graph indicates how much processor time is being used by this service. The status is a gray box if service is disabled, a green check mark if service is operational, a yellow warning symbol if service is used heavily, and a red 'x' if there is a problem with the service.
Reboot button Click this button to reboot the Lotus Foundations server.
Shutdown button Click this button to properly shut-down the Lotus Foundations server. Failure to click on the Shutdown button means that your RAID array has to rebuild. See Disk status messages for more information.
*Others Other items might be displayed on the system status screen depending on the addition of any optional software modules.

Notices box

In most cases, when you change a service option in WebConfig and click Save Changes, Lotus Foundations displays a drop-down list of major actions that are happening in the background at the top of that sub-service screen. Failure notices also are displayed in the Notices drop-down box.

System status details

The System Status Details page is a history of critical system information that has been stored by Lotus Foundations and can be viewed using an array of graphs. These graphs represent the usage of CPU load, memory usage, Ethernet traffic, and more.

Historical system status graphs

In addition to the real time status indicators on the system status page, located under these bars is a button that leads to a page which displays historical graphs of system status.

  1. Click Status in the left side menu of WebConfig.
  2. Underneath the system status is a button labeled System Status Details. Click this button to navigate to the historical graphs.
  3. On this page is a number of graphs for various resources on the server.

These graphs incorporate a new graphical representation of server usage. The system status history graphs have been extended to include not only the average resource usage over various time periods but also the minimum and maximum resource usages experienced during these periods. The average resource usage is displayed as a brightly-colored line against a background of progressively darker colors that show the variance of resource usage over various time periods.

The most important aspect of the improved status history graphs is that it is immediately evident on all the graphs for all time periods if there is a high variance for the resource usage because the shaded backgrounds corresponding to the ranges of measurements are much wider. On the other hand, if these backgrounds are narrow, the system does not experience much variation in the resource usage at all.

Take a snapshot

Now that you have taken the time to configure Lotus Foundations you can use the Take Snapshot selection in the menu to display all the information available on one scrollable page. You can also save this information in an offline Web Page format as reference material to cross check any changes that might occur in your configuration settings.

License information

To see how many Lotus Foundations users are licensed for the system and how many licenses are currently being used, follow these steps:

  1. Log in to WebConfig with your administrator username and password.
  2. Select Software Update from the WebConfig screen.
  3. Click the Licenses tab. The Software Update screen is displayed.
Figure 2. Licenses screen in the WebConfig console
screen shot of WebConfig console displaying licenses information

If you exceed your licensed number of Lotus Foundations Branch Office users, a Notices box is displayed at the top of each page in the WebConfig console.

Lotus Foundations user licenses are not required for team accounts without a password. Team members can still access team data/services using their personal user account passwords. If you choose to assign a password to a team, this counts towards your total user license usage.

Software update

Periodically, Lotus Foundations contacts distribution servers through its internet connection and requests an updated list of available software releases. A list of available software releases is found on the Software Update screen.

Upgrading Lotus Foundations

Note: If you are running Lotus Foundations from a CD or DVD, you must configure your disks from the WebConfig menu, shut down the system, remove the Lotus Foundations CD or DVD and restart the system before Software Update can work. For more information on configuring the hard disks, see Disk management. Software Update also requires a current license. See Activation keys for more information.

It is best to upgrade the software after-hours because rebooting disconnects all users and causes all services to stop functioning until the server has restarted.

  1. Select Software Update from the left-side of WebConfig. The Software Update screen is displayed, showing the Lotus Foundations software version the server is currently running and all versions available for download.
    Figure 3. Software Update screen
    screen shot of the System Status section of the webconfig console
  2. Scroll to the bottom of the screen and click Check for New Versions to update the list of available versions.

    The System Status screen is displayed. The Software Update line displays the progress.

  3. Click on a version's Release Notes(R) link to access its release notes.
  4. The new software has to be downloaded to the server. To do so, click the appropriate version's Download link. Read and accept the licenses. The System Status screen is displayed. The Software Update line displays the progress of the download.
  5. When the download is complete, the Software Update line tells you that a software update has been installed and prompts you to reboot your system.
  6. Click the Reboot link.
  7. Click Return when an IP address is displayed on the Lotus Foundations server's display console. The System Status screen is displayed. The Software Update line asks if you want to keep the new software release:
  8. If Lotus Foundations is not installed properly, the server uses the old version when it reboots. If the server encounters any difficulty starting the new software release, the previous version starts instead. If you choose not to confirm your download, and a power loss or reboot occurs, the server reverts back to the last-used software release.
  9. To revert back to the old version, select Software Update from the WebConfig menu. Click the Activate link in the "Foundations Versions already installed" section of the screen:

Switching languages

Lotus Foundations currently enables you to view WebConfig in various different languages. To switch between languages, follow these steps:

  1. Click Software Update from the left-side menu of WebConfig.
  2. In the Software Updates tab, locate the section titled Language Selection.
  3. Using the drop-down box, select the target language.
  4. Click the save icon to save the change.

To add language packs or change the language for the Lotus Foundations Branch Office server, see the Lotus Foundations Branch Office Getting Started Guide.

Activation keys

By default, Lotus Foundations comes configured in a 30-day trial mode. To get out of trial mode and activate the features and licenses you have purchased, you must enter a software activation key.

When you purchase Lotus Foundations software, a software activation key is provided. To fully activate the features that you have purchased, you need to enter a software activation key during the initial setup or within the first 30 days after installing. By default, Lotus Foundations Branch Office works in a 30-day trial mode. Until Lotus Foundations is activated, some features remain inactive. Your activation key is emailed to you. If you did not receive your activation key, call +1.866.384.8324, and select option 2.

Note: An Internet connection is required for activating the Lotus Foundations software license. It is the user's responsibility to ensure that an Internet connection is established when attempting to install the software.

Entering activation key to exit trial mode

Follow these steps to enter the software activation key:

  1. Login to WebConfig with an administrator account.
  2. Click Software Update.
  3. Enter your activation key in the Foundations Registration section.
  4. Click Save Changes.
Figure 4. Registration section of the Web Configuration console
screen shot of webconfig console activating the software key

Updating your activation key

Follow these steps to replace an existing activation key with a new one:

  1. Login to WebConfig with an administrator account.
  2. Click Software Update and you see the current activation key displayed under the Foundations Registration section.
  3. Click the Edit action button screen shot of edit (pencil) icon and the Lotus Foundations Registration box is displayed.
  4. Enter the new activation key in the Lotus Foundations Registration box.
  5. Click Save Changes.
Figure 5. Editing the activation key in the Web Configuration console
screen shot of the webconfig console with the key updated

Configuring Lotus Foundations Branch Office non-Domino settings

Refer to the Lotus Foundations Branch Office Getting Started Guide for instructions on installing and configuring Lotus Foundations Branch Office. Note that during the installation and configuration process Lotus Domino server names are case sensitive.

Note: When setting up the Lotus Foundations Branch Office server, if the remote server setup needs to be done over the Internet, you need to add port 8585 to the Firewall ports list. To do this:
  1. Login to WebConfig with an administrator account (root).
  2. Select Add-ons from the left-side menu.
  3. In the Lotus Foundations Branch Office row, select the edit icon screen shot of edit icon.
  4. In the Firewall Port(s): field, enter 8585.
  5. Click Save Changes.

This should only be enabled for as long as you need to do the setup. Once the setup is complete, it is recommended you delete port 8585 from the Firewall Port(s): field.

Changing the Lotus Foundations server host name and Internet domain name

Lotus Foundations automatically assigns a random host name to the Lotus Foundations server during the first boot-up. Host names should be unique because they are used to distinguish your server from others on the local network and are used by local users to identify Lotus Foundations file and print-sharing resources. In addition, the host name, in conjunction with the Internet domain name, forms a unique internet name under which the Lotus Foundations server and its Web and FTP services are addressed on the internet.

If you want to rename your server, follow these steps:

  1. Login to the Webconfig console and select Local Network from the menu on the left side
  2. Edit the Host Name and Domain Name fields accordingly. The hostname should be unique and should contain only numbers and letters.
    Figure 6. Changing the host name and domain name
    screen shot of the changing the host name and domain name
  3. Click Save Changes.

After you have installed Lotus Foundations Branch Office, the host name and Internet domain name are no longer modifiable.

Starting and stopping Lotus Foundations Branch Office

If you need to stop and restart the Lotus Foundations Branch Office server, follow these steps:

  1. Open a Web browser to the WebConfig console at https://server_ip_address:8043/.
  2. Enter the root administrator ID and password.
  3. Select Add-ons from the menu on the left.
  4. In the Lotus Foundations Branch Office row, select the edit icon screen shot of the edit icon. In the Addon Automatic Start row, click the Disable radio button.
  5. Click Save Changes.
  6. When you are ready to restart the server, return to theLotus Foundations Branch Office row, select the edit icon screen shot of the edit icon. In the Addon Automatic Start row, click the Enable radio button.
  7. Click Save Changes.
Note: It is recommended you do not use the IBM Domino Administrator client to start or stop Lotus Foundations Branch Office.

Uninstalling Lotus Foundations Branch Office

Follow these steps to uninstall Lotus Foundations Branch Office:

  1. Open a Web browser to the WebConfig console at https://server_ip_address:8043/.
  2. Enter the root administrator ID and password.
  3. Select Add-ons from the menu on the left.
  4. In the Lotus Foundations Branch Office 1.1 row, select the uninstall icon screen shot of uninstall icon.

Note that even after the add-on is uninstalled, to preserve important data, the following items are not removed:

User & Team management

Introduction to users and teams

Most user management is done using Domino Administrator. Users are created in Domino Administrator and then synchronized with the Lotus Foundations server. Lotus Foundations user and team management is integrated with a number of other Lotus Foundations services. It is important that you understand how user and team management relates to these other functions before creating, editing, and deleting users and teams. Read the following section carefully.

Lotus Foundations file, Web, and FTP services are tightly integrated. Every user and team account that is created has instant and automatic access to all of these services. When a user is created in Domino Administrator and then synchronized with the Lotus Foundations server, a number of things happen in the background:

Teams are used to create a group of users. That team can then be given authorization to certain services and applications. Lotus Domino groups are not the same as teams used in Lotus Foundations Branch Office. Lotus Foundations Branch Office teams are primarily used to control access to resources. When a Lotus Foundations team is created, a number of things happen in the background:

There are also three non-Domino local users that can be created on Lotus Foundations Branch Office. These are intended to be for additional administrators. The user ID root is one administrator, plus you can create up to two additional local user accounts, either as a regular user or as an administrator.

Note: All Lotus Foundations user and team accounts with a password require a Lotus Foundations user license. Lotus Foundations user licenses are not required for team accounts without a password; team members can still access team data/services using their personal user account passwords.

User accounts

Users are created and his or her email settings are managed through the Domino Administrator client connected to the Domino Enterprise server. Some user settings for Lotus Foundations can be modified through the WebConfig console.

A user license is required for every user who accesses Lotus Foundations Branch Office. Up to 500 users can be created through the Domino Administrator. Up to 3 local users (in other words, users created through Lotus Foundations Branch Office) can be created, one being root, and are expected to be used for administrators.

Browsing users

Users are listed in the Users section of the WebConfig console. You can search for users and teams by user ID, Team ID or full name.

Disabled Lotus Foundations users are displayed in this list with '(disabled)' appended to the Full Name field. Users are considered disabled when they have no password set.

Creating users

Users are created using the Domino Administrator connected to the Domino Enterprise server, not through the WebConfig console. To create users, see the Step 11: Set up and register Lotus Foundations Branch Office users chapter in the Lotus Foundations Branch Office Getting Started Guide.

Note that after a user is created or if the user's Internet password is changed in Lotus Domino, it is recommended that they log into the WebConfig console or some service other than Samba or VPN in order to 'establish' their password for use with those services. The Lotus Foundations Branch Office server synchronizes user information with the Domino Enterprise server every three minutes. This synchronization is done to the Lotus Foundations users; the Domino Enterprise user information is never altered.

When registering users, it's optional whether or not to include their ID file in the Domino directory. For Lotus Foundations Branch Office, it is recommend that it is included to simplify the Lotus Notes add-on installation for the user.

Editing users

Follow these steps to edit users:

  1. Open a Web browser to the WebConfig console at https://server_ip_address:8043/.
  2. Enter the root administrator ID and password.
  3. On the User Setup page, click the Users tab. Click the appropriate user's edit icon screen shot of edit icon. The Modify User screen is displayed.
  4. Edit the user's full name.
  5. Select a preferred language for the user. This determines the language for the email template and for the Lotus Notes(R) client through the one-click installation.
  6. Indicate whether or not this user has FTP access to his or her private directory.
  7. Indicate whether or not the user is allowed to establish a remote VPN (PPTP) or dial-in modem connection to the internal network.
  8. Select a quota value for this user. For more information, see Disk quotas.
  9. Under Join Teams, select the team(s) from the Available Teams list that this user is a part of. Click Join. The teams are displayed in the Member of Teams box.
    Note: Team membership gives users full access to the team's shared directory. If one of the joined teams is a member of any other team(s), when it is added to the Member of Teams list it has (# inherited) listed after it. The user has "inherited" team membership to those other team(s).
  10. Click Save Changes. This returns you to the main User Setup page, and the user is displayed in the list of previously created users.

Team accounts

Creating teams

Follow these steps to create teams:

  1. Select Users from left-side menu of WebConfig. Click the Teams tab. The main User Setup screen is displayed.
  2. Click Add Team. The Create New Team screen is displayed.
    Figure 7. Creating a team in the WebConfig console
    screen shot of the create team section of the webconfig console
  3. Enter a team ID.
  4. Enter a descriptive name for the team in the Full Name field. This descriptive name must be unique.
  5. Do not enter a login password for the team. A team that is created with a password uses one of the three included user licenses with Lotus Foundations Branch Office.
  6. Select a preferred language.
  7. Indicate whether or not the team has FTP access to the team directory.
  8. Indicate whether or not team members are allowed to establish a remote VPN (PPTP) or dial-in modem connection to the internal network. For security reasons, most teams should not be able to establish a remote connection.
  9. Select a quota value for this team. For more information, see Disk quotas.
  10. Under Team Members, select the user(s) from the Users list who are a part of this team. Click Add. The user(s) is displayed in the Team Members box.
  11. Click Save Changes. This returns you to the main User Setup page, and the team is displayed in the list of previously created teams.

Editing Teams

Follow these steps to edit teams:

  1. On the User Setup screen, click the Teams tab. Click the appropriate team's edit icon screen shot of the edit (pencil icon).
  2. The Modify Team screen is displayed.
    Note: While running Lotus Foundations Branch Office, Lotus Foundations Branch Office team IDs cannot be modified.
  3. Change team information as necessary. Refer to Creating teams for a description of the fields on this screen.
  4. Click Save Changes.

Deleting teams

Note: Deleting a team means that the team's shared network directory and all of the files contained within the directory are deleted. Once this is done, none of the above can be recovered unless you restore the data from a previous backup. autoinstall, backup, daemon, ftp, and log teams cannot be deleted.

Follow these steps to delete teams:

  1. On the main User Setup screen, click the Teams tab. Click the appropriate team's delete icon screen shot of the delete icon.
  2. In the confirmation dialog that displays, click OK.

The User Setup screen restricts the number of entries that are displayed by default. If there are a large number of teams, only the first 10 teams are displayed in the User Setup section. At the bottom of the section there are links to a series of teams. For example, if you have 43 teams, the screen displays: [show all] [a - o] [p - y]. Clicking on the [p - y] link displays all teams with team names beginning P through Y. To help administrators to easily locate teams' records, there is a Team Search field at the top of the User Setup screen. To search for a team, type in that team's ID (or portion thereof) and click Search.

Password policy

The password policy feature helps an administrator to set restrictions on the format of passwords chosen by users. For example, the administrator can specify that uppercase and lowercase letters must be included in the password and/or that passwords must be of a particular minimum length.

Creating a password policy

Follow these steps to create a password policy:

  1. Click Users from the left-side menu of WebConfig.
  2. Click the Password Policy tab.
  3. Choose whether or not to enforce the password policy on passwords set by administrators.
  4. Select which password policy criteria should be enforced by checking the appropriate boxes.
  5. If you want to enforce a minimum password length, enter the number of characters in the Password minimum length text box. Use 0 for no minimum.
  6. Click Save Changes.

Illegal passwords

When a password that does not conform to the policy as specified by the administrator is entered for a user, that user receives an email notifying them that they need to change their password to one that conforms to the policy. The email also includes instructions on how to perform this password change.

If a user changes their password in their personal WebConfig to one that does not meet the policy criteria, they get a pop-up error message.

An error message is also displayed in WebConfig's Notices box telling them that their password was not changed.

If the "Enforce password policy on passwords set by admins" option is set to No, Administrators are able to change a user's password to one that does not meet the policy criteria. This helps administrators to set an easy-to-remember temporary password for a new user, until that user can set his or her own password.

The administrator receives a warning message in WebConfig's Notices box informing him or her that the password does not meet the policy criteria, but that the password has been changed.

If a user is already set up and the administrator creates or changes a password policy, that user's password is valid - even if it does not meet the policy criteria - until the next time he or she logs onto WebConfig.

Disk quotas

Disk quota defines the maximum amount of hard disk space allowed for a user's files and email. The disk quota feature in Lotus Foundations helps administrators to set specific disk quotas for individual users.

For example, a user's disk quota value can be set to predetermined values such as small, medium, or large, to a specified value for that user, or you can choose not to have the user's disk usage subject to a quota.

Setting default disk quota values

Follow these steps to set default disk quota values that can be used when assigning disks quotas to users:

  1. Select Quotas from the left-side menu of WebConfig. The main Quota Setup screen is displayed.
    Figure 8. Quota Setup screen in the WebConfig console
    screen shot of the Quota Setup section in the webconfig console
  2. Enter a Default Small Quota Value.
  3. Enter a Default Medium Quota Value.
  4. Enter a Default Large Quota Value. The maximum size that a disk quota value can be is 2 TB.
  5. Click Save Changes to save the default quota values.

Setting individual user disk quotas

Follow these steps to define a user's disk quota:

  1. Select Users from left-side menu of WebConfig. The main User Setup screen is displayed.
  2. Click the Users tab. Click the appropriate user's edit action icon screen shot of the edit icon. The Modify User screen is displayed.
  3. In Quota Value, select a quota value from the drop-down list for that user. Your options are:
  4. Click Save Changes to save the quota values for that user.

Quota limit

All disk quota limits on Lotus Foundations are enforced as hard limits. This means that administrators can only define an absolute maximum and not a soft limit for warnings to users. When a user's quota limit is reached, Lotus Foundations prevents that user from using any more space on the hard disks by preventing them from creating new files or editing existing files.

User accounts with a quota over the limit cannot write to the disk anymore until some space is cleared.

When accounts have reached a quota, administrators:

Disk management

Some Lotus Foundations services are not enabled unless hard disks are configured through the WebConfig menu.

Disk configuration (idb and RAID)

A Redundant Array of Independent Disks (RAID) is a system of storing information that reduces risk by keeping data on two or more drives. If one drive fails, your data is still safely written and stored on another drive. You do not need to know much about RAID to configure it on your Lotus Foundations server.

Intelligent Disk Backup (idb) is a system that automatically performs backup procedures as often as every fifteen minutes without input from a system administrator. See the Intelligent disk backup (idb) section for more information.

If your Lotus Foundations server has one disk, then you cannot take advantage of idb or RAID. If your Lotus Foundations server has exactly two disks, you can have idb backup or a two-disk RAID array, but not both. If you have three or more disks, you can have a two or more disk RAID array and idb backup or a RAID array with all available disks and no idb backup.

Configuring your disks (generally done during the initial installation)

  1. The Disk Status section in WebConfig displays a message that disk(s) have not been configured.
    Figure 9. Disk Status section of WebConfig
    screen shot of the status page of webconfig
  2. Click the appropriate button to configure your disks.

Reconfiguring your disks

You can reconfigure your disk at any time. The Disk Status section of WebConfig displays your disk status and provides you with disk reconfiguration options.

Converting an idb disk to RAID

You can only convert an idb disk to part of a RAID array if your Lotus Foundations server has exactly two disks. If you have 3 or more disks, you cannot convert an idb disk to RAID.

Note: Converting your idb disk to part of a RAID array means that you will lose idb backup capabilities. In addition, the backup information that is stored on the idb disk is permanently deleted.

  1. The Disk Status section of WebConfig states information about the primary disk. It then states In order to improve redundancy you can:, followed by a button labeled Add disk #2 to your RAID array. Click this button.
  2. The RAID array then begins to rebuild. This process, which can take several hours depending upon your disk size, does not noticeably affect the performance of Lotus Foundations. Click your browser's Refresh button to view an updated status of your RAID array.
  3. When the array has finished building, a message is displayed in the Disk Status section of the screen.

Converting a RAID disk to idb

If your RAID array is working correctly, you can convert a RAID disk to idb.

If you have a two-disk RAID array, you cannot convert a RAID disk to an idb disk in WebConfig.

Note: Converting your last RAID disk to idb reduces disk redundancy, regardless of how many disks your Lotus Foundations server has.

  1. The Disk Status section of WebConfig has a button stating you can configure your last disk as idb. Click this button.
  2. The Disk Status section of the page displays your new disk configuration.

Disk status messages

Depending on your disk configuration, one or more of the following messages are displayed in the Disk Status section of WebConfig:

Table 2. Disk Status Messages
Message Reason for Display
The RAID array is rebuilding. Please do not add or remove any disks until this process is finished. (% complete) A RAID array needs to build itself the first time it is used, and rebuild when a new disk is added or when the power is turned off suddenly. Always click Shutdown before turning off your Lotus Foundations server. Failure to do so means that your RAID array needs to rebuild when you turn the server back on. Although this process does not noticeably affect the performance of Lotus Foundations, it can take several hours to complete depending on the size and number of disks in your array.
Your disk array is working correctly. A RAID array is finished building.
No disks detected! Are your drives inserted or locked? Your drives are not fully inserted and properly locked or when all available drives have crashed. If your drives are not locked, insert the hard disk key into the lock and turn it clockwise until it snaps back into the locked position. If your disks have crashed, refer to Recovering from a backup disk failure for information on how to replace failed disks.
The RAID array is in degraded mode. If you remove a disk, you lose access to your files. You are missing one configured drive in a RAID array. You can create a proper RAID array by configuring a second disk.
The primary disk is in standalone mode. If you remove the disk, you lose access to your files. You have a single disk drive, you are not using RAID, or your two-disk RAID array is in degraded mode.
There is no disk available for idb backup. No configured idb disk is present in the system.
Disk #_ is being used for Intelligent Disk Backup (idb). The last disk is used for idb instead of as part of a RAID array.
You can add disk #_ to your RAID array to improve redundancy. You have at least one unconfigured disk or if your last disk is being used for idb. Click the link to add the disk to the RAID array.
You can configure disk #_ for use in idb backups. The last disk drive is unconfigured. The previous message also displays, but you can only choose one of the options.
There is no reason to use disk #_. Any extra disks in the system that cannot be used. This occurs when the RAID array is complete, and there is already an idb disk.
Disk #_ is too small to be added to the RAID array. Any unconfigured disks that are too small to fit into the RAID. To solve this problem, turn the server off and replace the disk with a larger disk.

Recovering from a backup disk failure

If one of the disks in your RAID array fails, follow these steps:

  1. Shut down the server completely. If your server has a main power switch, turn off the main power switch. Unplug the power cord.
    Note: The button for the main power button on the Lotus Foundations Appliance is below the control panel either on the front or on the side of the Lotus Foundations Appliance. This is different from the power button in the upper left corner of the Lotus Foundations Appliance.
  2. Remove the hard disk and replace it with a new one as soon as possible. See Installing a new hard drive for more information.
  3. Plug the power cord back in. If your server has a main power switch, turn the main power on.
  4. Connect to WebConfig and log in.
  5. The Disk Status section of the Status page of WebConfig presents you with up to two options:
  6. Depending on your choice, Lotus Foundations configures the new disk as the idb disk or as part of your RAID array.

Recovering from a main hard disk failure

If your problem is a main hard disk failure, you need the following to restore your Lotus Foundations server:

Installing a new hard drive

  1. Shut down the server completely. If your server has a main power switch, turn off the main power switch. Unplug the power cord.
    Note: The button for the main power button on the Lotus Foundations Appliance is below the control panel either on the front or on the side of the Lotus Foundations Appliance. This is different from the power button in the upper left corner of the Lotus Foundations Appliance.
  2. Remove the disk from the unit.
  3. Insert a new hard disk into the drive.
  4. Insert your idb cartridge. Skip this step if your idb disk is already in.
  5. Plug the power cord back in. If your server has a main power switch, turn the main power on.
  6. Press the power button.
  7. Configure the new disk in WebConfig. See Configuring your disks (generally done during the initial installation).
  8. Initiate a restoration from WebConfig. See Backup & restore. The length of the restore process depends on the size of your hard disk and the amount of data that has to be restored. The entire process can take up to several hours.
    Note: Restoration is not necessary when adding a disk to a degraded RAID.

Backup & restore

 

Intelligent disk backup (idb)

Lotus Foundations takes a different approach to backup with intelligent disk backup (idb) technology, which is both cheaper and easier to use than conventional tape backup systems. The capacity of the idb backup unit varies.

The idb system automatically performs backup procedures without input from a system administrator. However, at any time you can turn off an idb job, pause or change an idb job schedule, or manually initiate a backup procedure. Refer to Initiating an idb backup for more information.

Features of idb

Instead of conventional backup tapes, idb uses a removable high-capacity hard disk, which provides the following advantages:

Backup jobs

When you configure Lotus Foundations to use idb, one job is automatically created. This job is named Master Job. It cannot be deleted, but it can be reconfigured. By default all users and teams are included in this backup job, with the exception of the notes, notesbackup, and domino teams. The data within the notes team includes live Domino databases that are regularly copied to the notesbackup team, and thus does not need to be backed up.

When you install the Lotus Foundations Branch Office add-on, another job is automatically created. This job is named LF Branch Office Backup. By default, this job includes the notesbackup team.

Configuring idb

General configuration

The idb feature of Lotus Foundations automatically backs up your data throughout the entire day, takes care of all backup tasks for you, and notifies you through email about its progress. Although most of the idb process is automated, you can adjust several parameters that determine how and when your backups are completed.

Clicking Backup from the left navigation pane of WebConfig opens the main idb Backup page. The main idb Backup page consists of three main sections.

Table 3. idb Backup page sections and elements
Main idb Backup page sections Section elements Element actions
idb Status Lists the Backup Status of idb and the amount of idb disk space being used by backups
Backup Jobs Create a new job Creates a new backup job
Backup all jobs Runs an unscheduled backup of all backup jobs
Suspend all scheduling or Resume all scheduling Stops or resume all scheduled backups
List of Backup Jobs Backup jobs set up on the server; clicking the job name takes you to the Modify Job Settings page
Disk Scan Scan idb Disk Scans the idb drive for backup sets; used after changing the idb disk in order to synchronize the server configuration and backup sets with the new drive

Figure 10. Main idb Backup page
screen shot of the main idb backup page of webconfig

Clicking the job name enables you to modify the settings for that specific backup job. The Modify Job Settings page has four tabs:

Table 4 lists the specifics of the Modify Job Settings page and its tabs.

Table 4. Modify Job Settings page tabs and elements
Modify Job Settings tab Tab elements Element actions
General Job Name Changes the job name
Cannot edit the Master Job name
Priority Assigns a unique value to the backup job; 1 is the highest priority
idb Quota Adjusts the size of the backup job
Email log level Sets the level of detail in the backup logs that are included in the backup reports; default setting is Error
All message levels are available in the system logs
Email backup reports to Identifies who receives an email copy of the backup reports
Enter the user ID of the administrator who should receive backup reports. If you enable the SMTP server, you can enter any email address in this field. You can also send backup reports to the Backup team to share the reports with other members of your team. See The idb backup team for more details.
Backup compression Sets compression of the backup files
Compressed backup files occupy less space on the idb drive, but require a longer time to back up and restore.
Encryption Notes if a backup job is encrypted or not
The Master Job and LF Branch Office Backup job cannot be encrypted; only user-created jobs can be encrypted.
If a job is encrypted, an Encryption password field and an Encryption password (verification) field also appear in the General tab.
Backup encryption can only be set during job creation. This setting cannot be changed after a job is created.
Backup Files Lists the directories available for backing up. If necessary, adjust these settings by clearing or selecting check boxes to set which directories are backed up in a specific job.
The default setting for the Master Job is to back up all directories except the notes team.
Note: Because the notes team's data is constantly in use, it is automatically copied over to the notesbackup team, where it is safely backed up by idb. Do not enable the backup for the notes team, as this needlessly increases the time to perform backups.
Schedule Full backup frequency Backs up everything on the system
Incremental backup frequency Backs up the changes to system
Daily backup at When the daily backup is performed; select a time when nobody is using the system, such as late at night or early in the morning
Weekly backup on When the weekly backup is performed
Base daily backups on Sets the baseline backup from which the incremental backups are generated
Advanced Data Retention Policy Indicates whether all teams and users use a retention policy
Minimum Retention Period Minimum amount of time the backup is retained
Maximum Retention Period Maximum amount of time the backup is retained

Figure 11. General tab of the Modify Job Settings page
screen shot of the general tab of the modify job settings window

idb action icons

In the Backup Jobs section of the main idb Backup page, action icons displayed to the right of a specific job control the way your backups are handled.

Table 5. idb Backup Job action icons
idb Backup Job action icons Icon action
Inactive Delete Job icon / Active Delete Job icon Delete Job: Forcibly deletes any backup (and its children, if any) that is not locked; if the icon is a light gray color, the job cannot be deleted (for example, the Master Job)
Restore from Job icon
Restore from Job: Browses the contents of a specific backup and restores them if necessary
Incremental Backup icon
Incremental Backup: Manually performs an incremental backup
Full Backup icon
Full Backup: Manually performs a full backup
Suspend Scheduling icon / Resume Scheduling icon Suspend Scheduling and Resume Scheduling: Suspends or resumes the schedule of a specific backup job
Abort icon
Abort: Stops a specific backup job while it is running

The idb backup team

The backup team account grants all members of the team access to the Backup page in WebConfig and all associated functions. Users have full control over backups and restorations without giving them access to other administrator functions.

  1. Click Users in the left-side menu of WebConfig. The User Setup page is displayed.
  2. Click the Teams tab. A team with the team ID backup and the full name Backup Team is created automatically.
  3. To add a team or an individual user to the backup team, click the backup team's edit icon screen shot of edit icon. The Modify Team page is displayed.
  4. Scroll down to the Team Members section, click to select a team or user from the Users & Teams field, and then click the Add button. The team or user appears in the Team Members field.
  5. To remove a user or team from the backup team, click to select the user or team from the Team Members field, and then click the Remove button.
  6. Click the Save Changes button to save your updates and return to the User Setup page.

idb backup

Creating an idb backup job

You can create an additional backup job to the Master Job. To create a new idb backup job, follow these steps:

  1. Click Backup in the left-side menu of WebConfig. The main idb Status page is displayed.
  2. Click the Create a new job button. The first page of the Create New Job process is displayed.
  3. For Encryption, select if you want to encrypt the backup job and if you have a license that allows for backup encryption. If you encrypt the backup, you need to provide a password in the Encryption Password field. Re-enter the password in the Encryption password (verification) field.
    Note: Encryption can only be set during job creation. It is not possible to change this option after creating a job.
  4. For Backup compression, select if you want to compress the backup.
    Note: Less space is required on the idb drive for compressed backup files, but a longer time is needed to restore files from a compressed backup.
  5. Click Next Page.
  6. For Job Name, type a unique name for this backup job.
  7. For Priority, set this job to the priority you want it to have in relation to other backup jobs. The highest priority for a backup job is 1.
  8. For idb Quota, enter the storage space on the idb disk you want this job to use. A maximum amount of storage space is listed next to the field.
  9. Click Next Page.
  10. Select which team directories you want this job to back up.
    Note: The directory for the notes team is not included in a backup by default. It is automatically copied over to the notesbackup team, where it is safely backed up by idb. Enabling the backup for the notes team needlessly increases the time to perform backups.
  11. Click Next Page.
  12. For Do you want this job to run automatically?, select if you want to automatically run the backups.
  13. If you choose to automatically run this job, select options for Full backup frequency and Incremental backup frequency.
  14. Click Finish. The following message is displayed briefly: idb is performing the requested operations. Then the idb Status main page is displayed, and the new backup job is listed in the Backup Jobs section of the page.

Initiating an idb backup

Although the idb system automatically performs backup procedures without input from a system administrator, you can turn off idb as well as manually initiate a backup from the idb Status page.

This can also be done from the control panel found on the front of a Lotus Foundations Appliance. A backup initiated from the control panel can only restore files from the Master Job backup. It uses the settings that were last configured for the Master Job.

Note: A copy of the server configuration is made each time a backup is performed. This configuration file can be used to restore your settings in the event of a catastrophic system failure.

Initiating a backup from the WebConfig menu

  1. Click Backup in the left-side menu of WebConfig. The main idb Status page is displayed.
  2. In the Backup Jobs section of the page, click the incremental backup icon screen shot of the incremental backup icon or the full backup icon screen shot of the full backup icon, depending on the type of backup you want to run. The following message is displayed briefly: idb is performing the requested operations. Then the idb Status main page is displayed.
  3. To stop the backup job before it is finished, click the abort icon screen shot of the abort icon.

When the backup is finished, Lotus Foundations automatically emails a backup report to the administrator.

Initiating a backup from a Lotus Foundations Appliance control panel

This can only be done with Lotus Foundations Appliances. All other hardware platforms must initiate a backup from the system's WebConfig menu.

  1. Press the Backup button on the front display panel.
  2. The display panel shows a 10-second countdown, during which you can stop the backup process by pressing the Cancel button.
  3. After 10 seconds, the backup procedure commences and the display panel/console displays a progress bar.
  4. You can delay backup for up to 24 hours by pressing the Up and Down arrows during the countdown.

idb restoration

There are four restoration scenarios:

  1. Complete System Restoration - Upon total hard disk failure, perform a complete system restore to restore your system to the state of your most recent backup. After a complete system restoration, older copies of the existing files from the backup disk overwrite the existing files; however, new files saved to the hard drive after the backup are left untouched. Generally, you should initiate a complete system restore only when recovering from complete hard disk failure.
  2. Specific Directory Restoration - It is possible to restore a specific user or team network directory if these files have been lost or mistakenly deleted. You can initiate a specific directory restoration only from the Backup menu. There are two types of specific directory restoration procedures:
  3. Specific File Restoration - It is possible to restore a specific user's or team's network files if they have been lost or mistakenly deleted. You can initiate a specific file restoration only from the Backup menu. There are two types of specific file restoration procedures:
  4. System Configuration Restoration - Restores the system configuration.

idb restoration options

In the Backup Jobs section, icons are displayed to the right of a specific backup in the Action column. These icons enable you to control the way your backups and restored data are handled.

Table 6. idb restoration action icons
idb restoration action icons Icon action
Open Backup icon
Open Backup: Browses the contents of a specific backup
Erase Backup icon
Erase Backup: Forcibly deletes any backup (and its children, if any) that is not locked
Re-verify Backup icon
Re-Verify Backup: Manually verifies an individual backup
Lock Backup icon
Lock Backup: Locks an individual backup
A locked backup cannot be deleted and idb does not expire this backup
Unlock Backup icon
Unlock Backup: Unlocks an individual backup
if you have a backup that is autolocked because it has a child which is also locked, you must first unlock the child backup

 

Locking and unlocking backups

A feature of the idb technology in Lotus Foundations is the ability to lock and unlock individual backups. This enables an administrator to enforce which backups do and do not expire on the idb disk. Backups might also be automatically locked due to the system's autonomics. Locking occurs in the following cases:

Initiating a full system idb restoration

A copy of your server configuration is made each time a backup is performed. This configuration file can be used to restore your entire Lotus Foundations server in the event of a catastrophic system failure.

To restore the entire Lotus Foundations system including the server configurations and all of the user data, follow these steps:

  1. Click Backup in the left-side menu of WebConfig. The main idb status page is displayed.
  2. Click the Restore from Job icon screen shot of the Restore from Job icon in the Action column for the backup job from which you want to restore files. The Restore Files page is displayed, which displays a list of backups and the date and time that the backup was performed.
  3. Click the Open Backup icon screen shot of the Open Backup icon in the Action column for the backup from which you want to restore.
  4. Click the Yes radio button for only the Select All section.
  5. Click the Start Restore button to begin the restoration procedure. To exit the Restore Files page without completing a backup, click Close Backup above the Action column.

Initiating a directory idb restoration

  1. Click Backup in the left-side menu of WebConfig. The main idb status page is displayed.
  2. Click the Restore from Job icon screen shot of the Restore from Job icon in the Action column for the backup job from which you want to restore files. The Restore Files page is displayed, which displays a list of backups and the date and time that the backup was performed.
  3. Click the Open Backup icon screen shot of the Open Backup icon in the Action column for the backup from which you want to restore.
    Note: The first entry in the Restore Files section of the page below the Select All option is the System Configuration option. The system configuration is automatically backed up every time any backup is performed. Restoring system configuration files overwrites the current system configuration, so be very careful with this setting. Leave the default setting, which is No.
  4. Indicate which directories you want included in the restoration procedure:
  5. Click the Start Restore button to begin the restoration procedure.

Initiating a file idb restoration

  1. Click Backup in the left side menu of WebConfig. The main idb status page is displayed.
  2. Click the Restore from Job icon screen shot of the Restore from Job icon in the Action column for the backup job from which you want to restore files. The Restore Files page is displayed, which displays a list of backups and the date and time that the backup was performed.
  3. Click the Open Backup icon screen shot of the Open Backup icon in the Action column for the backup from which you want to restore.
    Note: The first entry in the Restore Files section of the page below the Select All option is the System Configuration option. The system configuration is automatically backed up every time any backup is performed. Restoring system configuration files overwrites the current system configuration, so be very careful with this setting. Leave the default setting, which is No.
  4. Click the Open icon screen shot of the Open icon in the Action column for the directory that contains the data you want restore.
  5. Indicate which file(s) you want included in the restoration procedure.
  6. Click the Start Restore button to begin the restoration procedure.

Initiating a restoration from the Lotus Foundations Appliance control panel

This can only be done with a Lotus Foundations Appliance. All other hardware platforms must initiate a restore from the system's WebConfig menu.

Note: Initiate a restoration procedure from the control panel only if you want to perform a complete system restoration.

Press the Restore button. The display panel shows a 10-second countdown, during which time you can stop the restore process by pressing the Cancel button. After 10 seconds, the restore procedure commences and the display panel shows a progress bar.

Lotus Domino restoration procedures

Preliminary Steps

Before restoring your data, consider the following:

  1. Decide what data you want to restore. You may want to restore all data, or a specific Domino database or folder. For example, you may only need to restore a particular user's mail file, or perhaps all mail files. The procedures are similar for each case, as you have the option of choosing which folders or databases you want to restore. Note that user mail databases are stored in a folder called mail. A user's mail file has the .nsf extension. For example, if John Doe's username is jdoe, his mail file is mail/jdoe.nsf.
  2. Decide from where you want to restore the data. The notesbackup team contains the most recent backup, while idb contains older versions. The backup in the notesbackup team is a good place to restore from when a database has been corrupted or data accidentally deleted from it since the last time the Domino backup ran. If you need to go back further in time, you should restore from idb.
  3. Restoring idb data from Lotus Domino differs slightly from the standard idb restore process. Follow the instructions carefully to ensure a successful restoration of your Lotus Domino data.

Overview of the Lotus Domino restoration procedure

This is an overview of the procedure. Detailed steps to complete this procedure follow this overview.

  1. Stop the Lotus Foundations Branch Office server - Domino server add-on.
  2. Locate the desired data to restore. Use the instructions below corresponding to what you want to restore:
    1. Restoring data from idb
    2. Restoring data from the notesbackup team
  3. Copy the desired data from the backup, and paste it to the correct location. Use the instructions below corresponding to what you want to restore:
    1. Restoring all data
    2. Restoring a specific database
    3. Restoring a specific folder
    Note: Steps 3b and/or 3c may be repeated to restore as many databases and folders as required.
  4. Ensure correct file ownership.
  5. Restart the Lotus Foundations Branch Office server.

Detailed instructions

Step 1: Stop the Lotus Foundations Branch Office server - Domino server add-on

  1. Click Add-ons in the left side menu of WebConfig.
  2. Click the Edit icon screen shot of the edit icon in the Actions column for the Lotus Foundations Branch Office - Domion server add-on. The Add-on Settings page is displayed.
  3. Locate the Addon Automatic Start field and select the Disable radio button.
  4. Click Save Changes.
Note: Users cannot access email until the restoration is complete.

Step 2a: Restoring data from idb

  1. Click Backup in the left side menu of WebConfig.
  2. Click the Restore from Job icon screen shot of the restore from job icon in the Action column, and then click the Open Backup icon screen shot of the open backup icon in the Action column for the backup from which you want to restore data.
  3. Click the Open icon screen shot of the open icon for the Team notesbackup directory, then for the Files/ directory, and then for the notesdata/ directory. A directory labeled backup/ is displayed in the list.
  4. Select the Safe radio button for the backup directory, then click Start Restore. The restore time varies, depending on the amount of data that is contained in the folder.
    Note: Do not select the System Configuration option during a Domino restoration.
  5. From a Windows workstation, click Start -> Run.
  6. In the Open field, type the following text (where server_ip is the IP address of the server):
    \\server_ip\notesbackup\RESTORE\Files\notesdata
  7. You should see a folder named backup.

Step 2b: Restoring data from the notesbackup team

  1. From a Windows workstation, click Start -> Run.
  2. In the Open field, type the following text (where server_ip is the IP address of the server):
    \\server_ip\notesbackup\notesdata
  3. You should see a folder named backup.

Step 3a: Restoring all data

  1. Copy the backup folder (select the folder, then press Ctrl+C)
  2. Navigate to the following location (where server_ip is the IP address of the server):
    \\server_ip\notes
  3. Paste the backup folder in this location (click a blank area within the destination folder, then press Ctrl+V)
  4. Delete the folder labeled notesdata
  5. Rename the backup folder to notesdata by right-clicking the backup folder, clicking Rename from the pop-up menu, then typing notesdata.

Step 3b: Restoring a specific database

  1. Navigate to the desired database within the backup folder and copy it (select the database, then press Ctrl+C).
  2. Navigate to the following location (where server_ip is the IP address of the server):
    \\server_ip\notes\notesdata
  3. Navigate to the same folder from which you copied the database. For example, if you copied a database from the backup\mail folder, open the notesdata\mail folder.
  4. If the database you want to restore still exists in the destination, delete it (select the database and press Delete).
  5. Paste the database you are restoring in the destination (click a blank area within the destination folder, then press Ctrl+V).

Step 3c: Restoring a specific folder

  1. Navigate to the desired folder within the backup folder and copy it (select the folder, then press Ctrl+C).
  2. Navigate to the following location (where server_ip is the IP address of the server):
    \\server_ip\notes\notesdata
  3. Navigate to the same folder from which you copied the folder. If you copied the mail folder, you are already in the right folder.
  4. If the folder you want to restore still exists in the destination, delete it (select the folder and press Delete).
  5. Paste the folder you are restoring in the destination (click a blank area within the destination folder, then press Ctrl+V).

Step 4: Ensure correct file ownership

  1. Telnet into the Lotus Foundations server and log in as root or an administrative user.
  2. Change to the location of the Domino data:
    cd /home/notes/Files/notesdata
  3. Change ownership of all files:
    chown -R notes:notes . 
  4. Exit the Telnet session.

Step 5: Restart the Lotus Foundations Branch Office - Domino server add-on

  1. Click Add-ons in the left side menu of WebConfig.
  2. Click the Edit icon screen shot of the edit icon in the Actions column for the Lotus Foundations Branch Office - Domino server add-on. The Add-on Settings page is displayed.
  3. Locate the Addon Automatic Start field and select the Enable radio button.
  4. Click Save Changes.

idb hot swap

Hot swap is supported on SATA, SAS, SCSI, USB, and some IDE system configurations. The Lotus Foundations Appliance supports hot swap.

There are four possible hot swap messages that can appear on the display console:

The idb software leaves the idb disk unmounted until it needs to perform a backup or a restore. During this time, if you remove an idb disk from the Lotus Foundations server, the display panel continues to show idb HotSwap:OK until one of these events occurs:

After one of the above events occurs, Lotus Foundations detects that there is no idb disk installed and changes the display console message to No Backup Disk!

Swapping idb hard disks (with hot swap)

  1. Verify that the display console displays idb HotSwap:OK. idb hot swapping is only available on certain hardware platforms.
  2. Remove the idb disk from the server.
  3. Insert the new idb disk into the drive.

Lotus Foundations detects the new idb disk during either its next scheduled backup, or if you log in to WebConfig and click the Update Status button.

Swapping idb hard disks (without hot swap)

  1. Turn off the main power.
  2. Remove the disk from the server.
  3. Slide the new hard disk into the drive as far as you can, keeping the handle horizontal.
  4. Lower the handle and lock the drive in place with the provided hard drive key.
  5. Turn the main power back on.
  6. Press the power button.

Networking

First-time Lotus Foundations setup on a Lotus Foundations Appliance

See the Lotus Foundations Branch Office Getting Started Guide for instructions on the general setup of the Lotus Foundations Appliance. Advanced and less common configurations are included in this guide.

Connecting to the Internet - Ethernet ports 1 and 2

Use Ethernet ports 1 and 2 to connect to the Internet or to other segments of your local area network (LAN). Use an Ethernet cable to connect to your high-speed Internet routing device. Some devices might require the use of a crossover cable normally supplied with the device.

Figure 12. View of Ethernet ports 1 and 2
Photo of Ethernet connections 1 and 2

The figure above displays the locations of Ethernet ports 1 and 2:

  1. Ethernet port 1
  2. Ethernet port 2

If you are using your Lotus Foundations Appliance as a workgroup server without a direct connection to the Internet, it is possible to use Ethernet ports 1 and 2 to connect to other segments of the LAN. This is typically done to improve network throughput when large numbers of users are connected to Lotus Foundations.

Secondary segments must be physically separate from the primary network segment connected to the Ethernet port 0. You cannot connect all Ethernet ports to the same segment to improve network throughput.

Connecting an external dial-up modem

  1. Connect the cable included with your own external dial-up modem to the serial port on the back of the Lotus Foundations Appliance.
  2. Connect one end of the standard telephone cable to the external modem, and connect the other end to your telephone wall jack.

The external modem is auto-detected when the server goes through a power-up sequence.

Configuring Lotus Foundations network settings

Note: Some Lotus Foundations services are not enabled unless hard disks are configured through the WebConfig menu. For more information on configuring your disks, see Disk management.

Configuring general network settings

Follow these steps for general network configuration:

  1. Select Local Network from the left-side menu of the WebConfig console. This displays the Basic Setup tab on the Local Network Setup screen.

    Note that the Host Name and Domain Name fields are only editable if you have not installed Lotus Foundations Branch Office. After Lotus Foundations Branch Office is installed, those fields can no longer be modified.

    Figure 13. Local Network Setup section of the WebConfig console
    screen shot of the Local Network Setup screen of the webconfig console
  2. Indicate whether or not you want to display the system status page for non-admin users on users' personal WebConfig screens.
  3. Indicate whether or not you want the rsync server to be enabled. This option is for Unix-style clients only. Leave the default setting.
  4. Select the appropriate public DNS resolution option: If the public DNS server is enabled, internet hosts can resolve name-to-IP number queries for internet services provided by Lotus Foundations. Dynamic DNS resolution helps you to host Web and FTP services using an internet connection with a dynamic IP address.
  5. The DHCP server is disabled on all network interfaces by default and presumes there is no other DHCP server on the target LAN segment. Click the checkbox beside the interface name to enable this service.
  6. Indicate whether or not you want to enable the Simple Network Management Protocol (SNMP) server.
  7. If you enable the SNMP server, enter an appropriate SNMP community name.
  8. Indicate whether or not you want to enable the Network Information Server (NIS). Leave NIS disabled if you are using Windows. If you are using Unix or a similar system, leave it disabled unless you need NIS Service.
  9. Choose whether or not to restrict outgoing connections.
  10. Indicate whether or not you want to enable Lotus Foundations as a Network Time Protocol (NTP) Server.
  11. Lotus Foundations synchronizes its clock with a source on the Internet. To set the proper time, select your Time Zone from the drop-down list. Lotus Foundations attempts to auto-detect the proper time-zone and display its detected results for you.
  12. Click Save Changes.

Configuring advanced DHCP settings

To access the advanced DHCP settings, in the WebConfig console, select Local Network from the left-side menu. Select the DHCP Server Options tab.

DHCP lease length

For each interface that has DHCP enabled on it, a row is displayed listing the Interface, Length, and Actions you can perform on it. You can click the edit button on any of these rows to select the lease time that should be applied to that interface.

DHCP ranges

This is a list of ranges, giving Interface, the Range, and Actions you can perform on them. You can create a new DHCP range by clicking New DHCP Range.

  1. Choose a starting IP address and ending IP address that you want to have the DHCP server give out.
  2. Click Save Changes for it to take effect.

You can edit the ranges in a similar fashion by selecting the edit action button in the DHCP Ranges list.

Static DHCP leases

Static DHCP leases help you to choose which workstation receives a particular IP address by assigning that IP to its MAC Address.

  1. Click New Static DHCP.
  2. Enter the interface on which this static lease should occur.
  3. Enter the MAC address of the workstation to receive an IP.
  4. Enter the IP address that the workstation should receive.

You can edit leases in a similar fashion by clicking the edit button in the Action column of the Static DHCP leases list.

DHCP leases

You can see a table of current leases that have been served to workstations by clicking DHCP Leases. You can determine which MAC addresses are currently receiving specific IP addresses.

Configuring advanced network settings

To access the advanced network settings, in the WebConfig console, select Local Network from the left-side menu. Select the Advanced Setup tab.

The Advanced Setup tab helps you to configure some of Lotus Foundations more advanced features. Changing advanced network settings can potentially cause odd behavior in a network. For example, if you change a Lotus Foundations server's IP address or network mask to an incorrect value, you might not be able to reach it from your Web browser to change it back. If something goes wrong with these settings, you might be forced to change them back by logging into the local console menu or use the control panel on the front of a Lotus Foundations Appliance.

If you intend to use TunnelVision or IPsec, every network in each office location that is connected through a VPN must have a separate network subnet. If Lotus Foundations servers in various locations auto-configure their local network interfaces to the same subnet, you have to change your subnet number and IP address to a different value. Refer to Reconfiguring network devices for information.

Advanced network settings screen

Follow these steps to access the advanced network settings screen:

  1. Click Local Network in the left-side menu of WebConfig.
  2. Click Advanced Setup. The Advanced Setup screen is displayed.

Network devices

The following list describes the network devices section of the screen:

Table 7. Network device description
Column Description
Device Lists the network interfaces installed on the Lotus Foundations server. eth0 should be connected to the LAN. eth1 and eth2 should be connected to the Internet.
IP Address Lists the IP addresses to the interfaces.
Netmask Lists the IP network mask assigned to a particular interface.
Mode Describes how an IP address was assigned to an interface.
  • "Forced" means that a permanent IP address was assigned by an administrator. eth0 should always have a forced IP address.
  • "DHCP" means that a temporary IP address was assigned by the DHCP server. DHCP addresses change each time you turn-on your Lotus Foundations-powered server.
  • "NetMap" indicates that the IP address was automatically assigned by Lotus Foundations.
Trust An important parameter that needs to be set with careful consideration.
  • "Yes" signifies a trusting relationship with all hosts attached to that interface (meaning that no firewall protection is applied to that interface). eth0 is always configured as trusted.
  • "No" means that any traffic arriving at that interface is considered non-trusted. As such, appropriate firewall protection is applied. All Internet connections should be configured as non-trusted.
Action Button Click this button to display a screen where interface settings can be changed.

 

Reconfiguring network devices

  1. Select Local Network from the left-side menu of WebConfig. The Local Network Options screen is displayed.
  2. Click the Advanced Setup tab. The Network Devices list is displayed. Click an interface's Action button screen shot of the action (pencil) icon. The Network Settings screen for that interface is displayed.
  3. Optional: Enter a new IP address in the format 192.168.12.10.
  4. Optional: Enter a new network mask in the format 255.255.255.0.
  5. Optional: Indicate whether or not to trust computers on this network.
  6. Optional: Indicate whether or not you want Lotus Foundations to automatically choose an IP address and network mask.
  7. Optional: If you have a DHCP service, for example, your internet service provider and they specify that you need to have a DHCP Client ID when setting up your network, enter it here.
  8. Optional: Indicate whether or not you want Lotus Foundations to use this link as the default gateway.
  9. Click Save Changes.

Network routes

The Network routes section of the screen displays the IP routes known to Lotus Foundations. Because Lotus Foundations automatically discovers its network surroundings and sets up routing tables, you generally do not need to edit them. However, depending on your Internet connection, your ISP might assign you a new route, in which case you have to edit the default route.

Whether or not you have to change any route settings depends on your network setup and Lotus Foundations connection to the LAN and to the internet.

Deleting network routes

  1. Select Local Network from the left-side menu of WebConfig. The Local Network Setup screen is displayed.
  2. Click the Advanced Setup tab.
  3. Click the appropriate route's delete button screen shot of the delete icon.
  4. In the window that is displayed, confirm the deletion by clicking OK.

If the server prevents the route from being deleted, the server deems the route as required or important, as it must relate to another setting or subnet in the device list. If you continue to have issues, contact support. For information on Netscan, refer to the knowledge base article at the following URL:

http://kb.nitix.com/2565

Editing network routes

  1. Select Local Network from the left-side menu of WebConfig. The Local Network Options Setup is displayed.
  2. Click the Advanced Setup tab.
  3. Click the appropriate route's edit action button screen shot of the edit icon. The Modify Route screen is displayed.
  4. Optional: Enter a new destination IP address and netmask (in the format 192.168.12.0/24 ).
  5. Optional: Click the Interface drop-down and select the interface over which this network can be accessed.
  6. Optional: If this is not a local network route entry (eth1 or eth2), enter the network's gateway address.
  7. Click Save Changes.

Network configuration scenarios

Prior to configuring the server in any of these scenarios, you must first ensure that the server has been activated with the provided activation key. If your configuration scenario supports internet connectivity, you can activate at anytime. Remember, Lotus Foundations expires in 30 days without activation.

  1. Scenario: Lotus Foundations server as a workgroup server and high-speed gateway to the Internet
    Figure 14. Diagram of scenario 1
    Workgroup server and high-speed gateway network diagram

    Lotus Foundations auto-configures its parameters if the ISP uses DHCP as a means of automatic network configuration. In this case, there should be nothing for you to do on the Advanced Setup screen, although you can change the address of your local network interface if you want to do so.

    If the ISP assigns a unique static IP address, network mask, and default route, Lotus Foundations discovers the proper default route, but does not know which IP address to select. Although Lotus Foundations finds the available address and establishes a proper connection to the internet, you should change the IP address of the Internet interface to the address assigned by your ISP. You should do the same with the default route setting. If you run into problems configuring advanced network settings, contact technical support. For more information on configuring advanced network settings, refer to the list of Network and Internet knowledgebase articles at the following URL:

    http://kb.nitix.com/1426

    To change these settings:

    1. In the Network Devices section of the Advanced Setup screen, click the appropriate port's (for example, eth1) action button.
    2. The Network Settings screen is displayed. Enter the new IP address and click Save Changes.
    3. In the Network Routes section of the Advanced Setup screen, click the action button screen shot of the action (pencil) iconin the Default row, which the last entry in the list.
    4. The Modify Route screen is displayed. Change the default route and click Save Changes.
  2. Scenario: Lotus Foundations server as a workgroup server and dial-up gateway to the Internet
    Figure 15. Diagram of scenario 2
    Diagram of a workgroup server and dial-up gateway

    If Lotus Foundations has automatically chosen the proper IP addresses, there is nothing else for you to change. If you want to change the Lotus Foundations-powered server's local IP addresses, you can do so by clicking the edit button on the line describing the parameters for the Ethernet 0 interface.

    The default route is automatically determined when Lotus Foundations dials in to the Internet. In this case, there should be no default route entry in the Routes Table.

Configuring your internet connection

Configuring a cable modem

No extra tasks are required for configuring a cable modem.

Configuring a DSL connection

  1. Select Dial-up from the left-side menu of WebConfig. The Dial-up Networking Setup screen is displayed.
  2. Click the action button in the appropriate ADSL row (eth1 or eth2 only). The ADSL Dialer Options screen is displayed.
  3. Enter the Internet account username provided by the ISP.
  4. Enter the account password provided by the ISP.
  5. Re-enter your password to ensure it was entered correctly. If the passwords do not match, you are asked to re-enter your password in both fields.
  6. Optional: Enter your gateway IP address. Leave this blank if you do not know the address.
  7. Indicate whether or not you want to enable the connection.
  8. Click Save Changes.

Configuring a dial-up modem

The Lotus Foundations Appliance does not come with pre-installed modems. The following instructions are for configuring services if you have a device attached which is auto-detected by the Lotus Foundations server. Refer to your hardware vendor for details on installing third-party components.

  1. Select Dial-up from the left-side menu of WebConfig. The Dial-up Networking Setup screen is displayed.
  2. Optional: If you have an external modem connected, you might need to click Detect Modems to initiate the Modem Detection Cycle. Refer to DoubleVision for information on using multiple dial-up modems.
  3. Click the Modem #1 action button. The Dial-up networking setup screen is displayed.
  4. Enter the phone number provided by your ISP. If you have to dial 9 to get an outside line, enter this number. For example, enter: 9, 123-123-1234.
  5. Enter the Internet account username provided by your ISP.
  6. Enter the account password provided by your ISP.
  7. Re-enter your password to ensure that it was entered correctly. If the passwords do not match, you are asked to re-enter your password in both fields.
  8. Indicate the number of idle seconds before automatic disconnection.
  9. Select the appropriate dialing mode:
  10. Indicate whether or not you want your Lotus Foundations server to emulate Windows Dial-up Networking.
  11. Indicate whether or not users are able to establish a remote dial-in modem connection to the internal network.
  12. Click Save Changes.

DoubleVision

What is DoubleVision?

DoubleVision is a Lotus Foundations feature that helps you to configure two or more internet connections. For example, you can combine a cable modem and an ADSL link, two ADSL links, multiple dial-up modems to the same ISP or different ISPs, or any combination of internet connections supported by Lotus Foundations.

There is no single place to configure DoubleVision. Instead, it is automatically configured when more than one internet connection is used at the same time.

Note: To activate DoubleVision, you must have at least two gateway connections. You can choose a default connection.

What DoubleVision offers

Using DoubleVision technology, Lotus Foundations helps you to set up multiple internet connections and use them all simultaneously. DoubleVision does not bond your internet connections into a single pipe. It manages the connections independently.

Table 8. Advantages to DoubleVision
Advantage Description
Increased performance Internet traffic is increased by being able to use the bandwidth of both lines. You cannot specify which connection is used. It is automatically chosen by Lotus Foundations.
Increased reliability If one ISP's internet connections fails, the remaining ISP's connection stays functional. This means that your downtime is limited, also known as fail-over, or redundant connectivity.
Last Resort dial-up mode If one or more of your high-speed internet connections fail, Lotus Foundations can dial your modem automatically and use dial-up access instead. When your high-speed links are restored, the modem automatically disconnects after it verifies that the high-speed connections are stable and active. The same applies to high-speed connections if you choose to use them as a last resort connection.
Dynamic DNS Integration If you are using Dynamic DNS, Lotus Foundations automatically publishes appropriate DNS names so people can always find your Web site, even if your high speed links are down and you need to use a dial-up connection. See Domain Name Service for more information.
Full automation You do not have to reconfigure any client workstations on your local network to take advantage of DoubleVision. DoubleVision is fully automated and managed by the server. No human intervention is required to activate and deactivate internet services when they fail or are restored. Lotus Foundations automatically takes care of these situations.

 

Modem connections

Since modems are normally much slower than other internet connections, you probably do not want to use a modem as your primary connection. Instead, you can configure your modem as a "last resort" option, meaning that your modem only connects if one or more of the high-speed connections fails.

If a modem is configured as the primary connection, it connects to the internet even if high-speed connections are available. This is useful if you want to test the modem connection.

How internet failover and DoubleVision work

What internet failover does

What DoubleVision Does

DoubleVision quick summary

Virtual private networks

Private networks

In the past, private networks were created by using routers to connect different office locations through dedicated lines. This procedure is often called a wide area network (WAN). Conventional private networks are illustrated like this:

Figure 16. WAN private network
diagram of a private network

Virtual private networks

TunnelVision enables you to create a virtual private network (VPN) using the internet instead of a dedicated WAN connection for server-to-server or network-to-network connections. A VPN is illustrated as in the following diagram:

Figure 17. VPN topology
diagram of a virtual private network

For remote and mobile employees, see Remote access services for instructions on setting up client connections using VPN.

Making a virtual network private

In a conventional private network, the company owns all the routers, all the computers, and all the phone lines involved. Because the only people using the network are employees, the network is secure, at least in theory.

The internet, on the other hand, is connected to any number of businesses and organizations. As private data passes through the internet, it is possible that people might intercept what is being sent. To prevent this from happening, all of the data that passes through a VPN is encrypted with the strongest encryption technology available: 1024-bit RSA and 128-bit Blowfish algorithms. Such encryption makes it difficult to access the data in your transmissions.

VPN network topologies

Topology refers to the shape of a network or the network's layout. How different nodes in a network are connected to each other and how they communicate are determined by the network's topology. A VPN enables organizations to interconnect their offices securely. Applications and data can be readily shared throughout the VPN network if desired. For example, you could have the accounts departments of each branch connected to each other or each department could be connected to a central point.

TunnelVision can work in either a 'fully-meshed' topology or a 'non-meshed' topology.

Fully-meshed topology

In a fully-meshed topology, devices are connected with many redundant interconnections between network nodes. In a true meshed topology, every node has a connection to every other node in the network. An advantage of such a network would be that no branch is reliant upon a single connection.

Figure 18. Diagram of a fully-meshed topology
diagram of a fully meshed topology

Non-Meshed Topology

In a non-meshed or 'hub-and-spoke' topology all devices are connected to a central hub or headquarters that dictates the access rules of the VPN to the other branches. Nodes communicate across the network by passing data through the hub. A typical application would be to implement a terminal services solution using the headquarters as the gateway for the branch sites.

Figure 19. Diagram of a non-meshed topology
diagram of a non-meshed topology

How TunnelVision works

A VPN enables all of the computers on two networks to communicate with each other. For this to happen, you have to first configure their subnet addresses.

When you install Lotus Foundations, the IP addresses used on the local network do not really matter. Internet standards recommend that all IP addresses that are owned by internal business networks (and not used on the internet itself) begin with 192.168. The third part of the IP address specifies which private subnet number you are using, and the fourth part identifies an individual computer on the network. In special circumstances, however, you can use any subnet number at all (the first three parts of the IP address). Non-routable IP networks can be any of the following:

The important thing is that the Lotus Foundations server and the computers on the local network have the same subnet number and unique IP addresses.

Network address translation (NAT)

When you communicate with other computers on the internet, Lotus Foundations uses network address translation (NAT) to give each connection a valid, unique IP address that does not conflict with other networks.

But for a VPN, Lotus Foundations should not use NAT because then only two addresses are visible: Lotus Foundations server #1 and Lotus Foundations server #2. Instead, Lotus Foundations should pass addresses on each network through to the other network unchanged.

For this to happen, you need to assign different subnet numbers to each Ethernet network involved in the VPN. For example, use 192.168.1 for Network #1 and 192.168.2 for Network #2. That means each computer on Network #1 has an address starting with 192.168.1, and each computer on Network #2 has an address starting with 192.168.2.

The steel pipe (or tunnel)

Network #1 is connected to the internet through Lotus Foundations server #1 and has the subnet number 192.168.1. Network #2 is connected to the internet through Lotus Foundations server #2 and has the subnet number 192.168.2.

Gateway settings work when a computer on the Ethernet sends packets directly to another computer if its subnet number is the same. That means that 192.168.1.15 transmits directly to 192.168.1.46, since they are both on the same subnet. However, 192.168.1.15 cannot send packets directly to 192.168.2.20 - the subnet numbers are similar, but they are not the same. The station then sends the data through its default gateway: Lotus Foundations server #1.

This is where TunnelVision is used, as long as you have configured the Lotus Foundations servers to create a VPN. When TunnelVision starts, it creates an encrypted connection between the two Lotus Foundations servers through the Internet. This connection is sometimes called a steel pipe because, like a true steel pipe, it is hard to see what is inside or to break through it. More often it is known as a tunnel.

Lotus Foundations server #1 treats data addressed to Network #2 from its local Ethernet in a special way. Rather than just passing the data to the ISP, Lotus Foundations encrypts it and sends it through the tunnel. When Lotus Foundations server #2 receives the encrypted data, it decrypts the information and forwards it on to Network #2 as if it had arrived directly from Network #1. That way, Network #1 can communicate securely with Network #2 without any need for special changes to individual workstations.

Creating a VPN (server-to-server)

Because the Lotus Foundations server does most of the work for you, creating a VPN is much easier than it sounds. All you have to do is create the encrypted tunnel.

Using unique subnet numbers

Each Ethernet network in the VPN must use a different subnet number. Use any of the networks from 192.168.1 to 192.168.254, since these numbers are specifically reserved for private use. As noted in How TunnelVision works, there are three available address ranges for non-routable IP networks.

The master server needs an IP address or FQDN

The only way to find someone on the internet is to know their IP address. This can be accomplished with either a static IP address (a static IP address is guaranteed never to change so people on the Internet can always find you) or through the use of a fully qualified domain name (FQDN) such as server.domain.com. The DNS system translates the FQDN into an IP address. This is particularly useful for systems that utilize dynamic DNS.

The Lotus Foundations Dynamic Domain Name System (DDNS) feature automatically updates DNS information when a new IP address is assigned to a network, enabling you to publish DNS entries and provide internet services even if you have a dynamic IP address.

To create a connection between two Lotus Foundations servers, someone needs to act as the client and someone as the master server. It is similar to a phone call to an ISP: you, the client, need to know their phone number, but they, the server, do not need to know yours. With TunnelVision, you have a similar situation: the server side, accepting a connection, needs a static IP address or FQDN, while the client side can have either a static or dynamic IP address.

Only one Lotus Foundations server, usually the computer with the fastest internet connection at the head office, needs to act as the server and have a static IP address or fully-qualified domain name. All the others can simply act as clients.

To obtain a static IP address, talk to the ISP. Dynamic DNS can be used in place of a static IP address. Refer to Domain Name Service for more information.

Configuring a TunnelVision master server

Ensure that the Lotus Foundations server that you are configuring as the Master server has a static IP address or has a fully-qualified domain name.

  1. Select VPN from the left-side menu in WebConfig. The VPN Setup screen is displayed.
    Figure 20. VPN Setup screen
    screen shot of the VPN Setup section in the webconfig console
  2. Select Enable for the PPTP Server setting.
  3. Select Enable for the TunnelVision setting.
  4. Select Yes for the TunnelVision: Use Fully Meshed Mode setting to run TunnelVision in a Fully Meshed mode and No to run it in a non-meshed mode.
  5. Leave the TunnelVision: Address of Master Server field empty since the master server does not initiate connections.
  6. Enter a password that the server and client use to prove to each other that they are trusted.
  7. Re-enter the password to ensure it was entered correctly.
  8. Click Save Changes.

Configuring a TunnelVision client

A Lotus Foundations server does not need a static IP address to act as a TunnelVision client, but it needs to know the static IP address or fully-qualified domain name of the master server.

To find this information, select Local Network from the left-side menu in the WebConfig console on the master server. Click Advanced Setup tab. Note the address assigned to eth1.

  1. Select VPN from the left-side menu in WebConfig. The VPN Setup screen is displayed.
  2. Leave the default PPTP Server setting.
  3. Select Enable for the TunnelVision setting.
  4. Select Yes for the TunnelVision: Use Fully Meshed Mode setting if you are running TunnelVision in a fully-meshed mode, and No if you are running it in a non-meshed mode.
  5. In the TunnelVision: Address of the Master Server field, enter the master server's static IP address or fully-qualified domain name.
  6. Enter the password that was used in step 6 of Configuring a TunnelVision master server.
  7. Re-enter the password to ensure it was entered correctly.
  8. Click Save Changes.

To configure another Lotus Foundations server as a client, simply repeat this process.  

TunnelVision status

The System Status screen always displays the status of active VPNs. You might need to click the browser's Refresh button to see the latest information.

The idle time-out

If either end of the tunnel does not receive any data for approximately 20 minutes, it assumes that one end has disconnected from the Internet or that the tunnel is no longer needed.

If one end of the tunnel is still online, it tries to rebuild the connection automatically. Since this only takes a few seconds and happens only when the tunnel has been idle for a long time, this should not affect you. However, this behavior can often cause the VPN Tunnel's status light to turn yellow or red. This is not a sign of malfunction.

IPsec

IPsec is a server-to-server VPN technology, similar to TunnelVision. IPsec is the recommended technology for Lotus Foundations Branch Office.

Known configurations

The IPSec functionality in Lotus Foundations uses the industry standard ISAKMP/IKE protocol and is compatible with other standard IPSec devices.

Adding an IPsec route

To create a new IPsec route, follow these steps:

  1. Select VPN from the left-side menu WebConfig.
  2. Select the IPsec Setup tab.
  3. Select Add New IPsec Route. The Create IPsec Route screen is displayed.
    Figure 21. Create IPsec Route screen
    screen shot of the create IPsec route screen in the WebConfig console
  4. In the Remote Server field, enter the public IP address or the fully-qualified domain name (FQDN) of the remote server.
  5. To include a private subnet behind the remote server's firewall, enter the internal subnet containing the internal IP address of the remote unit in the Remote Subnet field. For example, if the unit's internal IP address is 192.168.10.1 with a subnet mask of 255.255.255.0, enter 192.168.10.0/24.
  6. Enter a remote IKE key. This is a password that should be unique and entered on both ends of the IPsec connection.
  7. Click Yes to enable the Perfect Forward Secrecy (PFS) feature. The two ends do not negotiate this automatically, so make sure that the setting is the same on both ends.
  8. For Enable this connection, click Yes.
  9. Click Save Changes.

Adding an anonymous incoming connection IPsec route

Creating an anonymous IPsec route eliminates the need for statically identifying the remote server IP address.

To configure an anonymous connection, follow these steps:

  1. Select VPN from the left-side menu in WebConfig.
  2. Select the IPsec Setup tab.
  3. Select Add New IPsec Route. The Create IPsec Route screen is displayed.
    Figure 22. Create IPsec Route screen
    screen shot of the create IPsec route screen in the WebConfig console
  4. Enter 0.0.0.0 in the Remote Server field. The Lotus Foundations server must have a static IP address.
  5. To include a private subnet behind the remote server's firewall, enter the internal subnet containing the internal IP address of the remote unit in the Remote Subnet field. For example, if the unit's internal IP address is 192.168.10.1 with a subnet mask of 255.255.255.0, enter 192.168.10.0/24.
  6. Enter a remote IKE key. This is a password that should be unique and entered on both ends of the IPsec connection.
  7. Click Yes to enable the Perfect Forward Secrecy (PFS) feature. The two ends do not negotiate this automatically, so make sure that the setting is the same on both ends.
  8. For Enable this connection, click Yes.
  9. Click Save Changes.

Editing an IPsec route

To edit an existing IPsec route, follow these steps:

  1. Select VPN from the left-side menu in WebConfig.
  2. Select the IPsec Setup tab.
  3. Select the appropriate IPsec route's edit icon screen shot of edit icon on the IPsec Setup screen.
  4. The Modify IPsec Route screen is displayed.
  5. In the Remote Server field, enter the fully-qualified domain name or IP address of the remote server that you want to connect to.
  6. To include a private subnet behind the remote server's firewall, enter the internal subnet containing the internal IP address of the remote unit in the Remote Subnet field. For example, if the unit's internal IP address is 192.168.10.1 with a subnet mask of 255.255.255.0, enter 192.168.10.0/24.
  7. Enter a remote IKE key. This is a password that should be unique and entered on both ends of the IPsec connection.
  8. Select Yes to enable the Perfect Forward Secrecy (PFS) feature. The two ends do not negotiate this automatically, so make sure that the setting is the same on both ends.
  9. Click Save Changes.

Setting up third-party IPsec clients

With the large number of IPsec servers available, configuration parameters cannot be provided for each device. The following information does, however, provide the best configuration for enabling a Lotus Foundations server to create a virtual private network (VPN), with third-party devices.

Lotus Foundations setup

For a Lotus Foundations setup, use these configurations:

Third-party IPsec client setup

For a third-party setup, use these configurations:

Remote access services

What is RAS?

Remote Access Services (RAS) is a feature that enables you to access an internal network while at home or on the road. You can take advantage of RAS with the following:

Windows typically has a PPTP client built-in. You might have to purchase a separate software package if you are using a Macintosh.

To establish a remote connection, users must have PPTP or dial-in access. Refer to the Creating users section in the User & Team Management chapter for more information.

PPTP - client-to-server VPN service

Configuring VPN service on Lotus Foundations

To configure the virtual private network (VPN) service on Lotus Foundations, perform these steps:

  1. Click VPN in the left-side menu of WebConfig. The VPN Setup tab of the VPN Setup page is displayed.
  2. In the PPTP Server field, select Enable to enable the Point-to-Point Tunneling Protocol (PPTP) server.
  3. Click Save Changes.

Establishing a VPN connection

To establish a VPN connection to a Lotus Foundations server, you need to know your username and password and the Lotus Foundations server's domain name or Internet Protocol (IP) address.

Windows 2000/XP/Vista

To establish a VPN connection on a Windows 2000, Windows XP, or Windows Vista machine, follow these steps (these steps vary slightly for Windows XP and Windows Vista):

  1. In Windows, go to Network Connections.
  2. Select New Connection Wizard and click Next.
  3. In the Network Connection Type window, select the Connect to the network at my workplace, then click Next.
  4. In the following Window, select Virtual Private Network connection, then click Next.
  5. In the Connection Name window, enter a name for the location to which you are connecting.
  6. In the Public Network window, select Do not dial the initial connection and click Next.
  7. In the VPN Server Selection window, enter the public IP address of the Lotus Foundations server, or enter the host name followed by the domain name. Click Next.
  8. Click Finish. Now that the VPN connection has been created, you need to configure the settings before connecting to the remote network.
  9. Open the VPN connection. Before logging in for the first time click Properties.
  10. Click the Networking tab and select PPTP VPN from the Type of VPN drop-down box. Click OK. This only needs to be set once for each connection.
  11. Log in using the provided Lotus Foundations username and password and click OK. Various messages display such as Verifying the connection... and Registering the user... prior to a complete connection. You can log in through PPTP as any user on the Lotus Foundations server, so long as the user has PPTP enabled from the Users menu.

Disconnect a PPTP connection

  1. Click Status in the left-side menu of WebConfig. Scroll to the Services Status section. The PPTP Connections line displays the status of all PPTP connections. If there are active connections, a Details link is displayed.
  2. Click the Details link. The Active PPTP Users screen is displayed.
  3. Click the Delete action icon of the user whose PPTP connection you want to disconnect.
  4. A window is displayed that asks Are you sure you want to disconnect username? Click OK to disconnect the PPTP connection.

Dial-in service

Configuring Dial-in Service on Lotus Foundations

  1. Click Dial-up in the left-side menu of WebConfig. The Dial-up Networking Setup page is displayed.
  2. Click the edit icon screen shot of the edit icon in the Action column for the appropriate modem.
  3. A second Dial-up Networking Setup page is displayed.
  4. In the Allow Dial in connections field, select Yes.
  5. Click Save Changes.

Configuring Dial-in Service in Windows

  1. Click Start -> Settings -> Control Panel. Double-click the Add/Remove programs icon.
  2. The Add/Remove Programs Properties window is displayed. Select the Windows Setup tab.
  3. Select Communications from the Components list and click Details.... A second Components list is displayed, showing the communications components that are already installed and those that can be installed.
  4. Select Dial-Up Networking from the Components list.
  5. Select Dial-Up Networking and click OK.
  6. The Windows Setup window is re-displayed. Click Apply. The software is installed automatically.
  7. Reboot your computer when the software is finished installing.

You might be asked to insert your Windows disk for additional software components to be loaded. Follow the instructions provided by the operating system during this process.

Establishing a dial-in connection

When a user dials into the Lotus Foundations server, their username is displayed in the Internet Status field in the Services Status section of Status page in the WebConfig console for the duration of the connection. The administrator can choose to terminate the user's connection from this page.

To establish a dial-in connection to your network, you need to know your Lotus Foundations user ID and password and the phone number of a modem that is connected to an external phone line. Depending on your Internet connection, it might take longer than normal to complete network requests.

To establish a dial-in connection on a Windows machine, follow these steps:

  1. Select Start -> Programs -> Accessories -> Communications -> Dial-up Networking.
  2. Double-click the Make New Connection icon.
  3. Enter a name for the dial-in connection. Click Next.
  4. Enter your area code, phone number, and country code.
  5. Click Next.
  6. Click Finish. You have created an icon that activates a dial-in connection to the internal network.
  7. Establish a dial-in connection by double-clicking the icon that you created in the previous step.
  8. Enter your Lotus Foundations login name and password. Click Connect. A window showing you the progress of the connection is displayed. An icon showing traffic between your workstation and the Lotus Foundations server to which you are connected to is displayed in the bottom right corner of your screen when you are connected to the local network.
  9. To terminate the connection, double-click the icon. Select Disconnect in the window that is displayed.

Terminating a connection from WebConfig

When a user dials into the Lotus Foundations server, their username is displayed in the Internet Status field in the Services Status section of Status page of WebConfig for the duration of the connection. The administrator can choose to terminate the user's connection from this page.

Workstation viewer

What is the workstation viewer?

The workstation viewer is a Lotus Foundations subsystem that can list the workstations and servers that are connected through the local network. The Workstations page tells you which computers are on the network, their names and Internet Protocol (IP) addresses, and who is logged on.

If a workstation can be administered remotely using virtual network computing (VNC), the remote administration program can be accessed from WebConfig.

Accessing the workstation viewer

To access the workstation viewer, follow these steps:

  1. Click Workstations in the left-side menu of WebConfig. The Workstations page is displayed.
  2. No workstations are displayed in the list by default. Click New Scan to view an updated list of workstations.
  3. Click Refresh after a few seconds to view the updated list. Workstations are displayed in the list if they are connected to the network. Refresh changes back to New Scan when the scan is complete.
  4. Workstations can be sorted by IP Address or Workstation Names by clicking the appropriate column title.

Remote administrative access to workstations

Using free Windows software called Virtual Network Computing (VNC), you can configure Windows, Macintosh, and UNIX workstations so they can be controlled remotely from a central workstation. If users need help or settings need to be changed, the VNC software provides an alternative to an administrator having to physically go and sit in front of the workstation to solve the problem.

Computers with a VNC remote administration server installed are displayed with the words Remote Admin next to them on the Workstations page.

Configuring VNC

There are two parts to configuring remote administration, the VNC server and the VNC viewer. In a VNC environment, the VNC server resides on the target workstation.

  1. VNC Server - Should be installed on every user's workstation.
  2. VNC Viewer - Should be installed on the administrator's workstation.

Once the servers and viewers are configured, clicking the Remote Admin link on the Workstations screen connects you to the remote virtual network computing (VNC) server and displays the remote desktop.

Configuring the VNC server (on the client workstation)

To configure the VNC server, perform these steps:

  1. To download VNC, go to one of the following sites:
  2. The file comes in a zipped format. Unzip the file in a temporary location for installation. Run the Setup program and follow the instructions. Accept all defaults during the installation process.
  3. When the installation is finished, reboot the workstation.
  4. Click Start -> Applications -> VNC -> Start VNC (App mode).
  5. The first time you start VNC you have to set up a password, which is needed to connect to your workstation.
  6. When VNC is active, a small VNC icon displays in the bottom right corner of your screen.

Configuring the VNC viewer (for the administrator's workstation)

To configure the VNC viewer, perform these steps:

  1. Download VNC from the Internet and configure the VNC server.
  2. Look for vncviewer.exe and copy it to an easily navigable location, such as C:\Windows.
  3. Click Start -> Programs -> Windows Explorer.
  4. From the Tools menu, select Folder Options.
  5. Click the File Types tab. The File Types window is displayed.
  6. Click New Type.... The Add New File Type window is displayed.
  7. Enter a description of the file type (such as VNC Viewer Admin) in the Description of Type field.
  8. Enter vnc in the Associated extension field.
  9. Enter application/x-vnc in the Content Type (MIME) field.
  10. Click New. The New Action window is displayed.
  11. Enter Open in the Action field.
  12. Enter the following line in the Application used... field: c:\windows refers to the location where VNC has been installed. The quotations around "%1" are required.
    c:\windows\vncviewer.exe /config "%1"
  13. Click OK. VNC Viewer Admin is displayed in the Registered file types list of the File Types screen.

Domain Name Service

What is DNS?

Domain Name Service (DNS) is the protocol used to convert Internet domain names into Internet Protocol (IP) addresses. If DNS is configured, users can access information on the local network and the Internet using domain names instead of specific IP addresses.

Configuring DNS services can be complicated because it often requires dealing with outside organizations called domain registrars. If you are uncertain about issues related to DNS, ask your Internet service provider (ISP) to help you.

DNS Services

Lotus Foundations runs two different kinds of services for Domain Name Service (DNS):

Configuring Public DNS

This public Domain Name Service (DNS) option only controls the DNS publishing server and how people outside your local network communicate with it. The DNS publishing server is always active for computers on your local network.

To configure the public DNS, follow these steps:

  1. Click Local Network in the left-side menu of WebConfig. The Basic Setup tab of the Local Network Options page is displayed.
  2. In the Act as Public DNS Server field, select one of the following options: No, Yes, or Dynamic.
  3. Click Save Changes.

How the DNS system works

DNS hierarchy

The Internet Domain Name Service (DNS) server network is arranged as a hierarchy, in which a single root domain, sometimes called dot (.), links to the set of top-level domains, such as .com and .org. Each of the top-level domains contains a link to each of the second-level domains, such as ibm.com and mydomain.org. Third- and fourth-level domains are less common and are used in large organizations like universities.

You most likely publish a second-level domain name such as example.com. When you do that, your DNS server, if enabled, automatically publishes the names inside example.com, such as www.example.com and mail.example.com .

Domain registrars

However, there is still a part that must be done manually. In this example, you have to create a link on the .com server to ask your second-level domain to be referred to your Lotus Foundations server's Internet Protocol (IP) address. To do this, you need to visit a domain registrar to make sure that your domain name is not already being used by someone else, as well as to give them the outside IP address of your Lotus Foundations server.

To register a domain name, your Lotus Foundations server must have a static IP address. Most Internet service providers (ISPs) provide this service for an additional fee. Dynamic DNS (DDNS) can be used in place of a static IP address. Refer to Dynamic DNS in this chapter for more information.

When you enable your public DNS server and register with a domain registrar, people should be able to look up the IP address associated with your domain name. To test this, follow these steps:

  1. Click Web Server in the left-side menu of WebConfig.
  2. Select Enable in the Web Server field of the Basic Setup tab.
  3. Ask someone outside the local network if they can view your domain.

Dynamic DNS

Dynamic DNS is a Lotus Foundations feature that enables you to publish Domain Name Service (DNS) entries and provide Internet services even if you have a dynamic Internet Protocol (IP) address, as opposed to a static IP address.

When you register your domain with a registrar, you give them the address of the primary server and backup server, which already have static IP addresses. When your Lotus Foundations server connects to the Internet, it automatically informs the servers about your current IP address and asks them to publish your up-to-date DNS information.

You need to provide a domain registrar with the following DNS server addresses:

  1. dyndns1.ivivanet.com
  2. dyndns2.ivivanet.com
  3. dyndns3.ivivanet.com

After you provide a domain registrar with the address of your primary and backup servers, you then need to set your public DNS server to Dynamic. Lotus Foundations does the rest of the configuration automatically.

Manually creating DNS entries

Based on the services you have enabled, Lotus Foundations automatically decides which Domain Name Service (DNS) names to publish. For example, if your domain name is example.com, and the Enable Web Server option is set to Yes (not Trusted Hosts Only), then Lotus Foundations automatically publishes the DNS name www.example.com as a pointer to your Web server. Similarly, if you enable the Simple Mail Transfer Protocol (SMTP) e-mail delivery server, it publishes the name mail.example.com.

Although Lotus Foundations publishes names automatically, you might want to occasionally add extra names to your DNS server. You might also want to add an entry that enables people to access your site without typing www. before the address.

Changing DNS information with a domain registrar can often take 24 - 72 hours to replicate through the DNS backbone.

Types of DNS entries

You can create four kinds of DNS entries:

Creating a DNS entry

To create a private DNS entry, follow these steps:

  1. Click DNS in the left-side menu of WebConfig. The Public Entries tab of the DNS Entries page is displayed.
  2. To list, create, or edit your private DNS entries, click the Private Entries tab.
  3. To add a private DNS entry, click Add Private Entry. The Add DNS Entry page is displayed.
  4. In the Name field, enter a name for the entry.
  5. In the Entry Type field, select one of the following: Copy from Nameserver (NS), Mail Exchanger (MX), Address (A), or Dynamic Redirect (DR).
  6. In the Value field, enter the target IP address.
  7. Click Save Changes.

Editing an existing DNS entry

To edit an existing private DNS entry, follow these steps:

  1. Click DNS in the left-side menu of WebConfig. The Public Entries tab of the DNS Entries page is displayed.
  2. To edit your private DNS entries, click the Private Entries tab.
  3. Click the edit icon screen shot of the edit icon in the Action column for the entry. The Modify DNS Entry page is displayed.
  4. Make the appropriate changes and click Save Changes.

Fast/Port Forward

What is Fast/Port Forward?

The Fast/Port Forward technology in Lotus Foundations enables you to forward Internet traffic from a specific address and interface to another address and interface. A subsystem that performs this function is usually called a proxy server.

When computers on the Internet access services on your internal, protected network, they "talk through" your Lotus Foundations server. Fast/Port Forward makes sure that these untrusted computers can only access the information and services that you want them to access.

If Fast/Port Forward is disabled, no one can see anything on your local network because Lotus Foundations acts as a firewall. If you enable Fast/Port Forward, you are making a protected "hole" in your firewall that enables computers on the outside to access your network. To decide whether you want to use Fast/Port Forward, you need to decide if enabling Fast/Port Forward is worth the added security risk.

Note: Because you are affecting the firewall security of your network, it is very important that you understand what you are doing while configuring Fast/Port Forward.

Fast/Port Forward belongs to a class of programs known as proxy servers. It is the Lotus Foundations inbound proxy server. Its job is to accept Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) connections on one address and port, then forward them off to some other address and port.

Introduction to TCP/IP

Each computer on the Internet must have a unique Internet Protocol (IP) address. Network protocols come in layers and IP is just one of those layers. The job of IP is to get data, split it into small chunks called packets, and then transport those packets from one computer to another on the Internet.

When the computer receives an IP packet, it needs to figure out what service it belongs to and which open connection in which it is involved. For that, it uses two higher-level protocols known as Transmission Control Protocol (TCP) and User Datagram Protocol (UDP). TCP and UDP introduce port numbers that specify where the data is supposed to go and how the computer is supposed to handle it.

Fast/Port Forward can handle both TCP and UDP. It processes them differently from each other, but you do not need to worry about this for configuration purposes.

User Datagram Protocol (UDP)

Using UDP is very much like sending a telegram. You receive a message, and you can send a reply. The Domain Name Service (DNS) mentioned earlier uses UDP. One computer sends a message asking to translate a name (for example, www.example.com) into a number. The answering DNS server sends a message saying that the IP address of www.example.com is 192.168.1.1.

Transport Control Protocol (TCP)

Using TCP is very much like making a telephone call. A person calls you, and you answer. You go through an introductory sequence, you have a conversation, and then you finish the call (or in TCP terminology, you close the connection). TCP is used for more complicated network tasks, such as Web browsing.

Proxy servers

Lotus Foundations acts as a firewall, meaning that it blocks computers on the Internet from having access to your private servers.

If you want to make a service available to the outside world, Fast/Port Forward controls the connection for you. When someone outside wants to access the service, they send the request to a port on your Lotus Foundations server. Fast/Port Forward then connects them to the service. This process has two connections: one from the client to the Lotus Foundations server, and another from the Lotus Foundations server to the service. When either the client or the server transmits information, Lotus Foundations forwards it to the opposite end of the connection.

As a result, you need to know the addresses and port numbers of both the source of the information and the destination of the information. Lotus Foundations receives connection requests from the source address and forwards them to the destination.

If you want to use Fast/Port Forward, you probably already have a clear idea of what your destination address is. The source, however, might be more difficult to determine and ultimately depends on how your Internet Protocol (IP) address is configured.

Static and dynamic IP addresses

A person trying to access Fast/Port Forward services through your Lotus Foundations server must know your assigned IP address to locate you on the Internet. Each time you connect to the Internet, your Internet service provider (ISP) assigns you an IP address. Dynamic IP addresses are inconvenient for use with Fast/Port Forward because your address changes each time you connect, making it difficult for your clients to find you.

If you specifically ask for one, your ISP can give you a static IP address (static IP addresses do not change). Once you have a working static IP address, you can add it to a Domain Name Service (DNS) server, which converts your domain's readable name into its IP address.

Configuring Fast/Port Forward

You can configure Fast/Port Forward once you know your source and destination addresses. If you still are not sure where the addresses come from, a few examples are displayed in Forwarding scenarios.

Note: Remember that you decrease firewall security when you enable Fast/Port Forward.

  1. Log in to WebConfig with your administrator username and password.
  2. Click Fast/Port Forward in the left-side menu of WebConfig. The Fast Forward Setup page is displayed, showing the list of addresses being forwarded. This list might be empty if no addresses are being forwarded.
    Figure 23. Fast Forward Setup page of WebConfig
    screen shot of the fast forward setup page of webconfig

Creating a new forward

To create a new forwarding entry, follow these steps:

  1. Click Add Forwarding Entry. The Add Forward page is displayed.
    Figure 24. Add Forward page for Fast/Port Forward
    add forward page for fast/port forward
  2. Enter the source address and port number in the From Address and From Port fields. You can only attach one forward connection to any given source address and port.
  3. Enter the destination address and port number in the To Address and To Port fields. Ensure that you have entered the destination information correctly. If you forward connections to a server that is not answering, Fast/Port Forward drops the connection.
  4. Enter a description of the Fast/Port Forward to keep track of its purpose or destination.
  5. Click Save Changes.

Editing a forward

To edit a forwarding entry, follow these steps:

  1. Click Fast/Port Forward in the left-side menu of WebConfig.
  2. On the Fast/Port Forward page, click the edit icon screen shot of the edit icon for the appropriate forward. The Modify Forward page is displayed.
  3. Change the appropriate source or destination information.
  4. Click Save Changes.

Deleting a forward

To delete a forwarding entry, follow these steps:

  1. Click Fast/Port Forward in the left-side menu of WebConfig.
  2. On the Fast/Port Forward page, click the delete icon screen shot of the delete icon for the appropriate forward.
  3. To confirm the deletion, click OK in the pop-up window that is displayed.

Forwarding scenarios

Below are a few common forwarding examples:

  1. If Fred has a Domain Name Services (DNS) server on port 53, you can set a forward from the source address of host_name and the source port of 53 to the destination address to 192.168.1.5 and the destination port of 53. People on the Internet now can look up host names that belong to your local network.
  2. You can make WebConfig accessible from the outside world. An example reason of why you might want to do this is to allow technical support to access your Lotus Foundations server and help you resolve problems. Port 80 on Lotus Foundations is already in use for the company Web server, so use port 81 as the source port. WebConfig uses port 8043; if the destination IP address is 192.168.1.1, the complete destination address is 192.168.1.1/port 8043. To access WebConfig from the outside, you would need to use a special address:
    https://www.yournetwork.com:81/

Multiple static IP addresses

In certain cases, you want Fast/Port Forward to treat connections differently depending on their target. For example, you might want email from mail1.yournetwork.com to be sent to Fred, your NT server, and email from mail2.yournetwork.com to be sent to Barney, your UNIX server. To do this, your Internet service provider (ISP) needs to assign you multiple static Internet Protocol (IP) addresses. Some ISPs may not offer this service.

If you have two static IP addresses (for example, 207.6.60.1 and 207.6.60.2), and you want the setup just described, follow these steps:

Common port numbers

A few common port numbers that you can use with Fast/Port Forward are listed in the table below.

Table 9. Common port numbers for use with Fast/Port Forward
Port Use
22 Secure Shell (SSH)
23 Telnet
25 Simple Mail Transfer Protocol (SMTP)
79 Finger
80 Hypertext Transfer Protocol (HTTP) - Web server
110 Post Office Protocol (POP)
5631 PCAnywhere
443 Web server secure port (HTTPS)

Some ports cannot be used with Fast/Port Forward. For example, the common port number for File Transfer Protocol (FTP), port 21, does not work because it uses multiple connections that include both ports 20 and 21.

Troubleshooting Fast/Port Forward

The WebConfig page in Lotus Foundations might display the following message:

An error occurred while Fast Forward tried to bind to one or more of the addresses specified.  

This message might be displayed in the following situations:

If you see this message, turn off the server that is already using the port. For example, to forward port 80 (the port used for Web services) to another address, you would first have to shut off the Web server on Lotus Foundations.

The log messages show which Fast/Port Forward entries did and did not work.

Firewall services

The firewall subsystem featured in Lotus Foundations is entirely auto-configuring and automatically reconfigures its parameters to adapt to any Lotus Foundations server settings. There are no user controls needed. However, you can choose to restrict outgoing traffic and view a log of all requests to traverse the firewall.

Traffic denied inbound

The firewall denies all inbound network traffic that is not for the following:

Traffic permitted inbound

The firewall supports access requests for the following services, if enabled.

See Log messages for what firewall request information is logged.

Traffic permitted outbound

Lotus Foundations permits the following protocols through the firewall.

Table 10. Permitted protocols through the Lotus Foundations firewall
Protocol - Transport Layer Protocol/Port Transport Layer Protocol - Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) Port Purpose
Telnet TCP 23 Access resources on a UNIX/Linux computer
File Transfer Protocol (FTP) TCP 20-21 Copy files between computers
Hypertext Transfer Protocol (HTTP) TCP 80 Make Web pages available over the Internet
Hypertext Transfer Protocol Secure (HTTPS) TCP 443 Make secure Web pages available over the Internet
Simple Mail Transfer Protocol (SMTP) TCP 25 Transfer or send e-mail messages between servers
Domain Name Service (DNS) TCP and UDP 53 Navigate the Internet using domain names instead of IP addresses
Post Office Protocol version 3 (POP3) TCP 110 Read e-mail from a single inbox
Internet Message Access Protocol (IMAP) TCP 143 Read e-mail from a remote location

All other non-Remote Administration traffic from private, service, and public network clients directed to or through the Lotus Foundations firewall is dropped or denied.

The option to restrict outgoing connections is disabled by default for Lotus Foundations. When the option to restrict outgoing connections is enabled, users within your network cannot use programs that do not adhere to the above protocols, such as ICQ.

To enable the Restrict Outgoing Traffic option, follow these steps:

  1. Click Local Network in the left-side menu of WebConfig. The Basic Setup tab of the Local Network Options page is displayed.
    Figure 25. Basic Setup tab of the Local Network Setup page of WebConfig
    screen shot of the basic setup tab of the local network setup page of webconfig
  2. In the Restricts outgoing connections field, select Enable to configure Lotus Foundations to only enable the above outbound ports. Select Disable to enable all outgoing traffic.
  3. Click Save Changes.

Restricting outgoing traffic helps to block applications such as MSN Messenger, Yahoo Messenger, Kazaa, Morpheus, and similar applications.

Firewall log

See Log messages for information on firewall logs.

Client application add-ons

Client applications such as Lotus Notes and Lotus Symphony are available for each user to install. The Lotus Notes client from the head office is assumed to be the company standard and can be used. Click here for information on supported clients for Lotus Domino 8.5. There is also a Lotus Notes client included with Lotus Foundations Branch Office that is simple and easy to deploy.

Lotus Notes

The following clients can be used with Lotus Foundations Branch Office:

Installing the Lotus Notes add-on

The IBM Lotus Notes client is the recommended option for efficient use of the Lotus Foundations Branch Office platform. The IBM Lotus Notes client provides mechanisms for email, collaboration, shared calendaring, and access to other Domino applications.

Note: The Lotus Foundations Branch Office add-on must be installed for the Lotus Notes add-on installation to work.

IBM Lotus Foundations Branch Office Lotus Notes add-on

The Lotus Notes add-on enables you to easily deploy the Lotus Notes workstation clients to the end users. This is a two part process.

  1. Install the Lotus Notes add-on feature to the server. Optional: Install language packs.
  2. Install the Lotus Notes clients to the workstations.

Part 1: Install the Lotus Notes add-on feature to the server

To install the server add-on package on the Lotus Foundations server, follow these steps:

  1. If you have a DVD, insert the DVD labeled Lotus Foundations Branch Office Disk 2 into the server.

    If you downloaded the software to your workstation, do the following:

    1. Connect to the autoinstall file share on the Lotus Foundations server. To do this, from a workstation, click Start -> Run and then enter '\\' followed by the server's IP address, followed by \autoinstall. For example: \\192.168.0.1\autoinstall
    2. Enter the administrative account and password.
    3. Locate the folder where you unzipped the Lotus Notes package. The naming convention is lf-notes85-nnnn.pkg. (for example, lf-notes85-2760.pkg)
    4. Drag the Lotus Notes file lf-notes85-nnnn.pkg into the autoinstall folder. Wait to proceed until all of the files are copied to the server autoinstall folder.
  2. At the WebConfig URL for the server (https://server_ip_address:8043), click Software Update from the menu on the left side of the WebConfig screen.
  3. A list of installable packages is displayed in the 'Add-on packages available for install' section. If there is no list of available packages, wait several seconds and refresh the screen again. The Lotus Notes add-on package should be listed and should be displayed as: Lotus Notes 8.5 (Team autoinstall/lf-notes85-nnnn.pkg).
  4. Click Install on the Lotus Notes add-on; read and accept the license agreements. The installation begins immediately and might take a few moments.
  5. Verify the setup is complete on the main status page in the Add-ons section.

Install Lotus Notes language packs

The languages for the Lotus Notes add-on are provided in language pack groups. Before you start the installation process, determine which language pack groups you need.

Follow these steps for the language pack group installation:

  1. If you have a DVD, insert the DVD labeled Lotus Foundations Branch Office, Disk 2 for the Lotus Notes language packs.

    If you downloaded the software to your workstation, do the following:

    1. Connect to the autoinstall file share on the Lotus Foundations server. To do this, from a workstation , click Start -> Run and then enter '\\' followed by the server's IP address, followed by \autoinstall. For example: \\192.168.0.1\autoinstall
    2. Enter the administrative account and password.
    3. Locate the folder where you unzipped the Lotus Notes language package. The naming convention is lf-notes85-MUI-language_pack-nnnn.pkg, where language_pack refers to the language pack group. (for example, lf-notes85-MUI-G1-2760.pkg for the group 1 languages)
    4. Copy the Domino lf-notes85-MUI-language_pack-nnnn.pkg into the autoinstall folder. Wait to proceed until all of the files are copied to the server autoinstall folder.
  2. At the WebConfig URL for the server (https://server_ip_address:8043), click Software Update from the menu on the left side of the WebConfig screen.
  3. A list of installable packages is displayed in the 'Add-on packages available for install' section. If there is no list of available packages, wait several seconds and refresh the screen again. The Lotus Notes language pack should be listed and should be displayed as: Lotus Notes 8.5 MUI Pack for language_pack (Team autoinstall/lf-notes85-MUI-language_pack-nnnn.pkg)
  4. Click Install on the Lotus Notes language pack; read and accept the license agreements. The installation begins immediately and might take a few moments.
  5. Verify the setup is complete on the main status page in the Add-ons section. The Lotus Notes installer automatically installs Lotus Notes in the preferred language of the user.
Note: You can add language packs at any time.

Part 2: Install the Lotus Notes clients to the workstations

These instructions are for the one-click installation and configuration of Lotus Notes on a Windows operating system.

To install Lotus Notes on the client workstations, follow these steps:

  1. From the user's workstation, connect to the user's file share on the Lotus Foundations server. To do this, click Start -> Run and then enter '\\' followed by the server's IP address, followed by \USERNAME. For example, type \\192.168.0.1\USERNAME where USERNAME corresponds to the user that you want to configure on the Lotus Foundations server.
    Figure 26. Accessing the user's workstation
    screen shot of the run dialog
  2. Navigate to the LotusFoundations -> NOTES85_INSTALL folder and double-click the NOTES85_SETUP.BAT file. Select Run when prompted.

    The Notes Installation and Setup screen displays. Press any key to continue.

    Note: When the command prompt window opens, a message is displayed that states: UNC paths are not supported. Defaulting to Windows directory. (as shown in the following screen shot). This message can be ignored.

    Figure 27. Notes Installation and Setup screen
    screen shot of the Notes Installation and Setup screen
  3. The installation should take approximately five to ten minutes for a workstation that is on the same local network as the Lotus Foundations server. When the installation is complete, you should see a message stating that the setup is complete. Click OK. The Installation and Setup screen appears. Press any key and the program closes.
    Figure 28. Notes Installation and Setup complete
    screen shot of the notes installation screen
    Note: If the preferred language of the user is not English and you have installed the corresponding language pack for Lotus Notes on the server, then the Lotus Notes client installation also includes the language pack.
  4. Open Lotus Notes from either a desktop icon or the Start menu.
  5. Enter the Lotus Notes password and click OK.
  6. Lotus Notes performs an initial setup that can take several minutes. When the initial setup is complete, Lotus Notes opens and the installation is complete.
    Figure 29. Lotus Notes Welcome screen
    screen shot of the Getting Started screen

Installing language packs for Lotus Notes to the client workstation

The one-click installation process automatically installs the language pack when the user installs Lotus Notes. Language packs can be installed at any time.

Lotus Symphony

Lotus Symphony is a product suite that contains the following productivity tools:

Lotus Symphony is available as either a stand-alone offering or an embedded client within Lotus Notes.

Lotus Symphony tools support the Open Document Format (ODF), which ensures the ability to access, use, and maintain documents without concern for end of life, or ongoing software licensing and royalty fees. Using the productivity tools that collectively compose Lotus Symphony, end users can create, manage, edit, and import documents in ODF. The Lotus Symphony tools can also import, edit, and save documents in Microsoft(R) Office formats or export those documents to ODF for sharing with other applications.

How does Lotus Symphony compare to other similar offerings?

IBM Lotus Symphony is a richly-featured set of productivity tools that are intuitive and easy to use and provided at no charge. There are three applications that make up Lotus Symphony: Lotus Symphony Documents, Lotus Symphony Spreadsheets, Lotus Symphony Presentations.

More information about Lotus Symphony

To learn more about using Lotus Symphony or for product support, refer to the Lotus Symphony website at the following URL:

http://symphony.lotus.com/software/lotus/symphony/

Installing Lotus Symphony add-on to the server

The first part of the installation of Lotus Symphony installs the server add-on package on the Lotus Foundations server. To install the server add-on package to the Lotus Foundations server, with the Lotus Foundations server running and configured, follow these steps:

  1. If you have a DVD, insert the DVD labeled Lotus Foundations Branch Office, Disk 2 add-on into the server.

    If you downloaded the software to your workstation, do the following:

  2. Select Software Update from the menu on the left side of the WebConfig screen.
  3. A list of installable packages is displayed. If there is no list of available packages, wait several seconds and refresh the screen again. The Lotus Symphony add-on package should be listed and should be displayed as: Lotus Symphony 1.2 (Team autoinstall/lf-symphony12-nnnn.pkg).
  4. Click Install on the Lotus Symphony add-on; read and accept the license agreements. The installation begins immediately and might take a few moments.
  5. Verify the setup is complete on the main status page in the Add-ons section.

The Lotus Symphony package that is deployed to the Lotus Foundations server includes support for all languages.

Installing Lotus Symphony to client workstations

Client requirements

The following list contains the client system requirements:

Windows installer does not support AMD64 CPU with XP/Vista 64 bit platforms installed.

Prerequisites

You must uninstall any previous versions of Lotus Symphony before installing the version integrated with Lotus Foundations.

Uninstall previous versions of IBM Lotus Symphony on Windows

Follow these steps to uninstall any previous versions of Lotus Symphony:

  1. Close IBM Lotus Symphony before uninstalling.
  2. Open the Control Panel by clicking Start -> Control Panel.
  3. Double-click Add or Remove programs.
  4. Select IBM Lotus Symphony, and click Remove.

Installing IBM Lotus Symphony on Windows XP and Windows Vista

Follow these steps to install Lotus Symphony to the client workstation:

  1. Optional: Specify the local language setting on the user's workstation. Click Start -> Control Panel -> Region and Language Options, if necessary. Lotus Symphony version 1.2 automatically switches to the native language version specified in this setting.
  2. From the user's workstation, connect to the user's file share on the Lotus Foundations server. To do this, click Start -> Run, and then enter '\\' followed by the server's IP address, followed by \USERNAME. For example, type \\192.168.0.1\USERNAME where USERNAME corresponds to the user that is installing Lotus Symphony.
  3. Navigate to the LotusFoundations -> SYMPHONY1_INSTALL folder and double-click the SYMPHONY1_SETUP.BAT file, then select Run when prompted.

    The Symphony Installation and Setup screen displays. Press any key to continue.

    Note: When the command prompt window opens, a message is displayed that states: UNC paths are not supported. Defaulting to Windows directory. (as shown in the following screen shot). This message can be ignored.

    Figure 30. Symphony Installation and Setup screen
    screen shot of the Symphony Installation and Setup screen
  4. The installation should take approximately five to ten minutes for a workstation that is on the same local network as the Lotus Foundations server. When the installation has completed, a message stating that "Symphony 1 auto setup is configured...Press any key to continue...". Press any key and the program closes.

You are ready to begin working with IBM Lotus Symphony to create new documents, spreadsheets, and presentations. You have one icon for Lotus Symphony on your desktop and one shortcut on the Start -> All Programs menu.

Note: The Lotus Symphony package that is installed from the Lotus Foundations server includes support for all languages and uses the language of the user's workstation.

Switching between languages

You can switch between English and any other supported language by switching system locale on your workstation. IBM Lotus Symphony only supports switching from one non-English language to another language within the same group or to English:

Without a successful switch between languages, you might get a partially translated or completely English user interface.

Server applications and extensions

 

Lotus Foundations Run feature

The Lotus Foundations Run feature provides users with the ability to run Windows applications on a Lotus Foundations server. This can be important when you find that you want to use the functions of idb and the ease of user management, but the client has an application that has to run on a Windows operating system (or any VMware 32-bit operating system supported by VMware). To accomplish this, a VMware server runs in an NVS environment. The user interface within the Webconfig console provides the ability to control the virtual server and customize configuration and backup settings. Additionally, if you have pre-built VMware images in a zip file format, Lotus Foundations Run can automatically import them into the VMware server.

What is VMware?

VMware is the virtualization platform used by the Lotus Foundations Run add-on. Virtualization allows users to transform or "virtualize" the hardware resources of a computer, including the CPU, memory, hard disk and network controller, to create a fully functional virtual machine that can run its own operating system and applications. Multiple virtual machines share hardware resources without interfering with each other, so users can run several operating systems and applications at the same time. Software virtual appliances are pre-built software, comprised of one or more virtual machines that are packaged, updated, maintained and managed as a unit. You can easily install and deploy these pre-integrated solution stacks. For more information on VMware and its capabilities, go to http://www.vmware.com/.

Installing the Lotus Foundations Run add-on

Note: For the Lotus Foundations Run add-on, Lotus Foundations Branch Office must be installed on a hardware platform and not as a virtual machine itself. VMware Server 2 for Linux does not work on a virtual installation of Lotus Foundations Branch Office.

The Lotus Foundations Run add-on installation is done in two parts:

Prerequisites

Before you begin installing the Lotus Foundations Run add-on onto a Lotus Foundations server, ensure you have:

Obtaining a license key for VMware Server 2 for Linux

If you do not already have a license for VMware Server 2 for Linux, you can obtain one online for free by following these steps:

  1. Proceed to the VMware free virtual server registration page (http://www.vmware.com/freedownload/login.php?product=server20).
  2. On the registration web page, enter your first name, last name, and email address. A valid email address must be provided in order to send the license information. Click Continue.
  3. On the following page, provide information about your company and your usage for VMware. You must also agree to the license terms and agreements. When asked "How many Hosts will have VMware installed?", make sure you enter at least one (1) for Linux.
  4. Click the Register button to complete the registration process.
  5. Two emails containing the registration information and the activation link are sent to you immediately. Upon receiving the activation email, open the message and click Activate Now.
  6. A web browser window opens and takes you to a page where you are required to enter your email address along with the password you provided during the registration process.
  7. Upon authentication, you are provided the license information for VMware Server 2 for Linux. Save this license key as you need it later to complete the Lotus Foundations Run setup with VMware.

Lotus Foundations Run installation

Before installing VMware Server 2 add-on for IBM Lotus Foundations Run, you must first install Lotus Foundations Run. With the Lotus Foundations server running and configured, follow these steps:

  1. Optional: If you have any pre-built VMware images in a ZIP file format, follow these steps:
    1. Connect to the autoinstall folder on the Lotus Foundations server. To do this, from a workstation, click Start -> Run and then enter '\\' followed by the server's IP address, followed by \autoinstall. For example, \\192.168.0.1\autoinstall.
    2. Create a folder titled vmdir.
    3. Place the pre-built image ZIP files in the \\server_ip_address\autoinstall\vmdir directory.

    Note: For any pre-built VMware images in a ZIP file format placed in this directory after the installation of Lotus Foundations Run, the add-on needs to be restarted for the VMware server to import them.

  2. If you have a DVD, insert the DVD labeled Lotus Foundations Branch Office, Disk 2 into the server.

    If you downloaded the software to your workstation, do the following:

    1. Connect to the autoinstall folder on the Lotus Foundations server. To do this, from a workstation, click Start -> Run and then enter '\\' followed by the server's IP address, followed by \autoinstall. For example, \\192.168.0.1\autoinstall.
    2. Enter the administrative account and password.
    3. Locate the folder where you unzipped the Lotus Foundations Run add-on package. The naming convention is lf-run11-nnnn.pkg (for example, lf-run11-5256.pkg).
    4. Place the lf-run11-nnnn.pkg into the autoinstall folder. Wait to proceed until all of the files are copied to the server autoinstall directory.
  3. Login to the Webconfig console and click Software Update from the menu on the left side.
  4. In the "Add-on packages available for install" section, you should see an option for the Lotus Foundations Run add-on. Click the corresponding Install link.
  5. Read and accept the license agreements and the installation process begins.
  6. Verify the setup is complete on the main status page in the Add-ons section. Until you install the VMWare Server 2.0, the status on the Add-ons screen displays as 'inactive.'

VMware Server 2 add-on for IBM Lotus Foundations Run installation

Follow these steps to install the VMWare Server 2.0 for Lotus Foundations Run onto Lotus Foundations Branch Office:

  1. If you burned this CD, insert the CD into the server (see Prerequisites for the installation package location).

    If you downloaded the software to your workstation, do the following:

    1. Connect to the autoinstall folder on the Lotus Foundations server. To do this, from a workstation, click Start -> Run and then enter '\\' followed by the server's IP address, followed by \autoinstall. For example, \\192.168.0.1\autoinstall.
    2. Enter the administrative account and password.
    3. Locate the folder where you unzipped the VMWare Server 2.0 for Lotus Foundations Run package. The naming convention is lfrun-vmware20-nnnn.pkg (for example, lfrun-vmware20-5256.pkg).
    4. Place the lfrun-vmware20-nnnn.pkg into the autoinstall folder. Wait to proceed until all of the files are copied to the server autoinstall directory.
  2. Login to the Webconfig console and click Software Update from the menu on the left side.
  3. In the "Add-on packages available for install" section, you should see an option for the VMWare Server 2.0 for Lotus Foundations Run. Click the corresponding Install link.
  4. Read and accept the license agreements.
  5. In the Input Serial Number field, enter the serial number you received in Obtaining a license key for VMware Server 2 for Linux and click Submit. The installation process begins.
  6. Verify the setup is complete on the main status page in the Add-ons section.

Using the VMware server

After you have successfully installed the Lotus Foundations Run add-on, you can access the VMware server administration console two ways:

If you copied any pre-built ZIP file VMware images over before the installation of the Lotus Foundations Run add-on (as shown in Lotus Foundations Run installation), they have been automatically unzipped and placed in the correct directory.

Adding a pre-built VMware image folder

If you want to add pre-built VMware image folders, follow these steps:

  1. Copy the entire folder to the following location on the Lotus Foundations server:

    \\server_ip_address\lf-virtualization\filesystem\var\lib\vmware\Virtual Machines

  2. Access the VMware administration console and select Add Virtual Machine to inventory. In the Add Existing Virtual Machine dialog, select your image and click OK. You are ready to use your VMware image.
    Figure 31. Adding a virtual machine to inventory
    screen shot of the VMware console with proper selection highlighted

Using the VMware administration console, you can change the size of the virtual disk, the amount of memory, configure connections, and set permissions. Refer to the VMware Server 2.0 documentation (http://www.vmware.com/support/pubs/server_pubs.html) for general how-to documentation and step-by-step instructions on using VMware.

VMware configuration tips

Additional VMware resources

The following additional VMware resources can be useful with Lotus Foundations Branch Office:

Editing Lotus Foundation Run add-on settings

You can edit some of the Lotus Foundations Run add-on settings by following these steps:

  1. In the WebConfig console, click Add-ons in the left-side menu of WebConfig.
  2. The Status tab is the default view. Click the edit icon edit (pencil) icon for Lotus Foundations Run.
  3. Optional: Edit the Start Command field to change the name of the program that you want to use to start up the add-on. It must be placed in the directory of the user who shares a name with this add-on.

    Note: It is recommended you do not change this setting. If modified incorrectly, the add-on does not function properly.

  4. Optional: Edit the Monitor Command field to change the name of the program that monitors the health of the add-on. It must be placed in the directory of the user who shares a name with this add-on and must publish its information into the /tmp/addons/addon-name/status section of the uniconf tree.

    Note: It is recommended you do not change this setting. If modified incorrectly, the add-on does not function properly.

  5. Optional: Edit the Firewall Port(s) field if you need to list ports to open up on the untrusted interfaces and allow external users to connect to programs running in the add-on. The ports in the list must be separated by spaces. By default this field is blank.
  6. Optional: The Addon Automatic Start option lets you select whether or not you want Lotus Foundations to start the add-on automatically on startup. The default is set to Enable.

Virtualization tab

The Virtualization tab helps you access and start or stop your virtual applications. The figure and table below illustrate the different options for each virtual application.

Figure 32. Virtualization tab
screen shot of the virtualization tab
Table 11. Virtualization Tab
Item Description
Status 'virtual machine up' green check mark - The virtual machine is running. 'virtual machine down' icon - The virtual machine is stopped.
Datastore The directory where VMware keeps virtual machine files/configuration. VMware Server 2.0 supports multiple stores and each store has a unique name. The default store is Standard.
Application Name The name of the virtual application.
Disk Space Used The amount of disk space used and the total amount of disk space available.
Memory Size The amount of memory is being used or will be used by the image.
IP The IP address of the virtual machine. To display the IP address, a user needs to install VMware tools inside of guest operating system. By default, this is blank.
Backup Option to select to back up or not back up the virtual machine as part of the LF Virtualization Backup job. See Backup & restore for details. The default is set to back up. Remember to select Save Changes if you change the default.
Action Start or stop your virtual machine.
Advanced Virtualization Settings Opens the VMware server administration console (http://server_ip_address:8222).

Restarting the Lotus Foundations Run add-on

You might need to restart the VMware server if it stops responding or you added a VMware image in a ZIP file format that you want automatically imported. To restart the VMware server, follow these steps:

  1. Login to the Webconfig console and select Add-ons from the left-side menu.
  2. Click the edit icon edit (pencil) icon for the Lotus Foundations Application Engine. Next to Addon Automatic Start, click Disable. Click Save Changes.
  3. Wait approximately 30 seconds, click the edit icon again, and then click Enable for Addon Automatic Start. Click Save Changes.

Backing up and restoring the virtual machine

When you install the Lotus Foundations Run add-on, a backup job called LF Virtualization Backup is created. You can select which virtual applications you want to be backed up through the Virtualization tab in the WebConfig console. When you select to have a virtual application backed up, the entire VMware image is backed up. This includes configuration and virtual disk files for the guest operating system. When selected, the VMware image is backed up every day at 1:00 AM.

If you cannot back up all VMware images, it is recommended that at a minimum the guest operating system files are backed up. For Windows, an administrator should be familiar with how to use Window shares with Lotus Foundations. Map a shared team directory in Windows and store the data in this directory. On the Lotus Foundations server, the administrator needs to make sure that the shared team directory is backed up by the Master Job or another idb backup job.

The frequency of when the backup occurs can be changed, along with other options, by clicking Backup from the left side menu in the WebConfig console and clicking on the job name. For more information on using the backup and restore options, see Backup & restore.

Troubleshooting

Table 12. Troubleshooting Tips
Error or Warning Possible Cause Possible Solution
Error: \\server_ip_address\lf-virtualization The network path was not found
screen shot of error message

This error occurs when trying to map to lf-virtualization folder on the Lotus Foundations Branch Office server from a workstation.

Lotus Foundations Run add-on (lf-run11-nnnn.pkg) is not installed. Install the Lotus Foundations Run add-on (lf-run11-nnnn.pkg).
Warning: Lotus Foundations Application Engine: Application components are not correctly installed.
screen shot of warning

This warning occurs in the WebConfig status page for Add-ons after the Lotus Foundations Run add-on (lf-run11-nnnn.pkg) is installed but VMWare Server 2.0 for Lotus Foundations Run (lfrun-vmware20-nnnn.pkg) is not yet installed.

The Lotus Foundations Run add-on (lf-run11-nnnn.pkg) is installed but VMWare Server 2.0 for Lotus Foundations Run (lfrun-vmware20-nnnn.pkg) is not yet installed. Install the VMWare Server 2.0 for Lotus Foundations Run (lfrun-vmware20-nnnn.pkg).
Error:
screen shot of error

This error occurs when an invalid VMware license was used in the installation of the VMware 2.0 Server for Lotus Foundations Run package.

An invalid VMware license was used in the installation of the VMware 2.0 Server for Lotus Foundations Run package. Uninstall the Lotus Foundations Run add-on and reinstall using a valid license number.

MySQL server

What is the MySQL Server?

MySQL is a relational database that can be used to store dynamic Web page data for services such as online catalogs and stores, create accounting databases, and create address books. MySQL is an advanced feature for users that are familiar with databases and SQL (structured query language). For more information, go to http://www.mysql.com.

If the MySQL server is enabled, users on the internal network can access personal databases and the databases of any teams to which they belong. User and team databases are automatically created when user and team accounts are set up.

Setting up Windows for MySQL Access

You can use Microsoft Access to access and manage database tables.

  1. You first have to download the MySQL ODBC (Open Database Connectivity) connector. You can download this at http://dev.mysql.com/downloads/connector/.
  2. On the page that is displayed, click the link for the Connector/ODBC. Ensure you are downloading the most recent stable release.
  3. From the Windows downloads section of the screen that displays, click the download link for Windows or Windows x64.
  4. On the screen that is displayed, select the nearest server to download from.
  5. In the window that is displayed, select the download location where you want to save the mysql-connector-odbc file. This set of steps assumes that it is saved to the desktop.
  6. Double-click the icon on your desktop and click Run.
  7. The Microsoft ODBC Setup screen is displayed. Click Continue.
  8. Select MySQL from the Available ODBC Drivers list. Click OK.
  9. For Windows XP and later, click Start -> Settings -> Control Panel -> Administrative Tools -> Data Sources (ODBC). For previous versions of Windows, click Start -> Settings -> Control Panel -> ODBC Data Source. The ODBC Data Source Administrator screen is displayed.
  10. Click Add.... The Create New Data Source screen is displayed.
  11. Select MySQL from the list. Click Finish.
  12. Provide the following information:
  13. Click OK on this screen and then on the ODBC Data Source Administrator screen.
  14. Open Microsoft Access.
  15. Create a database named address book.
  16. Anywhere in this window, right-click your mouse. Select Link Tables.
  17. In the Files of Type section of the screen that is displayed, select ODBC Databases. The Select Data Source screen is displayed.
  18. Select the Machine Data Source tab and select MySQL Address Book. The Link Tables screen is displayed.
  19. Select the appropriate table, then click OK.
  20. Make sure that the appropriate table is highlighted and click OK. The table opens in Microsoft Access.

What is a dynamic Web site?

Dynamic Web sites, such as online stores or catalogs, use databases to store information and PHP: Hypertext Preprocessor (PHP) or Perl scripts to produce the Web page based on the data stored in the database. This enables the changing information to be reflected on the site as it changes. Dynamic Web sites require knowledge of PHP or Perl script, and may require programming assistance.

Generating dynamic Web sites

For more information about PHP, visit the IBM developerWorks website for PHP project resources at http://www.ibm.com/developerworks/opensource/top-projects/php.html.

The following PHP script is used to render the example address book into a dynamic Web site.

  1. Ensure you have a team named AddressBook on your Lotus Foundations server.
  2. Ensure the user John is a member of the AddressBook team.
  3. Enter the following script into a text file and save it as addressbook.php:
    <?php 
    mysql_connect("localhost", "john", "password"); 
    mysql_select_db("john"); 
    $result = mysql_query("SELECT * FROM AddressBook"); 
    while ($line = mysql_fetch_array($result)) 
    list ($name[],$phone[]) = $line; 
    for ($i = 0; $i < sizeof($name); $i++)
    echo "<tr><td>$name[$i]</td><td>$phone[$i]</td></tr>\n"; 
    ?>
  4. In the Windows Network Neighborhood, copy the script in John's WWW folder on the local server.
  5. Open an Web browser on your workstation. In the address bar of the browser, enter:
    http://server_name/~john/addressbook.php
    The address book opens in the browser.

File services

File sharing services

Lotus Foundations provides high performance file sharing services for Windows, Macintosh, and UNIX-style clients. Files created by Windows users can transparently be seen by Macintosh users and vice versa.

File services management and administration integrate with user management and administration. Refer to Introduction to users and teams for a detailed explanation of how file sharing services are automatically set up during user and team creation.

Configuring file services

Follow these steps to configure file services:

  1. Click File Server from the left-side menu of WebConfig. The Basic Setup tab is the default view.
    Figure 33. File Server Setup screen in the WebConfig console
    screen shot of the File Server section of the webconfig console
  2. If appropriate, enable the file virus scanner. With this option selected, all files on the system are automatically scanned for viruses every 12 hours.

    The following steps happen automatically when a virus is encountered:

  3. To allow sharing across UNIX and Linux systems, enable the NFS file server.
  4. To allow Macs to access shared directories on the server, enable the Macintosh file server. Each user and team has a shared directory, accessible by Windows file sharing, FTP, Appletalk, or NFS. If you have no Macs on your network, you can safely disable this.
  5. In the Windows File Server section, you can select the following from the drop-down:
  6. Unless Lotus Domino Branch Office is acting as a domain member or controller, enter a workgroup name. This name indicates the workgroup under which the Lotus Foundations server is listed as a resource in Windows Network Neighborhood.
  7. In the section labeled WINS Support select whether or not the Lotus Foundations server responds to WINS requests by clicking Enable or Disable.

    If you select Enabled for the option above, specify the WINS server on the network in WINS Server section. If you want that Lotus Foundations server to act as the WINS server, leave the text box as is. If you want to use another server on the network to act as the WINS server, enter the IP address of that server.

  8. Click Save Changes.
  9. To ensure that the status of the file server has changed, select Status from the WebConfig menu. The Windows, Apple, and NFS File Server sections of the System Status screen should display the updated status.

Active server connections

The Active Connections section displays currently open files and services in use by client workstations.

To view the current active connections in Lotus Foundations:

  1. Click File Server in the left-side menu of WebConfig. Click the Active Connections tab.
  2. In the main window, you see a table that displays the following information:
  3. If you click the edit icon screen shot of the edit icon, you see a screen that displays the following information:

    Note: If no files are being accessed, you see (No files are being accessed yet.) underneath the four column headers.

Access control lists

An Access Control List (ACL) defines which permissions, or access rights, that each user or team has to a specific file or directory.

Administrators can modify a Lotus Foundations user or team's permissions, Read Only, Read/Write, or No Permissions on directories through the Lotus Foundations Permissions feature.

Setting a user's permissions

Follow these steps to set a user's permissions:

  1. Click File Server in the left-side menu of WebConfig. Click the Permissions tab.
  2. Scroll down the list of teams, administrators, and users in the selection box and click the directory to which you want to assign permissions. Click Show Permissions.
  3. The Modify File Permissions screen displayed the current permissions for that directory.
  4. Modify the user's permissions by selecting the Read Only, Read/Write, or No Permissions radio button. Click the check mark button in Include Subfolder(s) if you want the same permission applied recursively, then click the save icon in the Action column.
  5. If you want to add permissions, in the last row titled Add, select the folder from the drop-down, and click the green plus sign in the Action column.
  6. To set all of the files and folders under the current directory back to the default permission value, click Reset Folder Permissions.
  7. To set all of the files and folders under the current directory, including all sub-folder files back to the default permission value, click Reset Tree Permissions.

Setting a team's permissions

Follow these steps to set a team's permissions:

  1. Click File Server in the left-side menu of WebConfig. Click the Permissions tab.
  2. Scroll down the list of teams, admins, and users in the selection box and click on the directory of the team to whom you want to assign permissions. Click Show Permissions.
  3. The Modify File Permissions screen is displayed, showing the current permissions for that directory.
  4. Modify the team's permissions by selecting either the Read Only, Read/Write, or No Permissions radio button. Click the check mark button in Include Subfolder(s) if you want the same permission applied recursively, and then click save icon in the Action column.
  5. To view the permissions of all users assigned to that team, click the plus symbol to the left of the team name in the Modify File Permissions section. This expands the team list and shows all users within that team and their permission levels.
  6. If you want to add permissions, in the last row titled Add, select the folder from the drop-down, and click the green plus sign in the Action column.
  7. To set all of the files and folders under the current directory back to the default permission value, click Reset Folder Permissions.
  8. To set all of the files and folders under the current directory, including all sub-folder files back to the default permission value, click Reset Tree Permissions.

Setting permissions in Windows

Alternatively, you can configure file and folder permissions in Windows. Refer to the following links for further information:

Windows Vista: http://windowshelp.microsoft.com/Windows/en-US/Help/2464a180-e5dc-45d1-a2b8-3c8a2b571e9d1033.mspx

Windows XP: http://support.microsoft.com/kb/304040

Windows 2000: http://www.microsoft.com/technet/prodtechnol/windows2000serv/deploy/confeat/13w2kadc.mspx

Network file system

What is NFS?

NFS (Network File System) is a protocol that enables clients using UNIX and similar operating systems to mount file systems from remote servers. This chapter is for advanced users who are familiar with UNIX and similar operating systems. Refer to http://en.tldp.org/HOWTO/NFS-HOWTO/ for more information on NFS.

Lotus Foundations only supports situations where the user IDs are the same on the local system and the Lotus Foundations server.

FTP services

FTP Server

Lotus Foundations uses a File Transfer Protocol (FTP) server that enables users and teams to access network and Web files. FTP services are automatically enabled for any users synchronized with the Lotus Foundations Branch Office server.

Anonymous FTP Server

The FTP server can be used in anonymous mode to enable uploads and downloads of files to a specific directory without authentication from the remote user. This anonymous mode of operation is commonly used for public file distribution on the internet. Although the file can be downloaded from a Web server, FTP is the preferred method because it offers superior performance for high volume and large file transfers.

When Anonymous FTP is enabled, Lotus Foundations automatically creates a team called FTP. Members of this team have access to the FTP directory. All files placed in this directory by team members are accessible to anyone on the Internet. Similarly, when Anonymous Upload is enabled, anyone on the Internet can upload their own files to the subdirectory in the FTP directory.

Enabling the FTP server

  1. Click FTP Server in the left-side menu of WebConfig. The FTP Server Setup screen is displayed.
    Figure 34. FTP Server Setup screen
    screen shot of the FTP server setup section in the webconfig console
  2. Indicate whether or not you want to enable the FTP file server.
  3. Indicate whether or not you want to enable anonymous FTP.
  4. Indicate whether or not you want to enable anonymous uploads.
  5. Enter the total number of connections at any one time.
  6. Click Save Changes.

User vs. Team FTP access

Users can log into the Lotus Foundations FTP server by entering their username and password to access their own user directory.

To access the directory of any team of which they are a member, users need to use the team name in place of their user names, but they can continue to use their individual passwords rather than a team password.

Enabling FTP access for a specific team or user

Users that can have FTP access enabled on the Lotus Foundations Branch Office server are listed in the Users section of the WebConfig console. FTP access is disabled by default. Deleting a user initiates the deletion of the user's home directory, which is also the directory visible when the user logs in using FTP.

By default FTP access is disabled. The Users section of the WebConfig console displays users that have FTP access enabled. The user's home directory is also the user's FTP directory. When you delete a user, you delete the user's home directory. Deleting a user's home directory thus deletes the user's FTP directory.

Follow these steps to enable FTP access for a specific team or user:

  1. Select Users from the left-side menu of WebConfig.
  2. Click the appropriate user or team's edit icon screen shot of edit icon.
  3. The Modify Users or Modify Teams screen is displayed.
  4. Indicate whether or not you want this user or team to have FTP access in the Allow FTP Access field.
  5. Click Save Changes.
  6. Repeat steps 2-5 for any additional users or teams.

rsync

What is rsync?

rsync is a UNIX-based utility that enables incremental files and directory synchronization from one location to another. This can be used to copy data files from the Lotus Foundations server to another system that also supports rsync. An advantage to using this file transfer method is that only the changed portions of the files are transferred, rather than the entire new version of the files and directories.

In general, Domino servers do not support rsync. Replication is the typical method for file synchronization between a Domino server and a Lotus Foundations server.

Note: To use rsync, commands must be run within a Telnet session. Therefore, basic knowledge and understanding of the Linux command line is strongly recommended. For a more detailed explanation of rsync, visit the following Web site: http://samba.anu.edu.au/rsync/

Enabling rsync

To enable rsync, follow these steps:

  1. Log into WebConfig as an administrative user.
  2. Click Local Network in the left side menu of WebConfig. The Basic Setup tab of the Local Network Setup page is displayed.
    Figure 35. Basic Setup tab of the Local Network Setup page of WebConfig
    Screen shot of the Basic Setup tab of the Local Network Setup page of WebConfig
  3. For the Rsync Server field, select Enable or Only Trusted Hosts.
  4. Click Save Changes.

rsync from a Telnet session

Pushing data to another location

To push data to another location, use this command:

rsync -zav --progress /home/local_user/Files remote_user@remote_server::remote/path/
Note: Pushing data using rsync is different from initiating a Domino replication with the Push command.

Table 13. Options for the rsync push command
Command option Explanation
rsync rsync executable command
-z Compresses any data from the files rsync sends to the destination computer (useful for slow connections); the compression method is the same method used by the UNIX gzip compression utility
-a Enables recursion and preserves almost everything during the synchronization
-v Increases the amount of information you receive during the transfer (default is for rsync to work silently); a single -v provides information about which files are transferring and a brief summary at the end, while two -v flags provides information about skipped files and slightly more information at the end
--progress Displays the progress of individual files
/home/local_user/* Local directory to push out to the remote location
remote_user@remote_server remote_user is the team name at the remote location and remote_server can be either the remote server's IP address or the fully qualified domain name; the password prompt following the rsync line is for this account
:: A double colon in the destination field copies from the local server to the remote server; a double colon also separates the host name from the path that follows
remote/path Destination folder or path
/ Eliminates confusion rsync might have with the command when appended to the trailing directory; without it, the path might be interpreted as
/REMOTE_USER/dir/dir/
or something similar

You are then prompted to provide the password for the remote_user account entered into the syntax.

Pulling data from another location

To pull data from another location, use this command:

rsync -zav --progress remote_admin@remote_server::remote_user/* /home/local_user/Files
Note: Pulling data using rsync is different from initiating a Domino replication with the Pull command.

As with the push method, you are prompted to provide a password for the remote_admin account.

Print service

You can connect any type of printer that users are sharing on the internal network to the parallel printer port of a Lotus Foundations Branch Office server. Lotus Foundations supports parallel port printers and a range of local USB-based printers. Lotus Foundations Branch Office does not support the bi-directional mode of parallel devices; it can send output to printers but cannot read detailed status information. This means that any special print manager and status monitor software on your workstation should be disabled. Print services do not support green-enabled printers that shut themselves off when there is inactivity on the port.

Lotus Foundations supports network printing. This helps you to manage the print queues through Lotus Foundations directly for multiple network-enabled printers. The printer queues are accessible through Internet Printing Protocol (IPP), and standard Windows network printing. Lotus Foundations also enables aliased printing queues.

The administrator or installer must provide the appropriate drivers for the specified printer at the workstation.

Configuring local print services

Before you can print on a printer connected to your Lotus Foundations server, you must configure Lotus Foundations for printing.

  1. Click Printers in the left-side menu of WebConfig. The Print Setup page is displayed. Lotus Foundations lists all the available printers.
  2. For Printing Services, select Enable or Disable. You are not able to print with the printers connected to your server unless you enable printing services.
  3. Click Save Changes. It takes approximately five seconds to detect connected printers. Printers are not displayed in the list immediately after clicking Save Changes.

Configuring your workstation

Follow these steps to configure a printer for your workstation:

Note: Driver installations can vary according to each printer and manufacturer. The following instructions are provided as a basic guideline. For more information, refer the printer manufacturer's installation guide.

  1. Access the Lotus Foundations server file share. This can be done through Microsoft Windows Network or by clicking Start -> Run and typing in either \\server_ip or \\server_hostname. A window is displayed that shows the network file and print services to which you have access. Depending on the number of mail users on the Lotus Foundations Branch Office system, you might have to scroll down to see the Printers and Faxes icon.
  2. Right-click the printer icon to which you want to connect and click Connect.
  3. If the required driver is not detected as already installed, a print installation warning is displayed. Click Yes to continue.
  4. Select the printer in the list provided and click OK. If your printer is not listed, click Have Disk and point to the driver provided by your printer's manufacturer.
  5. Enter a name for the printer and click Next. If this is the only printer that the workstation is communicating with, it assumes that this printer is the default.
  6. Indicate whether or not you want to print a test page and click OK.

Configuring network printers

  1. Click Printers in the left-side menu of WebConfig.
  2. If Printing Service is disabled, select Enable and click Save Changes.
  3. Click Add Network Printer.
  4. Fill in details pertaining to the network printer to be added.
  5. Click Save Changes to add the network printer.
  6. Permit Lotus Foundations to probe the address for printer information, and click Printers in the left menu. Once the printer has been found, it displays the printer information.

Other network printing

If you are trying to configure network printing where the printer is not physically connected to a Lotus Foundations server, perform these steps:

  1. In Windows, go to Printers & Faxes, click Add a Printer and select A network printer, or a printer attached to another computer on the second screen of the Add Printer Wizard.
  2. Choose Connect to this printer, and type in the address and name of the printer; for example, http://printer_ip:631/printer
  3. Click Next. Windows warns you about installing drivers from an untrusted source. It then states that it cannot find drivers for the given printer. Lotus Foundations does not keep a repository of printers to maintain its small operating size.
  4. Select the type of printer, or download the driver from the printer's Web site.
  5. Select whether or not you want this to be your default printer.

You should now be configured to print to the networked printer directly through Lotus Foundations. You can configure printing services through Linux and Mac workstations.

Creating an aliased printer queue

  1. Click Printers in the left-side menu of WebConfig.
  2. Click Add Printer Alias....
  3. Enter the alias to apply to a particular printer.
  4. Click Save Changes to create the alias.

Web services

Web server

Lotus Foundations Branch Office contains two separate web servers:

  1. The Lotus Foundations web server. This web server is disabled by default when Branch Office is installed. When enabled, this web server provides access to your intranet site and the personal web pages of your users, content which is hosted on the Branch Office server.
  2. The Lotus Domino web server. Whether this web server is enabled or not depends on the options you selected when setting up the server. It can be enabled at any time using Domino Administrator. When enabled, this server provides access to Lotus Domino applications that reside on the Branch Office server, and in particular provides iNotes email access. This server also provides remote Lotus Domino administration through webadmin.nsf.

Because there are two web servers that can be enabled, you should be aware of the issue of port conflicts when you want to enable both servers.

The Lotus Foundations web server always serves on ports 80 (when Web Server is enabled) and/or port 443 (when Secure Web Server is enabled). If you want to enable both the Lotus Foundations web server and the Lotus Domino server, you have to ensure that the Lotus Domino web server uses ports other than 80 or 443 (common choices might be port 8080 and port 4443).

These port settings are modified using Domino Administrator or Domino Web Admin to edit the server document for the Lotus Foundations Branch Office server. The settings are found under Ports -> Internet Ports -> Web.

More information on modifying Domino's web server settings can be found at Modifying Web server Internet port and protocol settings.

The remainder of this section discusses the configuration of the Lotus Foundations web server, which is done in WebConfig.

Lotus Foundations Web server

The high-performance Web server featured in Lotus Foundations is based on the industry standard Apache Web server and it supports Common Gateway Interface (CGI) scripts. Perl and PHP: Hypertext Preprocessor (PHP) are also integral parts of the Web services of Lotus Foundations.

Lotus Foundations provides Web services on a master Web server and on virtual Web servers.

Master Web server

What is the master Web server?

The master Web server is designed to serve your intranet site and the personal Web pages of your Lotus Foundations users. Although it is possible to make these sites available to outside users, you can choose to keep them private for security reasons.

Master Web services are provided from IP addresses assigned to the internal and external network interfaces of Lotus Foundations. If the Web server is enabled and access is granted to outside users, anyone accessing the Lotus Foundations server's internal or external Internet Protocol (IP) address from a Web browser can access information on the master server.

Webmaster directory

When the webmaster team is created, a shared network directory called webmaster is made available to all members of the webmaster team. The subdirectory WWW is created in the webmaster directory, and this is the subdirectory from which files are served.

The webmaster directory also contains the log subdirectory, where server access and error logs are maintained, as well as a cgi-bin directory, where all Common Gateway Interface (CGI) scripts are stored.

Configuring your master Web server

To configure your master Web server, perform these steps:

  1. Click Web Server in the left-side menu of WebConfig. The Basic Setup tab of the Web Server Setup screen is displayed.
    Figure 36. Basic Setup tab of the Web Server Setup page of WebConfig
    screen shot of the basic setup tab of the web server setup page of webconfig
  2. In the Web Server field, select one of the following: Enable, Only Trusted Hosts, Disable, or Dynamic Redirect.
    Table 14. Web Server enablement options
    Option Description
    Enable
    • Enables the Web server
    • Enables users on the internal network and users on the Internet to access Web pages on this server
    • Serves pages out of the webmaster's WWW directory
    • Web server logs are written in the webmaster's directory
    Only Trusted Hosts
    • Enables the Web server
    • Enables users on the internal network to access Web pages on this server
    • Serves pages out of the webmaster's WWW directory
    • Web server logs are written in the webmaster's directory
    Disable Disables the Web server; no one can access Web pages on this server
    Dynamic Redirect
    • Enables redirection of Web connections
    • Can be employed to circumvent blocked HTTP (Web) ports
    • All Web requests directed at Lotus Foundations are handled by a dynamic DNS server, automatically redirecting them to a different port on the Lotus Foundations server; redirection is almost transparent to clients, who may notice the host name and port changed slightly
    • DynamicDNS must be enabled (see Domain Name Service for more information)
  3. In the Secure Web Server field, select one of the following: Enable, Only Trusted Hosts, or Disable.
    Table 15. Secure Web Server enablement options
    Option Description
    Enable
    • Enables the secure Web server
    • Enables users on the internal network and users on the Internet to access Web pages on this server
    • Serves pages out of the webmaster's WWW directory
    • Web server logs are written in the webmaster's directory
    Only Trusted Hosts
    • Enables the secure Web server
    • Enables users on the internal network to access Web pages on this server
    • Serves pages out of the webmaster's WWW directory
    • Web server logs are written in the webmaster's directory
    Disable Disables the secure Web server; no one can access secure Web pages on this server
  4. In the MySQL Server field, select one of the following: Enable or Disable.
    Table 16. MySQL Server enablement options
    Option Description
    Enable
    • Enables the MySQL server
    • Users on the internal network have access to personal databases and databases of any teams to which they belong
    Disable
    • Disables the MySQL server
    • Users do not have access to personal or team databases
    • Default setting
    User and team databases are automatically created when user and team accounts are set up. MySQL databases can be used to store dynamic Web page data for services such as online catalogs and stores.
    MySQL is an advanced feature for users that are familiar with SQL (Structured Query Language). Refer to MySQL server for more information.
  5. In the Users' personal home pages field, select one of the following: Enable, Only Trusted Hosts, or Disable.
    Table 17. Users' personal home pages enablement options
    Option Description
    Enable
    • Enables users' personal home pages to be viewed from anywhere
    • Master Web server must also be enabled
    • Format for addresses of personal home pages: http://server.domain/~username
    Only Trusted Hosts
    • Enables users' personal home pages to be viewed only from the local network
    • Master Web server must also be enabled
    • Format for addresses of personal home pages: http://server.domain/~username
    Disable Disables personal home pages
    This setting enables users to serve personal home pages to users on your network or the entire Internet from the WWW subdirectory located in each user's personal network directory.
  6. In the Content filtering field, select one of the following: Enable or Disable.
    Table 18. Content filtering enablement options
    Option Description
    Enable
    • Enables content filtering
    • Users can only access sites on a specified list; access to all others are forbidden
    • Configure settings on the Content Filtering tab
    Disable
    • Disables content filtering
    • Default setting
  7. In the Choose a team to act as webmaster field, select a team from the drop-down list to maintain the server. Although the webmaster team is created as the administrator of the master Web server and is listed as the default option for this field, any team can be designated to perform server maintenance tasks.
  8. In the Webmaster Email address field, enter the e-mail address of the webmaster (the person in charge of the Web site), or a name of a user on the server.
  9. In the Web Proxy port field, enter the appropriate Web proxy port. Leaving the default value of 0 enables the server to choose the Web proxy port.
  10. In the Megabytes of WWW cache field, enter the appropriate number of megabytes for the WWW cache field. Refer to Web caching for more details.
  11. Click Save Changes.

Virtual Web servers

Although virtual Web servers enable you to host a number of Web sites from the same server, these sites are displayed to outside users as though they are all hosted by different servers. To configure virtual Web servers on the outside interface, your Internet service provider (ISP) has to assign you multiple Internet Protocol (IP) addresses or you have to use name-based virtual Web sites, which use unique domain names to distinguish among Websites that share a single IP address.

Maintenance Teams

Every virtual Web site must be associated with a maintenance team, which can maintain the content for only one virtual Web site. This content, though, can reside on different virtual Web servers. For example, you create a virtual Web server for example.com and one for example.net, but you want both sites to display the same information. You must create two virtual Web servers, but the virtual Web servers can share the same maintenance team. In contrast, if you want to display different content on example.com than what is displayed on example.net, the two virtual Web servers need two different maintenance teams.

If the virtual Web site is maintained by users on the local network, they can be made members of the maintenance team. If the site is maintained by outside users, they have to use File Transfer Protocol (FTP) to access to the Web site directory. If they have an account on the server, they can use their own login name and password. If they do not have an account on the network, they have to use the team name and password.

Creating a new virtual Web server

To create a new virtual Web server, perform these steps:

  1. Click Web Server in the left-side menu of WebConfig. The Basic Setup tab of the Web Server Setup screen is displayed.
  2. Click the Virtual Web Server tab.
    Figure 37. Virtual Web Server tab of the Web Server Setup page of WebConfig
    screen shot of the virtual web server tab of the web server setup page of webconfig
  3. Click Add Virtual Web Server. The New Virtual Domain screen is displayed.
  4. In the Hostname of Virtual Web Server field, enter your Internet domain name. This host name is used as a Domain Name Service (DNS) entry for domain name resolution.
  5. The name of your Lotus Foundations server automatically populates the IP Address of Virtual Web Server field. If you want to use a different IP address, enter it in this field.
    Note: Your ISP must provide you with an extra IP address if you are configuring a virtual Web server on an outside, untrusted interface.
  6. In the Choose a team to act as webmaster field, select a team to perform webmaster duties from the drop-down list.
  7. In the Trusted hosts only field, select Yes or No. This option determines whether or not the virtual Web site is accessible only by trusted hosts. This option enables you to host both an intranet and a public Web site from the same server.
  8. In the Enable users' personal home pages field, select Enable or Disable. This option determines whether or not you want to serve personal home pages from the WWW subdirectory located in each user's personal network directory.
  9. Click Save Changes.

Deleting a virtual Web server

To delete a virtual Web server, perform these steps:

  1. Click Web Server in the left-side menu of WebConfig, then click theVirtual Web Server tab of the Web Server Setup page. The Virtual Domains Setup section is displayed, showing all existing virtual domains.
  2. Click the appropriate server's delete icon screen shot of the delete icon in the Action column.
  3. Click OK to confirm the deletion in the pop-up window.

All Web files for that server reside in the team's directory and are not deleted unless the team maintaining the site is deleted.

Editing a virtual Web server

To edit a virtual Web server, perform these steps:

  1. Click Web Server in the left-side menu of WebConfig, then click the Virtual Web Server tab of the Web Server Setup page. The Virtual Domains Setup section displays all existing virtual domains.
    Figure 38. The Virtual Domains Setup section of the Web Server Setup page of WebConfig
    screen shot of the virtual domains setup section of the web server setup page of webconfig
  2. Click the appropriate server's edit icon screen shot of the edit icon in the Action column. The Modify Virtual Domain page is displayed.
  3. Change the appropriate server settings.
  4. Click Save Changes.

Hosting multiple Web sites

If your Lotus Foundations server is used as a Web hosting platform for a number of Web sites owned by various customers, you should use the following strategy.

For example, if your Lotus Foundations server is used to serve a Web site for AcmeWidgets, follow these steps:

  1. Create a team called AcmeWidgets.
  2. Create a virtual Web server and choose the AcmeWidgets team as the Webmaster team. Anyone from the AcmeWidgets team can access these files using File Transfer Protocol (FTP) with the username AcmeWidgets and the team's password.

Secure Web services

Secure Socket Layer (SSL) encryption

The Lotus Foundations Web server can serve secure Web pages, which are transmitted over the Internet using Secure Socket Layer (SSL) encryption technology. All browsers on the market support SSL encryption. For SSL to work, the Web server must have a file with a security certificate. This file is unique to every Web server and, for encryption to properly work, the certificate has to be issued by a proper certificate authority. When the user loads a secure page, its certificate is compared to the certificate held by the certificate authority. If they match, the site is considered trusted, and encrypted communication can commence.

You can purchase SSL security certificates from a number of Internet security companies.

Lotus Foundations security certificates

The security certificates that Lotus Foundations generates can be checked for authenticity by all Web browsers. The security certificate generated by Lotus Foundations is placed in the webmaster directory and named certificate.pem.

A user loading the first secure Web page from the server is warned that this security certificate is valid, but that the company issuing it cannot be considered trusted. The user has to manually approve the continuation of the transaction. Despite this warning, information exchanged between the Web browser and the Web server cannot be viewed by others.

If you purchase a security certificate from a certificate authority, delete the file automatically created by Lotus Foundations and replace it with the one you purchased. See SSL certificate for more information. You might also want to store a copy of the purchased certificate in a different directory.

SSL certificate

Although a security certificate is automatically generated the first time you power up your Lotus Foundations server, you can overwrite this certificate at any time with a third-party certificate purchased from a certificate authority.

Note: You can only use X.509-based certificates.

Replace with a third-party certificate

To replace the automatically generated security certificate with a third-party security certificate, follow these steps:

  1. Click Web Server in the left-side menu of WebConfig. The Basic Setup tab of the Web Server Setup page is displayed.
  2. Click the SSL Certificates tab.
  3. Enter your personal information in the PKCS#10 Request Specifics fields.
  4. Click Generate PKCS#10 Request. A Security Alert window is displayed. Click Yes.
  5. The System Message box at the top of the page shows that Lotus Foundations is generating a new certificate request based on the information you provided in the previous steps. A new certificate request is generated in the PKCS#10 Certificate Request box.
  6. Copy and paste the new certificate request from the PKCS#10 Certificate Request box and give it to your certificate authority. They use this to generate a new certificate.
  7. Once you have received the new certificate from your certificate authority, copy and paste it into the X.509 Certificate box.
  8. Click Replace Certificate.

Web caching

To improve bandwidth, Lotus Foundations can temporarily store Web files accessed by internal users in a cache. If a user requests any of these stored files, Lotus Foundations serves them from the cache instead of from the original Web site. Internet bandwidth is used only to retrieve Web pages that have not previously been viewed, resulting in much faster access to the Internet.

Configuring Web caching

To configure Web caching, perform these steps:

  1. Click Web Server in the left-side menu of WebConfig. The Basic Setup tab of the Web Server Setup page is displayed.
  2. Enter the amount of data to be cached in the Megabytes of WWW cache field. Specify 5-10 MB for every active user on the internal network.
  3. Click Save Changes.
  4. For Web caching to run transparently, ensure that your Web browser is not configured to use a proxy server.

Web filtering

 

Web and content filtering

Lotus Foundations provides positive Web filtering, which is a feature that enables the system administrator to permit access to specific Internet sites, while blocking access to all others. By default, Web filtering is disabled, meaning any workstation can access any Website.

Enabling the Web filter

When the Web filter is enabled, users can only access permitted Websites (see Adding permitted Websites). Follow these steps to enable the Web filter:

  1. Select Web Server from the left-side menu in WebConfig. The Web Server Setup screen is displayed.
  2. In the Content filtering field, select Enable.
  3. Click Save Changes.

If you plan to use Web filtering in conjunction with Web caching, all proxy server settings must be removed.

Providing full internet access

To provide a specific workstation with access to all Internet sites, follow these steps:

  1. Click Web Server from the left-side menu in WebConfig.
  2. Click the Content Filtering tab.
  3. Enter their host name or IP address in the "Workstations Exempt from Filtering" section of the screen.
  4. Click the green plus sign to add the entry. The new entry is displayed in the list of workstations with full access.

    To remove full access for a workstation, click the delete action button located next to the workstation name or IP address. The exemption list can take up to two minutes to refresh.

Port exemptions

When enabled, the Lotus Foundations content filter monitors port 80 and all others above 1023 (1024-65535). If an application uses a port between 1024 and 65535 that you need to open, follow these steps to permit that application to bypass the content filter. Note that all other applications using this port also are exempt from Web filtering.

  1. Click Web Server from the left-side menu in WebConfig.
  2. Click the Content Filtering tab.
  3. Enter the port number you want to exempt in the "Ports Exempt From Filtering" section.
  4. Click the green plus sign to add the entry.

To remove full access for a port, click the delete action button located next to the Port number. The exemption list can take up to two minutes to refresh.

Adding permitted Websites

For users to access a specific Website, the administrator has to add it to the Permitted Websites list. By default, the Websites ibm.com(R), net-itech.com, and nitix.com are automatically added.

To add a Website you want to permit all users access to, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. In the Permitted Websites section, enter the site's name in the empty Add New Website field. Click the green plus sign to accept the change. The Website you entered is now added to the permitted Websites list. To view the permitted Website list, click Display Permitted Website List.
  4. Click the green plus sign to accept the change. The Website you entered is now displayed in the permitted Websites list.

    *.example.com

    example.*

 

Adding denied Websites

To manually add a denied Website for the first time, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Go to the Denied Websites section. Enter the Website address in the Add New Website field.
  4. Enter the reason for denial. This section is optional.
  5. Click the green plus sign to add the entry. When this is done, the Denied Websites box displays a link labeled Display Denied Website List. You can either click this link to view the current list and add new entries or add new entries on the main.

Accepting access requests

If a user has requested access to a Website that has not been authorized, a notice is displayed in their browser.

The user can request that this site be authorized by the administrator by clicking the Request Access button.

The administrator can view the all the pending requests in the main Content Filtering section of WebConfig by clicking the link Display Pending List.

To accept or deny requests, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Click Content Filtering Requests.
  4. A list containing the requested sites is displayed. Choose to permit the site by clicking the green plus icon.

    Users can now access the permitted Website.

Denying access requests

To deny a requested Website, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Click Content Filtering Requests as you would if you were going to accept a request. The list of pending requests is displayed.
  4. If you want to immediately deny the request, click the delete button. If you want to provide a reason, click the edit action button and enter it into the field labeled Reason for Denial. When you are done, click Deny Request.

List management

The list management feature enables you to import and customize content filtering lists from other Lotus Foundations servers. You can export and customize the local content filtering list to share with other Lotus Foundations servers.

Importing a list

To import a content filtering list you must first obtain an exported list from another Lotus Foundations server. Refer to Exporting a list for how to do this. After this is done, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Click Import/Export Website Lists
  4. Choose whether or not you want the imported list to include the list of permitted websites. Click either the Enable or Disable radio button.
  5. Choose whether or not you want the imported list to include the list of denied Web sites. Click either the Enable or Disable radio button.
  6. Click the Browse button in the File To Import field and locate the file you want to import. The file name and path should now be displayed.
  7. Click Import Lists.

Exporting a list

To export a content filtering list, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Click Import/Export Website Lists
  4. Choose whether or not you want the exported list to include the list of permitted Websites. Click either the Enable or Disable radio button.
  5. Choose whether or not you want the exported list to include the list of denied Websites. Click either the Enable or Disable radio button.
  6. Click Export Lists. A text file is generated that you can save and use to port to another Lotus Foundations server.

Email reporting

The Lotus Foundations content filter can send email notifications every time a website has been requested and email a daily report of all requested sites.

To use the email reporting options, follow these steps:

  1. Click Web Server from the left-side menu of WebConfig.
  2. Click the Content Filtering tab.
  3. Click Configure Report Options. The Content Filter Reporting Options screen is displayed.
  4. To enable daily reports, set the Daily Reports to Enabled. This feature requires the internal SMTP server to be enabled.
  5. If you enabled daily reports, in the Time of Day for Daily Report drop-down, choose the time of day that the daily report of pending content filtering requests is to be mailed to the administrator. 00:00 represents midnight.
  6. To enable instant notification, set Instant Notification to Enabled. This feature requires the internal SMTP server to be enabled.
  7. Enter the email address for the administrator in the Administrator's Email Address field.
  8. Click Save Changes.

Hardware components report

Lotus Foundations has the capability to report on hardware that is detected in the server--including processors, memory, Ethernet and hard drives--and verify whether or not that hardware is currently supported by the version of Lotus Foundations running.

The Hardware Status page displays the details of all the hardware on the system, and information pertaining to the compatibility/support of the hardware within the current version of Lotus Foundations.

To view the Hardware Status list, click Hardware Status in the left-side menu of WebConfig. The Hardware Status page is displayed.

While the server polls the hardware, the Hardware Status page displays the following message: (Collecting hardware status data. Please wait...)

The information displayed varies according to the specific hardware in your server.

Table 19. Hardware Status columns
Column Description
Type Type of hardware being reported; for example, CPU and memory
Description Brand of hardware
Device ID Where the hardware is located in the server
Status Specifies if the hardware is one of three states:
  • Supported - Has its required drivers installed in the Lotus Foundations core
  • Unsupported - Does not have its driver installed
  • Support Unknown - The Lotus Foundations operating system cannot determine the required driver

Log messages

Accessing log messages

There are a variety of log files on a Lotus Foundations Branch Office server.

Follow these steps to access the logs:

  1. Connect to the file shares on the Lotus Foundations server. To do this, from a workstation, click Start -> Run and then enter '\\' followed by the server's IP address. For example, \\192.168.0.1. Login using a Lotus Foundations administrator account, such as root.
  2. A list of all the shares on the system is displayed. The important ones are notes, log, and domino.

    Note: Be careful when accessing these shares. Do not delete any files or folders.

Lotus Foundations also keeps a log that displays the messages from all of the Lotus Foundations subsystems. To view the log from the firewall subsystem, refer to Firewall log.

To access this log, click Logs and Reports in the left-side menu of WebConfig. The Log Messages page is displayed.

Customizing message display

The Highlight drop-down menu enables you to highlight messages coming from a specific Lotus Foundations subsystem, such as Disk manager and Fast/Port Forward, making them easier to view.

To customize your message log display follow these steps:

  1. Select a subsystem from the Highlight drop-down menu.
  2. Select an option from the Priority drop-down menu.
  3. Click Apply. The appropriate messages are highlighted.

Firewall log

For ICSA Labs firewall compliance, Lotus Foundations logs requests to send traffic through the firewall. See the Firewall services chapter for more information on the Lotus Foundations firewall. Firewall logging is only enabled when the Restrict Outgoing Connections field is set to Yes.

The following firewall information is logged:

The logs contain the following information:

To view the firewall log, you must be a member of the log team. This team is automatically created by Lotus Foundations.

The firewall log file is displayed in the team folder on Lotus Foundations. The file wvlog.current contains the latest log messages. This log is found at \\server_ip\log\wvlog.current

To add a user to the log team, follow these steps:

  1. Click Users in the left side menu of WebConfig. The Users tab of the User Setup page is displayed.
  2. Click the appropriate user's edit icon screen shot of the edit icon in the Action column. The Modify User screen is displayed.
  3. Select the log team in the Join Teams field. Click Join . The team is displayed in the Member of Teams field.
  4. Click Save Changes.

Virus scanner

AntiVirus for Lotus Foundations virus scanner gives you complete anti-viral protection for your Lotus Foundations server with file-level virus scanning. AntiVirus for Lotus Foundations scans for viruses on the local file system. AntiVirus for Lotus Foundations detects infected, suspicious, corrupted and password-protected files, and files that fail to be scanned because of an error. All infected, suspicious and corrupted objects that can not be automatically repaired are quarantined.

File virus scanner

AntiVirus for Lotus Foundations file virus scanner is not a real-time scanner, meaning that it does not scan for viruses as data is transmitted, copied, or moved to the Lotus Foundations server. Instead, the Lotus Foundations server runs a scheduled file scan once every 12 hours by default. This provides maximum stability and available resources to the daily operations of the Lotus Foundations server, which is especially important if you are using several features of the server at the same time. When a virus is encountered, it is cleaned up if possible. Otherwise it is renamed to filename-INFECTED and the user in whose directory the file was found is informed through email of the virus.

Activating your file virus scanner license

To activate your file virus scanner license, follow these steps:

  1. Click File Server in the left-side menu of WebConfig. The Basic Setup tab of the File Server Setup page is displayed.
    Figure 39. Basic Setup tab of the File Server Setup page of WebConfig
    screen shot of the basic setup tab of the file server setup page of webconfig
  2. In the File Virus Scanner field, select Enable.
  3. Click Save Changes.

Performance considerations

As with any feature-rich system, there are many aspects of determining how Lotus Foundations performance can be optimized for a specific environment. How fast the processor should be, how much memory is required, how often backups should run, and the types of applications that are added to the system all need to be assessed.

The Domino Configuration Tuner (DCT) tool evaluates server settings in server documents, NOTES.INI, and database advanced properties according to a growing catalog of best practices. DCT can then suggest adjustments to administrators to improve server performance. DCT is available by download or as part of Domino Administrator 8.5.

This section provides some optimization guidelines for Lotus Foundations Branch Office.

Minimum hardware requirements

The Lotus Domino server that sits at the heart of Lotus Foundations Branch Office is a product built for scalability. While Lotus Domino initially requires a substantial pool of resources to be able to operate almost regardless of the number of users, the incremental resources required for each additional user is typically less than for traditional applications built for small deployments. Keep this in mind when choosing the hardware required to run the system.

Minimum requirements to run Lotus Foundations Branch Office:

It is recommended that you use a system with SATA disks. For larger installations and/or installations with higher performance requirements, it is recommended that you use a system with higher-end SCSI disks.

The basic requirements are met with a Lotus Foundations Appliance.

Deploy Lotus Foundations Branch Office on hardware as fast as your budget accommodates, particularly if you intend to deploy applications in addition to the standard email/groupware bundled with Lotus Foundations Branch Office.

Hardware sizing based on number of users

The following table illustrates the recommended sizes based on number of users for optimum system selection:

Table 20. Recommended configurations based on number of users
Number of users Configuration used in baseline Representative base hardware configurations Notes
1-150 Intel(R) Core 2 Duo 2.0 GHz / 800 MHz Bus / 2 MB Cache (E4400), 2 GB DDR2 SDRAM (4 GB max), 2 x 250 GB removable SATA hard drives Lotus Foundations Appliance, entry level - model CNx 1 disk reserved for idb backup
150+ Intel Core 2 Duo 2.6 GHz / 1066 MHz Bus / 4 MB Cache (E6600), 2 GB DDR2 PC5300, 3 x 250 GB removable SATA hard drives Lotus Foundations Appliance, advanced level - model DNx 1 disk reserved for idb backup

The average email user sends and receives approximately 100-200 emails per day, and has a mail database of 500 MB. The average email is 50 KB in size. For calculation purposes, the average Lotus Foundations Branch Office user uses a Lotus Notes client connected live to the server. Allowances should be made if your deployment environment differs significantly from the average, particularly with respect to the amount of email traffic and the size of the users' mail databases that are stored on the server.

Email protocol choices affecting server performance

This section provides the major protocol choices provided to permit email clients to connect to the Lotus Foundations Branch Office server and their relative impact on the server. This section includes the load required, based on relative system usage, to support the protocol, as well as any document conversions required to transmit the emails.

When determining the type of client to deploy, how many users, and type of users, the above demonstrates that not all clients have the same impact on system performance.

Other services running on the Lotus Foundations server

Careful consideration should also be given to the many other services running on the Lotus Foundations Branch Office server, including the file server, Web server, and Point-to-Point Tunneling Protocol (PPTP).

Lotus Foundations Branch Office requires approximately 1 GB of memory for Lotus Domino. If your system uses other services, consider upgrading memory to ensure that adequate memory is available to run services in addition to Lotus Domino.

The same consideration should be given to the processor selection: allowances should be planned so that other services may adequately run in conjunction with the Lotus Domino server.

Backup scheduling

Lotus Foundations Branch Office includes an idb job that takes care of backing up the notesbackup team. This job is the LF Branch Office Backup job. The job itself takes care of backing up the Lotus Domino databases safely to the notesbackup team each time the job runs so that the databases are in a consistent state when backed up. You should schedule the job for minimum impact on the business operations.

Carefully consider when a backup is scheduled to start and how often the backup is scheduled to run. You should gauge approximately how long your backups take based upon how much data you have.

The following should help you in your planning:

Table 21. Lotus Domino backup duration based on number of users
Number of Users Domino backup duration
20 First backup approximately 60 minutes; subsequent backups approximately 15 minutes
50 First backup approximately 3 hours; subsequent backups approximately 1 hour
150 First backup approximately 3.5 hours; subsequent backups approximately 1.5 hours

For example: If you have 20 users with a total email size of 5 GB and total disk space used on the system is 150 GB, you can expect the backing up the Lotus Domino databases part of the LF Branch Office Backup job to take approximately 15 minutes. A full backup of the same system takes approximately two to three hours, plus another two to three hours to perform the backup verification (for a total of four to six hours).

Most offices schedule their backups during off-hours, as backups place an extra load on the server. An example schedule assumes that you want the backups to start at some time after 9:00 PM and complete by 7:00 AM. If you schedule the LF Branch Office Backup job to begin at 9:00 PM, with 5 GB of data, the estimated time to completion for the Lotus Domino database backups part of the LF Branch Office Backup job would be 9:15 PM. Given the estimate that a full idb backup takes up to six hours to complete, the idb backup part of the LF Branch Office Backup job should start no later than 1:00 AM. To provide a bit of margin (and a bit of room for growth in the database and system server usage), schedule the LF Branch Office Backup job for 10:00 PM.

It might not always be possible to schedule the backups without impacting business operations, as the business might be open for extended time periods or the amount of data might require the backup windows overlap into the business day. In these circumstances, it is valuable to consider what time of the day the extra load would have the least impact on the business.

Future capacity planning

The storage space required on a server for files and email can rapidly increase. Anticipate your future needs and choose the correct hard drive capacities, but also be aware that increased capacities have an impact on your server performance. Effects of increased storage on server performance include the following:

Ever-increasing size in users' mail databases can have a negative overall impact to the server. It is worth considering setting user email quotas to limit the growth of mail databases. Desktop clients, such as Lotus Notes, can be set to automatically archive older mail offline so that an archive of mail is still available without suffering the performance penalties associated with keeping the seldom-accessed old mail active on the server.

Lotus Domino is an application platform. If you intend to use applications, then considerations need to be made regarding disk capacity, processor, and memory to accommodate the needs of the applications. Each application has different system needs, so application documentation should be referenced for capacity planning.

Glossary

ADSL Asymmetric Digital Subscriber Line. ADSL uses standard phone lines to deliver high-speed data communications. ADSL uses the portion of a phone line's bandwidth not utilized by voice, allowing for simultaneous voice and data transmission.
Bandwidth This term describes information-carrying capacity of telephone or network wiring. Bandwidth is usually measured in bits per second.
Bit Binary Digit. The smallest unit of computerized data. A bit is represented as either 1 or 0.
Cable Modem Cable modems provide Internet access over cable TV networks (which use fiber-optic or coaxial cables). They are generally much faster than modems that use phone lines.
Cache A copy of a program or data that is used for faster access. See also Web Cache.
Certificate Authority An issuer of security certificates used in SSL connections. See also SSL.
Client A computer system or process that requests a service from another computer system or process.
Data Encryption Encrypting data is accomplished by applying a scrambling code that makes the data unreadable to anyone who does not have a decryption key. Authorized personnel with access to this key can unscramble it. Data encryption is a useful tool against malicious users.
DHCP Dynamic Host Configuration Protocol. This is an industry-standard protocol that assigns IP information to computers.
Disk Quota Disk Quota defines the maximum amount of hard disk space allowed for a user's files.
DNS Domain Name Service. A set of guidelines and rules that allows you to navigate the Internet using domain names instead of IP addresses.
DDNS or DynamicDNS Dynamic Domain Name Service. A service that automatically updates DNS information when a new IP address is assigned to a network.
DNS Server A computer or server that matches an IP addresses to a domain name. Some ISPs provide a specific DNS address.
DSL Digital Subscriber Line. Technology that provides data transmission over the telephone network.
Ethernet A LAN that connects devices like computers, printers, and terminals. Ethernet transmits data over twisted-pair or coaxial cables at 10, 100, or 1000 Mbps.
EtherTalk Networking protocol used by Apple equipment connected directly to Ethernet.
FastForward The ability to create a passage (or open a port) through your firewall to a service or a server hosting a service. See also Port Number.
Firewall A device that provides secure Internet access and protects internal networks from intruders.
FTP File Transfer Protocol. An Internet based protocol used to copy files between computers (usually a client and a server) using UNIX-based command parameters. You can download shareware or freeware applications that remove all the complexities of UNIX and allow you to connect to FTP sites using a Web browser.
Gateway A computer or server that is connected to multiple networks and is capable of routing or delivering packets between them.
HTML Hypertext Markup Language. A set of tags and instructions used to create web pages. HTML tags create page layouts, format text, insert graphics and multimedia, and more.
HTTP Hypertext Transfer Protocol. A protocol that makes hypertext information such as web pages available over the Internet.
Hub A piece of hardware that connects computers together in a LAN, allowing information to travel between them.
Internet Gateway A gateway for accessing the Internet, which is loosely defined as points of entrance to and exit from a communications network. A gateway is the node that translates between two otherwise incompatible networks or network segments. Gateways perform code and protocol conversion to facilitate traffic between data highways of differing architecture. A gateway can be thought of as a function within a system that enables communications with the outside world.
IMAP Internet Message Access Protocol. A popular protocol that allows a client to access email without downloading it to a local computer. Used mainly to read email from a remote location.
IMAP Server A server that uses IMAP to provide access to multiple server-side folders.
IP Address Internet Protocol Address. The numeric address used to identify and locate a server, computer, or Web site on the Internet.
IP Address (Dynamic) A temporary IP address that is assigned to a computer by a DHCP server each time it goes online.
IP Address (Static) A permanent IP address that is assigned to a computer in a TCP/IP network. Network devices that serve multiple users, such as servers, routers, and printers, are usually assigned static IP addresses.
IPsec Internet Protocol Secure. A type of secure connection between computers at different locations, creating Virtual Private Networks. See also VPN (Virtual Private Network).
ISDN Integrated Services Digital Networking. A digital-communication networking system used for high-speed communication with the Internet. ISDN is available through most telephone companies.
ISP Internet Service Provider. An organization that maintains a server directly connected to the Internet. Users who are not directly connected to the Internet typically connect through an ISP.
Java(TM) Designed by Sun Microsystems, Java is a programming language for adding animation and other action to Web sites. To view web sites created with Java, your browser has to have Java enabled.
JavaScript(TM) Designed by Sun Microsystems and Netscape as an easy-to-use supplement to Java, JavaScript code can be added to standard HTML pages to create interactive documents. Most modern browsers support JavaScript.
kbps Kilobits per Second (thousands of bits per second). This is a measure of bandwidth, the amount of data that can flow in a given time, on a data transmission medium.
LDAP Lightweight Directory Access Protocol. The LDAP server provides a directory of users' names and email addresses.
LAN Local Area Network. A LAN links together computers that are in the same building. 10BaseT Ethernet is the most common LAN. See also Hub.
Mbps Megabits per Second (millions of bits per second). This is a measure of bandwidth (the amount of data that can flow in a given time) on a data transmission medium.
MX Record Mail Exchange Record. A DNS resource record type that indicates which host can handle mail for a particular domain.
NetBIOS Network Basic Input Output System. A protocol for networking on IBM PC and compatible systems.
NAT Network Address Translation. NAT enables one publicly visible IP address to refer to many IP addresses internally on a LAN, making it look like all traffic was generated by a single external IP address.
NFS Network File System. A protocol developed by Sun Microsystems which enables a computer to access files over a network as if they were on its local drive.
NIC Network Interface Card. An adapter card that physically connects a computer to a network cable.
NTP Network Time Protocol. An Internet standard protocol (built on top of TCP/IP) that assures accurate synchronization to the millisecond of computer clock times in a network of computers. Running as a continuous background client program on a computer, the NTP client sends periodic time requests to external time servers, obtaining server time stamps and using them to adjust the client's clock.
Packet A unit of data transmitted over a network. Large chunks of information are broken up into packets before they are sent across the Internet.
Packet Filter A filter that blocks traffic based on a specific IP address or type of application (email, FTP, Web), which is specified by port number.
Peer-to-Peer Network A network where there is no dedicated server. Computers with access privileges can share files and peripherals with all other computers on the network.
Perl A programming language used for various tasks such as system administration, web development, network programming, and graphical user interface development.
PHP PHP: Hypertext Preprocessor. A recursive acronym for a scripting language originally designed for producing dynamic web pages.
PING Packet InterNet Groper. A program used to determine if a server is functional. It sends small packets to the server, which replies with similar packets.
POP3 Post Office Protocol version 3. A popular protocol used most often by ISPs for receiving email messages. POP3 servers enable access to a single Inbox (as opposed to IMAP servers, which provide access to multiple server-side folders.
Port Number A number assigned to an application program running on a computer in a TCP/IP-based network such as the Internet. The number is used to link the incoming data to the correct service. There are several standard port numbers. For example, port 80 is used for Web traffic.
PPP Point-to-Point Protocol. A method of transmitting protocols (such as IP) over a serial link. PPP is most often used in dial-up modem connections from a home computer to an ISP.
PPPoE Point-to-Point Protocol over Ethernet. PPPoE is often used to connect DSL providers. Because it is based on two common standards (PPP and Ethernet), it is easy to integrate into existing networks.
PPTP Point-to-Point Tunneling Protocol. PPTP ensures secure communications over Virtual Private Networks.
Protocol A set of rules that govern network exchanges.
Proxy Server A server that acts as a barrier between an internal network and the Internet. Proxy servers can work with firewalls, which help keep outside users from gaining access to confidential information. A proxy server also enables the caching of Web pages for quicker retrieval.
RBL Realtime Blackhole List. A 'spam' blocker that has different levels of spam protection (such as Strong or Medium).
Router A device that handles the connection between two or more networks.
Routing The act of directing packets between networks.
Routing Table A list of destinations known to the router (server) that enables user traffic to get to and from its destinations.
RSA Rivest Shamir Adleman. An Internet encryption and authentication system that uses an algorithm developed by Ron Rivest, Adi Shamir, and Leonard Adleman.
Security Certificate Information used by the SSL protocol to establish a secure connection. Contains information about who a certificate belongs to, who issued it, its unique serial number, its valid dates, and its encrypted 'fingerprint' that is used to verify the contents of the certificate. See also SSL.
Server A computer or software package that provides specific services to a client. The term can refer to a particular piece of software (such as a Web server) or to the machine on which the software is running. A single server can run several different server software packages.
SNMP Simple Network Management Protocol. A protocol used to collect statistical information from a host about parameters such as central processing unit (CPU) utilization.
SMTP Simple Mail Transfer Protocol. A protocol used for transferring or sending email messages between servers. Another protocol (such as POP3) is used to retrieve the messages.
SQL Structured Query Language. A language used to create advanced databases.
SSL Secure Sockets Layer. A protocol that enables encrypted, authenticated communications to travel across the Internet. SSL is used mostly in communications between Web browsers and Web servers. URLs that begin with https indicate that an SSL connection is being used. Each side of an SSL connection must send a valid Security Certificate to the other. Each side then encrypts what it sends using both certificates, thereby ensuring that only the intended recipient can de-crypt it, that the other side can be sure of the data's origin, and that the message has not been tampered with.
Subnet A portion of a network (which can be a physically independent network segment) that shares a network address with other portions of a network. A subnet is distinguished by its own subnet number.
TCP/IP Transmission Control Protocol/Internet Protocol. A popular suite of protocols that allow computers to communicate on the Internet.
Telnet An application that lets you access resources on a UNIX or Linux computer. To use Telnet, you need to be familiar with UNIX-based programs.
UDP User Datagram Protocol. A protocol used throughout the Internet for services such as DNS.
URL Uniform Resource Locator. The standard method to give an address of any resource on the Internet. A URL looks like this: (http://www.ibm.com).
VPN Virtual Private Network. VPNs enable communication between users in different offices. To prevent people on the Internet from intercepting transmissions, all information that passes through a VPN is protected with 128-bit encryption, the strongest encryption technology available.
WAN Wide Area Network A network that connects different LANs using routers.
Web Browser An interface that lets you view material on the Internet. The most popular web browsers are from Microsoft and Netscape.
Web Cache An area on your hard disk that is reserved for storing images, text, and other files that have been viewed on the Internet.
WebConfig Web-based configuration system for Lotus Foundations. To connect to WebConfig, enter (http://hostname:8043) in the address bar of a Web browser. For example, if your Lotus Foundations server's host name is thunder, enter (http://thunder:8043) in the address bar.
WebMail Server A system that enables users to access their email account using any standard Web browser.

Note

As part of your purchase of IBM Lotus Foundations, you are also entitled to a full copy of SUSE Linux Enterprise Server (SLES) 10.1 operating system from Novell. You only need this if you need to modify your server with additional applications that require components from SLES that are not already integrated with Lotus Foundations. However, these extensions and applications are not a supported feature of IBM Lotus Foundations. To request a copy of SLES 10.1 send an email with your request to IBMLotusFoundations_Ops@us.ibm.com. Please include the following: contact name, company name, street address, city and postal code, country, contact phone, and contact email address.

Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation
Office 4360
One Rogers Street
Cambridge, MA 02142
U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Trademarks

IBM, the IBM logo, ibm.com, Lotus, and Notes are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol ((R) or (TM)), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft and Windows 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.