Summary of the content on the page No. 1
CrayDoc™ Installation and
Administration Guide
S–2340–21
Summary of the content on the page No. 2
© 2001–2003 Cray Inc. All Rights Reserved. This manual or parts thereof may not be reproduced in any form unless permitted by contract or by written permission of Cray Inc. U.S. GOVERNMENT RESTRICTED RIGHTS NOTICE The Computer Software is delivered as "Commercial Computer Software" as defined in DFARS 48 CFR 252.227-7014. All Computer Software and Computer Software Documentation acquired by or for the U.S. Government is provided with Restricted Rights. Use, duplication or disclosure by the U.S.
Summary of the content on the page No. 3
New Features CrayDoc™ Installation and Administration Guide S–2340–21 This book documents the following new features of CrayDoc 2.0 release: Complete rewrite of the Perl scripts, with attention to security issues Administration now from thecdadmin command line tool Highlighting of search results Man pages now available in HTML format Glossary of software terms available online Advanced search options This book also includes revised information in Section 6.6.
Summary of the content on the page No. 4
Summary of the content on the page No. 5
Record of Revision Version Description 1.0 December 2001 Original Printing. 2.0 December 2002 Updated to reflect new features in CrayDoc 2.0 release. 2.1 February 2003 Updated to include changes in Section 6.6, Upgrading from version 1.0. S–2340–21 i
Summary of the content on the page No. 6
Summary of the content on the page No. 7
Contents Page Preface v Ordering Documentation . . . . . . . . . . . . . . . . . . . . . . v Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . vi Reader Comments . . . . . . . . . . . . . . . . . . . . . . . . vii Introduction [1] 1 Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . 1 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 2 Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Perl . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 8
CrayDoc™ Installation and Administration Guide Page Apache in Shared Mode . . . . . . . . . . . . . . . . . . . . . . 12 Apache Tips and Troubleshooting . . . . . . . . . . . . . . . . . . . 13 Installing CrayDoc [4] 15 Automated Installation . . . . . . . . . . . . . . . . . . . . . . . 15 Manual Installation . . . . . . . . . . . . . . . . . . . . . . . . 16 CD Contents . . . . . . . . . . . . . . . . . . . . . . . . . 16 Thecraydoc-config File . . . . . . . . . . . . . . . . . . . . 18 Copyin
Summary of the content on the page No. 9
Preface This publication describes CrayDoc 2.0 release and installing and administering CrayDoc and Cray documentation. Ordering Documentation To order software documentation, contact the Cray Software Distribution Center in any of the following ways: E-mail: orderdsk@cray.com Web: http://www.cray.com/craydoc/ Click on theCray Publications Order Form link. Telephone (inside U.S., Canada): 1–800–284–2729 (BUG CRAY), then 605–9100 Telephone (outside U.S., Canada): Contact your Cray representative,
Summary of the content on the page No. 10
CrayDoc™ Installation and Administration Guide Conventions The following conventions are used throughout this document: Convention Meaning command This fixed-space font denotes literal items, such as file names, pathnames, man page names, command names, and programming language elements. variable Italic typeface indicates an element that you will replace with a specific value. For instance, you may replace filename with the namedatafile in your program. It also denotes a word or concept being de
Summary of the content on the page No. 11
Preface Reader Comments Contact us with any comments that will help us to improve the accuracy and usability of this document. Be sure to include the title and number of the document with your comments. We value your comments and will respond to them promptly. Contact us in any of the following ways: E-mail: swpubs@cray.com Telephone (inside U.S., Canada): 1–800–950–2729 (Cray Customer Support Center) Telephone (outside U.S., Canada): Contact your Cray representative, or call +1–715–726–4993 (Cr
Summary of the content on the page No. 12
Summary of the content on the page No. 13
Introduction [1] The CrayDoc software suite is a collection of open-source software components that allow easy searching and viewing of Cray documentation from a web browser. This document guides the system administrator through the installation and maintenance of CrayDoc. This document assumes you have a good understanding of file system permissions and basic system administration skills. This document does not attempt to cover the installation and configuration of Apache or Perl, because these
Summary of the content on the page No. 14
CrayDoc™ Installation and Administration Guide 1.2 Software Requirements CrayDoc requires the following software, all of which are included on the CrayDoc Documentation Library CD: 1. Apache version 1.3.x or later 2. Perl version 5.005 or later (version 5.6.1 recommended) 3. DB_File Perl module version 1.7.2 or later 4. CGI Perl module 5. Dumper.pm Perl module 6. Sendmail.pm Perl module (for the optional Order Form function) The version of Perl on the CrayDoc CD includes the correct versions of
Summary of the content on the page No. 15
Introduction [1] If you have Perl installed on your system, you can type the following at a shell prompt to test if you already have a module installed. For example, to verify the presence of theDB_File module type: find ‘Perl -e ’print "@INC"’‘ -name ’*.pm’ -print|grep DB_File If you are using a nonstandard Perl installation or you are missing a required module, you can either upgrade your Perl installation (Perl 5.6.1 is included on the CrayDoc CD; we recommend you upgrade) or compile and inst
Summary of the content on the page No. 16
CrayDoc™ Installation and Administration Guide 1.2.6 Sendmail.pm and Order Form Function CrayDoc includes an optional function that allows users to send e-mail to Cray requesting printed copies of manuals. The Order Form function requires the PerlSendmail.pm module. TheSendmail.pm module is not part of any standard Perl distribution, and so it is included separately on the CrayDoc CD. If you install CrayDoc with the included installation script (see Section 4.1, page 15), you will be prompted as
Summary of the content on the page No. 17
Introduction [1] 1.3.2 Hard Drive Space The entire set of Cray documentation (HTML and PDF versions) will fit on a single CD (that is less than 650 MB). A standard Red Hat Linux system and a typical CrayDoc installation will easily fit on a 2 GB hard drive. Take your backup system into consideration when making hard drive decisions. S–2340–21 5
Summary of the content on the page No. 18
Summary of the content on the page No. 19
Preparing for Installation [2] Before you install CrayDoc, think carefully about the environment in which you intend to use the CrayDoc system. CrayDoc requires the Apache web server. Your site may already be using the Apache web server. CrayDoc is designed to integrate smoothly with already-existing installations of the Apache web server. Refer to the mode that is best suited to your particular needs and environment: Stand-alone CrayDoc has a dedicated Apache installation. This scenario allows
Summary of the content on the page No. 20
CrayDoc™ Installation and Administration Guide to decide where on your file system you put the CrayDoc installation. We recommend only that you verify that you will have enough space on your file system to accommodate the Cray documentation (see Section 1.3.2, page 5). Verify that your Apache web server is running by pointing a web browser at your CrayDoc server. If you are using a web browser running on the CrayDoc server machine, you should be able to point your browser at: http://localhost/ a
