1 | # PyKota sample configuration file |
---|
2 | # |
---|
3 | # Copy this file into the /etc/pykota/ directory |
---|
4 | # under the name /etc/pykota/pykota.conf |
---|
5 | # |
---|
6 | # PyKota - Print Quotas for CUPS and LPRng |
---|
7 | # |
---|
8 | # (c) 2003-2004 Jerome Alet <alet@librelogiciel.com> |
---|
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. |
---|
13 | # |
---|
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. |
---|
22 | # |
---|
23 | # $Id$ |
---|
24 | # |
---|
25 | |
---|
26 | [global] |
---|
27 | # Storage backend for quotas |
---|
28 | # only PGStorage (PostgreSQL) and LDAPStorage (OpenLDAP) are supported. |
---|
29 | # MySQL and BerkeleyDB are planned. |
---|
30 | |
---|
31 | # the 'postgresql' value is deprecated, use 'pgstorage' instead. |
---|
32 | storagebackend: pgstorage |
---|
33 | |
---|
34 | # Quota Storage Server hostname (and optional port) |
---|
35 | # e.g. db.example.com:5432 |
---|
36 | storageserver: localhost |
---|
37 | |
---|
38 | # |
---|
39 | # name of the Quota Storage Database |
---|
40 | storagename: pykota |
---|
41 | |
---|
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 |
---|
53 | |
---|
54 | # Should the database caching mechanism be enabled or not ? |
---|
55 | # If unset, caching is disabled. Possible values Y/N/YES/NO |
---|
56 | # caching mechanism works with both PostgreSQL and OpenLDAP backends |
---|
57 | # but may be really interesting only with OpenLDAP. |
---|
58 | # |
---|
59 | # ACTIVATING CACHE MAY CAUSE PRECISION PROBLEMS IN PRINT ACCOUNTING |
---|
60 | # IF AN USER PRINTS ON SEVERAL PRINTERS AT THE SAME TIME. |
---|
61 | # YOU MAY FIND IT INTERESTING ANYWAY, ESPECIALLY FOR LDAP. |
---|
62 | # |
---|
63 | # FYI, I ALWAYS SET IT TO YES ! |
---|
64 | # |
---|
65 | storagecaching: No |
---|
66 | |
---|
67 | # Should full job history be disabled ? |
---|
68 | # If unset or set to No, full job history is kept in the database. |
---|
69 | # This will be useful in the future when the report generator |
---|
70 | # will be written. |
---|
71 | # Disabling the job history can be useful with heavily loaded |
---|
72 | # LDAP servers, to not make the LDAP tree grow out of control. |
---|
73 | # Disabling the job history with the PostgreSQL backend works too |
---|
74 | # but it's probably less useful than with LDAP. |
---|
75 | disablehistory: No |
---|
76 | |
---|
77 | # LDAP example, uncomment and adapt it to your own configuration : |
---|
78 | #storagebackend: ldapstorage |
---|
79 | #storageserver: ldap://ldap.librelogiciel.com:389 |
---|
80 | #storagename: dc=librelogiciel,dc=com |
---|
81 | #storageuser: cn=notadmin,dc=librelogiciel,dc=com |
---|
82 | #storageuserpw: abc.123 |
---|
83 | # |
---|
84 | # Here we define some helpers to know where |
---|
85 | # to plug into an existing LDAP directory |
---|
86 | #userbase: ou=People,dc=librelogiciel,dc=com |
---|
87 | #userrdn: uid |
---|
88 | #balancebase: ou=People,dc=librelogiciel,dc=com |
---|
89 | #balancerdn: uid |
---|
90 | #groupbase: ou=Groups,dc=librelogiciel,dc=com |
---|
91 | #grouprdn: cn |
---|
92 | #printerbase: ou=Printers,ou=PyKota,dc=librelogiciel,dc=com |
---|
93 | #printerrdn: cn |
---|
94 | #jobbase: ou=Jobs,ou=PyKota,dc=librelogiciel,dc=com |
---|
95 | #userquotabase: ou=UQuotas,ou=PyKota,dc=librelogiciel,dc=com |
---|
96 | #groupquotabase: ou=GQuotas,ou=PyKota,dc=librelogiciel,dc=com |
---|
97 | #lastjobbase: ou=LastJobs,ou=PyKota,dc=librelogiciel,dc=com |
---|
98 | # |
---|
99 | # How to create new accounts and groups |
---|
100 | # authorized values are "below" and "attach(objectclass name [, fail|warn])" |
---|
101 | # |
---|
102 | # "below" creates the new accounts/groups as standalone entries |
---|
103 | # below the above defined 'userbase' ou |
---|
104 | # |
---|
105 | # attach(objectclass name [, action]) tries to find some existing user/group |
---|
106 | # using the above defined 'userrdn' or 'grouprdn' and 'userbase' |
---|
107 | # 'groupbase', and attach the PyKota specific entries to it. |
---|
108 | # if action is "warn" and no entry exists to attach to, a new |
---|
109 | # entry is created, and a message is logged. |
---|
110 | # if action is "fail" and no entry exists to attach to, program |
---|
111 | # logs an error message and aborts. |
---|
112 | # if action is not set, the default value is "fail". |
---|
113 | # |
---|
114 | # a possible value: newuser: attach(posixAccount, warn) |
---|
115 | #newuser : below |
---|
116 | #newgroup : below |
---|
117 | # |
---|
118 | # LDAP attribute which stores the user's email address |
---|
119 | #usermail : mail |
---|
120 | |
---|
121 | # |
---|
122 | # Choose what attribute contains the list of group members |
---|
123 | # common values are : memberUid, uniqueMember, member |
---|
124 | #groupmembers: memberUid |
---|
125 | |
---|
126 | # Activate low-level LDAP cache yes/no |
---|
127 | # Nothing to do with "storagecaching" which is higher level |
---|
128 | # and database independant. |
---|
129 | # This saves some search queries and may help with heavily |
---|
130 | # loaded LDAP servers. |
---|
131 | # This is EXPERIMENTAL. |
---|
132 | # |
---|
133 | # BEWARE : SETTING THIS TO 'YES' CAUSES PROBLEMS FOR NOW |
---|
134 | # BETTER TO LET IT SET TO 'NO' |
---|
135 | # ldapcache: no |
---|
136 | |
---|
137 | # Where to log ? |
---|
138 | # supported values : stderr, system (system means syslog, but don't use 'syslog' here) |
---|
139 | # if the value is not set then the default SYSTEM applies. |
---|
140 | logger: system |
---|
141 | |
---|
142 | # Enable debugging ? Put YES or NO there. |
---|
143 | # From now on, YES is the default in this sample |
---|
144 | # configuration file, so that debugging is activated |
---|
145 | # when configuring PyKota. After all works, just |
---|
146 | # put NO instead to save some disk space in your |
---|
147 | # logs. |
---|
148 | # Actually only database queries are logged. |
---|
149 | debug : Yes |
---|
150 | |
---|
151 | # Mail server to use to warn users |
---|
152 | # If the value is not set then localhost is used. |
---|
153 | smtpserver: localhost |
---|
154 | |
---|
155 | # Crash messages' recipient : in addition to the log files |
---|
156 | # each software crash can be sent to the author of PyKota |
---|
157 | # or any other person of your choice. By default this |
---|
158 | # is disabled. The recipient pykotacrashed@librelogiciel.com |
---|
159 | # reaches PyKota's author. |
---|
160 | # The 'adminmail' (defined a bit below) is CCed. |
---|
161 | # |
---|
162 | # Privacy concerns : what is sent is only : |
---|
163 | # |
---|
164 | # - a copy of the software's traceback |
---|
165 | # - a copy of the software's command line arguments |
---|
166 | # - a copy of the software's environment variables |
---|
167 | # |
---|
168 | # suggested value |
---|
169 | # crashrecipient: pykotacrashed@librelogiciel.com |
---|
170 | |
---|
171 | # Email domain |
---|
172 | # If the value is not set, and the mail attribute for the user |
---|
173 | # is not set in the PyKota storage, be it LDAP (see usermail directive |
---|
174 | # above) or PostgreSQL, then email messages are sent to |
---|
175 | # username@smtpserver |
---|
176 | # |
---|
177 | # If the value is set, then email messages are sent to |
---|
178 | # username@maildomain using the SMTP server defined above |
---|
179 | # |
---|
180 | # Set the appropriate value below, example.com set as per RFC2606. |
---|
181 | maildomain: example.com |
---|
182 | |
---|
183 | # Should we force usernames to be all lowercase when printing ? |
---|
184 | # Default is No. |
---|
185 | # This is a global option only. |
---|
186 | # Some people reported that WinXP sends mixed case usernames |
---|
187 | # setting 'utolower: Yes' solves the problem. |
---|
188 | # Of course you have to use lowercase only when adding |
---|
189 | # users with edpykota, because ALL database accesses are |
---|
190 | # still case sensitive. |
---|
191 | # |
---|
192 | # If utolower is Yes, the usernames received from the printing |
---|
193 | # system is converted to lowercase at the start of the cupspykota |
---|
194 | # backend or of the lprngpykota filter. |
---|
195 | # |
---|
196 | # If utolower is No, which is the default, strict case checking |
---|
197 | # is done, this means that users 'Jerome' and 'jerome' are |
---|
198 | # different. Printer and groups names are ALWAYS case sensitive. |
---|
199 | utolower: No |
---|
200 | |
---|
201 | # Should we split usernames on a specific separator when printing ? |
---|
202 | # Default is No, i.e. if the value is unset. |
---|
203 | # This is a global option only. |
---|
204 | # This option adds support for Samba's Winbind utility, which |
---|
205 | # prefixes usernames with domain name and separator character. |
---|
206 | # Of course if you set this then you have to use NO separator when |
---|
207 | # adding users with edpykota. |
---|
208 | # |
---|
209 | # If winbind_separator is set, the usernames received from the printing |
---|
210 | # system are split on the separator's value, and only the last part |
---|
211 | # (real username) is used. |
---|
212 | # |
---|
213 | # If winbind_separator is not set, which is the default, strict |
---|
214 | # username equality checking will be done (modulo the setting |
---|
215 | # of the 'utolower' directive), this means that users 'DOMAIN1/jerome', |
---|
216 | # 'Domain2/jerome' and 'jerome' are different. |
---|
217 | # winbind_separator: / |
---|
218 | |
---|
219 | # Do we want to hide jobs' title, filename and options for privacy |
---|
220 | # reasons ? |
---|
221 | # This may be required in some countries (Italy comes to mind). |
---|
222 | # Allowed values are YES and NO. |
---|
223 | # If unset, the default value is NO, meaning that jobs' title, filename |
---|
224 | # and options will be saved into the history. |
---|
225 | # This option can't be set on a per printer basis, only into the |
---|
226 | # [global] section. |
---|
227 | privacy : no |
---|
228 | |
---|
229 | # What is the accounting backend to use |
---|
230 | # |
---|
231 | # supported values : |
---|
232 | # |
---|
233 | # - hardware : asks the printer for its lifetime page counter |
---|
234 | # via either SNMP, AppleTalk, or any external |
---|
235 | # command. This method is the recommended one |
---|
236 | # in PyKota since its beginning. |
---|
237 | # |
---|
238 | # In the lines below "%(printer)s" is automatically replaced |
---|
239 | # at run time with your printer's Fully Qualified Domain Name |
---|
240 | # for network printers, if PyKota can extract it from its |
---|
241 | # environment. |
---|
242 | # e.g. myprinter.example.com |
---|
243 | # |
---|
244 | # Recommended values : |
---|
245 | # |
---|
246 | # accounter: hardware(snmp) |
---|
247 | # |
---|
248 | # Extracts the printer's internal page counter via SNMP. |
---|
249 | # |
---|
250 | # Or : |
---|
251 | # |
---|
252 | # accounter: hardware(pjl) |
---|
253 | # |
---|
254 | # Extracts the printer's internal page counter via PJL queries over port tcp/9100. |
---|
255 | # |
---|
256 | # Other Examples : |
---|
257 | # |
---|
258 | # accounter: hardware(/usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
259 | # |
---|
260 | # Another untested example, using npadmin : |
---|
261 | # |
---|
262 | # accounter: hardware(/usr/bin/npadmin --pagecount %(printer)s) |
---|
263 | # |
---|
264 | # Another example, for AppleTalk printers which works fine : |
---|
265 | # (You may need the pap CUPS backend installed, and copy the |
---|
266 | # pagecount.ps file from untested/netatalk into /etc or any |
---|
267 | # appropriate location) |
---|
268 | # |
---|
269 | # accounter: hardware(/usr/share/pykota/papwaitprinter.sh "MyPrinter:LaserWriter@*" && /usr/bin/pap -p "MyPrinter:LaserWriter@*" /usr/share/pykota/pagecount.ps 2>/dev/null | /bin/grep -v status | /bin/grep -v Connect | /usr/bin/tail -1) |
---|
270 | # |
---|
271 | # An example for parallel printers like the HP Laserjet 5MP : |
---|
272 | # |
---|
273 | # accounter: hardware(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1) |
---|
274 | # |
---|
275 | # This value can be set either globally or per printer or both. |
---|
276 | # If both are defined, the printer option has priority. |
---|
277 | # |
---|
278 | # Some examples and comments provided by Bob Martel from csuohio.edu |
---|
279 | # |
---|
280 | # For several printers I could not get the page count using snmpget. I |
---|
281 | # resorted to snmpwalk: |
---|
282 | # |
---|
283 | # accounter: hardware(/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) |
---|
284 | # |
---|
285 | # The last example is still more ugly, some of the printers only provided |
---|
286 | # their counters without names, but at least always on the same line: |
---|
287 | # |
---|
288 | # accounter: hardware(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public -Ov %(printer)s | grep Counter32 | tail -2 | head -1 | cut -d " " -f2) |
---|
289 | # |
---|
290 | # An example using netcat and a preformatted PJL job which you can find |
---|
291 | # in the untested/pjl directory, which is sent to a JetDirect print |
---|
292 | # server on port 9100 : |
---|
293 | # |
---|
294 | # accounter: hardware(/bin/nc -w 2 %(printer)s 9100 </usr/share/pykota/pagecount.pjl | /usr/bin/tail -2) |
---|
295 | # |
---|
296 | # An example using the contributed pagecount.pl script which does |
---|
297 | # the same as above, but should work on more printers : |
---|
298 | # |
---|
299 | # accounter: hardware(LC_ALL=C /usr/share/pykota/pagecount.pl %(printer)s 9100) |
---|
300 | # |
---|
301 | # NB : the LC_ALL=C is used because sometimes Perl can correctly set locale and is verbose |
---|
302 | # about it, causing PyKota to miss the correct answer. |
---|
303 | # |
---|
304 | # WARNING : In any case, when using an hardware accounter, please test the command line outside |
---|
305 | # of PyKota before. This will save you some headaches in case it doesn't work as expected. |
---|
306 | # |
---|
307 | # The waitprinter.sh is there to wait until the printer is idle again. |
---|
308 | # This should prevent a job to be sent to the printer while another one is |
---|
309 | # not yet finished (not all pages are printed, but the complete job is in |
---|
310 | # the printer) |
---|
311 | # |
---|
312 | # YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE |
---|
313 | # PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER. |
---|
314 | # |
---|
315 | # PYKOTA INCLUDES SUCH SCRIPTS FOR SNMP AND APPLETALK PRINTERS, MORE TO COME |
---|
316 | # |
---|
317 | # SOME OF THE ABOVE EXAMPLES DON'T USE SUCH A SCRIPT, YOU HAVE BEEN WARNED |
---|
318 | # |
---|
319 | # |
---|
320 | # WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA |
---|
321 | # TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE |
---|
322 | # TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU, |
---|
323 | # AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE |
---|
324 | # YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS. |
---|
325 | # |
---|
326 | # |
---|
327 | # - software : delegates the job's size computation to any |
---|
328 | # external command of your choice. |
---|
329 | # |
---|
330 | # best choice for this is probably to set it |
---|
331 | # this way : |
---|
332 | # |
---|
333 | # accounter: software(/usr/bin/pkpgcounter) |
---|
334 | # |
---|
335 | # pkpgcounter is a command line tool which is |
---|
336 | # part of PyKota and which can handle both |
---|
337 | # DSC compliant or binary PostScript, PCL5, PCL6 (aka PCLXL) |
---|
338 | # and PDF documents. More file formats will be added |
---|
339 | # in the future, as time permits. |
---|
340 | # |
---|
341 | # while pkpgcounter is the recommended value |
---|
342 | # you can use whatever command you want provided |
---|
343 | # that your command accepts the job's data on its |
---|
344 | # standard input and prints the job's size in pages |
---|
345 | # as a single integer on its standard output. |
---|
346 | # |
---|
347 | # This value can be set either globally or on a per printer basis |
---|
348 | # If both are defined, the printer option has priority. |
---|
349 | # |
---|
350 | # accounter: hardware(/usr/share/pykota/waitprinter.sh %(printer)s && /usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ") |
---|
351 | # accounter: hardware(snmp) |
---|
352 | # accounter: hardware(pjl) |
---|
353 | accounter: software(/usr/bin/pkpgcounter) |
---|
354 | |
---|
355 | # What should we do if the accounter's subprocess doesn't return |
---|
356 | # a valid result (for example doesn't return an integer on its stdout) |
---|
357 | # |
---|
358 | # Valid values are : 'continue' and 'stop'. 'stop' is the default |
---|
359 | # if unset. |
---|
360 | # |
---|
361 | # 'continue' means try to process as usual, this may introduce |
---|
362 | # accounting errors and free jobs. This was the default behavior |
---|
363 | # until v1.20alpha5. |
---|
364 | # |
---|
365 | # 'stop' means fail and stop the print queue. If an accounter |
---|
366 | # error occurs, most of the time this is a misconfiguration, so |
---|
367 | # stopping the print queue is usually the better thing to do |
---|
368 | # until the admin has fixed the configuration. |
---|
369 | # |
---|
370 | # This value can be set either globally or on a per printer basis |
---|
371 | # If both are defined, the printer option has priority. |
---|
372 | # |
---|
373 | # NB : This directive shouldn't do much now because in case |
---|
374 | # of external accounter error, PyKota just loops. |
---|
375 | # |
---|
376 | # onaccountererror: continue |
---|
377 | onaccountererror: stop |
---|
378 | |
---|
379 | # Print Quota administrator |
---|
380 | # These values can be set either globally or per printer or both. |
---|
381 | # If both are defined, the printer option has priority. |
---|
382 | # If these values are not set, the default admin root |
---|
383 | # and the default adminmail root@localhost are used. |
---|
384 | admin: John Doe |
---|
385 | adminmail: root@localhost |
---|
386 | |
---|
387 | # |
---|
388 | # Who should we send an email to in case a quota is reached ? |
---|
389 | # possible values are : DevNull, User, Admin, Both, External(some command) |
---|
390 | # The Both value means that the User and the Admin will receive |
---|
391 | # an email message. |
---|
392 | # The DevNull value means no email message will be sent. |
---|
393 | # This value can be set either globally or per printer or both. |
---|
394 | # If both are defined, the printer option has priority. |
---|
395 | # If the value is not set, then the default BOTH applies. |
---|
396 | # |
---|
397 | # Format of the external syntax : |
---|
398 | # |
---|
399 | # mailto: external(/usr/bin/mycommand >/dev/null) |
---|
400 | # |
---|
401 | # You can use : |
---|
402 | # |
---|
403 | # '%(action)s' will contain either WARN or DENY |
---|
404 | # '%(username)s' will contain the user's name |
---|
405 | # '%(printername)s' will contain the printer's name |
---|
406 | # '%(email)s' will contain the user's email address |
---|
407 | # '%(message)s' will contain the message if you want |
---|
408 | # to use it. |
---|
409 | # |
---|
410 | # On your command line, to pass arguments to your command. |
---|
411 | # Example : |
---|
412 | # |
---|
413 | # mailto: external(/usr/bin/callpager %(username)s "Quota problem on %(printername)s" >/dev/null) |
---|
414 | # |
---|
415 | # To automatically send a WinPopup message (this may only work with a PDC, |
---|
416 | # here the same machine does Samba as PDC + CUPS) : |
---|
417 | # |
---|
418 | # mailto: external(echo "%(message)s" | /usr/bin/iconv --to-code utf-8 --from-code iso-8859-15 | /usr/bin/smbclient -M "%(username)s" 2>&1 >/dev/null) |
---|
419 | # |
---|
420 | # NB : I use ISO-8859-15, but Windows expects UTF-8, so we pipe the message |
---|
421 | # into iconv before sending it to the Windows user. |
---|
422 | # |
---|
423 | # or more simply : |
---|
424 | # |
---|
425 | # mailto: external(/usr/share/pykota/mailandpopup.sh %(username)s %(printername)s "%(email)s" "%(message)s" 2>&1 >/dev/null) |
---|
426 | # |
---|
427 | # NB : The mailandpopup.sh shell script is now included in PyKota |
---|
428 | # |
---|
429 | # NB : in ANY case, don't forget to redirect your command's standard output |
---|
430 | # somewhere (e.g. >/dev/null) so that there's no perturbation to the |
---|
431 | # underlying layer (filter or backend) |
---|
432 | # |
---|
433 | mailto: both |
---|
434 | |
---|
435 | # |
---|
436 | # Grace delay in days |
---|
437 | # This value can be set either globally or per printer or both. |
---|
438 | # If both are defined, the printer option has priority. |
---|
439 | # If the value is not set then the default seven (7) days applies. |
---|
440 | gracedelay: 7 |
---|
441 | |
---|
442 | # |
---|
443 | # Poor man's threshold |
---|
444 | # If account balance reaches below this amount, |
---|
445 | # a warning message is sent by email |
---|
446 | # |
---|
447 | # If unset, default poor man's threshold is 1.0. |
---|
448 | # This option can only appear in the global section |
---|
449 | poorman: 2.0 |
---|
450 | |
---|
451 | # Poor man's warning message |
---|
452 | # The warning message that is sent if the "poorman" value is reached |
---|
453 | # Again this must appear in the global section |
---|
454 | poorwarn: Your Print Quota account balance is low. |
---|
455 | Soon you'll not be allowed to print anymore. |
---|
456 | |
---|
457 | # Soft limit reached warning message |
---|
458 | # The warning message that is sent if the soft quota limit is reached |
---|
459 | # May appear either globally or on a per-printer basis |
---|
460 | softwarn: Your Print Quota Soft Limit is reached. |
---|
461 | This means that you may still be allowed to print for some |
---|
462 | time, but you must contact your administrator to purchase |
---|
463 | more print quota. |
---|
464 | |
---|
465 | # Hard limit reached error message |
---|
466 | # The error message that is sent if the hard quota limit is reached |
---|
467 | # May appear either globally or on a per-printer basis |
---|
468 | hardwarn: Your Print Quota Hard Limit is reached. |
---|
469 | This means that you are not allowed to print anymore. |
---|
470 | Please contact your administrator at root@localhost |
---|
471 | as soon as possible to solve the problem. |
---|
472 | |
---|
473 | # one section per printer, or no other section at all if all options |
---|
474 | # are defined globally. |
---|
475 | # Each section's name must be the same as the printer's queue name as defined |
---|
476 | # in your printing system, be it CUPS or LPRng, between square brackets, for |
---|
477 | # example a print queue named 'hpmarketing' would appear in this file as |
---|
478 | # [hpmarketing] |
---|
479 | |
---|
480 | |
---|
481 | # Default policy to apply when either : |
---|
482 | # |
---|
483 | # - Printer doesn't exist in PyKota's database |
---|
484 | # - User doesn't exist in PyKota's database |
---|
485 | # - User has no quota entry for this Printer in PyKota's database |
---|
486 | # |
---|
487 | # Value can be either allow or deny or external(some command here) |
---|
488 | # |
---|
489 | # This value can be set either globally or per printer or both. |
---|
490 | # If both are defined, the printer option has priority. |
---|
491 | # If the value is not set then the default policy DENY applies. |
---|
492 | # There's no policy wrt inexistant groups, they are ignored. |
---|
493 | # |
---|
494 | # external policy can be used to launch any external command of your choice, |
---|
495 | # for example to automatically add the user to the quota storage |
---|
496 | # if he is unknown. Example : |
---|
497 | # |
---|
498 | # policy: external(/usr/bin/edpykota --add --printer %(printername)s --softlimit 50 --hardlimit 60 %(username)s >/dev/null) |
---|
499 | # |
---|
500 | # NB : If you want to limit users by their account balance value, it is preferable to |
---|
501 | # use the following policy to automate user account creation on first print : |
---|
502 | # |
---|
503 | # policy: external(/usr/bin/autopykota --initbalance 25.0 >/dev/null) |
---|
504 | # |
---|
505 | # This will automatically add the user if he doesn't already exist, and |
---|
506 | # set his initial balance value to 25.0 (for example). If the user already |
---|
507 | # exists then his balance value will not be modified. |
---|
508 | # Please don't use autopykota if you want to limit your users by page |
---|
509 | # quota, and in any case, carefully read autopykota's help or manpage |
---|
510 | # and understand its goal before using it in your own configuration. |
---|
511 | # |
---|
512 | # Of course you can launch any command of your choice with this, e.g. : |
---|
513 | # |
---|
514 | # policy: external(/usr/local/bin/myadminscript.sh %(username)s >/dev/null) |
---|
515 | |
---|
516 | # You can use : |
---|
517 | # |
---|
518 | # '%(username)s' will contain the user's name |
---|
519 | # '%(printername)s' will contain the printer's name |
---|
520 | # |
---|
521 | # On your command line, to pass arguments to your command. |
---|
522 | # |
---|
523 | # NB : Don't forget to redirect your command's standard output somewhere |
---|
524 | # (e.g. >/dev/null) so that there's no perturbation to the underlying |
---|
525 | # layer (filter or backend) |
---|
526 | # |
---|
527 | # If the printer, user, or user quota entry still doesn't exist after |
---|
528 | # external policy command was launched (the external command didn't add it), |
---|
529 | # or if an error occured during the execution of the external policy |
---|
530 | # command, then the job is rejected. |
---|
531 | # |
---|
532 | policy: deny |
---|
533 | |
---|
534 | # Pre and Post Hooks |
---|
535 | # These directives allow the easy plug-in of any command of your choice |
---|
536 | # at different phases of PyKota's execution. |
---|
537 | # Pre and Post Hooks can access some of PyKota's internal information |
---|
538 | # by reading environment variables as described below. |
---|
539 | # The actual phase of PyKota's execution is available in the |
---|
540 | # PYKOTAPHASE environment variable. |
---|
541 | # Pre and Post Hooks can be defined either globally, per printer, |
---|
542 | # or both. If both are defined, the printer specific hook has |
---|
543 | # priority. |
---|
544 | # |
---|
545 | # List of available environment variables : |
---|
546 | # NB : Most of these variables are also available during the execution |
---|
547 | # of external commands defined in the accounter and mailto |
---|
548 | # directives. |
---|
549 | # |
---|
550 | # PYKOTAMD5SUM : Contains an hexadecimal digest of the md5 sum of the job's datas |
---|
551 | # PYKOTAPHASE : BEFORE or AFTER the job is sent to the printer |
---|
552 | # PYKOTAACTION : ALLOW or DENY or WARN for current print job |
---|
553 | # PYKOTAUSERNAME : user's name |
---|
554 | # PYKOTAPRINTERNAME : printer's name |
---|
555 | # PYKOTAPGROUPS : list of printers groups the current printer is a member of |
---|
556 | # PYKOTAJOBID : job's id |
---|
557 | # PYKOTATITLE : job's title |
---|
558 | # PYKOTAFILENAME : job's filename |
---|
559 | # PYKOTACOPIES : number of copies |
---|
560 | # PYKOTAOPTIONS : job's options |
---|
561 | # PYKOTABALANCE : user's account balance |
---|
562 | # PYKOTALIFETIMEPAID : user's grand total paid |
---|
563 | # PYKOTALIMITBY : user print limiting factor, for example 'quota' or 'balance' |
---|
564 | # PYKOTAPAGECOUNTER : user's page counter on this printer |
---|
565 | # PYKOTALIFEPAGECOUNTER : user's life time page counter on this printer |
---|
566 | # PYKOTASOFTLIMIT : user's soft page limit on this printer |
---|
567 | # PYKOTAHARDLIMIT : user's hard page limit on this printer |
---|
568 | # PYKOTADATELIMIT : user's soft to hard limit date limit on this printer |
---|
569 | # PYKOTASTATUS : contains "CANCELLED" when SIGTERM was received by PyKota |
---|
570 | # else is not set. |
---|
571 | # PYKOTAJOBSIZEBYTES : contains the job's size in bytes. Always available. |
---|
572 | # PYKOTAPRECOMPUTEDJOBSIZE : contains the precomputed job's size (with enforcement: strict) |
---|
573 | # PYKOTAPRECOMPUTEDJOBPRICE : contains the precomputed job's price (with enforcement: strict) |
---|
574 | # PYKOTAJOBORIGINATINGHOSTNAME : contains the client's hostname if |
---|
575 | # it is possible to retrieve it. |
---|
576 | # PYKOTAPRINTERHOSTNAME : the printer's hostname or IP address for network |
---|
577 | # printers, or "localhost" if not defined or not |
---|
578 | # meaningful. |
---|
579 | |
---|
580 | # PreHook : gets executed after being sure the user, printer and user quota |
---|
581 | # entry on the printer both exist in the PyKota database, and after |
---|
582 | # checking if the user is allowed to print or not, but just before |
---|
583 | # the job is sent to the printer (if allowed) |
---|
584 | # prehook has access to many environment variables : |
---|
585 | # |
---|
586 | # PYKOTAACTION contains either "ALLOW", "WARN" or "DENY" and |
---|
587 | # represents the action which is to be done wrt the print job. |
---|
588 | # PYKOTAPHASE contains 'BEFORE' during execution of prehook |
---|
589 | # |
---|
590 | # uncomment the line below to see what environment variables are available |
---|
591 | # prehook: /usr/bin/printenv >/tmp/before |
---|
592 | |
---|
593 | # PostHook : gets executed after the job has been added to the history. |
---|
594 | # posthook has access to all the environment variables defined above, |
---|
595 | # as well as two additionnal environment variables : PYKOTAJOBPRICE |
---|
596 | # and PYKOTAJOBSIZE. |
---|
597 | # PYKOTAPHASE contains 'AFTER' during execution of posthook. |
---|
598 | # |
---|
599 | # uncomment the line below to see what environment variables are available |
---|
600 | # posthook: /usr/bin/printenv >/tmp/after |
---|
601 | |
---|
602 | # AccountBanner : how should banner accounting be done ? |
---|
603 | # |
---|
604 | # NB : CUPS ONLY FOR NOW ! |
---|
605 | # |
---|
606 | # If enabled, banner pages printed from StartingBanner and/or EndingBanner |
---|
607 | # (depending on the value) will be included in the accounting for the |
---|
608 | # print job |
---|
609 | # |
---|
610 | # If disabled, banner pages printed from StartingBanner and EndingBanner will |
---|
611 | # *not* be included in the accounting for the print job |
---|
612 | # |
---|
613 | # IMPORTANT : CUPS generated banners are ALWAYS accounted for, although you |
---|
614 | # can refund them by using negative prices on printers. |
---|
615 | # |
---|
616 | # Allowed values : Starting | Ending | None | Both |
---|
617 | # |
---|
618 | # - Starting : only the starting banner will be accounted for. |
---|
619 | # - Ending : only the ending banner will be accounted for. |
---|
620 | # - Both : both starting and ending banners will be accounted for. |
---|
621 | # - None : banners will not be accounted for. |
---|
622 | # |
---|
623 | # Default value : |
---|
624 | # accountbanner: Both |
---|
625 | |
---|
626 | # StartingBanner : if defined will print a banner before the rest of the job |
---|
627 | # is printed. The argument can be a printable file, or an executable file. |
---|
628 | # If not executable, the file will be printed as is. If executable, the |
---|
629 | # file will be executed and its output will be printed. |
---|
630 | # |
---|
631 | # NB : CUPS ONLY FOR NOW ! |
---|
632 | # |
---|
633 | # In any case, the banner content which will be sent to the printer |
---|
634 | # MUST be in a format your printer will accept !!! |
---|
635 | # |
---|
636 | # The pkbanner command included in PyKota can automatically generate |
---|
637 | # starting and ending banners in the PostScript format. You can use |
---|
638 | # this command in a pipe through GhostScript if your printer doesn't |
---|
639 | # accept PostScript as an input format. |
---|
640 | # NB : pkbanner's default page size is A4 |
---|
641 | # |
---|
642 | # startingbanner: /home/joe/mystaticbanner.ps |
---|
643 | # startingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
644 | # startingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
645 | # startingbanner: /usr/bin/pkbanner |
---|
646 | |
---|
647 | # EndingBanner : if defined will print a banner before the rest of the job |
---|
648 | # is printed. The argument can be a printable file, or an executable file. |
---|
649 | # If not executable, the file will be printed as is. If executable, the |
---|
650 | # file will be executed and its output will be printed. |
---|
651 | # |
---|
652 | # NB : CUPS ONLY FOR NOW ! |
---|
653 | # |
---|
654 | # In any case, the banner content which will be sent to the printer |
---|
655 | # MUST be in a format your printer will accept !!! |
---|
656 | # |
---|
657 | # The pkbanner command included in PyKota can automatically generate |
---|
658 | # starting and ending banners in the PostScript format. You can use |
---|
659 | # this command in a pipe through GhostScript if your printer doesn't |
---|
660 | # accept PostScript as an input format. |
---|
661 | # NB : pkbanner's default page size is A4 |
---|
662 | # |
---|
663 | # endingbanner: /home/joe/mystaticbanner.ps |
---|
664 | # endingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
665 | # endingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
666 | # endingbanner: /usr/bin/pkbanner |
---|
667 | |
---|
668 | # How should enforcement be done for this printer ? |
---|
669 | # |
---|
670 | # "laxist" is the default if value is not set, and allows users |
---|
671 | # to be over quota on their last job. |
---|
672 | # |
---|
673 | # "strict" tries to prevent users from ever being over quota. |
---|
674 | # |
---|
675 | # Enforcement can be defined either globally, per printer, |
---|
676 | # or both. If both are defined, the printer specific enforcement |
---|
677 | # setting has priority. |
---|
678 | # |
---|
679 | # valid values : "strict" or "laxist" |
---|
680 | # |
---|
681 | # default value |
---|
682 | # enforcement : laxist |
---|
683 | enforcement : strict |
---|