Subsections

2 Installation

Ensure that everything is installed on paths with no spaces in the names. For example, on the Windows platforms, the default installation path for java looks like C:/Program Files/java/jdk1.5. Choose an alternate installation directory, for example C:/java.

2.1 Requirements

Before running the WANdisco CVS Replicator, please ensure:

You have copied a valid license.key file into cvs-replicator/config. Depending upon your license, certain features may be disabled. This document will highlight any features that require an Enterprise Edition license.
At each replication site, a local CVS repository has been initialized and all CVS repositories have exact same data prior to replication.
JDK 1.5 is installed, and the JAVA_HOME environment variable is defined.
- Please ensure the full JDK is installed, not just the JRE. This can be confirmed by running java -server -version. If it generates a not found error, uninstall the JRE Java package and reinstall the JDK Java package. You can also setup the PATH to pick up the correct java instead of the the JRE version.
On UNIX/Cygwin platform, Perl version 5.6 or greater is installed and the perl executable is on the system PATH.
- The optional cvspasswd tool requires Perl package Term::ReadKey. You need cvspasswd only if you are going to use the :ext protocol.
- The optional logtimefix script requires Perl package Date::Manip. - To install a Perl package on UNIX/Cygwin, using CPAN, for example:
```
$ perl -MCPAN -eshell
cpan> install  Term::ReadKey
```
On Windows platform, ActivePerl version 5.8 or greater is installed and the perl executable is on the system PATH. Please download the MSI installer for ActivePerl from here: [http://activestate.com/Products/Download/Download.plex?id=ActivePerl]
- The optional logtimefix script requires Perl package Date::Manip. - To install a Perl package on Windows, using ActivePerl package manager, for example:
```
c:\>ppm
...
ppm>install DateManip
```
importauditdb script requires Perl package Perl::DBI.
- validate-local-setup script requires Perl package Term::ReadKey and File::Which.
The WANdisco CVS Replicator can communicate with the CVS server using the pserver protocol. Although the WANdisco CVS Replicator uses the pserver protocol to communicate with the CVS server, the CVS client can communicate with the WANdisco CVS Replicator using either SSH or PServer protocol.
For CVSNT based repository, please copy or commit cvs-replicator/config/cvsnt/keywords to CVSROOT/keywords for each cvsroot.

2.2 Installing the bits

Untar or unzip (using WinZip for example on Windows) the WANdisco CVS Replicator package (tar.gz) into the intended subdirectory. You should see the following directory structure:

$ cd cvs-replicator
$ ls
audit  config  lib  logs bin docs systemdb

bin: Contains scripts like cvsreplicator , shutdown
config: Contains the cvs-replicator/config/prefs.xml file used to configure the WANdisco CVS Replicator
lib: Contains the jar files and DLLs that are required to run the product.
docs: Contains the administration guide in various formats: PDF, Html and UNIX man page.
logs: Contains the pid file, log files and other temporary files. WANdisco CVS Replicator's log file is named ProxyServer-prefs.log.0.
systemdb: Contains the system database with its transaction journal. Warning: Deleting files from systemdb will likely corrupt your installation.
audit: Contains the security audit trail files if WANdisco for CVS Enterprise Edition license is enabled.

2.3 Setup

If the installation requirements in the previous section have been met, setup should take 20 minutes or less to get a basic WANdisco CVS Replicator configured.

To begin the setup process run:
```
cvs-replicator/bin/setup [port]
```
If no port parameter is specified the default port 6444 will be used. This port is used for web administration.
Once the server has started it will log a message to point a web browser to http://server:port/. Please note that server should be replaced with the IP address or machine name that the WANdisco CVS Replicator is being installed to.
You should see the screen above. After reading this page click Continue
The next page requires acceptance of the EULA to continue
This page depicts a standard installation of CVS
On the next screen, the recommended configuration will be displayed
This page allows the user to configure the CVS Replicator.
1. Display Name - a friendly name for the Replicator
2. Port - the port which will be used as the proxy port for CVS (typically 2401). This is the port which CVS clients will connect to
3. MAC Address - the MAC address of the machine. This can be acquired by running ifconfig. If it is not found in the path it may be in the /sbin or /usr/sbin directory.
4. Web Admin Password - enter and confirm a password for the web admin. The username for the admin is set to root.
5. CVS Host - the server on which the CVSROOT resides.
6. CVS Port - the port where CVS is actually running (typically 2402). This is the port which the replicator will send client requests after their security access has been verified.
7. CVS Type - CVS or CVSNT. Using CVSNT is not recommended because CVSNT itself is unstable and can be verified by looking at the CVSNT forums.
8. CVSROOT - enter the path to the directory in which the CVSROOT resides.
The Installation Checklist page provides a checklist of tasks which must be completed prior to the installation of the replicator. Please be sure to perform and check each of the tasks on the list prior to proceding.
1. System settings
  1. Linux kernal must be version 2.6 or higher.
  2. JDK must be version 1.5 or above.
  3. The link provided displays the minimum requirements of each system. Please verify that these requirements are met.
  4. The link provided displays the minimum requirements of the network. Please verify that these requirements are met.
  5. Ensure that there is enough space for a two week period of commits.
2. CVS Settings
  1. All sites must have the same CVS versions.
  2. Email triggers should only fire from one location to avoid multiple email notifications.
  3. All usernames and passwords must be consistent at all sites. Best practice is to use CVSROOT/passwd.
  4. Ensure that port 2401 is available for the WANdisco proxy.
  5. Ensure that the CVS pserver port has been moved to port 2402.
  6. Complete Xinetd setup.
  7. At the bottom there is a link to a more detailed explanation of the installation checklist.
This next page will allow the user a chance to check the settings. When all of the settings are in place click on the restart button. Now the product will activate itself and restart with the specified configuration and license.
Once the product has restarted the user will be prompted to enter the credentials provided during the setup to log into the system.
Adding Replicator Sites
1. Site Properties can be entered under the Proxy tab Membership Create Site option.
  1. Name - a user friendly display name for the site.
  2. MAC Address - the Mac address of the machine. This can be acquired by running ifconfig. If it is not found in the path it may be in the /sbin or /usr/sbin directory.
  3. Host - a globally accessible IP address for this site which must be able to be resolved from all sites.
  4. Bind Host - host name where the source code management system runs that the proxy will bind to. Typically 0.0.0.0
  5. Port - the port which WANdisco will talk to CVS.
Creating Membership
1. Membership Properties can be entered under the Proxy tab Membership Create Membership option.
  1. Name - user friendly name for the membership.
  2. Quorum Configuration - the Singleton Quorum optimizes performance at the Distinguished node (which can be rotated using a cron job or Replicator's scheduler). Contact WANdisco Support if a different configuration is needed.
  3. Distinguished Node - select the node to be declared the distinguished node
  4. Sites - select sites to be included in the membership
Activate Membership
1. Membership activation can be found under the Proxy tab Membership Activate Membership option.
  1. CVS Root - current location CVS Root
  2. Proxy Directory - current location of WANdisco replicator
  3. Temp Directory - directory in which the installers for the new sites will be created
  4. Activate Membership - select membership to be activated
Installing new sites
1. After the membership is activated, installers for the new sites will be created in the Temp Directory specified on the Activate Membership page. Copy the following files to their respective servers. The path to the temp directories should match at all sites.
  1. replicator-[site].tgz
  2. repository.tgz
  3. packager
  4. task
  5. setup-site.pl
2. Untar the replicator-[site].tgz and repeat setup at each site.

Joining Memberships
1. Upon completion and restart of a new site's setup, the site now needs to join the membership.
2. Navigate to the Proxy tab Membership Join Membership option.