root / pykota / trunk / docs / installation.sgml @ 2842

Revision 2842, 42.5 kB (checked in by jerome, 18 years ago)

Now includes the documentation on how to setup an SQLite database

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
1<!-- $Id$ -->
4  <title id="installation">Installation</title>
6  <para>Last modified on $Date$</para>
8  <para>
9    Before being able to use <application>PyKota</application>, you have of course to
10    install it first. But before installing, you must carefully plan your installation.
11  </para>
13  <para>
14    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
16    for keeping a centralized database of print usage for all your printers, users and groups.
17  </para>
19  <para>
20    Then you have to list all the <firstterm>Print Servers</firstterm> for which
21    you plan to use <firstterm>print quota</firstterm> facilities.
22  </para>
24  <para>
25    Finally you have to download <application>PyKota</application>'s latest version
26    or buy an official package, from
27    <ulink url=""></ulink>.
28    If you've just bought an official package, then as soon as you've receive it you
29    have to decompress and visit its archive, to do so just type the following commands :
30    <screen>
31jerome@nordine:~$ tar -zxf pykota-1.24_official.tar.gz   
32jerome@nordine:~$ cd pykota-1.24_official
34    </screen>
35  </para>
37  <para>
38    You can see many files in this directory, the first ones to read are <filename>README</filename>,
39    then <filename>COPYING</filename> and <filename>LICENSE</filename>. They will give you
40    basic installation instructions and explain the licensing terms under which
41    <application>PyKota</application> is distributed. Of course they are also mostly
42    boring to read ! Detailed installation and operating instructions are defined
43    in the <filename>./docs</filename> directory, in the form of <acronym>SGML</acronym>
44    documentation in the <ulink url="">DocBook</ulink> format.
45    You have to compile these files into readable documentation like the <acronym>HTML</acronym>
46    or <acronym>PDF</acronym> formats, or buy an official <application>PyKota</application> package
47    which already contains these compiled forms of the documentation. Of course you already
48    know this because that's what you are currently reading !
49  </para>
51  <para>
52    Now we will see what has to be done on each of the servers we are planning to use.
53    <note>
54      <title>Note</title>
55      <para>
56        Of course, depending on the size of your network, you may very well
57        use the same machine as both a Print Server and a Storage Server.
58        This is especially the case if you've got only one server.
59      </para>
60    </note> 
61  </para>
63  <sect1>
64    <title>Storage Server Installation</title>
66    <para>
67      Depending on <application>PyKota</application>'s version number, different
68      types of storage backends may be supported, so we will see for each one of
69      them how to configure it.
70    </para>
72    <sect2>
73      <title>PostgreSQL</title>
75      <para>
76        <application>PostgreSQL</application> is an <firstterm>Object Relationnal DataBase
77        Management System</firstterm> distributed under a <firstterm>Free Software</firstterm>
78        license from the
79        <ulink url=""></ulink>
80        web site. It certainely is the free <acronym>RDBMS</acronym> which has the most advanced
81        features, and is widely used all over the world.
82      </para>
84      <para>
85        To configure your Storage Server, you must have PostgreSQL already working.
86        The complete installation of <application>PostgreSQL</application> is not covered by
87        the present manual, please refer to your system's documentation or to
88        <ulink url=""></ulink> for
89        details.
90      </para>
92      <para>
93        One thing you have to check, though, is that every Print Server on which you
94        want to install the print quota mechanism, must be able to connect to the
95        <application>PostgreSQL</application> server. In the default installation of
96        <application>PostgreSQL</application> this may not be the case for security reasons, except if both
97        servers are in fact the same machine. In any case, it is recommended that you
98        check the <filename>/etc/postgresql/pg_hba.conf</filename> file and modify it if
99        needed. This file is self documented and its modification is straightforward.
100        You also have to make sure that <application>PostgreSQL</application> accepts <acronym>TCP/IP</acronym> connections.
101        To do so you either have to launch it with the <option>-i</option> option or
102        modify the <filename>/etc/postgresql/postgresql.conf</filename> file, which is
103        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
105        the very same host.
106      </para> 
108      <para>
109        Here's an excerpt from a <filename>pg_hba.conf</filename> file. This one rejects all
110        connections to PyKota's database excepted when made from the same host by <application>PostgreSQL</application> users
111        <literal>pykotauser</literal> or <literal>pykotaadmin</literal> with the correct password.
113        local all    postgres                              ident sameuser
114        local all    all                                   reject
115        host  pykota pykotauser crypt
116        host  pykota pykotaadmin crypt
117        host  pykota all reject
119     </para>
121     <para>
122        Of course if your print server and your database servers have different <acronym>IP</acronym>
123        addresses, you have to replace the <literal></literal> address above with your print
124        server's <acronym>IP</acronym> address. As an alternative, you could still keep these
125        lines and add similar lines with other <acronym>IP</acronym> addresses if you have several
126        print servers for which you want a single centralized database.
127        <tip>
128          <title>Tip</title>
129          <para>
130            Don't forget to restart <application>PostgreSQL</application> if you modify
131            any of its configuration files, in order for the changes to take effect.
132          </para>
133        </tip> 
134      </para>
136      <para>
137        Be careful, you may be unable to connect from a Print Server to the <application>PostgreSQL</application>
138        server even if the configuration is correct. Sometimes your connections may be blocked by
139        one or more network firewalls along the route from one machine to the other. If this
140        is the case, then the best thing you can do is to ask your <firstterm>Network Administrator</firstterm>
141        to not filter the IP port used by <application>PostgreSQL</application>, which is
142        usually port <literal>5432/tcp</literal>.
143        <note>
144          <title>Note</title>
145          <para>
146            The TCP/IP network port used by PostgreSQL may be different. When in doubt, ask your
147            <firstterm>System Administrator</firstterm> for the correct value.
148          </para>
149        </note> 
150      </para>
152      <para>
153        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.
155        To do so, you'll have to feed <application>PostgreSQL</application> with the
156        <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
161        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
163        is <literal>pykotaadmin</literal>.
164        A Quota Storage read-only user is also created under the name of <literal>pykotauser</literal>.
165        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
167        <footnote><para>a <application>PyKota</application> administrator is an user who can read the <filename>~pykota/pykotadmin.conf</filename> file.</para></footnote>
168        launches a pykota command. This prevents normal
169        users from being able to modify their own, or other users', quota information.
170        The database which will be created will be named <literal>pykota</literal> by default.
171        <note>
172          <title>Note</title>
173          <para>
174            You can choose other names if you want, just modify the
175            <filename>initscripts/postgresql/pykota-postgresql.sql</filename> file
176            accordingly, and report your changes into <application>PyKota</application>'s
177            configuration files.
178          </para>
179        </note> 
180      </para>
182      <para>
183        To run this script, you can use the <command>psql</command> frontend to
184        <application>PostgreSQL</application>, but your priviledges must be sufficient
185        to be allowed to create users and databases. You can launch <command>psql</command>
186        as the <literal>postgres</literal> user which is <application>PostgreSQL</application>'s
187        default administrator, and connect to the default database named <literal>template1</literal>.
188        From a command line interpreter (i.e. shell), type the following commands :
189        <screen>
190jerome@nordine:~$ cd pykota-1.24_official/initscripts/postgresql
191jerome@nordine:~/pykota-1.24_official/initscripts$ psql -h localhost -U postgres template1
192Welcome to psql, the PostgreSQL interactive terminal.
194Type:  \copyright for distribution terms
195       \h for help with SQL commands
196       \? for help on internal slash commands
197       \g or terminate with semicolon to execute query
198       \q to quit
200template1=# \i pykota-postgresql.sql
201            ... a lot of output lines
203        </screen>
204        <note>
205          <title>Note</title>
206          <para>
207            If you use RPM or DEB packages, usually the
208            <filename>pykota-postgresql.sql</filename> file gets installed into the
209            <filename>/usr/share/pykota/postgresql</filename> directory, along
210            with a README file.
211          </para>
212        </note> 
213      </para>
215      <para>
216        For security reasons, you may want to set passwords in
217        <application>PostgreSQL</application> for the
218        <literal>pykotaadmin</literal> and <literal>pykotauser</literal> users.
219        Otherwise any user able to connect to
220        <application>PostgreSQL</application> on your Quota Storage Server
221        could connect to the quota database, and either see it, or even modify it without problem.
222      </para>
224      <para>
225        To do so, just type the following lines while still being at the <command>psql</command>
226        prompt (replace the password values by your own, and do the same for the <literal>pykotauser</literal> user) :
227        <screen>
228pykota=# ALTER USER pykotaadmin PASSWORD 'somepassword';
230pykota=# \q
232        </screen>
233      </para>
235      <para>
236        The <literal>\q</literal> command above will quit the <command>psql</command>
237        program and return you to the shell's command line prompt.
238      </para>
240      <para>
241        To improve security further, you could encrypt your database connections, or
242        take any other step as needed. Please refer to <application>PostgreSQL</application>'s
243        documentation for details.
244        <warning>
245          <title>Warning</title>
246          <para>
247            Defining passwords may not be sufficient if your database access rule is
248            set to <literal>trust</literal> in the <filename>/etc/postgresql/pg_hba.conf</filename>.
249            Again, please refer to <application>PostgreSQL</application>'s documentation
250            for details. Also, passwords will fly unencrypted over the network by default,
251            so be sure to take any necessary step to secure your database server from
252            unauthorized use. This has nothing to do with <application>PyKota</application>
253            though, it is just a general rule to keep in mind.
254          </para>
255        </warning> 
256      </para>
258      <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
261        will have to be done on each one of the print servers which will
262        use this particular Quota Storage Server.
263        <tip>
264          <title>Tip</title>
265          <para>
266            If an error occured, maybe your PostgreSQL version is too old, or
267            an unexpected problem (like a bug) happened. Please contact us via email so that we
268            can try to fix the problem. Thanks in advance.
269          </para>
270        </tip> 
271      </para>
273    </sect2> 
275    <sect2>
276      <title>LDAP</title>
278      <para>
279        Any <acronym>LDAP</acronym> server, and particularly <application>OpenLDAP</application>, can be used
280        as a Quota Storage Backend.
281        Some other LDAP servers can be used, but this is currently untested in production.
282      </para>
284      <para>
285        <application>OpenLDAP</application> is a Lightweight Directory Access Protocol server
286        implementation published as Free Software.
287        You can download it from <ulink url=""></ulink>.
288      </para>
290      <para>
291        To use <application>OpenLDAP</application> as your Quota Storage Backend, you have to copy the
292        <filename>pykota/initscripts/ldap/pykota.schema</filename> into <application>OpenLDAP</application>'s
293        schemas directory.
294        Under Debian GNU/Linux, this is something like :
295        <screen>       
296$ cp pykota.schema /etc/ldap/schema
297        </screen>
298        <note>
299          <title>Note</title>
300          <para>
301            If you use RPM or DEB packages, the
302            <filename>pykota.schema</filename> file is usually installed into the
303            <filename>/usr/share/pykota/ldap</filename> directory, along
304            with a README file, and may also be installed automatically in
305            your <acronym>LDAP</acronym> server's schemas directory.
306          </para>
307        </note> 
308     </para>
309     <para>   
310       Then edit <filename>/etc/ldap/slapd.conf</filename> and add a line to   
311       include the PyKota schema. You should have something
312       like :
313       <screen>   
314# Schema and objectClass definitions
315include         /etc/ldap/schema/core.schema
316include         /etc/ldap/schema/cosine.schema
317include         /etc/ldap/schema/nis.schema
318include         /etc/ldap/schema/inetorgperson.schema
319include         /etc/ldap/schema/pykota.schema
320        </screen>       
321      </para>
323      <para>
324        While this is not mandatory, it is recommended that you setup
325        some indexes for some often accessed PyKota attributes.
326        Here are the minimal indexes
327        lines you may want to put in <filename>slapd.conf</filename> :
328        <screen>
329# Indexes for PyKota
330index pykotaUserName pres,eq,sub
331index pykotaGroupName pres,eq,sub
332index pykotaPrinterName pres,eq,sub
333index pykotaBillingCode pres,eq,sub
334index pykotaLastJobIdent eq
335        </screen>
336      </para>
338      <para>
339        Now you must ensure that the DNs you'll use to bind to   
340        your OpenLDAP server don't have search queries size limits,
341        which gives for example (OpenLDAP 2.1.x or above) :
344# No Limits for PyKota's administrator and read-only user
345limits dn="cn=pykotaadmin,dc=example,dc=com" size.soft=-1 size.hard=soft
346limits dn="cn=pykotauser,dc=example,dc=com" size.soft=-1 size.hard=soft
349        Where pykotaadmin and pykotauser are the usernames used to bind to your
350        OpenLDAP server within PyKota, respectively in ReadWrite mode
351        (as set in pykotadmin.conf) and in ReadOnly mode (as set in pykota.conf).
352      </para>
354      <para>
355        Finally, stop the <application>OpenLDAP</application> server, generate
356        the index files, and restart <application>OpenLDAP</application>
357        <screen>   
358$ /etc/init.d/slapd stop
359$ slapindex
360$ /etc/init.d/slapd start
361        </screen>
362      </para>
364      <para>
365        With an <acronym>LDAP</acronym> backend, PyKota will need some branches
366        in your <acronym>LDAP</acronym> directory to put its own datas.
367        You can configure PyKota to either attach its datas to your existing
368        users and groups, or to put them in their own <literal>ou</literal>.
369        But some <literal>ou</literal>s dedicated to PyKota are needed in any case,
370        so the best bet may be to put all PyKota's datas below an <literal>ou=PyKota</literal>
371        branch. While this will separate these datas from your existing users and groups
372        entries, this may ease the maintainance.
373      </para>
375      <para>
376        PyKota needs at least an <literal>ou</literal> for printers, for users quotas, for
377        groups quotas, for print jobs, for billing codes, and for pointers to the last job of each printer.
378        In the future, this last <literal>ou</literal> may disappear as its content
379        will probably be attached to each printer.
380      </para>
382      <para>
383        Actually PyKota doesn't create these <literal>ou</literal>s for you, because it's
384        difficult to guess what is the best configuration for you. So you have to
385        create them by yourself, either directly with a text editor and the
386        <command>ldapadd</command> command, or with some specialized tool
387        like <command>gq</command>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename>
388        file to see which minimal branches are necessary.
389        <note>
390          <title>Note</title>
391          <para>
392            If you use RPM or DEB packages, usually the
393            <filename>pykota-sample.ldif</filename> file is installed into the
394            <filename>/usr/share/pykota/ldap</filename> directory, along
395            with a README file.
396          </para>
397        </note> 
398      </para>
400      <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
403        will have to be done on each one of the print servers which will
404        use this particular Quota Storage Server.
405        <tip>
406          <title>Tip</title>
407          <para>
408            If an error occured, maybe your OpenLDAP version is too old, or
409            an unexpected problem (like a bug) happened. Please contact us via email so that we
410            can try to fix the problem. Thanks in advance.
411          </para>
412        </tip> 
413      </para>
414    </sect2> 
416    <sect2>
417      <title>MySQL</title>
419      <para>
420        <application>MySQL</application> is supported but not documented for now.
421      </para>
422    </sect2> 
424    <sect2>
425      <title>SQLite</title>
427      <para>
428        <application>SQLite</application> is an embeddable Relationnal DataBase
429        distributed under a Free Software
430        license from the
431        <ulink url=""></ulink>
432        web site.
433        If is very easy to configure and use, offers a very small memory footprint,
434        is very fast, but can only be used on the print server because it doesn't include
435        a server daemon : the database is directly embedded in the application.
436      </para>
438      <para>
439        To configure your database, you must have SQLite already working.
440        The complete installation of <application>SQLite</application> is not covered by
441        the present manual, please refer to your system's documentation or to
442        <ulink url=""></ulink> for
443        details.
444      </para>
446      <para>
447        Once <application>SQLite</application> is installed, you have to decide where
448        you'll put your database. A good idea is to store it into the <literal>pykota</literal>
449        user's home directory. Then to create the database, just type :
451# sqlite3 ~pykota/pykota.db &lt;pykota/initscripts/sqlite/pykota.sqlite
452# chown pykota.pykota ~pykota/pykota.db
453# chmod 660 ~pykota/pykota.db
454# chown pykota.pykota ~pykota
456      </para>
457      <para>
458        If user <literal>pykota</literal> doesn't exist yet, then please
459        follow the instructions a bit below which explain how to install PyKota on the print server.
460      </para>
462      <para>
463        Once this is done, you'll want to set in <filename>~pykota/pykota.conf</filename> the
464        following lines in the <literal>[global]</literal> section :
466storagebackend : sqlitestorage
467storagename : /etc/pykota/pykota.db
469      </para>
470      <para>
471        Of course you'll want to replace the path on the <literal>storagename</literal> line
472        with the full path to the newly created <application>SQLite</application> database.
473      </para>
474      <para>
475        That's all ! For more details, please refer to <filename>pykota/initscripts/sqlite/README.sqlite</filename>.
476      </para>
477    </sect2> 
479    <sect2>
480      <title>Berkeley DB</title>
482      <para>
483        A <application>Berkeley DB</application> Storage Backend is planned, but it actually
484        doesn't exist. It seems that remote storage won't be possible with such a backend,
485        so in other terms this means that you will have a different quota database on
486        each print server. This may still prove to be useful for small configurations.
487      </para>
488    </sect2> 
489  </sect1> 
491  <sect1>
492    <title>Print Server Installation</title>
494    <para>
495      For each Print Server on which you plan to implement the print quota
496      mechanism, you have, of course, to have an already working printing environment.
497      Currently <application>PyKota</application> works with
498      <ulink url=""><application>CUPS</application></ulink>
499      but older releases also supported <ulink url=""><application>LPRng</application></ulink>.
500      <application>LPRng</application> support might be re-added in the future.
501    </para>
503    <para>
504      Here's the list of software you have to install on each Print Server, version numbers
505      are given as an indication of which was successfully tested, but older versions may
506      work too.
507      <itemizedlist>
508        <listitem>
509          <para>
510            <application>CUPS</application> version 1.1.14 or above.
511            You can download it from <ulink url=""></ulink>
512          </para>
513        </listitem> 
514        <listitem>
515          <para>
516            <application>Python</application> version 2.2 or above.
517            You can download it from <ulink url=""></ulink>.
518            While <application>PyKota</application> itself will try to preserve compatibility
519            with <application>Python</application> version 2.2 for the near future, some <application>Python</application>
520            modules which are needed by <application>PyKota</application> may require a more recent version
521            of this language.
522          </para>
523        </listitem> 
524        <listitem>
525          <para>
526            Quota Storage client libraries, depending on your Quota Storage Backend :
527            <itemizedlist>
528              <listitem>
529                <para>
530                  PostgreSQL backend :
531                  <itemizedlist>
532                    <listitem>
533                      <para>
534                        <application>PostgreSQL</application> client libraries. They must match the <application>PostgreSQL</application>
535                        version used on your Quota Storage Server.
536                      </para>
537                    </listitem> 
538                    <listitem>
539                      <para>
540                        The <application>PygreSQL</application> python module.
541                        It must have been compiled against the same
542                        <application>PostgreSQL</application> client libraries.
543                        <application>PygreSQL</application> is normally included in
544                        <application>PostgreSQL</application>, but you may want to
545                        download it from <ulink url=""></ulink>
546                      </para>
547                    </listitem> 
548                  </itemizedlist> 
549                </para>
550              </listitem> 
551              <listitem>
552                <para>
553                  OpenLDAP backend :
554                  <itemizedlist>
555                    <listitem>
556                      <para>
557                        <application>OpenLDAP</application> client libraries. They must match
558                        the <application>OpenLDAP</application> version used on your Quota Storage Server.
559                      </para>
560                    </listitem> 
561                    <listitem>
562                      <para>
563                        The <application>Python-LDAP</application> python module.
564                        It must have been compiled against the same
565                        <application>OpenLDAP</application> client libraries.
566                        You may download this module from <ulink url=""></ulink>
567                      </para>
568                    </listitem> 
569                  </itemizedlist>
570                </para>
571              </listitem>
572              <listitem>
573                <para>
574                  MySQL backend : Supported but not documented yet.
575                </para>
576              </listitem>
577              <listitem>
578                <para>
579                  SQLite backend : SQLite is not a database server, but an embeddable database, so
580                  if you want to use it you MUST install SQLite on your print server. With
581                  <application>PostgreSQL</application>, <application>MySQL</application> or
582                  <application>OpenLDAP</application> you can store your datas on a different
583                  machine than the print server, but this is not possible with <application>SQLite</application>.
584                  <itemizedlist>
585                    <listitem>
586                      <para>
587                        <application>SQLite</application> version 3.2.1 or higher and its library.
588                        You can download it from
589                        <ulink url=""></ulink>
590                      </para>
591                    </listitem> 
592                    <listitem>
593                      <para>
594                        The <application>Python-SQLite</application> python module version 2.0.5 or higher.
595                        You can download it from
596                        <ulink url=""></ulink>
597                      </para>
598                    </listitem> 
599                  </itemizedlist>
600                </para>
601              </listitem>
602              <listitem>
603                <para>
604                  Berkeley DB backend : Not supported yet.
605                </para>
606              </listitem>
607            </itemizedlist> 
608          </para>
609        </listitem> 
610        <listitem>
611          <para>
612            <application>ucd-snmp</application> or <application>net-snmp</application> tools, version 4.2.5 or above. You only need
613            the <command>snmpget</command> command.
614            You can download this software from <ulink url=""></ulink>.
615            You only need this if you plan to query your printers for their internal page counter via SNMP.
616          </para>
617        </listitem> 
618        <listitem>
619          <para>
620            <application>netatalk</application> version 1.6.1 or above. You only need
621            the <command>pap</command> command.
622            You can download this software from <ulink url=""></ulink>.
623            You only need this if you plan to query your printers for their internal page counter via AppleTalk.
624          </para>
625        </listitem> 
626        <listitem>
627          <para>
628            eGenix' mxDateTime Python module version 2.0.3 or above. It must match your default Python version.
629            You can download it from <ulink url=""></ulink>.
630          </para>
631        </listitem> 
632        <listitem>
633          <para>
634            The Python acccelerator <application>Psyco</application>. It must match your default Python version.
635            You can download it from <ulink url=""></ulink>.
636            You only need this if you run on the <literal>x86</literal> architecture because
637            <application>Psyco</application> doesn't yet exist on other architectures.
638          </para>
639        </listitem> 
640        <listitem>
641          <para>
642            The <application>pysnmp</application> Python module version 3.4.2, 3.4.3 or 3.4.4 exclusively.
643            You can download it from <ulink url=""></ulink>.
644          </para>
645        </listitem> 
646        <listitem>
647          <para>
648            The <application>JAXML</application> Python module.
649            You can download it from <ulink url=""></ulink>.
650          </para>
651        </listitem> 
652        <listitem>
653          <para>
654            The <application>ReportLab</application> Toolkit Python module.
655            You can download it from <ulink url=""></ulink>.
656          </para>
657        </listitem> 
658        <listitem>
659          <para>
660            The <application>Python Imaging Library - PIL</application> module.
661            You can download it from <ulink url=""></ulink>.
662          </para>
663        </listitem> 
664        <listitem>
665          <para>
666            The <application>PyOSD</application> Python module.
667            You can download it from <ulink url=""></ulink>.
668          </para>
669        </listitem> 
670        <listitem>
671          <para>
672            The <application>pkpgcounter</application> Generic Page Description Language parser.
673            You can download it from <ulink url=""></ulink>.
674          </para>
675        </listitem> 
676        <listitem>
677          <para>
678            The <application>PyPAM</application> Python interface to <acronym>PAM</acronym>.
679            You'll need this if you plan to ask users to authenticate when printing through <command>pknotify</command>
680            and <command>pykoticon</command>. You don't need this module otherwise.
681            If needed, you can download it from <ulink url=""></ulink>.
682          </para>
683        </listitem> 
684      </itemizedlist> 
685    </para>
687    <para>
688      Instead of downloading all these programs' sources and compiling them, which really
689      is a boring task considering that many software are needed, you may prefer to look
690      into the packages included with your GNU/Linux distribution of choice (if you use
691      this operating system of course). Most, if not all, GNU/Linux distributions include
692      all the software mentionned above, in the form of packages which are easier to
693      install than sources tarballs. This is probably the same for the many *BSD
694      distributions.
695    </para>
697    <para>
698       You can check that all needed software is installed by launching the <command></command>
699       command :
700      <screen>     
701$ python     
702      </screen>
703    </para>
705    <para>
706      Once all these software are installed, installing PyKota itself is a breeze.
707      PyKota being written entirely in the Python language, which is interpreted,
708      there's no need to compile anything. You just have to execute the installation
709      script :
710      <screen>     
711$ python install     
712      </screen>
713    </para>
715    <para>
716      The setup script will automatically create the
717      <filename>/usr/share/pykota/conf</filename> directory and put the sample
718      configuration files <filename>conf/pykota.conf.sample</filename> and
719      <filename>conf/pykotadmin.conf.sample</filename> there, along with
720      a <filename>README</filename> file explaining their purpose.
721    </para>
723    <para>
724      Now you have to create a <literal>pykota</literal> system user and group. The <application>PyKota</application>
725      software will automatically search its configuration files in user <literal>pykota</literal>'s
726      home directory. For example we could create the user and group, and set <filename>/etc/pykota</filename>
727      as the home directory, but any other home directory will do :
729    adduser --system --group --home /etc/pykota --gecos PyKota pykota
731    </para>
733    <para>
734      You now have to copy the sample configuration files into the <filename>~pykota</filename>
735      directory, under the respective names <filename>pykota.conf</filename> and
736      <filename>pykotadmin.conf</filename>. Once copied there, you just
737      have to modify these files to adapt them to your own setup.
738      These files are heavily commented, so you should have no problem.
739      Also their format is quite common, because it's the one used by
740      <application>Samba</application> for example, or by <literal>.ini</literal>
741      files under <application>MS-Windows</application>, so you may already
742      be familiar with this syntax.
743      In a future release, this documentation will include the complete
744      reference for all configuration fields available. Keep in mind that
745      <application>PyKota</application> can be really heavily customized, and can delegate some work
746      to any external command of your choice.
747    </para>
749    <para>
750      Please create a backup copy of the <filename>~pykota</filename>
751      directory before modifying a working installation.
752    </para>
754    <para>
755      PyKota features some interesting possibilities which allow you to
756      define options either globally so that they apply to all printers,
757      or on a per printer basis. Please see the sample configuration files
758      to see what I mean. In the simplest form, only a <literal>[global]</literal> section is
759      needed. In more complex configurations, you will have to create
760      one section per printer. Each section in the configuration files
761      begins with a name between square brackets <literal>[]</literal>.
762      The name to use to define a particular printer section is the name
763      of the print queue you want to manage with PyKota.
764    </para>
766    <para>
767      After you have modified <application>PyKota</application>'s configuration files, you have to
768      double check their permissions, otherwise your installation may be
769      insecure or may not work at all.
770      The main configuration file <filename>~pykota/pykota.conf</filename>
771      doesn't contain much sensitive information, so it can be made
772      readable by anyone. If normal users read this file, at best they
773      will learn the username and optional password of the read-only
774      database user. This means that beside being allowed to read all the contents of
775      the quota database, they won't be allowed to modify or delete it.
776      On the other hand, the <filename>~pykota/pykotadmin.conf</filename>
777      file contains the read-write user's identity and password. You must then
778      ensure that no normal user can read this file. It should only be readable
779      by the <literal>root</literal> user, which is always the case, and by
780      <application>PyKota</application> administrators. In addition,
781      users for which <application>CUPS</application> doesn't run as user <literal>root</literal> will
782      have to ensure that the user their printing system is run as
783      can read both of these files. An easy way to do so is to put the <literal>lp</literal> user
784      (for example) into the <literal>pykota</literal> system group, then
785      to give the correct permissions to <application>PyKota</application>'s configuration files :
786      <screen>
787$ chown pykota.pykota ~pykota/pykota.conf     
788$ chmod 644 ~pykota/pykota.conf     
789$ chown pykota.pykota ~pykota/pykotadmin.conf     
790$ chmod 640 ~pykota/pykotadmin.conf     
791      </screen>
793      <warning>
794        <title>Warning</title>
795        <para>
796          All the users allowed to read the <filename>~pykota/pykotadmin.conf</filename>
797          are considered to be <application>PyKota</application> administrators. So be
798          careful with these files permissions.
799        </para>
800      </warning>
801    </para>
803    <para>
804      On some systems, you may be able to strenghten permissions like this :
805      <screen>
806$ chown pykota.pykota ~pykota/pykota.conf     
807$ chmod 640 ~pykota/pykota.conf     
808$ chown pykota.pykota ~pykota/pykotadmin.conf     
809$ chmod 600 ~pykota/pykotadmin.conf     
810      </screen>
811    </para>
813    <para>
814      And on other ones, you may need to relax them, and change the files' owner :
815      <screen>
816$ chown lp.pykota ~pykota/pykota.conf     
817$ chmod 640 ~pykota/pykota.conf     
818$ chown lp.pykota ~pykota/pykotadmin.conf     
819$ chmod 640 ~pykota/pykotadmin.conf     
820      </screen>
821    </para>
823    <para>
824      This all depends on the printing system you are using, and the user the
825      printing system is usually running as. You need to remember three things :
827      <itemizedlist>
828        <listitem>
829          <para>
830            The user your printing system runs as MUST be allowed to read
831            both <application>PyKota</application>'s configuration files.
832          </para> 
833        </listitem> 
834        <listitem>       
835          <para>
836            Any user who can read <filename>pykotadmin.conf</filename>
837            is a <application>PyKota</application> administrator, and
838            can do whatever he wants to the print quota database.
839          </para>
840        </listitem>
841        <listitem>       
842          <para>
843            If <filename>cupsd.conf</filename> contains <literal>RunAsUser</literal>, then
844            you won't be able to authenticate users with <command>pknotify</command> and <command>pykoticon</command>.
845            Also in this case you may have to make <application>PyKota</application>'s configuration files
846            owned by the user <application>CUPS</application> runs as.
847          </para>
848        </listitem>
849      </itemizedlist> 
850    </para>
852    <para>
853      Don't forget to restart your print server sofware if you changed group membership for the user it runs
854      as, otherwise your change wouldn't be taken into account.
855    </para>
857    <para>
858      Now depending on your printing system, the configuration to do is particular.
859      We will now see how to plug PyKota into <application>CUPS</application> since <application>LPRng</application>
860      is not supported anymore.
861    </para>
863    <sect2>
864      <title>With CUPS</title>
866      <para>
867        From version 1.16alpha7 on, configuring <application>PyKota</application> to integrate
868        within <application>CUPS</application> is more than easy.
869      </para>
871      <para>
872        You just have to create a symbolic link to the <command>cupspykota</command>
873        command in <application>CUPS</application>' backend directory :
874        <screen>       
875$ cd /usr/lib/cups/backend       
876$ ln -s /usr/share/pykota/cupspykota cupspykota
877        </screen>
878      </para>
880      <para>
881        You have to restart <application>CUPS</application> for this modification to
882        take effect :
883        <screen>
884$ /etc/init.d/cupsys restart       
885        </screen>
886      </para>
888      <para>
889        Now point your web browser to CUPS configuration page, usually at
890        <ulink url="http://localhost:631">http://localhost:631</ulink> on
891        your print server.
892      </para>
894      <para>
895        Then when creating new printers or reconfiguring existing ones, just
896        choose devices which are <literal>PyKota managed</literal>
897        <footnote>
898          <para>
899            Debian 3.0 Woody is known to have problems : CUPS 1.1.14 doesn't automatically
900            detect <literal>PyKota managed</literal> devices. So you have to manually
901            modify CUPS' <filename>printers.conf</filename> file as explained in
902            PyKota's toplevel <filename>README</filename> file.
903          </para>
904        </footnote>
905        instead of
906        normal devices. You've got one <literal>PyKota managed</literal> device
907        for each regular device available from CUPS, so just choose the appropriate
908        one.
909      </para>
911      <para>
912        Repeat the above procedure for each print queue on which you want to use
913        PyKota. That's all !
914      </para>
916      <sect3>
917        <title>Troubleshooting</title>
918        <para>
919          In case of problem, the simplest way to solve it is currently
920          to ask on PyKota's mailing list, describing the symptoms, as
921          well as the hardware and software you use.
922        </para>
924        <para>
925          A searchable FAQ is now available at
926          <ulink url=""></ulink>.
927          A FAQ entry explaining in great details how to diagnose a problem correctly is
928          available at
929          <ulink url=""></ulink>.
930        </para>
932        <para>
933          You can also ask questions on IRC :
934          <screen>
936/join #pykota
937          </screen>
938        </para> 
939      </sect3> 
941    </sect2>
943  </sect1> 
Note: See TracBrowser for help on using the browser.