Installation Guide
Publication number: 613P10303; September 2003
Copyright © 2002-2003 Xerox Corporation. All Rights Reserverved. Xerox ®, The Document Company®, the digital X and DocuShare® are trademarks of Xerox Corporation. All other signs or marks are the properties of their respective companies, and recognized as such. Specifications accurate at time of publications. Specifications subject to change without notice.
Table of Contents
Chapter 1 Welcome to DocuShare
About DocuShare . . . 1–2 Server types . . . 1–2 DocuShare client requirements . . . 1–2 Licensing . . . 1–3 United States and Canada . . . 1–3 Europe . . . 1–3 Asia Pacific . . . 1–3 Other Regions . . . 1–3 Support . . . 1–4 Additional resources . . . 1–5
Chapter 2 Windows Server Installation
Preparing to install DocuShare . . . 2–2 System requirements . . . 2–2 Operating system . . . 2–2 Web servers . . . 2–2 Databases . . . 2–2 Security. . . 2–4 Installing DocuShare on a Windows server . . . 2–5 Migrating data to DocuShare 3.x. . . 2–13 Migration overview . . . 2–13 Preparing to migrate data . . . 2–13 Installing the migration tool . . . 2–14 Starting the migration tool . . . 2–15 Upgrading DocuShare 3.0. . . 2–18 Uninstalling DocuShare. . . 2–20 Configuring SSL for IIS web server. . . 2–21 Closing the Tomcat servlet port. . . 2–23 Configuring for auto login . . . 2–24 Connecting to your DocuShare server . . . 2–27 DocuShare login . . . 2–27
Chapter 3 Solaris/Linux Server Installation
Preparing to install DocuShare . . . 3–2 System requirements . . . 3–2
Table of Contents
Installing DocuShare on a Solaris or Linux server . . . 3–5 DocuShare download files . . . 3–5 Installing DocuShare . . . 3–5 Migrating data to DocuShare 3.x. . . 3–11 Migration overview . . . 3–11 Preparing to migrate data . . . 3–11 Installing the migration tool . . . 3–12 Starting the migration tool . . . 3–14 Upgrading DocuShare 3.0. . . 3–17 Uninstalling DocuShare. . . 3–19 Closing the Tomcat servlet port. . . 3–20 Disabling the UNIX FTP service . . . 3–21 Connecting to your DocuShare server . . . 3–22 DocuShare login . . . 3–22
Appendix A DocuShare Applications
DocuShare Windows Client . . . A–2 System requirements . . . A–2 DocuShare Outlook Client. . . A–4 System requirements . . . A–4 PaperPort Link to DocuShare . . . A–6 PaperPort versions . . . A–6 System requirements . . . A–6
Appendix B Web Servers
Configuring DocuShare for Apache on Windows . . . B–2 Configuring the Apache connection . . . B–2 Configuring DocuShare for Apache on Linux . . . B–3 Apache version 2.0.47 . . . B–3 Apache version 1.3.27 . . . B–4 Configuring DocuShare for Apache on Solaris . . . B–5 Apache version 2.0.47 . . . B–5 Apache version 1.3.27 . . . B–6 Sun ONE Web Server . . . B–7 Configuring Sun ONE for DocuShare on Windows . . . B–7 Configuring Sun ONE for DocuShare on Linux . . . B–9 Configuring Sun ONE for DocuShare on Solaris . . . B–11
Appendix C Databases
PostgreSQL on Linux . . . C–2 Verifying PostgreSQL . . . C–2 Using PostgreSQL 7.0 . . . C–2
Table of Contents
Installing PostgreSQL 7.2.3 with the source version . . . C–3 TCP/IP Connectivity . . . C–4 DocuShare 3 Tablespace . . . . C–6 PostgreSQL on Solaris . . . C–7 Installing PostreSQL with the compiled version . . . C–7 Installing PostgreSQL with the source version . . . C–8 TCP/IP Connectivity . . . C–9 DocuShare 3 Tablespace . . . . C–9 PostgreSQL with DocuShare on Windows . . . C–10 Verifying PostgreSQL . . . C–10 Using PostgreSQL 7.0 . . . C–11 TCP/IP Connectivity . . . C–11 DocuShare 3 Tablespace . . . C–13 Oracle database . . . C–14 Tablespace creation script example . . . C–14 Recommended database settings . . . C–15
Appendix D DocuShare Interact
What is DocuShare Interact . . . D–2 Enabling Interact . . . D–3 Configuring Interact . . . D–3
Glossary
Table of Contents
1
Welcome to DocuShare
DocuShare is a web-based document management application that enables workgroups and document intensive businesses to dynamically capture, manage, retrieve, and distribute information. With DocuShare, users can create their own accounts and add or delete information without a webmaster or site administrator.
This chapter contains the following:
• About DocuShare . . . 1–2
• Licensing. . . 1–3
• Support . . . 1–4
• Additional resources . . . 1–5
About DocuShare Welcome to DocuShare
About DocuShare
DocuShare is a web-based document management application that stores information organized in folders called collections. Collections can contain other DocuShare objects such as files, calendars, bulletin boards, URLs, and other collections. Any of these DocuShare objects can appear in mutliple collections at once and can be quickly located by using the various DocuShare navigation and search features.
Server types
DocuShare can be installed on the following platforms:
• Windows NT Server 4.0 (SP6a) using the IIS 4 http server
• Windows 2000 Server (SP1) using the IIS 5 http server
• Windows 2000 or NT Server using the Apache http server
• Sun Solaris
• Linux
DocuShare client requirements
Once DocuShare is installed on a networked server, users can access the shared information from any web browser equipped client workstation with access to the network server. Web browsers that are supported:
• Netscape Communicator 4.7 or higher
• Internet Explorer 4.x or higher
With DocuShare Windows Client software or the optional DocuShare Outlook Client software, DocuShare can be accessed with Windows Explorer or Microsoft Outlook.
Welcome to DocuShare Licensing
Licensing
DocuShare is distributed as a restricted use evaluation server. A 30-day license is required for the evaluation period and can be obtained at http://docushare.xerox.com/ds30/ds30-trial.htm.
If you have purchased DocuShare, you can disable the 30-day restriction by acquiring a DocuShare license.
United States and Canada
To obtain a DocuShare license, login as a DocuShare administrator and obtain the DocuShare Server ID from the Site Management/Server License Management page. Email the Server ID along with the number of seats and your customer information to the Xerox Teleweb Center at [email protected] or call 1-800-428-2995 and a DocuShare license will be generated and sent to you.
NOTE: Due to the length of the new licensing strings, licenses can only be emailed to customers.
Europe
To obtain a DocuShare license, login as a DocuShare administrator and obtain the DocuShare Server ID from the Site Management/Server License Management page. Send your Server ID and customer information to your local Xerox DocuShare reseller or distributor. The Xerox License Administrator will email your DocuShare license via your local Xerox DocuShare reseller or distributor.
Asia Pacific
To obtain a DocuShare license, login as a DocuShare administrator and obtain the DocuShare Server ID from the Site Management/Server License Management page. Send your Server ID and customer information to your local Xerox DocuShare reseller or distributor. The Xerox License Administrator will email your DocuShare license via your local Xerox DocuShare reseller or distributor.
Other Regions
To obtain a DocuShare license, login as a DocuShare administrator and obtain the DocuShare Server ID from the Site Management/Server License Management page. Send your Server ID and customer information to your local Xerox DocuShare reseller or distributor. The Xerox License Administrator will email your DocuShare license via your local Xerox DocuShare reseller or distributor.
Support Welcome to DocuShare
Support
Xerox offers installation and technical phone support to DocuShare customers at no additional cost for 30 days from installation. The DocuShare Web site at http://docushare.xerox.com provides online support information, current information about updates, and other resources available for download.
If you require technical assistance installing or using DocuShare:
• For the U.S., contact the Xerox Customer Support team through the web site, call 1-800-835-9013, or visit http://docushare.xerox.com/support.html.
Customer Support representatives are available Monday through Friday from 9 AM-7 PM, Eastern Time.
• For Canada, call 1-800-93-XEROX or visit the web site at http://www.xerox.ca.
• For Europe, contact your local Xerox DocuShare reseller or distributor for support or go to the DocuShare Web site at http://docushare.xerox.com/support.html for support information.
• For other regions, contact your local Xerox DocuShare reseller or distributor for support or go to the DocuShare Web site at http://docushare.xerox.com/support.html for support information.
Welcome to DocuShare Additional resources
Additional resources
In addition to the online help, the following information is available to help you work with DocuShare 3.x.
Resource Name Description
DocuShare User Tutorial Provides brief overviews and procedures on DocuShare basic functions—available online in HTML from the DocuShare Help page.
DocuShare Administrator Tutorial Provides brief overviews and procedures on DocuShare basic administrative functions—
available online in HTML from the DocuShare Administration Help page.
DocuShare User Guide Provides in-depth description of all DocuShare features—available online in HTML and PDF formats from the DocuShare Help page.
DocuShare Administrator Guide Provides in-depth description of all DocuShare administrator functions—available online in HTML and PDF from the DocuShare Administration Help page.
VDF Reference Guide Provides the template building mechanism to
customize the DocuShare web page—available in PDF from the DocuShare Administration Help page.
Command Line Utilities Guide Provides information for using the command line interface to administer DocuShare object and server properties—available in PDF from the DocuShare Administration Help page.
LDAP and Active Directory Guide Provides information to administer LDAP and Active Directory specific to the DocuShare server—available in PDF from the DocuShare Administration Help page.
DocuShare 3.x Release Notes Describes features and known problems with this release. On the server home page, click About DocuShare and click Release Notes.
Additional resources Welcome to DocuShare
2
Windows Server Installation
This chapter contains the following:
• Preparing to install DocuShare . . . 2–2
• Installing DocuShare on a Windows server . . . 2–5
• Migrating data to DocuShare 3.x . . . 2–13
• Upgrading DocuShare 3.0 . . . 2–18
• Uninstalling DocuShare . . . 2–20
• Configuring SSL for IIS web server. . . 2–21
• Closing the Tomcat servlet port. . . 2–23
• Configuring for auto login . . . 2–24
• Connecting to your DocuShare server . . . 2–27
Preparing to install DocuShare Windows Server Installation
Preparing to install DocuShare
The DocuShare Release 3.x server can be configured to work with several types of hardware and software. Use this pre-installation checklist to prepare your server for DocuShare installation.
System requirements
DocuShare 3.x installation on a Windows server requires the following:
Pentium III, 1GHz or equivalent
600 MB free disk space or greater
1GB RAM or greaterOperating system
Windows NT Server 4.0 SP 6a or higher
Windows 2000 Server with SP4 or later
Windows 2003 Server
Windows Small Business Server (SBS)Web servers
DocuShare requires a web servlet or server as part of its functionality. DocuShare includes a web servlet or can be configured to use one of the following web servers.
Microsoft IIS 4.0, 5.0, 6.0—the web server must be installed and running before installing DocuShare.
Apache 2.0.40—the web server must be installed and running before installing DocuShare.
iPlanet 4.0 SP12 (Netscape)/Sun ONE 6.0 SP5—the web server must be installed and running before installing DocuShare.NOTE: Refer to Appendix B, Web Servers for configuring one of the web servers.
Databases
DocuShare uses a database as part of its functionality. DocuShare can be configured to use MSDE, SQL Server, Oracle, and PostgreSQL databases.
MSDE 2000 (Microsoft SQL Server Desktop Engine)—is included in the DocuShare Release 3.x installation program. If MSDE is not installed on your system, DocuShare Release 3.x installer can install MSDE 2000. Refer to the Microsoft website for the latest service packs and hot fixes for MSDE 2000 or to Support on page 1–4 for Xerox support information.Windows Server Installation Preparing to install DocuShare
CAUTION: Do not install MSDE if an SQL Server is installed on your server. Your SQL Server data can be corrupted.
SQL Server v.7, 2000—SQL Server must be installed and functioning (database established). You can create and define the DocuShare database or if selected, a new Named Instance can be created and defined by the DocuShare installer.To connect DocuShare to the database, obtain the following information from your database administrator before installing DocuShare.
• Database User Name
• Database User Password
• Database Port
• Tablespace Name
• Database Host Name
Refer to Appendix C, Databases for a typical DocuShare tablespace creation script.
On your Windows server, set the SQLServer for SQL Server and Windows authentication only.
DocuShare 3.x does not support Windows only authentication at this time.
CAUTION: Do not install SQL Server if MSDE is installed on your server. Your MSDE data can be corrupted.
Oracle v7, v8i, v.9i—the database must be installed and functioning. You can create and define the Oracle tablespace or if selected, can be created and defined by the DocuShare installer. Oracle 9.2.0 should have the Server Patch Set 9.2.0.4 installed.To connect DocuShare to the database, obtain the following information from your database administrator before installing DocuShare.
• Database User Name
• Database User Password
• Database Port
• Tablespace Name
• Database SID
• Database Host Name
Preparing to install DocuShare Windows Server Installation
TECH NOTE: Oracle v.9i, the CLOB datatype must be enabled and the No Sort option disabled to work with DocuShare. Check the DocuShare Knowledge Base at http://www.xerox.com/
docushare/support for details.
Security
Scanning
The typical DocuShare installation has Scan-to-DocuShare capability, which utilizes an FTP server port to receive documents.
CAUTION: If your environment prohibits installing an FTP server for security reasons, select the option to install DocuShare without scanning.
Secure Sockets Layer (SSL)
SSL provides a secured communication layer between the IIS web server and client web browsers. SSL functionality is provided by the web server. To achieve SSL connectivity for DocuShare, you must enable SSL for the IIS web server and shut off the Tomcat servlet port.
To enable SSL for the IIS web server, see Configuring SSL for IIS web server on page 2–21. To close the Tomcat servlet port, see Closing the Tomcat servlet port on page 2–23.
Windows Server Installation Installing DocuShare on a Windows server
Installing DocuShare on a Windows server
1. Log into the server as a Windows server administrator.
TECH NOTE: To monitor the DocuShare installation, initial installation activity is recorded in a log.txt file located in the directory, C:\temp. When the DocuShare directory is created by the installer, a new log.txt file in the DocuShare home directory continues recording the remaining installation activities.
Local installation of DocuShare with MSDE is required. Windows Remote Terminal Services does not support remote MSDE installation.
2. To start the DocuShare installation.
a. Insert the DocuShare CD-ROM into the server CD-ROM drive. The DocuShare setup should start automatically. If you have disabled AutoRun, double-click setup.bat in the CD root directory. The DocuShare Install Menu displays.
b. If you downloaded DocuShare from the web into a temporary directory, to launch the installer, enter docushare.exe in the Run window.
Optional for DocuShare installation: use the command line -P docushareLog.cleanUp=false to preserve configuration and installation data at the completion of the DocuShare installation.
To use this utility, start the installation in a Command window:
docushare.exe -P docushareLog.cleanUp=false
NOTE: If this is a first time DocuShare install, it is recommended that you read the DocuShare Installation Guide before starting the installation. Click View Documentation to view or print
Installing DocuShare on a Windows server Windows Server Installation
3. Click Install DocuShare 3.0 on the DocuShare Install Menu to begin the installation.
The installation program uses Java to install the product. It takes a few minutes to unpack and install the Java files.
NOTE: An onscreen status indicator is not available while JVM completes its installation. The DocuShare Welcome screen displays at the completion of the Java installation.
Windows Server Installation Installing DocuShare on a Windows server
4. Click Next to start the DocuShare installation. Follow the onscreen instructions.
5. When the DocuShare Installation options window displays, select the option to install DocuShare.
NOTE: The DocuShare 2.2 Data Migration Tool is included with the Full DocuShare 3.x and DocuShare 3.x without Scan Feature installations.
CAUTION: The full DocuShare installation has Scan-to-DocuShare capability which utilizes an FTP server port to receive documents. If your environment prohibits installing an FTP server for security reasons, select the option to install DocuShare without scanning.
6. Click Next and follow the onscreen instructions.
7. When the DocuShare Install Parameters window displays, make any changes to the parameters or click Next to accept the default settings. DocuShare requires 6 TCP ports.
• Tomcat port—designated port for the Tomcat servlet (default port: 8080)
• RMI port—designated port for the RMI server (default port: 1090)
• RMI host—matches the RMI server’s hostname
• IMQ port—designated port for the IMQ JMS server port number (default port: 7676)
Installing DocuShare on a Windows server Windows Server Installation
• Tomcat Web Bridge Port—designated port for the Tomcat Web Bridge (default port: 8009)
• Tomcat Server Admin Port—designated port for the Tomcat Web servlet (default port: 8005)
8. When the Database Configuration screen displays, select the database option for your DocuShare site and click Next.
9. If you are using MSDE as your DocuShare database, do the following:
a. Enter the Database User Password (required).
b. Click the checkbox to Install MSDE.
c. Click Next to continue.
Windows Server Installation Installing DocuShare on a Windows server
TECH NOTE: If MSDE 2000 is currently installed on the server that will be used by DocuShare, select Default Instance or a new Named Instance to be created and defined by the
DocuShare installer.
10. A Reboot message displays if Install MSDE was selected. Click Next to continue.
NOTE: If an older version of MSDE exists, the DocuShare installer will upgrade to MSDE 2000 and reboot the system. At the completion of system reboot, restart the DocuShare installation.
11. When the Web Server Interaction screen displays, select the web server option for your DocuShare site.
Installing DocuShare on a Windows server Windows Server Installation
NOTE: If you are using IIS as your web server, select the option to install Tomcat/IIS web server.
Running IIS on your Windows server is recommended
12. Click Next to continue.
13. When the DocuShare Web server parameters window displays:
a. Enter the hostname (fully qualified DNS name, such as docushare.domain.com) b. Server root (docushare is the default).
NOTE: Refer to Connecting to your DocuShare server on page 2–27.
Windows Server Installation Installing DocuShare on a Windows server
14. Click Next to continue the installation.
15. When the Windows Service setup window displays, select the option for the DocuShare Windows Service.
TECH NOTE: Running DocuShare as services on your Windows server is recommended. If you do not select to run DocuShare as a service, you must enter the command
<DSHome>\bin\start_docushare in a command window to start DocuShare.
Installing DocuShare on a Windows server Windows Server Installation
18. Reboot the system if you selected to run DocuShare as a service, otherwise enter the command
<DSHome>\bin\start_docushare in a command window to start DocuShare; or in the Control Panel, open the Services application to select and start DocuShare.
NOTE: DocuShare initial startup automatically performs dsindexing; allow five minutes before accessing the site via a browser.
TECH NOTE: If you are using IIS as your only web server, go to Closing the Tomcat servlet port on page 2–23 to close the Tomcat servlet port.
19. To license your DocuShare server:
a. Log into the DocuShare server as admin using the password you supplied during the installation.
b. On the navigation bar, click Admin Home.
c. From the Administration menu, click Site Management / License.
d. Record or copy your server ID.
e. If this installation is for evaluation, click the link or go to:
http://docushare.xerox.com/ds30/ds30-trial.htm to complete the form and obtain a 30-day license.
See Licensing on page 1–3 for details obtaining a DocuShare server site license.
20. Refer to the DocuShare Administrator Guide to configure your DocuShare site.
Windows Server Installation Migrating data to DocuShare 3.x
Migrating data to DocuShare 3.x
If you are upgrading from DocuShare 2.2 to DocuShare 3.x on a Windows server, the DocuShare Installer CD includes a data migration tool to transfer your 2.2 data files to your new DocuShare 3.x server. Install the migration tool on your existing DocuShare 2.2 server.
Migration overview
The migration tool copies content and metadata from a DocuShare 2.2 server (source) to a DocuShare 3.x server (target). This includes repository contents as well as object property metadata and all user and group accounts. The following is an overview for migrating data from DocuShare 2.2 to a DocuShare 3.x server:
1. Access to a licensed DocuShare 3.x server (target).
NOTE: The server must be a new install, not a previously installed 3.x server with metadata. The 3.x server must be licensed to equal or exceed the number of users for the 2.2 server.
2. Install the migration tool on the DocuShare 2.2 server (source) .
NOTE: The DocuShare server must have Service Pack 1b or higher and be set to Read-Only.
3. Migrate DocuShare data.
4. If applicable, upgrade users to DocuShare 3.x Windows Client software.
5. If applicable, merge 3.x VDF files.
Preparing to migrate data
NOTE: If source and target servers are on the same system, you only need to install DocuShare once.
The DocuShare 2.2 Data Migration Tool is included with the Full DocuShare 3.x and DocuShare 3.x without Scan Feature installations.
Backup
The migration tool makes a copy of your content but does not modify the current site. It is recommended to backup the source server prior to attempting the migration.
Disk space
Migrating data requires access to adequate system disk space and virtual memory.
Migrating data to DocuShare 3.x Windows Server Installation
– Remote migration—migrating from a local to a remote system: minimum free disk space is equal or greater than the DS 2.2 directory size.
• Recommended system and virtual memory requirements: the target DS 3.x system and virtual memory is equal or greater than the current DS 2.2 system.
Trashcan contents
Items in the Trashcan are not copied to the new 3.x server. Trashcan items should be Restored to their collections or Expunged prior to migrating data between the servers.
VDF files
The migration tool does not migrate any customized VDF files to your DS 3.x server. The files must be merged for 3.x.
Installing the migration tool
1. Log into your DocuShare 2.2 server as a Windows server administrator.
2. Disable, on the source system, any remote access applications (for example, Remote Terminal Service or PC Anywhere).
3. Insert the DocuShare CD-ROM into the server CD-ROM drive. The DocuShare setup should start automatically. If you have disabled AutoRun, double-click setup.bat in the CD root directory.
TECH NOTE: If you downloaded DocuShare from the web into a temporary directory, to launch the installer, enter docushare.exe in the Run window.
4. When the DocuShare Installation Options window displays, select the DocuShare 2.2 Data Migration Tool option.
5. Click Next. The Migration Target screen displays.
Windows Server Installation Migrating data to DocuShare 3.x
6. Enter the target hostname (fully qualified DNS name, such as localhost.xerox.com) and the port parameter. Click Next to continue.
TECH NOTE: The upgrade target port is the RMI port of the DocuShare 3.x server (target). The default port number is 1099.
7. When the Install Wizard completes the Migration Tool installation, click Finish to close the installer.
Starting the migration tool
1. Create a temporary transfer folder (for example, c:\temp).
2. Disable any virus scanning to improve throughput performance during the migration.
3. Set the source DocuShare server to Read-Only.
4. Change directory to where the DocuShare migration tool is installed (<DSHome>\bin).
5. Enter dsupgrade2 c:\temp in a command window to start the data migration.
The source server starts copying the files to the temp folder. Data migration continues by exporting the files to the target server. Progress of the migration is displayed in the command window. A log file is created in the DocuShare 3.x installed directory, for example <DSHome>\logs.
6. At the completion of data migration, you are prompted to remove the temporary files. Enter yes to remove the files or no to retain the temporary copy.
Migrating data to DocuShare 3.x Windows Server Installation
8. Perform the following database maintenance procedure. This procedure should be included in your normal database maintenance schedule.
a. For a PostgreSQL database: vacuumdb -d <yourdatabase> -f -z -e.
CAUTION: To preserve your PostgreSQL indexes, do not use the PostgreSQL cluster command.
Cluster will physically reorder your index information.
b. For a SQL server database: update statistics for query analyzer, select 100% option.
9. Run dsindex -a index_all from the DocuShare 3.x server bin directory.
10. When migration completes, a Migration Status log displays.
11. Verify that all DocuShare 2.2 data has migrated to the DocuShare 3.x server. Compare the Migration Status log with the About Statistics on the DocuShare 2.2 server.
If there are significant differences in the migration statistics, it is possible that Trashcan contents were not expunged or restored prior to starting migration. Refer to Trashcan contents on page 2–
14.
12. Reboot the server.
TECH NOTE: If Summary and Keyword fields contain more than 256 characters, the DocuShare 3.x Migration Tool leaves the fields empty after migration from DocuShare 2.2. The problem value and the original value are logged into the upgrader2.log file. The field values must be corrected to 256 characters or less.
13. Configure your DocuShare 3.x server.
Windows Server Installation Migrating data to DocuShare 3.x
NOTE: The migration tool does not copy your DocuShare 2.2 system configuration to the new 3.x server. System configuration must be manually changed on the DocuShare 3.x server Home site. Refer to the DocuShare Administrator Guide to configure your DocuShare 3.x server.
14. If applicable, upgrade users to DocuShare 3.x Windows Client software. Previous versions of Windows Client cannot map to the DocuShare 3.x server.
15. If applicable, merge your 3.x VDF templates.
RESOURCES: To merge VDF templates, refer to the VDF Reference Guide, available from the Developer Tools tab on the Administrator Help Desk.
Upgrading DocuShare 3.0 Windows Server Installation
Upgrading DocuShare 3.0
If you are upgrading DocuShare 3.0 to DocuShare 3.x, the DocuShare Installer includes an upgrade utility.
You can upgrade your DocuShare 3.0 server to DocuShare 3.x using the DocuShare 3.x Installer CD or from the DocuShare 3.x application downloaded from the web.
NOTE: The DocuShare upgrade utility upgrades DocuShare 3.00.00 or a later version. To check your DocuShare version, click About DocuShare on the Home page.
To monitor the DocuShare upgrade, installation and upgrade activity is recorded in a log.txt file located in the DocuShare home directory.
To upgrade DocuShare 3.0:
1. Log into the server as a Windows server administrator.
2. In the Control Panel, select and open the Services application.
3. Select DocuShare to stop the server. Do not stop the database; the database must be running for the DocuShare Installer to upgrade the database schema.
4. To ensure the security of your DocuShare site data, backup your database. Refer to Chapter 3, DocuShare Administrator Guide or to your database server documentation, for data backup and restore procedures.
5. Exit all Windows applications before starting the DocuShare Installer Setup.
CAUTION: The DocuShare Installer will shutdown the IIS service during the upgrade and restart at its completion. If IIS service is not restarted by the DocuShare Installer, enter in a command window: net start w3svc.
6. To start the DocuShare upgrade.
a. Insert the DocuShare CD-ROM into the server CD-ROM drive. The DocuShare setup should start automatically. If you have disabled AutoRun, double-click setup.bat in the CD root directory. The DocuShare Install Menu displays.
b. If you downloaded DocuShare from the web into a temporary directory, to launch the installer, enter docushare.exe in the Run window.
Optional for DocuShare upgrade: use the command line -P docushareLog.cleanUp=false to preserve configuration and upgrade data at the completion of the DocuShare upgrade.
To use this utility, start the upgrade in a Command window:
docushare.exe -P docushareLog.cleanUp=false
Windows Server Installation Upgrading DocuShare 3.0
7. Click Install DocuShare on the DocuShare Install Menu to begin the installation.
The installation program uses Java to install the product. It takes a few minutes to unpack and install the Java files. Click Next to start the DocuShare installation and follow the onscreen instructions.
8. When the DocuShare Installation options window displays, select the option to install DocuShare.
CAUTION: The full DocuShare installation has Scan-to-DocuShare capability which utilizes an FTP server port to receive documents. If your environment prohibits installing an FTP server for security reasons, select the option to install DocuShare without scanning.
9. Click Next and follow the onscreen instructions.
10. When the Upgrade Option window displays, click Yes to upgrade your server.
11. Follow the onscreen instructions to continue the upgrade. During the upgrade process, the DocuShare upgrade utility backs up the appropriate system server configuration and data.
12. When the installer completes the DocuShare upgrade, click Finish to close the installer.
13. Reboot the system if you selected to run DocuShare as a service, otherwise enter the command
<DSHome>\bin\start_docushare in a command window to start DocuShare; or in the Control Panel, open the Services application to select and start DocuShare.
14. Perform the following database maintenance procedure. This procedure should be part of your normal database maintenance schedule.
a. For a PostgreSQL database: vacuumdb -d <yourdatabase> -f -z -e.
CAUTION: To preserve your PostgreSQL indexes, do not use the PostgreSQL cluster command.
Cluster will physically reorder your index information.
b. For a SQL server database: update statistics for query analyzer, select 100% option.
15. Run dsindex index_all from the DocuShare 3.x server bin directory.
Uninstalling DocuShare Windows Server Installation
Uninstalling DocuShare
To uninstall DocuShare 3.x from your Windows NT, 2000, or 2003 server, use the Add/Remove application in the server Control Panel. Uninstall will not remove the DocuShare directory that includes your
DocuShare repository content. You can do the following before uninstalling DocuShare.
• Leave the repository in its current location.
• Save your repository content to another storage media by using the DocuShare command line utility, dsexport, prior to uninstalling DocuShare. Refer to the DocuShare Command Line Utilities Guide for details.
CAUTION: If MSDE 2000 (Microsoft SQL Server Desktop Engine) was installed with the
DocuShare Installer, DocuShare Uninstaller will remove DocuShare and MDSE 2000.
Data for all Windows applications sharing the MSDE 2000 database should be backed up.
To uninstall DocuShare:
1. In the Control Panel, select and open the Services application.
2. Select DocuShare to stop the server.
3. In the Control Panel, select and open the server Add/Remove application.
4. Scroll and select DocuShare to uninstall the program. Follow the onscreen instructions.
5. Delete the directory in which DocuShare was installed.
NOTE: Uninstall removes all installed languages, such as French, German, and Spanish.
Windows Server Installation Configuring SSL for IIS web server
Configuring SSL for IIS web server
Secure Sockets Layer (SSL) provides an encrypted communication layer between your web server and client web browsers. DocuShare supports SSL when used with the IIS server. SSL functionality is provided by your web server, but DocuShare must be informed that SSL is being used so that it will supply
SSL-based addresses (https:// instead of http://). SSL may be enabled or disabled anytime after DocuShare has been installed.
To configure SSL:
NOTE: The following procedure and screens are for a Windows 2000 server. The procedure and screens will vary for an NT4.0 server.
1. From the Start menu, select Internet Information Manager.
2. In the Internet Information Manager window, right-click the Default Web Site and select Properties. The Default Web Site Properties window displays.
3. Click the Directory Security tab.
4. Click Edit in the Secure Communications section. The Secure Communications window displays.
Configuring SSL for IIS web server Windows Server Installation
5. Click the Ignore client certificates option.
TECH NOTE: If Require secure channel (SSL) is not checked, the DocuShare site can be accessed in a non-secured mode.
6. Click OK. SSL is now configured for the IIS web server.
Windows Server Installation Closing the Tomcat servlet port
Closing the Tomcat servlet port
During the DocuShare 3.x installation, if you selected to install the IIS option on the Web Server Interaction page, you can configure your DocuShare server for SSL by closing the Tomcat web servlet port to web browser access.
To close the Tomcat servlet port:
1. In a command window, check the Tomcat servlet port status using the command, dsservice status in the directory <DSHome>\bin.
2. Stop DocuShare by entering the command, stop_docushare.
RESOURCES: For a complete list of start_docushare commands and arguments, enter start_docushare help in the command window.
3. Enter the command, start_docushare tomcat http off, to close the Tomcat web servlet http port.
This action closes the port providing access to the Tomcat web servlet via a web browser.
4. Enter the command, start_docushare tomcat http on, to open the port to the Tomcat web servlet. This action allows access to the Tomcat web servlet.
NOTE: To update only the environment, add the argument update-only to the end of the start_docushare command.
5. Start DocuShare by entering the command, start_docushare. Reboot the system if you are using IIS as a service.
Configuring for auto login Windows Server Installation
Configuring for auto login
If you are enabling the DocuShare Auto Login feature to allow DocuShare Login Authentication to be handled by the Windows Domain Authentication, you must have the Internet Information Server (IIS) web server installed and configured to use with DocuShare.
NOTE: Ensure that the DocuShare server usernames and passwords are the same as authenticated by the web server.
To configure IIS for DocuShare Auto Login:
NOTE: The following procedure and screens are for an NT4.0 server. The procedure and screens will vary for a Windows 2000 server.
1. From the Start menu, select Internet Information Manager.
2. Stop the IIS web server. Right-click the IIS Server and select Stop.
3. In the Microsoft Management Console window, right-click the DocuShare host server and select Properties. The host server Properties window displays.
Windows Server Installation Configuring for auto login
4. Click Edit for Master Properties. The WWW Service Master Properties window displays.
5. Click the Directory Security tab.
6. Click Edit for Anonymous Access and Authentication Control. The Authentication Methods window displays.
a. Disable Allow Anonymous Access.
b. Enable Windows NT Challenge/Response.
c. Click OK.
Configuring for auto login Windows Server Installation
RESOURCES: Refer to the Getting Started chapter of the Administrator Guide to enable auto login.
TECH NOTE: It is also possible to use auto login with a customized web server other than IIS. The web server must be configured to set the REMOTE_USER environment variable to the username of the user it has authenticated as follows:
REMOTE_USER = <Domain>/<username>
Windows Server Installation Connecting to your DocuShare server
Connecting to your DocuShare server
At the completion of the DocuShare installation, try connecting to your new DocuShare server using a web browser. The default URL is http://<fully qualified DNS name>:8080/docushare.
A. If DocuShare was installed to the home directory on your web site, the URL is:
http://<fully qualified DNS name>:<port>/docushare
B. If DocuShare was installed into a subdirectory on your web site, the URL is:
http://<fully qualified DNS name>:<port>/<subdirectory_path>/docushare
• If you specified to install IIS on your server, then the :<port> component of the URL is not used. For example: http://<fully qualified DNS name>/docushare
• If you specified to install only Tomcat on your server, then the :<port> component of the URL is 8080 (default).
C. If you changed the server root to root during the installation, the /docushare (default) component of the URL is not required. For example, http://<fully qualified DNS name> or http://<fully qualified DNS name>:8080
If the installation was successful, you should be viewing the default home page of your new DocuShare server. The home page has links to many useful features and to several pre-installed collections.
DocuShare login
You can log in as admin at this time, using the password you created during the installation. You need to license the server to enable creating collections and adding documents to your server.
Account Creation Authorityis the default allowing all users to access the site and create their own user accounts. Site access can be configured for limited or restricted access. Refer to the Account
Management/Access Policies section in the DocuShare Administrator Guide.
RESOURCES: Take a moment to scan the DocuShare User and Administrator Tutorials that are included on the DocuShare Help page to familiarize yourself with DocuShare features and administration.
Connecting to your DocuShare server Windows Server Installation
3
Solaris/Linux Server Installation
This chapter contains the following:
• Preparing to install DocuShare . . . 3–2
• Installing DocuShare on a Solaris or Linux server . . . 3–5
• Migrating data to DocuShare 3.x . . . 3–11
• Upgrading DocuShare 3.0 . . . 3–17
• Uninstalling DocuShare . . . 3–19
• Closing the Tomcat servlet port. . . 3–20
• Disabling the UNIX FTP service . . . 3–21
• Connecting to your DocuShare server . . . 3–22
Preparing to install DocuShare Solaris/Linux Server Installation
Preparing to install DocuShare
The DocuShare Release 3.x server can be configured to work with several types of hardware and software. Use this pre-installation checklist to prepare your server for DocuShare installation.
System requirements
DocuShare 3.x installation on a Solaris/Linux server requires the following:
Solaris—Sun UltraSparc II
Linux—Pentium III, 1GHz or equivalent
600 MB free disk space or greater
1 GB RAM or greaterOperating systems
Solaris—Sun Solaris 7, 8, and 9
Linux—Redhat 7.1, 7.2, 7.3, and 8Web servers
DocuShare requires a web servlet or server as part of its functionality. DocuShare can be configured to use one of the following web servers.
Apache 1.3.27 and 2.0.47—the web server must be installed and running before installing DocuShare.A version of Apache is included in a separate directory within the DocuShare ds-linux-3.x.tar.gz file or ds-solaris-3.x.tar file.
iPlanet 4.1 SP12 (Netscape)/Sun ONE 6.0 SP5—the web server must be installed and running before installing DocuShare.NOTE: Refer to Appendix B, Web Servers for configuring one of the web servers.
Databases
DocuShare uses a database as part of its functionality. DocuShare can be configured to use PostgreSQL, SQL Server, and Oracle databases.
PostgreSQL—the database must be installed and functioning. You can create and define the DocuShare database or if selected, a new Named Instance can be created and defined by the DocuShare installer. A version of PostgreSQL is included in a separate directory within the DocuShare ds-linux-3.x.tar.gz file or ds-solaris-3.x.tar file. Refer to Appendix C, Databases for configuring PostgreSQL for DocuShare.
SQL Server v.8—SQL Server must be installed and functioning (database established). You can create and define the DocuShare database or if selected, a new Named Instance can be created andSolaris/Linux Server Installation Preparing to install DocuShare
To connect DocuShare to the database, obtain the following information from your database administrator before installing DocuShare.
• Database User Name
• Database User Password
• Database Port
• Tablespace Name
• Database Host Name
Refer to Appendix C, Databases for a typical DocuShare tablespace creation script.
Oracle v8i, v.9i—the database must be installed and functioning. You can create and define the Oracle tablespace or if selected, can be created and defined by the DocuShare installer. Oracle 9.2.0 should have the Server Patch Set 9.2.0.4 installed.To connect DocuShare to the database, obtain the following information from your database administrator before installing DocuShare.
• Database User Name
• Database User Password
• Database Port
• Tablespace Name
• Database SID
• Database Host Name
Refer to Appendix C, Databases for a typical DocuShare tablespace creation script.
TECH NOTE: Oracle v.9i, the CLOB datatype must be enabled and the No Sort option disabled to work with DocuShare. Check the DocuShare Knowledge Base at http://www.xerox.com/
docushare/support for details.
Security
Scanning
The typical DocuShare installation has Scan-to-DocuShare capability which utilizes an FTP server port to receive documents.
CAUTION: If your environment prohibits installing an FTP server for security reasons, select the
Preparing to install DocuShare Solaris/Linux Server Installation
Secure Sockets Layer (SSL)
SSL provides a secured communication layer between the Apache web server and client web browsers.
SSL functionality is provided by the Apache web server. To achieve SSL connectivity for DocuShare, you must close the Tomcat servlet port. See Closing the Tomcat servlet port on page 3–20.
Solaris/Linux Server Installation Installing DocuShare on a Solaris or Linux server
Installing DocuShare on a Solaris or Linux
server
If this is a first time DocuShare install, it is recommended that you read the DocuShare Installation Guide before starting the installation. Go to the DocuShare /doc/install/pdf directory on the CD-ROM to view or print the Installation Guide (PDF).
DocuShare download files
If you downloaded the ds-linux-3.x.tar.gz file or ds-solaris-3.x.tar file into a temporary directory, you need to extract the DocuShare directory files before launching the installer. Follow the instructions to unzip or untar the file.
Linux gz file
1. Unzip the file, gunzip ds-linux-3.x.tar.gz.
2. Extract the unzipped tar file, tar -xvf ds-linux-3.x.tar to a temporary directory.
Solaris tar file
If you downloaded ds-solaris-3.x.tar, extract the tar file, tar -xvf ds-solaris-3.x.tar to a temporary directory.
Installing DocuShare
TECH NOTE: A database must be installed and functioning, otherwise the DocuShare installation will fail. See Databases on page 3–2.
1. Log into the server as a UNIX server administrator (root).
TECH NOTE: To monitor the DocuShare installation, initial installation activity is recorded in a log.txt file located in the root directory. When the DocuShare directory is created by the installer, a new log.txt file in the DocuShare home directory continues recording the remaining installation activities.
2. Insert the DocuShare CD-ROM into the server CD-ROM drive. If necessary, mount the cd as root.
NOTE: Refer to your Linux or Solaris documentation for mounting the CD-ROM drive.
Installing DocuShare on a Solaris or Linux server Solaris/Linux Server Installation
3. To start the DocuShare installation.
a. Double-click docushare in the CD-ROM root directory to start the installation.
b. If you had downloaded DocuShare from the web and extracted the executable from the gz (Linux) or tar (Solaris) file, cd to <DSHome>/bin and enter
./docushare.sh.
Optional for DocuShare installation: use the command line -P docushareLog.cleanUp=false to preserve configuration and installation data at the completion of the DocuShare installation.
To use this utility, start the installation in a console window:
./docushare.sh -P docushareLog.cleanUp=false
4. The installation program uses Java to install the product. It takes a few minutes to unpack and install the Java files.
5. The DocuShare Welcome screen displays at the completion of the Java installation.
# ./docushare InstallShield Wizard
Initializing InstallShield Wizard...
Preparing Java(tm) Virtual Machine...
...
...
...
Solaris/Linux Server Installation Installing DocuShare on a Solaris or Linux server
7. When the DocuShare Installation options window displays, select the option to install DocuShare.
NOTE: The DocuShare 2.2 Data Migration Tool is included with the Full DocuShare 3.x or DocuShare 3.x without Scan Feature installations. The Migration tool is used to transfer DocuShare 2.2 data to your 3.x server.
CAUTION: The full DocuShare installation has Scan-to-DocuShare capability which utilizes an FTP server port to receive documents. If your environment prohibits installing an FTP server for security reasons, select the option to install DocuShare without scanning.
8. Click Next and follow the onscreen instructions.
9. When the DocuShare Install Parameters window displays, make any changes to the parameters or click Next to accept the default settings. DocuShare requires 6 TCP ports.
• Tomcat port—designated port for the Tomcat server (default port: 8080)
• RMI port—designated port for the RMI server (default port: 1090)
• RMI host—matches the RMI server’s hostname
• IMQ port—designated port for the IMQ JMS server port number (default port: 7676)
• IMQ host—matches the IMQ server’s hostname
• Content store—designated directory location for document repository
Installing DocuShare on a Solaris or Linux server Solaris/Linux Server Installation
• Tomcat Web Bridge Port—designated port for the Tomcat Web Bridge (default port: 8009)
• Tomcat Server Admin Port—designated port for the Tomcat Web server (default port: 8005)
10. When the Database Configuration screen displays, select the database option for your DocuShare site and click Next.
11. If you are using PostgreSQL as your DocuShare database, do the following:
a. Enter the Database User and Password.
b. Enter the appropriate database information.
c. Click Next to continue.
Solaris/Linux Server Installation Installing DocuShare on a Solaris or Linux server
13. When the DocuShare Web server parameters window displays, enter the hostname (fully qualified DNS name, such as docushare.domain.com) for your DocuShare server. Click Next to continue.
14. When the UNIX Account Parameters window displays, enter the appropriate information.
NOTE: The default is nobody, which allows any user with an UNIX account to login and start
DocuShare. If Scan-to-DocuShare is installed, you must be root to start DocuShare to enable the scan feature.
Installing DocuShare on a Solaris or Linux server Solaris/Linux Server Installation
NOTE: DocuShare initial startup automatically performs dsindexing; allow five minutes before accessing the site via a browser.
18. If you had elected to use Apache as a web server, go to Appendix B, Web Servers to configure Apache as the web server.
19. If your DocuShare site is enabled for Scan-to-DocuShare, you need to disable the UNIX FTP service on your UNIX system. Go to Disabling the UNIX FTP service on page 3–21.
20. To license your DocuShare server:
a. Log into the DocuShare server as admin using the password you supplied during the installation.
b. On the navigation bar, click Admin Home.
c. From the Administration menu, click Site Management / License.
d. Record or copy your server ID.
e. If this installation is for evaluation, click the link or go to:
http://docushare.xerox.com/ds30/ds30-trial.htm to complete the form and obtain a 30-day license.
See Licensing on page 1–3 to obtain a DocuShare license for your site.
21. Refer to the DocuShare Administrator Guide to configure your DocuShare site.
Solaris/Linux Server Installation Migrating data to DocuShare 3.x
Migrating data to DocuShare 3.x
If you are upgrading from DocuShare 2.2 to DocuShare 3.x on an UNIX server, the DocuShare Installer CD includes a data migration tool to transfer your 2.2 data files to your new DocuShare 3.x server. Install the migration tool on your existing DocuShare 2.2 server.
Migration overview
The migration tool copies content and metadata from a DocuShare 2.2 server (source) to a DocuShare 3.x server (target). This includes repository contents as well as object property metadata and all user and group accounts. The following is an overview for migrating data from DocuShare 2.2 to a DocuShare 3.x server:
1. Access to a licensed DocuShare 3.x server (target).
NOTE: The server must be a new install, not a previously installed 3.x server with metadata. The 3.x server must be licensed to equal or exceed the number of users for the 2.2 server.
2. Install the migration tool on the DocuShare 2.2 server (source) .
NOTE: The DocuShare server must have Service Pack 1b or higher and be set to Read-Only.
3. Migrate DocuShare data.
4. If applicable, upgrade users to DocuShare 3.x Windows Client software.
5. If applicable, merge 3.x VDF files.
Preparing to migrate data
NOTE: If source and target servers are on the same system, you only need to install DocuShare once.
The DocuShare 2.2 Data Migration Tool is included with the Full DocuShare 3.x and DocuShare 3.x without Scan Feature installations.
Backup
The migration tool makes a copy of your content but does not modify the current site. It is recommended to backup the source server prior to attempting the migration.
Disk space
Migrating data requires access to adequate system disk space and virtual memory.
Migrating data to DocuShare 3.x Solaris/Linux Server Installation
– Remote migration—migrating from a local to a remote system: minimum free disk space is equal or greater than the DS 2.2 directory size.
• Recommended system and virtual memory requirements: the target DS 3.x system and virtual memory is equal or greater than the current DS 2.2 system.
Trashcan contents
Items in the Trashcan are not copied to the new 3.x server. Trashcan items should be Restored to their collections or Expunged prior to migrating data between the servers.
VDF files
The migration tool does not migrate any customized VDF files to your DS 3.x server. The files must be merged for 3.x.
Installing the migration tool
1. Log into your DocuShare 2.2 server as a UNIX server administrator (root).
2. Disable, on the source system, any remote access applications (for example, Xterm).
3. Insert the DocuShare CD-ROM into the server CD-ROM drive. If necessary, mount the cd as root.
NOTE: Refer to your Linux or Solaris documentation for mounting the CD-ROM drive.
4. Double-click docushare in the CD-ROM root directory to start the installation.
TECH NOTE: If you had downloaded DocuShare from the web, run the executable ./DocuShare/
docushare.sh after extracting the executable from the gz (Linux) or tar (Solaris) file.
See DocuShare download files on page 3–5.
5. When the DocuShare Installation Options window displays, select the DocuShare 2.2 Data Migration Tool option.
Solaris/Linux Server Installation Migrating data to DocuShare 3.x
6. Click Next. The Migration Target screen displays.
7. Enter the target hostname (fully qualified DNS name, such as localhost.xerox.com) and the port parameter. Click Next to continue.
TECH NOTE: The upgrade target port is the RMI port of the DocuShare 3.x server (target). The default
Migrating data to DocuShare 3.x Solaris/Linux Server Installation
Starting the migration tool
1. Set the DSHOME environment variable with the DocuShare 2.2 setup_docushare script so the migration tool can locate the DocuShare 2.2 site.
a. In the DocuShare 2.2 directory, cd <docushare directory>/bin b. Enter source setup_docushare.
TECH NOTE: An alternative is to set the environment variable directly in the bourne shell:
DSHOME=/Docushare 2.2;export DSHOME
2. Create a temporary transfer directory (for example, ../temp).
3. Disable any virus scanning to improve throughput performance during the migration.
4. Set the source DocuShare server to Read-Only.
5. Change directory to where the DocuShare migration tool is installed (<DSHome>/bin).
6. Enter dsupgrade2 ../temp in a command window to start the data migration.
The source server starts copying the files to the temp directory. Data migration continues by exporting the files to the target server. Progress of the migration is displayed in the command window. A log file is created in the DocuShare 3.x installed directory, for example ../Xerox/
Docushare/logs.
7. At the completion of data migration, you are prompted to remove the temporary files. Enter yes to remove the files or no to retain the temporary copy.
8. Check the log file for any errors.
9. Perform the following database maintenance procedure. This procedure should be part of your normal database maintenance schedule.
a. For a PostgreSQL database: vacuumdb -d <yourdatabase> -f -z -e.
CAUTION: To preserve your PostgreSQL indexes, do not use the PostgreSQL cluster command.
Cluster will physically reorder your index information.
b. For a SQL server database: update statistics for query analyzer, select 100% option.
10. Run dsindex -a index_all from the DocuShare 3.x server bin directory.
Solaris/Linux Server Installation Migrating data to DocuShare 3.x
11. When migration completes, a Migration Status log displays.
12. Verify that all DocuShare 2.2 data has migrated to the DocuShare 3.x server. Compare the Migration Status log with the About Statistics on the DocuShare 2.2 server.
If there are significant differences in the migration statistics, it is possible that Trashcan contents were not expunged or restored prior to starting migration. Refer to Trashcan contents on page 3–
12
13. Reboot the server.
TECH NOTE: If Summary and Keyword fields contain more than 256 characters, the DocuShare 3.x Migration Tool leaves the fields empty after migration from DocuShare 2.2. The problem value and the original value are logged into the upgrader2.log file. The field values must be corrected to 256 characters or less.
14. Configure your DocuShare 3.x server.
NOTE: The migration tool does not copy your DocuShare 2.2 system configuration to the new 3.x server. System configuration must be manually changed on the DocuShare 3.x server Home site. Refer to the DocuShare Administrator Guide to configure your DocuShare 3.x server.
15. If applicable, upgrade users to DocuShare 3.x Windows Client software. Previous versions of Windows Client cannot map to the DocuShare 3.x server.
Migrating data to DocuShare 3.x Solaris/Linux Server Installation
RESOURCES: To merge VDF templates, refer to the VDF Reference Guide, available from the Developer Tools tab on the Administrator Help Desk.
Solaris/Linux Server Installation Upgrading DocuShare 3.0
Upgrading DocuShare 3.0
If you are upgrading DocuShare 3.0 to DocuShare 3.x, the DocuShare Installer includes an upgrade utility.
You can upgrade your DocuShare 3.0 server to DocuShare 3.x using the DocuShare 3.x Installer CD or from the DocuShare 3.x application downloaded from the web.
NOTE: The DocuShare upgrade utility only upgrades DocuShare 3.00.00 or a later version. To check your DocuShare version, click About DocuShare on the Home page.
To monitor the DocuShare upgrade, installation and upgrade activity is recorded in a log.txt file located in the DocuShare home directory.
To upgrade DocuShare 3.0:
1. Log into your DocuShare 3.0 server as a UNIX server administrator (root).
2. Stop the DocuShare server. In a console window, cd to <DSHome>/bin and enter ./dsservice.sh -shutdown.
3. To ensure the security of your DocuShare site data, backup your database. Refer to Chapter 3, DocuShare Administrator Guide or to your database server documentation, for data backup and restore procedures.
4. Insert the DocuShare CD-ROM into the server CD-ROM drive. If necessary, mount the cd as root.
NOTE: Refer to your Linux or Solaris documentation for mounting the CD-ROM drive.
5. To start the DocuShare upgrade.
a. Double-click docushare in the CD-ROM root directory to start the installation.
b. If you had downloaded DocuShare from the web and extracted the executable from the gz (Linux) or tar (Solaris) file, cd to <DSHome>/bin and enter
./docushare.sh. See DocuShare download files on page 3–5.
Optional for DocuShare upgrade: use the command line -P docushareLog.cleanUp=false to preserve configuration and upgrade data at the completion of the DocuShare upgrade.
To use this utility, start the upgrade in a console window:
./docushare.sh -P docushareLog.cleanUp=false
6. Click Install DocuShare on the DocuShare Install Menu to begin the installation.
The installation program uses Java to install the product. It takes a few minutes to unpack and install the Java files. Click Next to start the DocuShare installation and follow the onscreen instructions.
Upgrading DocuShare 3.0 Solaris/Linux Server Installation
CAUTION: The full DocuShare installation has Scan-to-DocuShare capability which utilizes an FTP server port to receive documents. If your environment prohibits installing an FTP server for security reasons, select the option to install DocuShare without scanning.
8. Click Next and follow the onscreen instructions.
9. When the Upgrade Option window displays, click Yes to upgrade your server.
10. Follow the onscreen instructions to continue the upgrade. During the upgrade process, the DocuShare upgrade utility backs up the appropriate system server configuration and data.
11. When the installer completes the DocuShare upgrade, click Finish to close the installer.
12. In a command window, cd to<DSHome>/bin/ and enter ./start_docushare.sh to start DocuShare.
13. Perform the following database maintenance procedure. This procedure should be part of your normal database maintenance schedule.
a. For a PostgreSQL database: vacuumdb -d <yourdatabase> -f -z -e.
CAUTION: To preserve your PostgreSQL indexes, do not use the PostgreSQL cluster command.
Cluster will physically reorder your index information.
b. For a SQL server database: update statistics for query analyzer, select 100% option.
NOTE:
14. Run dsindex index_all from the DocuShare 3.x server bin directory.
Solaris/Linux Server Installation Uninstalling DocuShare
Uninstalling DocuShare
To uninstall DocuShare 3.x from your Solaris/Linux server, run the uninstall script, doc_uninstaller.
Uninstall will remove the DocuShare directory and its contents. You can do the following before uninstalling DocuShare.
• Leave the repository in its current location.
• Save your repository content to another storage media by using the DocuShare command line utility, dsexport, prior to uninstalling DocuShare. Refer to the DocuShare Command Line Utilities Guide for details.
To uninstall DocuShare:
1. Log into the server as a UNIX server administrator (root).
2. Stop the DocuShare server. In a console window, change directory to <DSHome>/bin and enter ./stop_docushare.sh.
3. Change directory to <DSHome>/_uninst.
4. Enter ./doc_uninstall. Follow the onscreen instructions.
5. Remove the directory in which DocuShare was installed.
NOTE: Uninstall removes all installed languages, such as French, German, and Spanish.
Closing the Tomcat servlet port Solaris/Linux Server Installation
Closing the Tomcat servlet port
During the DocuShare 3.x installation, if you selected to install the Apache option on the Web Server Interaction page, you can configure your DocuShare server for SSL by closing the Tomcat web servlet port to web browser access.
To close the Tomcat servlet port:
1. Log into the server as a UNIX server administrator (root).
2. In a console window, check the Tomcat servlet port status using the command, ./dsservice.sh status in the directory ../Xerox/Docushare/bin.
3. Stop DocuShare by entering the command, ./stop_docushare.sh.
RESOURCES: For a complete list of start_docushare commands and arguments, enter ./start_docushare.sh help in the console window.
4. Enter the command, ./start_docushare.sh tomcat http off, to close the Tomcat web servlet http port. This action closes the port providing access to the Tomcat web servlet via a web browser.
5. Enter the command, ./start_docushare.sh tomcat http on, to open the port to the Tomcat web servlet. This action allows access to the Tomcat web servlet.
NOTE: To update only the environment, add the argument update-only to the end of the start_docushare command.
Solaris/Linux Server Installation Disabling the UNIX FTP service
Disabling the UNIX FTP service
The typical DocuShare installation has Scan-to-DocuShare capability which utilizes its own FTP server to receive documents. The FTP service on the UNIX systems must be disabled to allow DocuShare to receive scanned documents through its own FTP server port.
To disable the FTP service on Linux:
1. Log into the server as a UNIX server administrator (root).
2. From the Start menu, select Service Configuration.
3. In the Service Configuration window, de-select wu-ftpd.
To disable the FTP service on Solaris:
1. Log into the server as a UNIX server administrator (root).
2. Edit /etc/inetd.conf file by commenting out the line for FTPD daemon.
3. Enter ps -ef | grep inetd to obtain your system PID.
4. Restart inetd.
5. Enter the command, Kill -HUP PID (PID obtained in step 3).