25 January 2000 ========================= QUIKdata 2.1 for LINUX Release Notes ========================= QUIKdata enables ERL 2.x and ERL 4.x customers to electronically transfer SilverPlatter databases and license sheets to their site via the Internet. The QUIKdata software consists of a small collection of Perl scripts, executables, and shell scripts that you install and run directly from your ERL server machine. You can run QUIKdata manually at any time or you can schedule it to run automatically via the operating system (as a cron job, for example). The results of all QUIKdata transactions are then sent to any e-mail address you specify during installation. This document contains the following sections: 1. System Requirements 2. Downloading the QUIKdata Software 3. Installing the QUIKdata Software in a LINUX Environment 4. Updating QUIKdata Software 5. Running QUIKdata 6. Running QUIKdata in concert with a Proxy Server 7. Known Issues ---------------------- 1. System Requirements ---------------------- * Supported platforms: - Linux RedHat verion 6 on Intel. * An installed ERL 2.x or 4.x server. * 15 MB of available disk space for the installation. The version of Perl 5 installed in /sproot/perl requires 7 MB of space, while the rest of the QUIKdata files need an additional 8 MB of space. ------------------------------------ 2. Downloading the QUIKdata Software ------------------------------------ The QUIKdata software is available as a self-extracting file from SilverPlatter's FTP site. For Linux, a self-extracting compressed tar file is provided. Self-extracting file contains the following components: * Perl 5.004 - automatically installed in the /sproot/perl directory. * libwww 5.36 and related libraries - automatically installed under the ${QD_ROOT}/perl5 directory. * gunzip, diskfree - automatically installed in the ${QD_ROOT}/bin directory. * quikdata.pl - This script is the main component of the QUIKdata process. It is automatically installed in the ${QD_ROOT}/perlscripts directory. * quikdata.sh - In a Unix environment, this shell script sets the QUIKdata environment and runs the main script (QUIKdata.pl). It is automatically installed in the ${QD_ROOT}/perlscripts directory. * An empty ${QD_ROOT}/filelists directory - This directory will hold all the file lists of downloaded database volumes. * An empty ${QD_ROOT}/licsheets directory - This directory will hold all downloaded database license sheets. * An empty ${QD_ROOT}/log directory - This directory will hold all log files for the latest QUIKdata run. To Download the QUIKdata Software: 1. Login to your ERL server as user "erl". 2. Go to SilverPlatter's FTP site and the appropriate directory for your platform. 3. Select the installation tar. 4. Set the transfer mode to "binary" (using the "bin" command) and download the tar file to any directory on your ERL server. 5. Once the file is downloaded, change the file mode to make the file executable. For example, you could type the following: chmod +x qd2.sh You are now ready to install the QUIKdata software. ---------------------------------------------------------- 3. Installing the QUIKdata Software in a Linux environment. ---------------------------------------------------------- To install the QUIKdata software: 1. Login to your ERL server as user "root". 2. Run the installation script. For example, type: ./qd2.sh 3. When the License Agreement screen appears, press [q] to stop viewing the agreement and continue with the install, [Ctrl-C] to abort the installation process, or [space] to view the next page of the agreement. Type Yes to agree to the license and continue with the installation process. 4. If you accept the license agreement, the script prompts you for the following information: A. The directory to install QUIKdata in (defaults to /opt/QUIKdata). B. The directory where ERL is installed on the system (defaults to /sproot). C. Your ERL server ID (defaults to host name). D. The directory where volumes will be automatically downloaded (defaults to the directory called download in the install directory entered in step A. default). E. The e-mail address to receive the results of QUIKdata transactions (defaults to erl@localhost). The information you enter is stored in a file named quikdata.cfg in the perlscripts directory in the install directory specified in step A. You can edit this file at any time after installation to change the QUIKdata configuration. 5. When the script prompts you to confirm the information you entered, type "Y" to begin the installation or "N" to loop through the list again. Typing Ctrl-C will abort the install process. If you type "Y", the installation script does the following: * Creates the necessary directory structure for the installation files. * Extracts and installs the contents of the tar file, including Perl 5.003, libwww 5.07 and its supporting libraries, gunzip, quikdata.pl, quikdata.sh, and quikdata.cfg. * Attempts to verify a 16-bit GNU sum command. If the initial sum command fails, the script automatically tries the sum -s command. If sum -s fails as well, the script displays an "incompatible sum command" error message and the installation quits. NOTE: Once installation is complete, you can delete the original tar file (qd2.sh). ------------------------------ 4. Updating QUIKdata Software. ------------------------------ Updating the QUIKdata 2.0 software will happen automatically. Every time the QUIKdata script is started, it will always check the version variable from the main Perl script (QUIKdata.pl) against the latest version of QUIKdata available on the download server. When a new software update is available, QUIKdata will install the update automatically, and then continue with the regular download operation. You will be automatically informed about this upgrade by an email from QUIKdata, and you can also find the upgrade history in the {QD_ROOT}/log/install.log file. --------------------- 5. Running QUIKdata. --------------------- You can run QUIKdata manually at any time through the QUIKdata shell script (quikdata.sh). This script sets the QUIKdata environment and runs the main Perl script (quikdata.pl) automatically. To run QUIKdata manually: 1. Login to your ERL server as user "erl". 2. Run the QUIKdata shell script from the perlscripts directory of the QUIKdata install directory by typing: ./quikdata.sh QUIKdata has two command line options which are mutually exclusive: -i: run QUIKdata in interactive mode, prompting the user before downloading any databases. -q: run QUIKdata in quiet mode, accepting the default repsonse of [y] for each database to download. This option is appropriate when automating the download process via scheduling. The default setting for interactive mode is determined by the INTERACT setting in the quikdata.cfg file. The initial setting for this variable is YES. Each time you run QUIKdata, the results are sent to the e-mail address you specified during installation. NOTE: If you are running QUIKdata in automatic mode (INTERACT=NO in quikdata.cfg) this will allow you to schedule QUIKdata to run automatically via the operating system as a "cron" or "at" job. Refer to the documentation of your operating system for more information on scheduling. When run in automatic mode QUIKdata will download all database updates that are available for your subscriptions without asking confirmation for each update. QUIKdata will download database updates unless the database update is already installed on the ERL server or already downloaded to the "SPDBDOWNLOAD" directory of QUIKdata. If you want to continue running in automatic mode but you want to prevent certain downloads from taking place, you can create an empty directory in /sproot/spdbvols directory with the same database id as the database update you do not want to receive. For instance,you would create an empty directory /sproot/spdbvols/CCOC0123 to prevent the download of this database update. ---------------------------------------------------- 6. Running QUIKdata in concert with a Proxy Server. ---------------------------------------------------- If you are running QUIKdata behind a firewall and you are using a proxy server to gain access to the internet, you will need to change the QUIKdata.cfg file in order for QUIKdata to function properly. You will need to add a line of the form: PROXY=http://192.168.0.1:80 to the QUIKdata.cfg file found in the perlscripts directory in the install directory specified during the installation process. Substitute for 192.168.0.1 the address of the proxy server that you wish QUIKdata to communicate with. Also, substitute for 80 the port number that the proxy server uses for HTTP access. Release Notes first released for QUIKdata 2.0 Beta 30 October 1998 Revised: 1 December 1998