Changeset 2117

Show
Ignore:
Timestamp:
03/01/05 00:17:40 (13 years ago)
Author:
jalet
Message:

Improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/docs/installation.sgml

    r2116 r2117  
    239239        To improve security further, you could encrypt your database connections, or 
    240240        take any other step as needed. Please refer to <application>PostgreSQL</application>'s 
    241         documentation for details. Also if <application>PyKota</application>'s configuration 
    242         file <filename>~pykota/pykotadmin.conf</filename> is readable by anyone with access on your file system,  
    243         a local user could create some script to modify his own print quota. 
     241        documentation for details.  
    244242        <warning> 
    245243          <title>Warning</title> 
     
    266264            If an error occured, maybe your PostgreSQL version is too old, or 
    267265            an unexpected problem (like a bug) happened. Please contact us via email so that we 
    268             can try to solve the problem. Thanks in advance. 
     266            can try to fix the problem. Thanks in advance. 
    269267          </para> 
    270268        </tip>   
     
    290288      <para> 
    291289        To use <application>OpenLDAP</application> as your Quota Storage Backend, you have to copy the 
    292         <filename>pykota/initscripts/ldap/pykota.schema</filename> in <application>OpenLDAP</application>'s  
     290        <filename>pykota/initscripts/ldap/pykota.schema</filename> into <application>OpenLDAP</application>'s  
    293291        schemas directory. 
    294292        Under Debian GNU/Linux, this is something like : 
     
    394392       
    395393      <para> 
    396         Once you have chosen and created your directory structure, you have to modify PyKota's configuration files <filename>~pykota/pykota.conf</filename> 
    397         and <filename>~pykota/pykotadmin.conf</filename> 
    398         to set some LDAP specific options and binding <literal>dn</literal>s. The easiest is 
    399         probably to give a look at  
    400         <filename>pykota/conf/pykota.conf.sample</filename> to see all the options that are 
    401         needed. Adapt the values to your own configuration, and finally initialize your  
    402         Quota Storage with the help of the <command>edpykota</command> command. 
     394        If no error occured, then your Quota DataBase is ready to be used. 
     395        Now you can let the Quota Storage Server alone, the remaining work 
     396        will have to be done on each one of the print servers which will 
     397        use this particular Quota Storage Server. 
     398        <tip> 
     399          <title>Tip</title> 
     400          <para> 
     401            If an error occured, maybe your OpenLDAP version is too old, or 
     402            an unexpected problem (like a bug) happened. Please contact us via email so that we 
     403            can try to fix the problem. Thanks in advance. 
     404          </para> 
     405        </tip>   
    403406      </para> 
    404407    </sect2>   
     
    539542          </para> 
    540543        </listitem>   
     544        <listitem> 
     545          <para> 
     546            The Python acccelerator <application>Psyco</application>. It must match your default Python version. 
     547            You can download it from <ulink url="http://psyco.sourceforge.net">http://psyco.sourceforge.net</ulink>. 
     548            You only need this if you run on the <literal>x86</literal> architecture because  
     549            <application>Psyco</application> doesn't yet exist on other architectures. 
     550          </para> 
     551        </listitem>   
     552        <listitem> 
     553          <para> 
     554            The <application>pysnmp</application> Python module version 3.4.2 or 3.4.3 exclusively.  
     555            You can download it from <ulink url="http://pysnmp.sourceforge.net">http://pysnmp.sourceforge.net</ulink>. 
     556          </para> 
     557        </listitem>   
     558        <listitem> 
     559          <para> 
     560            The <application>JAXML</application> Python module.  
     561            You can download it from <ulink url="http://www.librelogiciel.com/software/">http://www.librelogiciel.com/software/</ulink>. 
     562          </para> 
     563        </listitem>   
     564        <listitem> 
     565          <para> 
     566            The <application>ReportLab</application> Toolkit Python module.  
     567            You can download it from <ulink url="http://www.reportlab.org">http://www.reportlab.org</ulink>. 
     568          </para> 
     569        </listitem>   
     570        <listitem> 
     571          <para> 
     572            The <application>PyOSD</application> Python module.  
     573            You can download it from <ulink url="http://repose.cx/pyosd/">http://repose.cx/pyosd/</ulink>. 
     574          </para> 
     575        </listitem>   
    541576      </itemizedlist>   
    542577    </para> 
     
    577612      a <filename>README</filename> file explaining their purpose. 
    578613    </para> 
    579     <para> 
    580       You have to copy these files into the <filename>~pykota</filename> 
    581       directory (you have to create it before), under the respective names <filename>pykota.conf</filename> and  
     614     
     615    <para> 
     616      Now you have to create a <literal>pykota</literal> system user and group. The <application>PyKota</application> 
     617      software will automatically search its configuration files in user <literal>pykota</literal>'s 
     618      home directory. For example we could create the user and group, and set <filename>/etc/pykota</filename> 
     619      as the home directory, but any other home directory will do : 
     620<screen>       
     621    adduser --system --group --home /etc/pykota --gecos PyKota pykota 
     622</screen> 
     623    </para> 
     624     
     625    <para> 
     626      You now have to copy the sample configuration files into the <filename>~pykota</filename> 
     627      directory, under the respective names <filename>pykota.conf</filename> and  
    582628      <filename>pykotadmin.conf</filename>. Once copied there, you just 
    583629      have to modify these files to adapt them to your own setup. 
     
    622668      file contains the read-write user's identity and password. You must then 
    623669      ensure that no normal user can read this file. It should only be readable 
    624       by the <literal>root</literal> user, which is always the case, by 
    625       the user your printing system is running as, and optionally by the print administrators, 
    626       who are usually members of the <literal>lpadmin</literal> group. Under my Debian GNU/Linux system, 
    627       with CUPS, here's how to do to give the correct permissions : 
     670      by the <literal>root</literal> user, which is always the case, and by  
     671      <application>PyKota</application> administrators. In addition, <application>LPRng</application> 
     672      users, or users for which <application>CUPS</application> doesn't run as user <literal>root</literal> will  
     673      have to ensure that the user their printing system is run as 
     674      can read both of these files. An easy way to do so is to put the <literal>lp</literal> user 
     675      (for example) into the <literal>pykota</literal> system group, then 
     676      to give the correct permissions to <application>PyKota</application>'s configuration files : 
    628677      <screen> 
    629 $ chown root.root ~pykota/pykota.conf       
     678$ chown pykota.pykota ~pykota/pykota.conf       
    630679$ chmod 644 ~pykota/pykota.conf       
    631 $ chown lp.lpadmin ~pykota/pykotadmin.conf       
     680$ chown pykota.pykota ~pykota/pykotadmin.conf       
    632681$ chmod 640 ~pykota/pykotadmin.conf       
    633682      </screen> 
     
    782831 
    783832$Log$ 
     833Revision 1.32  2005/02/28 23:17:40  jalet 
     834Improved documentation 
     835 
    784836Revision 1.31  2005/02/28 22:29:25  jalet 
    785837More complete PostgreSQL configuration.