[695] | 1 | # PyKota sample configuration file |
---|
| 2 | # |
---|
| 3 | # Copy this file in cups' configuration directory |
---|
| 4 | # usually /etc/cups under the name pykota.conf |
---|
| 5 | # |
---|
[952] | 6 | # PyKota - Print Quotas for CUPS and LPRng |
---|
[695] | 7 | # |
---|
| 8 | # (c) 2003 Jerome Alet <alet@librelogiciel.com> |
---|
[873] | 9 | # This program is free software; you can redistribute it and/or modify |
---|
| 10 | # it under the terms of the GNU General Public License as published by |
---|
| 11 | # the Free Software Foundation; either version 2 of the License, or |
---|
| 12 | # (at your option) any later version. |
---|
[695] | 13 | # |
---|
[873] | 14 | # This program is distributed in the hope that it will be useful, |
---|
| 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 17 | # GNU General Public License for more details. |
---|
| 18 | # |
---|
| 19 | # You should have received a copy of the GNU General Public License |
---|
| 20 | # along with this program; if not, write to the Free Software |
---|
| 21 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. |
---|
[695] | 22 | # |
---|
| 23 | # $Id$ |
---|
| 24 | # |
---|
| 25 | |
---|
| 26 | [global] |
---|
| 27 | # Storage backend for quotas |
---|
| 28 | # only PostgreSQL is supported |
---|
| 29 | # Ldap, MySQL, Berkeley are planned |
---|
| 30 | storagebackend: postgresql |
---|
[859] | 31 | |
---|
[952] | 32 | # Quota Storage Server hostname (and optional port) |
---|
[859] | 33 | # e.g. db.mydomain.com:5432 |
---|
[695] | 34 | storageserver: localhost |
---|
[859] | 35 | |
---|
| 36 | # |
---|
| 37 | # name of the Quota Storage Database |
---|
[695] | 38 | storagename: pykota |
---|
[859] | 39 | |
---|
| 40 | # Quota Storage administrator's and normal user's names and passwords |
---|
[695] | 41 | storageadmin: pykotaadmin |
---|
| 42 | storageuser: pykotauser |
---|
[806] | 43 | # storageadminpw: Comment out if unused, or set to Quota Storage admin password |
---|
| 44 | # storageuserpw: Comment out if unused, or set to Quota Storage user password |
---|
[695] | 45 | |
---|
| 46 | # Where to log ? |
---|
[707] | 47 | # supported values : stderr, system (system means syslog, but don't use 'syslog' here) |
---|
[853] | 48 | # if the value is not set then the default SYSTEM applies. |
---|
[782] | 49 | logger: system |
---|
[695] | 50 | |
---|
| 51 | # Mail server to use to warn users |
---|
[853] | 52 | # If the value is not set then localhost is used. |
---|
[695] | 53 | smtpserver: localhost |
---|
[806] | 54 | |
---|
[974] | 55 | # What is the accounting backend to use |
---|
| 56 | # |
---|
| 57 | # supported values : |
---|
| 58 | # |
---|
| 59 | # - querying : asks the printer for its lifetime page counter |
---|
[976] | 60 | # via either SNMP, AppleTalk, or any external |
---|
| 61 | # command. This method is the method used by |
---|
| 62 | # default in PyKota since its beginning. |
---|
| 63 | # |
---|
[980] | 64 | # - external : delegates the job's size computation to any |
---|
| 65 | # external command of your choice. A stupid and |
---|
| 66 | # completely unreliable example, but which |
---|
| 67 | # shows what this command may be is : |
---|
| 68 | # |
---|
| 69 | # accounter: external(/bin/grep -c showpage) |
---|
| 70 | # |
---|
[976] | 71 | # - stupid : counts the occurences of the 'showpage' postscript |
---|
| 72 | # statement in the document to be printed, only at |
---|
| 73 | # the beginning of each line which makes the postscript |
---|
| 74 | # file. THIS IS NOT RELIABLE. This is just to serve as |
---|
| 75 | # an example on how to implement your own accounting |
---|
| 76 | # method. |
---|
| 77 | # |
---|
[974] | 78 | # This value can be set either globally or on a per printer basis |
---|
[976] | 79 | # If both are defined, the printer option has priority. |
---|
| 80 | # if not set it defaults to 'querying'. |
---|
[994] | 81 | # |
---|
| 82 | # A script which seems to be accurate, copy it from the |
---|
| 83 | # untested/postscript directory to another place. |
---|
| 84 | # accounter: external(/usr/local/bin/pagecount.sh) |
---|
[998] | 85 | # WARNING : it may produce broken pipes, I don't know why yet. YMMV. |
---|
[994] | 86 | # |
---|
| 87 | # default value |
---|
[974] | 88 | accounter: querying |
---|
[806] | 89 | |
---|
| 90 | # Print Quota administrator |
---|
| 91 | # These values can be set either globally or per printer or both. |
---|
| 92 | # If both are defined, the printer option has priority. |
---|
[853] | 93 | # If these values are not set, the default admin root |
---|
| 94 | # and the default adminmail root@localhost are used. |
---|
[806] | 95 | admin: Jerome Alet |
---|
| 96 | adminmail: alet@librelogiciel.com |
---|
| 97 | |
---|
[695] | 98 | # |
---|
[852] | 99 | # Who should we send an email to in case a quota is reached ? |
---|
| 100 | # possible values are : DevNull, User, Admin, Both |
---|
| 101 | # The Both value means that the User and the Admin will receive |
---|
| 102 | # an email message. |
---|
| 103 | # The DevNull value means no email message will be sent. |
---|
| 104 | # This value can be set either globally or per printer or both. |
---|
| 105 | # If both are defined, the printer option has priority. |
---|
[853] | 106 | # If the value is not set, then the default BOTH applies. |
---|
[852] | 107 | mailto: both |
---|
| 108 | |
---|
| 109 | # |
---|
[695] | 110 | # Grace delay in days |
---|
[806] | 111 | # This value can be set either globally or per printer or both. |
---|
| 112 | # If both are defined, the printer option has priority. |
---|
[853] | 113 | # If the value is not set then the default seven (7) days applies. |
---|
[695] | 114 | gracedelay: 7 |
---|
| 115 | |
---|
[853] | 116 | # one section per printer, or no other section at all if all options |
---|
| 117 | # are defined globally |
---|
[695] | 118 | [lp] |
---|
[806] | 119 | |
---|
[980] | 120 | # How to query the lp printer for its page counter. |
---|
| 121 | # THIS IS ONLY USED IF YOU HAVE SET 'accounter' TO 'querying' |
---|
| 122 | # JUST COMMENT IT OUT IF YOU USE ANY OTHER ACCOUNTING METHOD. |
---|
[780] | 123 | # Only snmp(community, oid) and external(command) are supported |
---|
[903] | 124 | # |
---|
| 125 | # Example : |
---|
[999] | 126 | # requester: external(snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
[780] | 127 | # and : |
---|
[998] | 128 | # requester: snmp(public, mib-2.43.10.2.1.4.1.1) |
---|
[794] | 129 | # are equivalent |
---|
[903] | 130 | # |
---|
| 131 | # Another untested example, using npadmin : |
---|
| 132 | # requester: external(npadmin --pagecount %(printer)s) |
---|
| 133 | # |
---|
[919] | 134 | # Another example, for AppleTalk printers which works fine : |
---|
[952] | 135 | # (You may need the pap CUPS backend installed, and copy the |
---|
| 136 | # pagecount.ps file from untested/netatalk into /etc or any |
---|
| 137 | # appropriate location) |
---|
[964] | 138 | # requester: external(/usr/bin/pap -p "%(printer)s:LaserWriter" /etc/pagecount.ps 2>/dev/null | grep -v status | grep -v Connect | tail -1) |
---|
[919] | 139 | # |
---|
[806] | 140 | # This value can be set either globally or per printer or both. |
---|
| 141 | # If both are defined, the printer option has priority. |
---|
[830] | 142 | # |
---|
[998] | 143 | # NB : The SNMP oid mib-2.43.10.2.1.4.1.1 works on HP Laserjet Printers, but it may |
---|
[830] | 144 | # be different with other brands, refer to your printer's documentation |
---|
[999] | 145 | # for details. Also you may have to specify -v2c or -v3 depending on your |
---|
| 146 | # printer's support for different versions of the SNMP specification. |
---|
| 147 | requester: external(snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
[806] | 148 | |
---|
[695] | 149 | # Default policy for inexistant users (e.g. root) |
---|
[713] | 150 | # either allow or deny |
---|
[806] | 151 | # This value can be set either globally or per printer or both. |
---|
| 152 | # If both are defined, the printer option has priority. |
---|
[956] | 153 | # If the value is not set then the default policy DENY applies. |
---|
| 154 | # ATTENTION : |
---|
[960] | 155 | # Before 1.04 the default value was ALLOW, but unknown users |
---|
[956] | 156 | # allowed to print causes accuracy problems : their jobs are |
---|
| 157 | # charged to the next person who prints on the same printer. |
---|
| 158 | policy: deny |
---|