[695] | 1 | # PyKota sample configuration file |
---|
| 2 | # |
---|
[1087] | 3 | # Copy this file into the /etc/pykota/ directory |
---|
| 4 | # under the name /etc/pykota/pykota.conf |
---|
[695] | 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 |
---|
[1047] | 28 | # only PGStorage (PostgreSQL) and LDAPStorage (OpenLDAP) are supported. |
---|
| 29 | # MySQL and BerkeleyDB are planned. |
---|
[859] | 30 | |
---|
[1021] | 31 | # the 'postgresql' value is deprecated, use 'pgstorage' instead. |
---|
| 32 | storagebackend: pgstorage |
---|
| 33 | |
---|
[952] | 34 | # Quota Storage Server hostname (and optional port) |
---|
[859] | 35 | # e.g. db.mydomain.com:5432 |
---|
[695] | 36 | storageserver: localhost |
---|
[859] | 37 | |
---|
| 38 | # |
---|
| 39 | # name of the Quota Storage Database |
---|
[695] | 40 | storagename: pykota |
---|
[859] | 41 | |
---|
[1087] | 42 | # |
---|
| 43 | # Quota Storage normal user's name and password |
---|
| 44 | # These two fields contain a username and optional password |
---|
| 45 | # which may give readonly access to your print quota database. |
---|
| 46 | # |
---|
| 47 | # PLEASE ENSURE THAT THIS USER CAN'T WRITE TO YOUR PRINT QUOTA |
---|
| 48 | # DATABASE, OTHERWISE ANY USER WHO COULD READ THIS CONFIGURATION |
---|
| 49 | # FILE COULD CHANGE HIS PRINT QUOTA. |
---|
| 50 | # |
---|
| 51 | storageuser: pykotauser |
---|
| 52 | # storageuserpw: Comment out if unused, or set to Quota Storage user password |
---|
[695] | 53 | |
---|
[1038] | 54 | # LDAP example, uncomment and adapt it to your own configuration : |
---|
[1016] | 55 | #storagebackend: ldapstorage |
---|
| 56 | #storageserver: ldap://ldap.librelogiciel.com:389 |
---|
| 57 | #storagename: dc=librelogiciel,dc=com |
---|
[1087] | 58 | #storageuser: cn=notadmin,dc=librelogiciel,dc=com |
---|
| 59 | #storageuserpw: abc.123 |
---|
[1025] | 60 | # |
---|
| 61 | # Here we define some helpers to know where |
---|
| 62 | # to plug into an existing LDAP directory |
---|
[1029] | 63 | #userbase: ou=People,dc=librelogiciel,dc=com |
---|
[1025] | 64 | #userrdn: uid |
---|
[1038] | 65 | #balancebase: ou=People,dc=librelogiciel,dc=com |
---|
| 66 | #balancerdn: uid |
---|
[1029] | 67 | #groupbase: ou=Groups,dc=librelogiciel,dc=com |
---|
[1025] | 68 | #grouprdn: cn |
---|
[1029] | 69 | #printerbase: ou=Printers,ou=PyKota,dc=librelogiciel,dc=com |
---|
[1025] | 70 | #printerrdn: cn |
---|
[1029] | 71 | #jobbase: ou=Jobs,ou=PyKota,dc=librelogiciel,dc=com |
---|
| 72 | #userquotabase: ou=UQuotas,ou=PyKota,dc=librelogiciel,dc=com |
---|
| 73 | #groupquotabase: ou=GQuotas,ou=PyKota,dc=librelogiciel,dc=com |
---|
| 74 | #lastjobbase: ou=LastJobs,ou=PyKota,dc=librelogiciel,dc=com |
---|
| 75 | # |
---|
| 76 | # Choose what attribute contains the list of group members |
---|
| 77 | # common values are : memberUid, uniqueMember, member |
---|
| 78 | #groupmembers: memberUid |
---|
[1016] | 79 | |
---|
[695] | 80 | # Where to log ? |
---|
[707] | 81 | # supported values : stderr, system (system means syslog, but don't use 'syslog' here) |
---|
[853] | 82 | # if the value is not set then the default SYSTEM applies. |
---|
[782] | 83 | logger: system |
---|
[695] | 84 | |
---|
[1047] | 85 | # Enable debugging ? Put YES instead here, |
---|
| 86 | # but only if something went wrong and you want |
---|
| 87 | # to learn from where the problem comes from. |
---|
| 88 | # Actually only database queries are logged. |
---|
[1021] | 89 | debug : No |
---|
| 90 | |
---|
[695] | 91 | # Mail server to use to warn users |
---|
[853] | 92 | # If the value is not set then localhost is used. |
---|
[695] | 93 | smtpserver: localhost |
---|
[806] | 94 | |
---|
[974] | 95 | # What is the accounting backend to use |
---|
| 96 | # |
---|
| 97 | # supported values : |
---|
| 98 | # |
---|
| 99 | # - querying : asks the printer for its lifetime page counter |
---|
[976] | 100 | # via either SNMP, AppleTalk, or any external |
---|
| 101 | # command. This method is the method used by |
---|
| 102 | # default in PyKota since its beginning. |
---|
| 103 | # |
---|
[980] | 104 | # - external : delegates the job's size computation to any |
---|
| 105 | # external command of your choice. A stupid and |
---|
| 106 | # completely unreliable example, but which |
---|
| 107 | # shows what this command may be is : |
---|
| 108 | # |
---|
| 109 | # accounter: external(/bin/grep -c showpage) |
---|
[1000] | 110 | # |
---|
| 111 | # Another one, which should work with all DSC |
---|
| 112 | # compliant Postscript files : |
---|
| 113 | # |
---|
| 114 | # accounter: external(/bin/grep -c "%%Page:") |
---|
[980] | 115 | # |
---|
[976] | 116 | # - stupid : counts the occurences of the 'showpage' postscript |
---|
[1001] | 117 | # statement in the document to be printed. |
---|
| 118 | # THIS IS NOT RELIABLE. This is just to serve as |
---|
[976] | 119 | # an example on how to implement your own accounting |
---|
| 120 | # method. |
---|
| 121 | # |
---|
[974] | 122 | # This value can be set either globally or on a per printer basis |
---|
[976] | 123 | # If both are defined, the printer option has priority. |
---|
| 124 | # if not set it defaults to 'querying'. |
---|
[994] | 125 | # |
---|
| 126 | # A script which seems to be accurate, copy it from the |
---|
| 127 | # untested/postscript directory to another place. |
---|
| 128 | # accounter: external(/usr/local/bin/pagecount.sh) |
---|
[1000] | 129 | # WARNING : it may not work when multiple copies are asked. |
---|
| 130 | # this breaks ghostscript, I don't know why yet. |
---|
[994] | 131 | # |
---|
| 132 | # default value |
---|
[974] | 133 | accounter: querying |
---|
[806] | 134 | |
---|
| 135 | # Print Quota administrator |
---|
| 136 | # These values can be set either globally or per printer or both. |
---|
| 137 | # If both are defined, the printer option has priority. |
---|
[853] | 138 | # If these values are not set, the default admin root |
---|
| 139 | # and the default adminmail root@localhost are used. |
---|
[806] | 140 | admin: Jerome Alet |
---|
| 141 | adminmail: alet@librelogiciel.com |
---|
| 142 | |
---|
[695] | 143 | # |
---|
[852] | 144 | # Who should we send an email to in case a quota is reached ? |
---|
| 145 | # possible values are : DevNull, User, Admin, Both |
---|
| 146 | # The Both value means that the User and the Admin will receive |
---|
| 147 | # an email message. |
---|
| 148 | # The DevNull value means no email message will be sent. |
---|
| 149 | # This value can be set either globally or per printer or both. |
---|
| 150 | # If both are defined, the printer option has priority. |
---|
[853] | 151 | # If the value is not set, then the default BOTH applies. |
---|
[852] | 152 | mailto: both |
---|
| 153 | |
---|
| 154 | # |
---|
[695] | 155 | # Grace delay in days |
---|
[806] | 156 | # This value can be set either globally or per printer or both. |
---|
| 157 | # If both are defined, the printer option has priority. |
---|
[853] | 158 | # If the value is not set then the default seven (7) days applies. |
---|
[695] | 159 | gracedelay: 7 |
---|
| 160 | |
---|
[1077] | 161 | # |
---|
| 162 | # Poor man's threshold |
---|
| 163 | # If account balance reaches below this amount, |
---|
| 164 | # a warning message is sent by email |
---|
| 165 | # |
---|
| 166 | # If unset, default poor man's threshold is 1.0. |
---|
| 167 | # This option can only appear in the global section |
---|
| 168 | poorman: 2.0 |
---|
| 169 | |
---|
| 170 | # Poor man's warning message |
---|
| 171 | # The warning message that is sent if the "poorman" value is reached |
---|
| 172 | # Again this must appear in the global section |
---|
| 173 | poorwarn: Your Print Quota account balance is low. |
---|
| 174 | Soon you'll not be allowed to print anymore. |
---|
| 175 | |
---|
| 176 | # Soft limit reached warning message |
---|
| 177 | # The warning message that is sent if the soft quota limit is reached |
---|
| 178 | # May appear either globally or on a per-printer basis |
---|
| 179 | softwarn: Your Print Quota Soft Limit is reached. |
---|
| 180 | This means that you may still be allowed to print for some |
---|
| 181 | time, but you must contact your administrator to purchase |
---|
| 182 | more print quota. |
---|
| 183 | |
---|
| 184 | # Hard limit reached error message |
---|
| 185 | # The error message that is sent if the hard quota limit is reached |
---|
| 186 | # May appear either globally or on a per-printer basis |
---|
| 187 | hardwarn: Your Print Quota Hard Limit is reached. |
---|
| 188 | This means that you are not allowed to print anymore. |
---|
| 189 | Please contact your administrator at root@localhost |
---|
| 190 | as soon as possible to solve the problem. |
---|
| 191 | |
---|
[853] | 192 | # one section per printer, or no other section at all if all options |
---|
[1025] | 193 | # are defined globally. |
---|
[1047] | 194 | # Each section's name must be the same as the printer's queue name as defined |
---|
[1025] | 195 | # in your printing system, be it CUPS or LPRng. |
---|
[1027] | 196 | # If you don't want any special printer section, just comment out |
---|
| 197 | # the line below so that following options are global. |
---|
[1025] | 198 | [hpmarketing] |
---|
[806] | 199 | |
---|
[1047] | 200 | # How to query the hpmarketing printer for its page counter. |
---|
[980] | 201 | # THIS IS ONLY USED IF YOU HAVE SET 'accounter' TO 'querying' |
---|
| 202 | # JUST COMMENT IT OUT IF YOU USE ANY OTHER ACCOUNTING METHOD. |
---|
[1002] | 203 | # (it would be ignored anyway) |
---|
| 204 | # |
---|
[1047] | 205 | # In the lines below "%(printer)s" is automatically replaced |
---|
| 206 | # at run time with your printer's Fully Qualified Domain Name |
---|
| 207 | # e.g. myprinter.domain.com |
---|
| 208 | # |
---|
[780] | 209 | # Only snmp(community, oid) and external(command) are supported |
---|
[903] | 210 | # |
---|
| 211 | # Example : |
---|
[1025] | 212 | # requester: external(/usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
[780] | 213 | # and : |
---|
[998] | 214 | # requester: snmp(public, mib-2.43.10.2.1.4.1.1) |
---|
[794] | 215 | # are equivalent |
---|
[903] | 216 | # |
---|
| 217 | # Another untested example, using npadmin : |
---|
[1025] | 218 | # requester: external(/usr/bin/npadmin --pagecount %(printer)s) |
---|
[903] | 219 | # |
---|
[919] | 220 | # Another example, for AppleTalk printers which works fine : |
---|
[952] | 221 | # (You may need the pap CUPS backend installed, and copy the |
---|
| 222 | # pagecount.ps file from untested/netatalk into /etc or any |
---|
| 223 | # appropriate location) |
---|
[964] | 224 | # requester: external(/usr/bin/pap -p "%(printer)s:LaserWriter" /etc/pagecount.ps 2>/dev/null | grep -v status | grep -v Connect | tail -1) |
---|
[919] | 225 | # |
---|
[806] | 226 | # This value can be set either globally or per printer or both. |
---|
| 227 | # If both are defined, the printer option has priority. |
---|
[830] | 228 | # |
---|
[998] | 229 | # NB : The SNMP oid mib-2.43.10.2.1.4.1.1 works on HP Laserjet Printers, but it may |
---|
[830] | 230 | # be different with other brands, refer to your printer's documentation |
---|
[999] | 231 | # for details. Also you may have to specify -v2c or -v3 depending on your |
---|
| 232 | # printer's support for different versions of the SNMP specification. |
---|
[1002] | 233 | # |
---|
[1055] | 234 | # |
---|
| 235 | # Some examples and comments provided by Bob Martel from csuohio.edu |
---|
| 236 | # |
---|
| 237 | # For several printers I could not get the page count using snmpget. I |
---|
| 238 | # resorted to snmpwalk: |
---|
| 239 | # |
---|
| 240 | # requester: external(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public %(printer)s | grep mib-2.43.10.2.1.4.1.1 | cut -d " " -f4) |
---|
| 241 | # |
---|
| 242 | # The last example is still more ugly, some of the printers only provided |
---|
| 243 | # their counters without names, but at least always on the same line: |
---|
| 244 | # |
---|
| 245 | # requester: external(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public -Ov %(printer)s | grep Counter32 | tail -2 | head -1 | cut -d " " -f2) |
---|
| 246 | # |
---|
| 247 | # |
---|
[1002] | 248 | # WARNING : In any case, when using an external requester, please test the command line outside |
---|
| 249 | # of PyKota before. This will save you some headaches in case it doesn't work as expected. |
---|
[1025] | 250 | requester: external(/usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
[806] | 251 | |
---|
[695] | 252 | # Default policy for inexistant users (e.g. root) |
---|
[713] | 253 | # either allow or deny |
---|
[806] | 254 | # This value can be set either globally or per printer or both. |
---|
| 255 | # If both are defined, the printer option has priority. |
---|
[956] | 256 | # If the value is not set then the default policy DENY applies. |
---|
| 257 | # ATTENTION : |
---|
[960] | 258 | # Before 1.04 the default value was ALLOW, but unknown users |
---|
[956] | 259 | # allowed to print causes accuracy problems : their jobs are |
---|
| 260 | # charged to the next person who prints on the same printer. |
---|
[1038] | 261 | # There's no policy wrt inexistant groups, they are ignored. |
---|
[956] | 262 | policy: deny |
---|