Changeset 2844

Show
Ignore:
Timestamp:
04/07/06 22:34:44 (17 years ago)
Author:
jerome
Message:

Added some stuff about MySQL.
Removed confusing vocabulary.

Location:
pykota/trunk/docs
Files:
3 modified

Legend:

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

    r2842 r2844  
    1313  <para> 
    1414    First you have to determine which machine will be the <application>PyKota</application> 
    15     <firstterm>Storage Server</firstterm>. The Storage Server is the host responsible 
     15    database server. The database server is the host responsible 
    1616    for keeping a centralized database of print usage for all your printers, users and groups. 
    1717  </para> 
     
    1919  <para> 
    2020    Then you have to list all the <firstterm>Print Servers</firstterm> for which 
    21     you plan to use <firstterm>print quota</firstterm> facilities. 
     21    you plan to use print quota facilities. 
     22  </para> 
     23   
     24  <para> 
     25    With most database backends, several print servers can share a single database, however 
     26    as we'll see later this is not possible if you choose to use <application>SQLite</application> 
     27    as your print quota database backend. 
    2228  </para> 
    2329   
     
    102108        modify the <filename>/etc/postgresql/postgresql.conf</filename> file, which is 
    103109        self documented and easy to modify too. Allowing <acronym>TCP/IP</acronym> connections 
    104         is not necessary though if your Quota Storage Server and your Print Server are 
     110        is not necessary though if your print quota database server and your Print Server are 
    105111        the very same host. 
    106112      </para>   
     
    152158      <para> 
    153159        Now that your <application>PostgreSQL</application> server is up and running, and 
    154         is waiting for your connections, you have to create the Quota Storage DataBase. 
     160        is waiting for your connections, you have to create the print quota database. 
    155161        To do so, you'll have to feed <application>PostgreSQL</application> with the 
    156162        <filename>pykota-1.24/initscripts/postgresql/pykota-postgresql.sql</filename> file. 
    157         This file will create a Quota DataBase administrator in the <application>PostgreSQL</application> system, then create an empty 
    158         Quota DataBase and set some permissions on it. The Quota DataBase administrator 
    159         is the <application>PostgreSQL</application>'s user used to manage the Quota database. 
    160         The Quota DataBase Administrator is not present in the Quota Database 
     163        This file will create a print quota database administrator in the <application>PostgreSQL</application> system, then create an empty 
     164        print quota database and set some permissions on it. The print quota database administrator 
     165        is the <application>PostgreSQL</application>'s user used to manage the quota database. 
     166        The print quota database Administrator is not present in the quota database 
    161167        itself, he is only defined in <application>PostgreSQL</application> and don't 
    162         have to exist on any system, nor in the Quota DataBase. His default name 
     168        have to exist on any system, nor in the print quota database. His default name 
    163169        is <literal>pykotaadmin</literal>.  
    164         A Quota Storage read-only user is also created under the name of <literal>pykotauser</literal>. 
     170        A print quota database read-only user is also created under the name of <literal>pykotauser</literal>. 
    165171        This read-only user is used by <application>PyKota</application> to connect to the  
    166         Quota Storage when an user who is not a <application>PyKota</application> administrator  
     172        print quota database when an user who is not a <application>PyKota</application> administrator  
    167173        <footnote><para>a <application>PyKota</application> administrator is an user who can read the <filename>~pykota/pykotadmin.conf</filename> file.</para></footnote> 
    168174        launches a pykota command. This prevents normal 
     
    218224        <literal>pykotaadmin</literal> and <literal>pykotauser</literal> users. 
    219225        Otherwise any user able to connect to  
    220         <application>PostgreSQL</application> on your Quota Storage Server  
     226        <application>PostgreSQL</application> on your print quota database server  
    221227        could connect to the quota database, and either see it, or even modify it without problem.  
    222228      </para> 
     
    257263       
    258264      <para> 
    259         If no error occured, then your Quota DataBase is ready to be used. 
    260         Now you can let the Quota Storage Server alone, the remaining work 
     265        If no error occured, then your print quota database is ready to be used. 
     266        Now you can let the print quota database server alone, the remaining work 
    261267        will have to be done on each one of the print servers which will 
    262         use this particular Quota Storage Server. 
     268        use this particular print quota database server. 
    263269        <tip> 
    264270          <title>Tip</title> 
     
    278284      <para> 
    279285        Any <acronym>LDAP</acronym> server, and particularly <application>OpenLDAP</application>, can be used  
    280         as a Quota Storage Backend. 
     286        as a print quota database backend. 
    281287        Some other LDAP servers can be used, but this is currently untested in production. 
    282288      </para> 
     
    289295       
    290296      <para> 
    291         To use <application>OpenLDAP</application> as your Quota Storage Backend, you have to copy the 
     297        To use <application>OpenLDAP</application> as your print quota database backend, you have to copy the 
    292298        <filename>pykota/initscripts/ldap/pykota.schema</filename> into <application>OpenLDAP</application>'s  
    293299        schemas directory. 
     
    399405       
    400406      <para> 
    401         If no error occured, then your Quota DataBase is ready to be used. 
    402         Now you can let the Quota Storage Server alone, the remaining work 
     407        If no error occured, then your print quota database is ready to be used. 
     408        Now you can let the print quota database server alone, the remaining work 
    403409        will have to be done on each one of the print servers which will 
    404         use this particular Quota Storage Server. 
     410        use this particular print quota database server. 
    405411        <tip> 
    406412          <title>Tip</title> 
     
    473479      </para> 
    474480      <para> 
    475         That's all ! For more details, please refer to <filename>pykota/initscripts/sqlite/README.sqlite</filename>. 
     481        If no error occured, then your print quota database is ready to be used. 
     482        In case you need them, additional instructions are available in <filename>pykota/initscripts/sqlite/README.sqlite</filename> 
     483        <tip> 
     484          <title>Tip</title> 
     485          <para> 
     486            If an error occured, maybe your SQLite version is too old, or 
     487            an unexpected problem (like a bug) happened. Please contact us via email so that we 
     488            can try to fix the problem. Thanks in advance. 
     489          </para> 
     490        </tip>   
    476491      </para> 
    477492    </sect2>   
     
    481496       
    482497      <para> 
    483         A <application>Berkeley DB</application> Storage Backend is planned, but it actually 
     498        A <application>Berkeley DB</application> backend is planned, but it actually 
    484499        doesn't exist. It seems that remote storage won't be possible with such a backend, 
    485500        so in other terms this means that you will have a different quota database on 
     
    524539        <listitem> 
    525540          <para> 
    526             Quota Storage client libraries, depending on your Quota Storage Backend : 
     541            print quota database client libraries, depending on your print quota database backend : 
    527542            <itemizedlist> 
    528543              <listitem> 
     
    533548                      <para> 
    534549                        <application>PostgreSQL</application> client libraries. They must match the <application>PostgreSQL</application> 
    535                         version used on your Quota Storage Server. 
     550                        version used on your print quota database server. 
    536551                      </para> 
    537552                    </listitem>   
     
    539554                      <para> 
    540555                        The <application>PygreSQL</application> python module.  
    541                         It must have been compiled against the same 
    542                         <application>PostgreSQL</application> client libraries. 
    543556                        <application>PygreSQL</application> is normally included in 
    544557                        <application>PostgreSQL</application>, but you may want to 
     
    556569                      <para> 
    557570                        <application>OpenLDAP</application> client libraries. They must match 
    558                         the <application>OpenLDAP</application> version used on your Quota Storage Server. 
     571                        the <application>OpenLDAP</application> version used on your print quota database server. 
    559572                      </para> 
    560573                    </listitem>   
     
    562575                      <para> 
    563576                        The <application>Python-LDAP</application> python module. 
    564                         It must have been compiled against the same 
    565                         <application>OpenLDAP</application> client libraries. 
    566577                        You may download this module from <ulink url="http://python-ldap.sourceforge.net">http://python-ldap.sourceforge.net</ulink> 
    567578                      </para> 
     
    572583              <listitem> 
    573584                <para> 
    574                   MySQL backend : Supported but not documented yet. 
     585                  MySQL backend : 
     586                  <itemizedlist> 
     587                    <listitem> 
     588                      <para> 
     589                        <application>MySQL</application> client libraries. They must match the <application>MySQL</application> 
     590                        version used on your database server. 
     591                      </para> 
     592                    </listitem>   
     593                    <listitem> 
     594                      <para> 
     595                        The <application>Python-MySQL</application> python module, version 1.2.x or higher.  
     596                        You can download it from <ulink url="http://sourceforge.net/projects/mysql-python">http://sourceforge.net/projects/mysql-python</ulink> 
     597                      </para> 
     598                    </listitem>   
     599                  </itemizedlist>   
    575600                </para> 
    576601              </listitem> 
  • pykota/trunk/docs/repykota.sgml

    r2551 r2844  
    77  <para> 
    88    To account for print usage is good, however there must be a way to easily 
    9     query the <emphasis>Quota Storage Server</emphasis> and generate 
     9    query the print quota database and generate 
    1010    reports describing current usage for every user on every printer. 
    1111  </para> 
  • pykota/trunk/docs/warnpykota.sgml

    r2147 r2844  
    3838    message. He can specify a printer name's filter to check his quota only 
    3939    on specific printers. If a normal user uses the <literal>--groups</literal> command line 
    40     argument, then for each group he is a member of in the Quota Storage, each 
     40    argument, then for each group he is a member of in the print quota database, each 
    4141    group member may receive a warning message. You can take care of this if this 
    4242    becomes annoying by forbidding normal users to launch the <command>warnpykota</command>