Changeset 856

Show
Ignore:
Timestamp:
03/18/03 23:10:54 (22 years ago)
Author:
jalet
Message:

Documentation improvements.

Files:
1 modified

Legend:

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

    r753 r856  
    22 
    33<chapter> 
    4   <title>TODO : Title here</title> 
     4  <title>Installation</title> 
    55  <para> 
    6     TODO : blah 
     6    Before being able to use <application>PyKota</application>, you have of course to 
     7    install it first. But before installing, you must carefully plan your installation. 
    78  </para> 
     9   
     10  <para> 
     11    First you have to determine which machine will be the <application>PyKota</application> 
     12    <glossaryterm>Storage Server</glossaryterm>. The Storage Server is the host responsible 
     13    for keeping a centralized database of print usage for all your printers, users and groups. 
     14  </para> 
     15   
     16  <para> 
     17    Then you have to list all the <glossaryterm>Print Servers</glossaryterm> for which 
     18    you plan to use <glossaryterm>print quota</glossaryterm> facilities. 
     19  </para> 
     20   
     21  <para> 
     22    Now we will see what has to be done on all those servers. 
     23    <note> 
     24      <title>Note</title> 
     25      <para> 
     26        Of course, depending on the size of your network, you may very well 
     27        use the same machine as both a Print Server and a Storage Server. 
     28        This is especially the case if you've got only one server. 
     29      </para> 
     30    </note>   
     31  </para> 
     32   
     33  <sect1> 
     34    <title>Storage Server Installation</title> 
     35     
     36    <para> 
     37      Depending on <application>PyKota</application>'s version number, different 
     38      types of storage backends may be supported, so we will see for each one of 
     39      them how to configure it. 
     40    </para> 
     41     
     42    <sect2> 
     43      <title>PostgreSQL</title> 
     44       
     45      <para> 
     46        <application>PostgreSQL</application> is an <glossaryterm>Object Relationnal DataBase 
     47        Management System</glossaryterm> distributed under a <glossaryterm>Free Software</glossaryterm> 
     48        license from the  
     49        <ulink url="http://www.postgresql.org">http://www.postgresql.org</ulink> 
     50        web site. It certainely is the free <acronym>RDBMS</acronym> which has the most advanced 
     51        features, and is widely used all over the world. 
     52      </para> 
     53       
     54      <para> 
     55        To configure your Storage Server, you must have PostgreSQL already working. 
     56        The complete installation of <application>PostgreSQL</application> is not covered by 
     57        the present manual, please refer to your system's documentation or to  
     58        <ulink url="http://www.postgresql.org">http://www.postgresql.org</ulink> for 
     59        details. 
     60      </para> 
     61       
     62      <para> 
     63        One thing you have to check, though, is that every Print Server on which you 
     64        want to install the print quota mechanism must be able to connect to the 
     65        <application>PostgreSQL</application> server. In the default installation of 
     66        <application>PostgreSQL</application> this may not be the case for security reasons, except if both 
     67        servers are in fact the same machine. In any case, it is recommended that you 
     68        check the <filename>/etc/postgresql/pg_hba.conf</filename> and modify it if 
     69        needed. This file is self documented and its modification is straightforward. 
     70        <tip> 
     71          <title>Tip</title> 
     72          <para> 
     73            Don't forget to restart <application>PostgreSQL</application> if you modify 
     74            any of its configuration files, in order for the changes to take effect. 
     75          </para> 
     76        </tip>   
     77      </para> 
     78       
     79      <para> 
     80        Be careful, you may be unable to connect from a Print Server to the <application>PostgreSQL</application> 
     81        server even if the configuration is correct. Sometimes your connections may be blocked by 
     82        one or more network firewalls along the route from one machine to the other. If this 
     83        is the case, then the best thing you can do is to ask your <glossaryterm>Network Administrator</glossaryterm> 
     84        to not filter the IP port used by <application>PostgreSQL</application>, which is 
     85        usually port 5432/tcp. 
     86        <tip> 
     87          <title>Tip</title> 
     88          <para> 
     89            The TCP/IP network port used by PostgreSQL may be different. When in doubt, ask your  
     90            <glossaryterm>System Administrator</glossaryterm> for the correct value. 
     91          </para> 
     92        </tip>   
     93      </para> 
     94       
     95      <para> 
     96        TODO. 
     97      </para> 
     98    </sect2>   
     99     
     100    <sect2> 
     101      <title>MySQL</title> 
     102       
     103      <para> 
     104        TODO. 
     105      </para> 
     106    </sect2>   
     107     
     108    <sect2> 
     109      <title>LDAP</title> 
     110       
     111      <para> 
     112        TODO. 
     113      </para> 
     114    </sect2>   
     115     
     116    <sect2> 
     117      <title>Berkeley DB</title> 
     118       
     119      <para> 
     120        TODO. 
     121      </para> 
     122    </sect2>   
     123  </sect1>   
     124   
     125  <sect1> 
     126    <title>Print Server Installation</title> 
     127     
     128    <para> 
     129      For each Print Server on which you plan to implement the print quota 
     130      mechanism, you have, of course, to have an already working printing environment.  
     131      Currently <application>PyKota</application> only works with the 
     132      <ulink url="http://www.cups.org"><application>CUPS</application></ulink> environment, 
     133      but more may be added in the future. 
     134    </para> 
     135     
     136    <para> 
     137      TODO 
     138    </para> 
     139  </sect1>   
    8140</chapter> 
    9141 
     
    11143 
    12144$Log$ 
     145Revision 1.2  2003/03/18 22:10:54  jalet 
     146Documentation improvements. 
     147 
    13148Revision 1.1  2003/02/08 00:03:35  jalet 
    14149Documentation skeleton added