INSTALL

Installing RevisionManager

Requirements
RevisionManager requires Zope 2.4 or later, the PageTemplates product and the cvs program. Zope 2.5 or later is recommended. For Windows users, it is recommended to install WinCVS (http://www.wincvs.org).

Linux as the operating system is recommended, it should work on all common Unices, though. Windows is not officially supported, though users have reported running it successfully.

It is recommended that Zope runs as a privileged user, e.g. zope, not as nobody. In any case, it is absolutely necessary that the user Zope is running under has a valid home directory and has write access there. When using the INSTANCE_HOME feature of Zope, for example, you could use that as a home directory.

Keep in mind that all cvs transactions will be executed by the user Zope is running under, especially when using SSH (for the ~/.ssh directory) and public key authentication. Note that when using the server access method with SSH, public key authentication is absolutely necessary since the password prompt is not supported.
Installing the product
Like all other products, RevisionManager should be installed into the Products directory (of your INSTANCE_HOME).

When a RevisionManager is created, RevisionManager will create a directory named INSTANCE_HOME/var/RevisionManager. Make sure it has the permissions to do so and to write to it.
Adding a RevisionManager instance to your site
1. 1 Location
  You need one RevisionManager for each CVS module you'd like to use. Add it in the corresponding top-level folder of your module.
  
  For example, if you have a Folder at /portal and you would like to manage all objects inside the portal folder, add RevisionManager to the portal folder.
  
  If you are serving many virtual hosts with one Zope instance and you wish separate CVS modules for them, you will have to create an instance in every folder that is serving a virtual host.
  
  For most people, one RevisionManager instance in the Root folder should work.
2. 2 Add dialogs
  Since you likely are familiar with CVS, the form should be self- explanatory.
  1. 2.1 Note to Windows users
    On Unix, RevisionManager will create a fake CVSPASS file when using the pserver method. This is not supported for Windows. However, the CVS from WinCVS writes equivalent data to the Windows registry when cvs login is invoked. Therefore, if you want to use the pserver method, execute cvs -d CVSROOT login on the DOS command line before adding the RevisionManager object.
    
    Also make sure that the path to the CVS executable is valid. If it contains spaces, for example, wrap it in double quotes like so:
```
           "C:\Program files\GNU\Wincvs 1.3\cvsnt\cvs.exe"
```
  After you've clicked the Add button, RevisionManager will show you one of two possible forms, depending whether the module already exists or not.
  - Module does not exist yet:
    You will be shown the import dialog next. There, select the objects you want to be revision controlled. If you'll have more in the future or if you forgot some, don't worry. You will always have the possibility to add to or remove from this list.
  - Module already exists:
    In the following form, RevisionManager will show you all files that already are available in the module and how you can map them to objects.
3. 3 When something goes wrong...
  ...during the process of adding an instance of RevisionManager, you may likely still find a RevisionManager instance in your folder which is, however, not properly initialized. In general, it is best to delete this and start all over.
  
  Note: When deleting a RevisionManager instance, neither the CVS module nor the objects that were managed with it are being deleted. At most, you will have to enter all your settings into the Add form again.
Upgrading
RevisionManager supports upgrading from one version to another through the upgrade() method. Create a PythonScript in the same folder that RevisionManager is in and enter the following line of code:
```
      context.RevisionManager.upgrade()
```
Save and go to the Try tab. RevisionManager should now be upgraded. Please be aware that, depending on your installation, this might take quite some time.
Properties
Since version 1.3, RevisionManager supports the file system synchronization of properties. If you are already running a RevisionManager instance without synchronizing properties and want use the property synchronization feature, carete a PythonScript in the same folder that RevisionManager is in and enter the following line of code:
```
        context.RevisionManager.upgradeToProperties()
```
Save and go to the Try tab. RevisionManager will then extract the properties of all objects currently managed with it and for which property sychronization is supported and add them to the CVS. Please be aware that this this might take quite some time.