| 1 | # $Id$ |
|---|
| 2 | |
|---|
| 3 | PyKota - Print Quota for CUPS |
|---|
| 4 | |
|---|
| 5 | (c) 2003 Jerome Alet <alet@librelogiciel.com> |
|---|
| 6 | You're welcome to redistribute this software under the |
|---|
| 7 | terms of the GNU General Public Licence version 2.0 |
|---|
| 8 | or, at your option, any higher version. |
|---|
| 9 | |
|---|
| 10 | You can read the complete GNU GPL in the file COPYING |
|---|
| 11 | which should come along with this software, or visit |
|---|
| 12 | the Free Software Foundation's WEB site http://www.fsf.org |
|---|
| 13 | |
|---|
| 14 | ============================================================ |
|---|
| 15 | |
|---|
| 16 | PyKota is a complete Print Quota system for the Common Unix Printing |
|---|
| 17 | System (aka CUPS), which works by directly querying the printers |
|---|
| 18 | for the number of pages they have printed. |
|---|
| 19 | |
|---|
| 20 | Current or planned features are : |
|---|
| 21 | |
|---|
| 22 | - Easy installation. |
|---|
| 23 | |
|---|
| 24 | - Per printer User and Group quotas. Currently Group |
|---|
| 25 | quotas are only at skeleton stage. |
|---|
| 26 | |
|---|
| 27 | - Centralized configurable storage : currently |
|---|
| 28 | only a PostgreSQL database backend is supported, |
|---|
| 29 | but at least LDAP and MySQL are planned. |
|---|
| 30 | |
|---|
| 31 | - Automated mailing of warning or error messages to |
|---|
| 32 | users and print administrator when print quota is |
|---|
| 33 | exceeded. |
|---|
| 34 | |
|---|
| 35 | - Configurable printer querying methods. Currently |
|---|
| 36 | only SNMP method is supported. |
|---|
| 37 | |
|---|
| 38 | Look at the documentation in the docs subdirectory to learn |
|---|
| 39 | more. |
|---|
| 40 | |
|---|
| 41 | ============================================================ |
|---|
| 42 | |
|---|
| 43 | INSTALLATION: |
|---|
| 44 | ============= |
|---|
| 45 | |
|---|
| 46 | Download the latest PyKota version from : |
|---|
| 47 | |
|---|
| 48 | http://www.librelogiciel.com/software/ |
|---|
| 49 | |
|---|
| 50 | Extract it: |
|---|
| 51 | |
|---|
| 52 | gzip -d pykota-x.xx.tar.gz | tar -xf - |
|---|
| 53 | |
|---|
| 54 | where x.xx is PyKota's latest version number. |
|---|
| 55 | |
|---|
| 56 | Go to PyKota's directory: |
|---|
| 57 | |
|---|
| 58 | cd pykota-x.xx |
|---|
| 59 | |
|---|
| 60 | Just type: |
|---|
| 61 | |
|---|
| 62 | python setup.py install |
|---|
| 63 | |
|---|
| 64 | You may need to be logged in with sufficient privileges (e.g. root) |
|---|
| 65 | |
|---|
| 66 | Go to the initscripts subdirectory of PyKota's sources, and choose |
|---|
| 67 | the appropriate storage backend for your configuration. Read |
|---|
| 68 | the associated README file and execute the initialization script |
|---|
| 69 | to create an empty PyKota Storage. |
|---|
| 70 | |
|---|
| 71 | Copy the conf/pykota.conf.sample sample configuration file to |
|---|
| 72 | CUPS' configuration directory, usually /etc/cups, under the |
|---|
| 73 | name pykota.conf. |
|---|
| 74 | |
|---|
| 75 | Adapt this file to your own needs and configuration. |
|---|
| 76 | |
|---|
| 77 | Modify the PPD files for each printer on which you want to manage |
|---|
| 78 | print quotas, for example /etc/cups/ppd/lp.ppd : |
|---|
| 79 | |
|---|
| 80 | --- Add the line below exactly as-is somewhere near the top --- |
|---|
| 81 | *cupsFilter: "application/vnd.cups-postscript 0 /usr/bin/pykota" |
|---|
| 82 | --- Add the line above exactly as-is somewhere near the top --- |
|---|
| 83 | |
|---|
| 84 | Modify the path to pykota if needed, unfortunately you have to |
|---|
| 85 | supply the correct absolute path here due to CUPS internals. |
|---|
| 86 | |
|---|
| 87 | Do this in each ppd file present in this directory if you want |
|---|
| 88 | to enable quota on every printer. |
|---|
| 89 | |
|---|
| 90 | Add users to the quota system and set their quota values : |
|---|
| 91 | |
|---|
| 92 | $ edpykota username printer softlimit hardlimit |
|---|
| 93 | |
|---|
| 94 | Restart CUPS, for example under Debian GNU/Linux systems : |
|---|
| 95 | |
|---|
| 96 | $ /etc/init.d/cupsys restart |
|---|
| 97 | |
|---|
| 98 | Your users now should be able to print but not exceed their |
|---|
| 99 | printing quota. |
|---|
| 100 | |
|---|
| 101 | ============================================================ |
|---|
| 102 | |
|---|
| 103 | Please e-mail bugs to: alet@librelogiciel.com (Jerome Alet) |
|---|
