Changeset 3209

Show
Ignore:
Timestamp:
07/19/07 15:38:45 (15 years ago)
Author:
jerome
Message:

Added more steps.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/qa-assistant/pykota.xml

    r3208 r3209  
    1 <?xml version='1.0' ?> 
     1<?xml version='1.0' encoding="UTF-8" ?> 
    22<!DOCTYPE checklist PUBLIC "-//BadgerWare//DTD QA Assistant Checklist File 0.3//EN" "http://qa-assistant.sf.net/dtds/checklist/0.3/checklist.dtd"> 
    33<checklist version="0.3" name="PyKota Installation" revision="0.1"> 
     
    4848    </entry> 
    4949  </category> 
    50   <category name="Execute the pykota/checkdeps.py script to check for missing Dependecies"> 
     50  <category name="Run pykota/checkdeps.py to look for missing dependencies"> 
    5151    <description>PyKota depends on a lot of third party software. 
    5252      Some of them are required, other ones simply recommended : they don't 
     
    5454      be unavailable to you if they are not installed. 
    5555    </description>   
     56    <entry name="python-egenix-mxdatetime" display="true"> 
     57      <states> 
     58        <state name="Pass">python-egenix-mxdatetime is installed</state> 
     59        <state name="Fail">python-egenix-mxdatetime is not installed</state> 
     60      </states> 
     61      <description> 
     62        python-egenix-mxdatetime is required for PyKota to work.  
     63        You must install it with 'apt-get install python-egenix-mxdatetime' 
     64      </description> 
     65    </entry> 
     66    <entry name="python-imaging" display="true"> 
     67      <states> 
     68        <state name="Pass">python-imaging is installed</state> 
     69        <state name="Fail">python-imaging is not installed</state> 
     70      </states> 
     71      <description> 
     72        python-imaging is required for PyKota to work. While basic PyKota functionnality 
     73        may work without python-imaging, it is highly recommended that you install it 
     74        You must install it with 'apt-get install python-imaging' 
     75      </description> 
     76    </entry> 
    5677    <entry name="python-pygresql" display="true"> 
    5778      <states> 
    5879        <state name="Pass">python-pygresql is installed</state> 
    5980        <state name="Fail">python-pygresql is not installed</state> 
    60         <state name="Not-Applicable">We don't want to use a PostgreSQL database backend for PyKota</state> 
     81        <state name="Not-Applicable">I don't want to use a PostgreSQL database backend for PyKota</state> 
    6182      </states> 
    6283      <description> 
     
    6990        <state name="Pass">python-ldap is installed</state> 
    7091        <state name="Fail">python-ldap is not installed</state> 
    71         <state name="Not-Applicable">We don't want to use an LDAP database backend for PyKota</state> 
     92        <state name="Not-Applicable">I don't want to use an LDAP database backend for PyKota</state> 
    7293      </states> 
    7394      <description> 
     
    80101        <state name="Pass">python-mysqldb is installed</state> 
    81102        <state name="Fail">python-mysqldb is not installed</state> 
    82         <state name="Not-Applicable">We don't want to use a MySQL database backend for PyKota</state> 
     103        <state name="Not-Applicable">I don't want to use a MySQL database backend for PyKota</state> 
    83104      </states> 
    84105      <description> 
     
    91112        <state name="Pass">python-pysqlite2 is installed</state> 
    92113        <state name="Fail">python-pysqlite2 is not installed</state> 
    93         <state name="Not-Applicable">We don't want to use an SQLite database backend for PyKota</state> 
     114        <state name="Not-Applicable">I don't want to use an SQLite database backend for PyKota</state> 
    94115      </states> 
    95116      <description> 
     
    98119      </description> 
    99120    </entry> 
    100     <entry name="python-egenix-mxdatetime" display="true"> 
    101       <states> 
    102         <state name="Pass">python-egenix-mxdatetime is installed</state> 
    103         <state name="Fail">python-egenix-mxdatetime is not installed</state> 
    104       </states> 
    105       <description> 
    106         python-egenix-mxdatetime is required for PyKota to work.  
    107         You must install it with 'apt-get install python-egenix-mxdatetime' 
    108       </description> 
    109     </entry> 
    110121    <entry name="python-osd" display="true"> 
    111122      <states> 
    112123        <state name="Pass">python-osd is installed</state> 
    113124        <state name="Fail">python-osd is not installed</state> 
    114         <state name="Not-Applicable">We don't want to use 'pykosd', PyKota's X-Window end user print quota reminder</state> 
     125        <state name="Not-Applicable">I don't want to use 'pykosd', PyKota's X-Window end user print quota reminder</state> 
    115126      </states> 
    116127      <description> 
     
    124135        <state name="Pass">python-pysnmp4 is installed</state> 
    125136        <state name="Fail">python-pysnmp4 is not installed</state> 
    126         <state name="Not-Applicable">We don't want to use PyKota's internal SNMP hardware accounting</state> 
     137        <state name="Not-Applicable">I don't want to use PyKota's internal SNMP hardware accounting</state> 
    127138      </states> 
    128139      <description> 
     
    137148        <state name="Pass">python-jaxml is installed</state> 
    138149        <state name="Fail">python-jaxml is not installed</state> 
    139         <state name="Not-Applicable">We don't want to use PyKota's XML data dumping facilities</state> 
     150        <state name="Not-Applicable">I don't want to use PyKota's XML data dumping facilities</state> 
    140151      </states> 
    141152      <description> 
     
    150161        <state name="Pass">python-reportlab is installed</state> 
    151162        <state name="Fail">python-reportlab is not installed</state> 
    152         <state name="Not-Applicable">We don't want to use PyKota banners, nor its invoicing and refunding modules</state> 
     163        <state name="Not-Applicable">I don't want to use PyKota banners, nor its invoicing and refunding modules</state> 
    153164      </states> 
    154165      <description> 
     
    177188        <state name="Pass">python-pam is installed</state> 
    178189        <state name="Fail">python-pam is not installed</state> 
    179         <state name="Non-Blocker">We don't want to force the authentication of end users at printing time through pknotify+PyKotIcon</state> 
     190        <state name="Non-Blocker">I don't want to force the authentication of end users at printing time through pknotify+PyKotIcon</state> 
    180191      </states> 
    181192      <description> 
     
    187198      </description> 
    188199    </entry> 
     200    <entry name="python-pkipplib" display="true"> 
     201      <states> 
     202        <state name="Pass">python-pkipplib is installed</state> 
     203        <state name="Fail">python-pkipplib is not installed</state> 
     204        <state name="Non-Blocker">PyKota v1.26 is the latest release which still falls back to another method if pkipplib is not installed</state> 
     205      </states> 
     206      <description> 
     207        python-pkipplib allows PyKota to dialog with CUPS directly, instead of having to parse CUPS' configuration file to learn some details. 
     208        Unfortunately this library is not yet available as a package, so you must download and install it manually. 
     209        You can download it with 'wget http://www.pykota.com/software/pkipplib/download/tarballs/pkipplib-0.07.tar.gz' 
     210      </description> 
     211    </entry> 
     212    <entry name="pkpgcounter" display="true"> 
     213      <states> 
     214        <state name="Pass">pkpgcounter is installed</state> 
     215        <state name="Fail">pkpgcounter is not installed</state> 
     216        <state name="Non-Blocker">Only advanced PyKota administrators can make PyKota work without pkpgcounter. I am an Advanced PyKota Administrator</state> 
     217      </states> 
     218      <description> 
     219        pkpgcounter is PyKota's Page Description Languages parser. It really is the heart of software based 
     220        accounting methods in PyKota, since it is responsible for counting pages and computing ink usage. 
     221        While you can make PyKota work without pkpgcounter, this is not recommended excepted in the 
     222        situations where you've got a better or faster parser. 
     223        Unfortunately this software is not yet available as a package, so you must download and install it manually. 
     224        You can download it with 'wget http://www.pykota.com/software/pkpgcounter/download/tarballs/pkpgcounter-2.17.tar.gz' 
     225      </description> 
     226    </entry> 
     227    <entry name="python-psyco" display="true"> 
     228      <states> 
     229        <state name="Pass">python-psyco is installed</state> 
     230        <state name="Fail">python-psyco is not installed</state> 
     231        <state name="Not-Applicable">python-psyco is not supported on this platform</state> 
     232      </states> 
     233      <description> 
     234        python-psyco is an accelerator module for the Python language which can make the parsing  
     235        of Page Description Languages by pkpgcounter faster. 
     236        It is only supported on the x86 platform though, so if you use something else you 
     237        won't be able to install it. 
     238        It recommended but not necessary that you install it for PyKota to work. 
     239        You can install it with 'apt-get install python-psyco' 
     240      </description> 
     241    </entry> 
    189242  </category> 
     243  <category name="Print Server Installation procedure"> 
     244    <description>PyKota needs to be installed on the CUPS server. 
     245    </description>   
     246    <entry name="Go to PyKota's download directory" display="true"> 
     247      <states> 
     248        <state name="Pass">Working directory is now pykota/</state> 
     249        <state name="Fail">Current working directory is not pykota/</state> 
     250      </states> 
     251      <description> 
     252        PyKota's installation script expects to be run from PyKota's download directory. 
     253        You've previously downloaded PyKota into the ./pykota/ directory, so 
     254        you can go to this directory with 'cd pykota' 
     255      </description> 
     256    </entry> 
     257    <entry name="Install PyKota's files" display="true"> 
     258      <states> 
     259        <state name="Pass">PyKota files are installed</state> 
     260        <state name="Fail">PyKota's files are not installed</state> 
     261      </states> 
     262      <description> 
     263        PyKota's files must be installed on your system for PyKota to work. 
     264        Once you're in the pykota/ directory you can install them 
     265        with 'python setup.py install' 
     266      </description> 
     267    </entry> 
     268    <entry name="Create a 'pykota' system group" display="true"> 
     269      <states> 
     270        <state name="Pass">The 'pykota' system group exists</state> 
     271        <state name="Fail">The 'pykota' system group doesn't exist</state> 
     272      </states> 
     273      <description> 
     274        PyKota requires a dedicated system group named 'pykota', you can create 
     275        it with 'addgroup --system pykota' 
     276      </description> 
     277    </entry> 
     278    <entry name="Create a 'pykota' system user in group 'pykota'" display="true"> 
     279      <states> 
     280        <state name="Pass">The 'pykota' system user exists</state> 
     281        <state name="Fail">The 'pykota' system user doesn't exist</state> 
     282      </states> 
     283      <description> 
     284        PyKota requires a dedicated system user named 'pykota'. 
     285        You can create it with 'adduser --system --ingroup pykota --home /etc/pykota --gecos PyKota pykota' 
     286      </description> 
     287    </entry> 
     288    <entry name="Copy PyKota's sample configuration file from conf/" display="true"> 
     289      <states> 
     290        <state name="Pass">pykota.conf now exists in ~pykota/</state> 
     291        <state name="Fail">pykota.conf doesn't exist in ~pykota/</state> 
     292      </states> 
     293      <description> 
     294        PyKota's main configuration file is named 'pykota.conf' and must be present in user pykota's home directory, 
     295        by default /etc/pykota/ 
     296      </description> 
     297    </entry> 
     298    <entry name="Copy PyKota's sample administrative configuration file from conf/" display="true"> 
     299      <states> 
     300        <state name="Pass">pykotadmin.conf now exists in ~pykota/</state> 
     301        <state name="Fail">pykotadmin.conf doesn't exist in ~pykota/</state> 
     302      </states> 
     303      <description> 
     304        PyKota's administrative configuration file is named 'pykotadmin.conf' and must be present in user pykota's home directory, 
     305        by default /etc/pykota/. 
     306        All users who can read this file have write access to PyKota's database. 
     307      </description> 
     308    </entry> 
     309    <entry name="Check permissions on PyKota's configuration files" display="true"> 
     310      <states> 
     311        <state name="Pass">Permissions on configuration files are correct</state> 
     312        <state name="Fail">Permissions on configuration files are incorrect</state> 
     313      </states> 
     314      <description> 
     315        Any user who with read access to ~pykota/pykotadmin.conf will be considered a PyKota  
     316        administrator, with full read+write access to PyKota's database. 
     317        Any user with read access to ~pykota/pykota.conf will have read access to PyKota's database. Access 
     318        is limited to this particular user's personal datas and to impersonal datas like printers 
     319        informations. Take extreme care when relaxing the permissions on those files. 
     320        In any case, the user CUPS runs as, for example 'lp' or 'cupsys', MUST be given read 
     321        access to both of these files for PyKota to work. Under Debian, CUPS currently runs 
     322        as root, following the recommandations from CUPS' authors, so it's safe to make 
     323        both of these files owned by user pykota:pykota and chmod 0640. You can even 
     324        make ~pykota/pykotadmin.conf be chmod 0600 if you want to be really secure. 
     325      </description> 
     326    </entry> 
     327  </category>   
    190328</checklist>