Installation Guide DocuShare Express
Fuji Xerox Australia 101 Waterloo Road North Ryde NSW 2113 Copyright 2010 by Fuji Xerox Australia Pty. Limited, A.C.N. 000 341 819. All Rights Reserved. Copyright protection claimed includes all forms and matters of copyrighted material and information now allowed by statutory or judicial law or hereinafter granted, including without limitation, material generated from the software programs that are displayed on the screen such as styles, templates, icons, screen displays, looks, etc. This document is and shall remain the exclusive property of Fuji Xerox Australia and its use is governed by the terms of the applicable license agreement. Xerox, the sphere of connectivity design, and DocuShare are registered trademarks or trademarks of Xerox Corporation in the U.S. and/or other countries. Other company trademarks are also acknowledged. For technical queries please contact the Fuji Xerox Australia Customer Support Centre on 1800 028 962. Updates This document is subject to continual updating and improvement. You are strongly advised to check the Fuji Xerox website to ensure that you have the most recent version. Page ii
About this Guide This guide provides details on how to install and configure DocuShare Express. This includes Checking system requirements Installing DocuShare Express Connecting to the DocuShare Express web page Licensing DocuShare Express Configuring DocuShare Express Configuring Subscriptions Configuring LDAP Changing the Default Login Domain in DocuShare Express Adding Users from LDAP This document forms a part of a series of documents that also includes: Installation Guide for Docushare Connect Administration Guide for DocuShare Connect User Guide for DocuShare Connect Intended Audience This guide is intended for the personnel responsible for installing and configuring DocuShare Express. Prerequisites You must have installation privileges to perform the tasks presented in this guide. Organisation of the Guide Information in this guide has been organised as follows: Organisation of this Guide Section 1 Introduction Section 2 Installing DocuShare Express Section Section 3 Connecting to DocuShare Express Section 4 Licensing This section provides information about DocuShare Express. It also provides information about system requirements and operating system settings. This section provides information about pre-installation tasks and installation of DocuShare Express on the server. This section provides information about connecting to DocuShare Express and provides login information. This section provides information about getting license and applying license for Description Page iii
DocuShare Express Section 5 Configuring DocuShare Express Section 6 Configuring DocuShare Express Subscriptions Section Section 7 Configure DocuShare Express to use Windows Logins (via LDAP) Section 8 Helpdesk and Support DocuShare Express on the server. This section provides information about configuring DocuShare Express. This section provides information about configuring DocuShare Express Subscriptions. This section provides information about configuring DocuShare Express to use Windows Logins via LDAP. This section provides details of customer support. Description Typographical Conventions The following table gives the details of the typographical conventions used in the document: Typographical Conventions Formatting Convention Command and Screen element names System response Type of Information Buttons, Check boxes, etc. Commands that you choose from the menus or dialog boxes appear in title case and in bold font. Example: Click Next. The system response is mentioned in the next line after the respective action step. Page iv
Contents 1 Introduction... 8 1.1 System Requirements... 8 1.1.1 Hardware Requirements... 8 1.1.2 Software Requirements... 8 2 Installing DocuShare Express... 9 2.1 Prerequisites for Installation... 9 2.2 DocuShare Express Installation... 9 3 Connecting to DocuShare Express... 10 3.1 Connect to your DocuShare server... 10 3.2 DocuShare Login... 10 4 Licensing DocuShare Express... 11 5 Configuring DocuShare Express... 12 6 Configuring DocuShare Express Subscriptions... 13 6.1 Configure Subscriptions... 13 7 Configure DocuShare Express to use Windows Logins (via LDAP)... 14 7.1 Required Information for LDAP... 14 7.2 Sample LDAP Configuration... 14 7.3 Adding Users from LDAP... 17 7.4 Setting the Default Login Domain for DocuShare Express... 18 8 Helpdesk and Support... 19 The total number of pages in this document, including the cover page, is 19. Page 5
List of Figures Figure 1: DocuShare Express License Page... 11 Figure 2: DocuShare Express Subscription Page... 13 Figure 3: Security Services Page... 14 Figure 4: Directory Services Page... 15 Figure 5: LDAP Configuration Page... 15 Figure 6: Domain Configuration Page... 16 Figure 7: LDAP Advanced Page... 17 Page 6
List of Abbreviations Abbreviation/ Acronym Description DVD Digital Versatile Disc / Digital Video Disc GB Giga Byte LAN Local Area Network LDAP Lightweight Directory Access Protocol MB Mega Byte ROM Read Only Memory SMB Small-Medium Business SP2 Service Pack 2 SQL Structured Query Language URL Uniform Resource Locator VGA Video Graphics Adapter Page 7
1 Introduction DocuShare is a content management system developed by Xerox Corporation. DocuShare makes use of open standards and allows for managing content, integrating it with other business systems, and developing customized and packaged software applications. DocuShare Express delivers content management tailored to SMBs, for managing digital documents and converting paper content to digital form. This section provides information about the system requirements and operating system settings for the server machine, to install DocuShare Express. 1.1 System Requirements This section describes the software and hardware environment required to install DocuShare Express. 1.1.1 Hardware Requirements Communication Infrastructure CPU Memory Hard Disk Network Card Other Hardware LAN Card Intel Xeon, 3GHz or greater or AMD Opteron processor or greater 4 GB or greater 25 GB free disk space (greater is highly recommended for document storage) 100MB or greater VGA Video Card, DVD - ROM Drive 1.1.2 Software Requirements Operating System Database Server Software Windows 2003 Server R2 or SP2, Standard or Enterprise (32- bit) Windows 2008 Server SP2 Standard or Enterprise (32-bit or 64-bit) Windows 2008 Server R2 Standard or Enterprise (64-bit) DocuShare Express includes a version of Microsoft s SQL Server Express 2005 database Web Server: DocuShare Express includes a version of the Tomcat web servlet as part of its functionality. The servlet is installed by the DocuShare Express installer. Page 8
2 Installing DocuShare Express This section describes the prerequisites for installation, and the installation procedure. 2.1 Prerequisites for Installation Ensure that the following settings are in place before installing DocuShare Express: The hardware requirements are as per the information provided in section 1.1.1 Hardware Requirements. The software system requirements are as per the information provided in section 1.1.2 Software Requirements. Network connectivity and domain trust/share access control lists should be tested prior to installation. The latest Windows updates must be installed in the machine. 2.2 DocuShare Express Installation To install DocuShare Express: 1. Insert the DocuShare Connect DVD-ROM into the server DVD-ROM drive. Double-click \DocuShare Connect\DocuShare Express\setup.bat. 2. The installation program uses Java to install the product. It takes a few minutes to unpack and start Java. An onscreen status indicator is not available while JVM completes its installation. 3. A language selection screen displays. 4. If you want to install a language pack in addition to English, choose the language you want and click OK. The DocuShare Welcome screen displays. 5. Click Next to start the DocuShare Express installation. Follow the onscreen instructions. 6. You will be required to accept the terms of the license agreement. 7. The default install path is C:\Xerox\Docushare, you can change this to another local path. 8. Enter the admin password you wish to use and an email address for the admin account. 9. When the installer completes the DocuShare Express installation, click Finish to close the installer. The DocuShare Welcome screen displays. 10. Reboot the system. DocuShare Express initial startup automatically updates the search indexes; allow five minutes before accessing the site via a browser. Page 9
3 Connecting to DocuShare Express 3.1 Connect to your DocuShare server At the completion of the DocuShare Express installation, try connecting to your new DocuShare server using a web browser. The default URL is: http://<localhost>:8080/docushare For users connecting to DocuShare from their systems, the URL is: http://<server hostname>:8080/docushare Note: 8080 is the default port for the Tomcat web servlet. If another application is using 8080, DocuShare will check and assign another port number to its URL during the install. 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. User and Administrator tutorials are available via the Help link. 3.2 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 configuration of your server and adding content to your server. Page 10
4 Licensing DocuShare Express DocuShare Express is distributed as a restricted use server. To license your DocuShare Express server: 1. Log into the DocuShare server as admin, using the password you created during the installation. 2. On the navigation bar, click Admin Home. 3. From the Administration menu, click Site Management License. 4. Record or copy your server Host ID. 5. Email the server Host ID along with your customer information to the Fuji Xerox Software Licensing team at Software.License@aus.fujixerox.com or call 1800 028 962 and a DocuShare Express license will be generated and sent to you. 6. Enter the generated license into the License text box on the License page. 7. Click Apply. Figure 1: DocuShare Express License Page Page 11
5 Configuring DocuShare Express Refer to the DocuShare Administrator Guide to configure your DocuShare site. Click the Help link on the DocuShare home page to access the DocuShare Administrator Guide. Common items you may want to configure are: Access Levels set login level required to access DocuShare and to add Users and Groups Homepage set the default homepage for users Personal Trashcan Enable the personal trashcan for users Trashcan Configure the trashcan settings Repository Log Files Enable access and error log files Date Format Set the date format (US or International English) Subscriptions Configure the DocuShare server for sending email notifications (see below) LDAP (Lightweight Directory Access Protocol) Configure LDAP to synchronise DocuShare users with corresponding Windows logons (see below) Page 12
6 Configuring DocuShare Express Subscriptions Subscriptions are used to send email notifications to DocuShare users based on events that occur in DocuShare. The most common notification is for new content being added. Refer to the DocuShare User Guide for more information on how to use Subscriptions. Click the Help link on the DocuShare home page to access the DocuShare User Guide. 6.1 Configure Subscriptions To license your DocuShare Express server: 1. Log into the DocuShare server as admin, using the password you created during the installation. 2. On the navigation bar, click Admin Home. 3. From the Administration menu, click Services and Components Subscription. 4. Enter your SMTP Mail Gateway and SMTP Mail Port. 5. Enter the address to be used to send emails in Subscription Administrator Email. 6. Select Yes in Enable Subscriptions. 7. Click Apply to accept the settings. Figure 2: DocuShare Express Subscription Page Page 13
7 Configuring DocuShare Express to use Windows Logins (via LDAP) Lightweight Directory Access Protocol (LDAP) is the protocol that is used between a directory client and a server. DocuShare uses LDAP to communicate with an Active Directory LDAP server to authenticate users and to get user properties. The most common use is to import users into DocuShare from LDAP and have LDAP handle the authentication for users this means they can use their Windows logon to connect to DocuShare as well. Refer to the LDAP Active Directory Guide to configure LDAP for your DocuShare site. Click the Help link on the DocuShare home page to access the LDAP Active Directory Guide. 7.1 Required Information for LDAP You will require the following information to configure LDAP in DocuShare Express: The Domain Name for your Windows Domain The User Container in Active Directory that contains the Users who will access DocuShare Express The host name of the LDAP Server The port number of the LDAP Server (default is 389) The Directory Information Tree (DIT) Root The User Relative Distinguished Name (RDN) Key (default is cn) The Relative Authentication and Directory Services Attributes The Distinguished Name (DN) for an account with access to LDAP to be used as the LDAP System Agent The password for the LDAP System Agent account Object Class Attributes 7.2 Sample LDAP Configuration 1. Security Services. 2. Directory Services. Figure 3: Security Services Page Page 14
3. LDAP Configuration. Figure 4: Directory Services Page Figure 5: LDAP Configuration Page Page 15
4. Domain Configuration. In this case the users are all on the cn=users container. If the Locator fields are left blank and Enable Subtree Search is selected then DocuShare will look from the DIT root when adding, synchronising, and authenticating users. Figure 6: Domain Configuration Page 5. Advanced Configuration. Figure 7 below shows DocuShare has been configured to synchronise users when they log in to DocuShare and to automatically create an account if a valid Windows user tries to log in to DocuShare and they don t already have a DocuShare account. Group membership will also be synchronised if any Groups have been added via LDAP. Page 16
Figure 7: LDAP Advanced Page 7.3 Adding Users from LDAP DocuShare Users are added from LDAP via the Admin pages. The new User properties are populated from LDAP. 1. Adding an LDAP User Account 2. Log into DocuShare as admin. 3. Click Admin Home link in the navigation bar 4. Click the [+] symbol next to Account Management 5. Click the [+] symbol next to LDAP Accounts 6. Click the Add link. The Add page displays. 7. From the By User Domain menu, select the external domain that you just added to DocuShare. 8. DocuShare displays accounts as they exist on the LDAP server. 9. From the displayed User or Group list, select one or more accounts to add to DocuShare. 10. Click the Add button. The accounts will be added to the external domain in DocuShare. Page 17
7.4 Setting the Default Login Domain for DocuShare Express Change the default login domain from the internal DocuShare domain to an external LDAP domain. You must be a Windows Administrator to perform this configuration. A restart of the DocuShare Service will be required to make the changes. 1. Stop the Docushare service. 2. Open Windows Explorer and Open the Xerox\DocuShare\config folder 3. Make a copy of the dscommon.properties file and name it dscommon.properties.bak 4. Open the dscommon.properties file in a text editor like notepad. 5. Add the following entry at the top or bottom of the file defaultlogindomain=yourdomainname Where yourdomainname is your external domain name The domain name you enter must match the spelling (case sensitive) that shows up in the Domain pull down menu on the DocuShare Home page. 6. Restart DocuShare for the changes to take effect. NOTE: When logging in as DocuShare admin, you will need to change the domain to DocuShare from the Domain pull down menu. Page 18
8 Helpdesk and Support The install DVD and the Help section on your server (once DocuShare Express is installed) will contain the following documents that might answer many of your queries: DocuShare User Guide DocuShare Administrator Guide LDAP Active Directory Guide You can also refer to the Online Support at http://www.fujixerox.com.au/support/ and Knowledge Base at http://customer.docushare.xerox.com. If you require further assistance, contact the Fuji Xerox Australia Customer Support Center (CSC) on 1800 028 962. Page 19