=========================================================
Documentation for MTPGW (Marine Trans Purchasing GateWay)
=========================================================

Instalation
===========

Prerequisites
-------------

Developed and tested on Linux Ubuntu & Debian. Other UNIXes should be usable too, also Windows and other python supported OS, but not tested and some changes are maybe needed.

Prerequisites:

 - python2.4
 - python-lxml

Optional:

 - postfix (or other email server for email robot)
 - python-cheetah (for generation of templates)

Not needed for PB138 version:

 - gnumeric (excel conversion using 'ssconvert') (some nice patches are in /PROJECT/gnumeric)
 - python-cherrypy2.1 (Web&SOAP interface)

Instalation
-----------

Copy all files and folders from distribution directory to root (e.g. default directories are inside of /opt/mtpgw)
(you can choose different directory, but than you have to change path in config file too).
Script mtpimport must run under privileges of user, who can read all files and write into archive directory.


Postfix binding for user 'robot'
--------------------------------
Choose one of these:

  1. '~robot/.forward' content in home directory of robot user::

	|/opt/mtpgw/bin/robot

	(Note: best is to run robot under user, who do not have login posibility and have restricted rights in the system)

  2. '/etc/aliases' content (don't forget to run 'postalias') (robot runs under postfix configured user)::

	robot: |/opt/mtpgw/bin/robot

  3. Best is modify '/etc/postfix/master.cf' (``man pipe``) (robot runs under user
     you specify, as many instances as you specify, etc.)::

	.../mtp/robot as pipe, transport

Configuration
=============

All MTPGW variables are in file /opt/mtpgw/etc/mtpgw.ini. Every option is commented there.

Documentation
=============

Command ``mtpimport``
---------------------

Command line interface for processing of documents, also can act as email robot.
Help is printed when it is ran without parameters or with -h.


Developer Documentation
=======================
All sources are prepared for ``pydoc`` -- so you can generate help from them directly by ``pydoc file.py``.