Copyright (c) 2002 Infrae. All rights reserved.
See also LICENSE

Meta::

  Valid for:  Docma 0.6
  Author:     Christian Zagrodnick and Guido Wesdorp
  Email:      cz@gocept.com, guido@infrae.com
  CVS:        $Id: INSTALL.txt,v 1.10 2003/08/11 11:40:49 guido Exp $

 
DocmaServer is a Python application developed by Infrae for the processing and
generation of Silva XML. Note that DocmaServer is not a Zope product; it is an
independent application that can be access remotely by Silva using XML-RPC.  


Installing Docma

  IMPORTANT NOTE: When you install Docma on a Windows NT version that allows
  per-user security settings (Local Security Policy), the user/group under 
  which the DocmaServer runs *must* be adjusted so it is allowed to kill
  processes. Not doing so can cause DocmaServer to end up in an unusable state
  (freezing). To set this, go to 'Settings'->'Control Panel'->'Administrative
  Tools'->'Local Security Policy'->'Local Policies'->'User Rights Assignment'
  and assign the 'Act as part of the operating system' permission to the user/
  group. Note that the information above was retrieved from Windows 2000 
  (NT5), the actual location of the permission tool may differ if you're 
  running a different NT version.

  Docma depends on several other software products.  

  Active State's Python (>=2.2)

    Active State's Python distribution contains besides Python itself 
    expat for XML processing and the PythonCOM library.

    It can be found here:
    
        http://activestate.com/Products/ActivePython/

    or just download the file here:        

        http://downloads.activestate.com/ActivePython/windows/2.2/ActivePython-2.2.2-224-win32-ix86.msi

    This installs itself to C:\Python22.  

    
  Twisted

    Twisted is a framework, written in Python, for writing networked
    applications. 

    Download it here

        http://twistedmatrix.com/ 

    or directly here    

        http://twistedmatrix.com/products/get-current.epy?type=win32-py2.2.exe
    
    After installing Python install Twisted.  On setup twisted shows you 
    available Python installations.  Select Python Version 2.2 in C:\Python22.

   
  PyXML
    
    PyXML offers better XML processing facilities as Python itself. 

    Download it here

      http://pyxml.sourceforge.net/

    or grab PyXML 0.8.2 from here

      http://switch.dl.sourceforge.net/sourceforge/pyxml/PyXML-0.8.2.win32-py2.2.exe
    

  Microsoft Word 2000

    This version of Docma depends on Word 2000 beeing installed on the same
    machine.


  Unpack the Docma archive to a folder of you choice.  Edit docma_config.cfg 
  to suit your needs.
  
  Configuration options in docma_config.cfg are:

    xmlrpc_port - the port on which the XMLRPC server will run, this will
                      have to be set in Silva as well.

    xmlrpc_password - the password for the XMLRPC server, not real safe but
                      it protects the server from third party usage

    smtp_server - the SMTP server to use for sending emails

    sender_address - the address placed in the 'reply-to' field of emails

    storage_directory - the path to the directory where finished documents
                      are stored

    storage_expire - how long finished documents are kept on disc before they
                      are deleted, set this to a reasonable level so users
                      have the time to pick up their finished jobs (probably
                      a couple of days)

    command_timeout - how long Docma will wait before it receives a response
                      from Word, set this so that each individual job has 
                      plenty of time to finish, when this time has passed
                      Docma will reboot Word and retry

    max_retries - the number of times Docma will try to run a job, is only
                      used on command timeouts (see the previous setting)

    log_file - the path to the logfile

    word_frontpages - the directoryname of the Word frontpage templates

    word_template - the path (relative or absolute) where the default Word 
                      template can be found

  Start the server with the server.py file, which should be associated to the 
  just installed Python 2.2. 
  
  Assuming you have a recent version of Silva installed and running, go to the
  Zope Management Interface (ZMI) and add a ``Docma Service'' into your
  ``Silva Root''.  Selecting ``Add and Configure'' leads you directly to the
  configuration screen.  The configuration screen will always state whether
  there is a connection to a Docma server or not.  If Silva is connected to a
  Docma server the import and export pages have additional options for using
  it.

