Changeset 862

Show
Ignore:
Timestamp:
03/22/03 16:34:50 (22 years ago)
Author:
jalet
Message:

More complete installation documentation.

Files:
1 modified

Legend:

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

    r861 r862  
    9595        <application>PostgreSQL</application> this may not be the case for security reasons, except if both 
    9696        servers are in fact the same machine. In any case, it is recommended that you 
    97         check the <filename>/etc/postgresql/pg_hba.conf</filename> and modify it if 
     97        check the <filename>/etc/postgresql/pg_hba.conf</filename> file and modify it if 
    9898        needed. This file is self documented and its modification is straightforward. 
    9999        You also have to make sure that <application>PostgreSQL</application> accepts <acronym>TCP/IP</acronym> connections. 
    100100        To do so you either have to launch it with the <option>-i</option> option or 
    101         modify the <filename>/etc/postgresql/postgresql.conf</filename>, which is 
     101        modify the <filename>/etc/postgresql/postgresql.conf</filename> file, which is 
    102102        self documented and easy to modify too. 
    103103        <tip> 
     
    133133        This file will create a Quota DataBase administrator and a Quota DataBase user 
    134134        in the <application>PostgreSQL</application> system, then create an empty 
    135         Quota DataBase and set some permissions on it. 
     135        Quota DataBase and set some permissions on it. The Quota DataBase administrator 
     136        will be able to add printers, users and groups to the Quota DataBase, while 
     137        the Quota DataBase user will be used to update the print quota usage 
     138        in the Quota DataBase. None of these two users is present in the Quota Database 
     139        itself, they are only defined in <application>PostgreSQL</application> and don't 
     140        have to exist on any system, nor in the Quota DataBase. Their default names 
     141        are <literal>pykotaadmin</literal> for the administrator and <literal>pykotauser</literal> 
     142        for the user. The database which will be created will be named <literal>pykota</literal>. 
     143        <note> 
     144          <title>Note</title> 
     145          <para> 
     146            You can choose other names if you want, just modify the  
     147            <filename>initscripts/pykota-postgresql.sql</filename> file 
     148            accordingly.  
     149          </para> 
     150        </note>   
    136151      </para> 
    137152       
     
    156171template1=# \i pykota-postgresql.sql  
    157172            ... a lot of output lines 
    158 template1=# \q       
     173pykota=#        
    159174        </screen> 
     175      </para> 
     176       
     177      <para> 
     178        For security reasons, you may want to set passwords in  
     179        <application>PostgreSQL</application> for the  
     180        <literal>pykotaadmin</literal> and <literal>pykotauser</literal>  
     181        users. Otherwise any user able to connect to  
     182        <application>PostgreSQL</application> on your Quota Storage Server  
     183        could connect to the quota database as one of them and modify it without problem.  
     184      </para> 
     185       
     186      <para> 
     187        To do so, just type the following lines while still being at the <application>psql</application> 
     188        prompt (replace the passwords values by your own) : 
     189        <screen> 
     190pykota=# ALTER USER pykotaadmin PASSWORD 'somepassword'; 
     191ALTER USER 
     192pykota=# ALTER USER pykotauser PASSWORD 'anotherpassword'; 
     193ALTER USER 
     194pykota=# \q 
     195jerome@nordine:~/pykota-1.02-official/initscripts$ 
     196        </screen> 
     197      </para> 
     198       
     199      <para> 
     200        The <literal>\q</literal> command above will quit the <application>psql</application> 
     201        program and return you to the shell's command line prompt. 
     202      </para> 
     203       
     204      <para> 
     205        To improve security further, you could encrypt your database connections, or 
     206        take any other step as needed. Please refer to <application>PostgreSQL</application>'s 
     207        documentation for details. 
     208        <warning> 
     209          <title>Warning</title> 
     210          <para> 
     211            Defining passwords may not be sufficient if your database access rule is 
     212            set to <literal>trust</literal> in the <filename>/etc/postgresql/pg_hba.conf</filename>. 
     213            Again, please refer to <application>PostgreSQL</application>'s documentation 
     214            for details. Also, passwords will fly unencrypted over the network by default, 
     215            so be sure to take any necessary step to secure your database server from 
     216            unauthorized use. This has nothing to do with <application>PyKota</application> 
     217            though, it is just a general rule to keep in mind. 
     218          </para> 
     219        </warning>   
    160220      </para> 
    161221       
     
    174234        </tip>   
    175235      </para> 
     236       
    176237    </sect2>   
    177238     
     
    218279     
    219280    <para> 
    220       TODO 
     281      Here's the list of software you have to install on each Print Server : 
     282      <itemizedlist> 
     283        <listitem> 
     284          <para> 
     285            CUPS version 1.1 or above. 
     286            You can download it from <ulink url="http://www.cups.org">http://www.cups.org</ulink>. 
     287          </para> 
     288        </listitem>   
     289        <listitem> 
     290          <para> 
     291            Python version 2.1 or above. 
     292            You can download it from <ulink url="http://www.python.org">http://www.python.org</ulink>. 
     293          </para> 
     294        </listitem>   
     295        <listitem> 
     296          <para> 
     297            Quota Storage client libraries, depending on your Quota Storage Backend : 
     298            <itemizedlist> 
     299              <listitem> 
     300                <para> 
     301                  PostgreSQL backend : 
     302                  <itemizedlist> 
     303                    <listitem> 
     304                      <para> 
     305                        <application>PostgreSQL</application> client libraries. They must match the <application>PostgreSQL</application> 
     306                        version used on your Quota Storage Server. 
     307                      </para> 
     308                    </listitem>   
     309                    <listitem> 
     310                      <para> 
     311                        The <application>PygreSQL</application> python module.  
     312                        It must match the  
     313                        <application>PostgreSQL</application> client libraries' 
     314                        version, as well as Python's version. 
     315                      </para> 
     316                    </listitem>   
     317                  </itemizedlist>   
     318                </para> 
     319              </listitem>   
     320              <listitem> 
     321                <para> 
     322                  MySQL backend : TODO 
     323                </para> 
     324              </listitem> 
     325              <listitem> 
     326                <para> 
     327                  LDAP backend : TODO 
     328                </para> 
     329              </listitem> 
     330              <listitem> 
     331                <para> 
     332                  Berkeley DB backend : TODO 
     333                </para> 
     334              </listitem> 
     335            </itemizedlist>   
     336          </para> 
     337        </listitem>   
     338        <listitem> 
     339          <para> 
     340            <application>ucd-snmp</application> or <application>net-snmp</application> tools, version 4.2.5 or above. You only need 
     341            the <application>snmpget</application> command. 
     342            You can download them from <ulink url="http://www.sourceforge.net/projects/net-snmp/">http://www.sourceforge.net/projects/net-snmp/</ulink> 
     343          </para> 
     344        </listitem>   
     345        <listitem> 
     346          <para> 
     347            eGenix' mxDateTime Python module. It must match your default Python version. 
     348            You can download it from <ulink url="http://www.egenix.com">http://www.egenix.com</ulink>. 
     349          </para> 
     350        </listitem>   
     351      </itemizedlist>   
    221352    </para> 
    222353  </sect1>   
     
    226357 
    227358$Log$ 
     359Revision 1.8  2003/03/22 15:34:50  jalet 
     360More complete installation documentation. 
     361 
    228362Revision 1.7  2003/03/22 14:26:45  jalet 
    229363Download instructions added.