1 | # PyKota sample configuration file |
---|
2 | # |
---|
3 | # |
---|
4 | # File format : |
---|
5 | # |
---|
6 | # - A mandatory [global] section : |
---|
7 | # |
---|
8 | # Contains configuration directives which apply for all printers. |
---|
9 | # Some directives MUST be set in the [global] section, e.g. |
---|
10 | # database related directives. |
---|
11 | # |
---|
12 | # - Any number of optional [PrintQueueName] sections : |
---|
13 | # |
---|
14 | # Contain directives which apply for a particular print queue only. |
---|
15 | # |
---|
16 | # Override the values of the same directives present in [global]. |
---|
17 | # |
---|
18 | # |
---|
19 | # Directives format : |
---|
20 | # |
---|
21 | # - Directive's name, followed by ':' followed by the directive's value. |
---|
22 | # |
---|
23 | # - No leading whitespace : leading whitespace tell the parser that the |
---|
24 | # current directive is the continuation of the previous one. Use with |
---|
25 | # care and only when you need it. |
---|
26 | # |
---|
27 | # |
---|
28 | # PyKota - Print Quotas for CUPS and LPRng |
---|
29 | # |
---|
30 | # (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com> |
---|
31 | # This program is free software; you can redistribute it and/or modify |
---|
32 | # it under the terms of the GNU General Public License as published by |
---|
33 | # the Free Software Foundation; either version 2 of the License, or |
---|
34 | # (at your option) any later version. |
---|
35 | # |
---|
36 | # This program is distributed in the hope that it will be useful, |
---|
37 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
38 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
39 | # GNU General Public License for more details. |
---|
40 | # |
---|
41 | # You should have received a copy of the GNU General Public License |
---|
42 | # along with this program; if not, write to the Free Software |
---|
43 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
44 | # |
---|
45 | # $Id$ |
---|
46 | # |
---|
47 | |
---|
48 | |
---|
49 | # |
---|
50 | # All directives must be placed below the following line |
---|
51 | [global] |
---|
52 | |
---|
53 | |
---|
54 | |
---|
55 | #################################################################### |
---|
56 | # SQLite3 : comment this section out if you use another backend # |
---|
57 | #################################################################### |
---|
58 | |
---|
59 | #storagebackend : sqlitestorage |
---|
60 | #storagename: /etc/pykota/pykota.db |
---|
61 | |
---|
62 | #################################################################### |
---|
63 | |
---|
64 | |
---|
65 | |
---|
66 | ############################################################################ |
---|
67 | # PostgreSQL or MySQL: comment this section out if you use another backend # |
---|
68 | ############################################################################ |
---|
69 | storagebackend: pgstorage |
---|
70 | # storagebackend: mysqlstorage |
---|
71 | |
---|
72 | # Quota Storage Server hostname (and optional port) |
---|
73 | # e.g. db.example.com:5432 (for PostgreSQL) or db.example.com:3306 (for MySQL) |
---|
74 | # NB : leave the directive empty to use unix sockets (same host only) |
---|
75 | storageserver: localhost |
---|
76 | |
---|
77 | # |
---|
78 | # name of the Quota Storage Database |
---|
79 | storagename: pykota |
---|
80 | |
---|
81 | # |
---|
82 | # Quota Storage normal user's name and password |
---|
83 | # These two fields contain a username and optional password |
---|
84 | # which may give readonly access to your print quota database. |
---|
85 | # |
---|
86 | # PLEASE ENSURE THAT THIS USER CAN'T WRITE TO YOUR PRINT QUOTA |
---|
87 | # DATABASE, OTHERWISE ANY USER WHO COULD READ THIS CONFIGURATION |
---|
88 | # FILE COULD CHANGE HIS PRINT QUOTA. |
---|
89 | # |
---|
90 | storageuser : pykotauser |
---|
91 | # In the line below change the password's value if needed. |
---|
92 | storageuserpw : readonlypw |
---|
93 | |
---|
94 | ############################################################################ |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | #################################################################### |
---|
99 | # LDAP : comment this section out if you use another backend # |
---|
100 | #################################################################### |
---|
101 | # LDAP example, uncomment and adapt it to your own configuration : |
---|
102 | # |
---|
103 | #storagebackend: ldapstorage |
---|
104 | #storageserver: ldap://ldap.example.com:389 |
---|
105 | #storagename: dc=example,dc=com |
---|
106 | # |
---|
107 | # NB : the user and password below are the ones contained in |
---|
108 | # the sample LDIF file pykota/initscripts/ldap/pykota-sample.ldif |
---|
109 | # Please adapt these lines to your own needs. |
---|
110 | # |
---|
111 | #storageuser: cn=pykotauser,dc=example,dc=com |
---|
112 | #storageuserpw: ls88DT5j |
---|
113 | |
---|
114 | |
---|
115 | |
---|
116 | # TLS support for LDAP |
---|
117 | # |
---|
118 | # ldaptls can be set to either Yes or No |
---|
119 | # the default value when not set is No, meaning that TLS won't be used. |
---|
120 | # |
---|
121 | #ldaptls: No |
---|
122 | # |
---|
123 | # cacert points to the CA Certificate file to use for TLS. |
---|
124 | # Ensure that every user who can launch PyKota commands can read this file. |
---|
125 | # There's NO default value for this directive. |
---|
126 | # |
---|
127 | #cacert: /etc/pykota/mycertfile |
---|
128 | |
---|
129 | |
---|
130 | |
---|
131 | # Here we define some helpers to know where |
---|
132 | # to plug into an existing LDAP directory |
---|
133 | # NB : THE DIRECTIVES BELOW MUST BE PRESENT WITH AN LDAP BACKEND |
---|
134 | # BUT YOU ARE FREE TO CHANGE THE VALUES. |
---|
135 | # |
---|
136 | #userbase: ou=People,dc=example,dc=com |
---|
137 | #userrdn: uid |
---|
138 | #balancebase: ou=People,dc=example,dc=com |
---|
139 | #balancerdn: uid |
---|
140 | #groupbase: ou=Groups,dc=example,dc=com |
---|
141 | #grouprdn: cn |
---|
142 | #printerbase: ou=Printers,ou=PyKota,dc=example,dc=com |
---|
143 | #printerrdn: cn |
---|
144 | #jobbase: ou=Jobs,ou=PyKota,dc=example,dc=com |
---|
145 | #lastjobbase: ou=LastJobs,ou=PyKota,dc=example,dc=com |
---|
146 | #billingcodebase: ou=BillingCodes,ou=PyKota,dc=example,dc=com |
---|
147 | |
---|
148 | # These two fields are special, they either accept a branch |
---|
149 | # dn, like an ou for example, or the special keywords 'user' |
---|
150 | # and 'group'. If 'user' or 'group' is used, the print quota |
---|
151 | # entries will be created below the user or group entry itself, |
---|
152 | # which will then be used like a branch (you can mix and match |
---|
153 | # different values depending on what you want to do). |
---|
154 | # |
---|
155 | # NB : YOU MUST CHOOSE A VALUE FOR USERQUOTABASE AND A VALUE |
---|
156 | # FOR GROUPQUOTABASE, BUT ONLY ONE LINE OF EACH MUST BE PRESENT. |
---|
157 | #userquotabase: user |
---|
158 | #userquotabase: ou=UQuotas,ou=PyKota,dc=example,dc=com |
---|
159 | #groupquotabase: group |
---|
160 | #groupquotabase: ou=GQuotas,ou=PyKota,dc=example,dc=com |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | # How to create new accounts and groups |
---|
165 | # authorized values are "below" and "attach(objectclass name [, fail|warn])" |
---|
166 | # |
---|
167 | # "below" creates the new accounts/groups as standalone entries |
---|
168 | # below the above defined 'userbase' ou |
---|
169 | # |
---|
170 | # attach(objectclass name [, action]) tries to find some existing user/group |
---|
171 | # using the above defined 'userrdn' or 'grouprdn' and 'userbase' |
---|
172 | # 'groupbase', and attach the PyKota specific entries to it. |
---|
173 | # if action is "warn" and no entry exists to attach to, a new |
---|
174 | # entry is created, and a message is logged. |
---|
175 | # if action is "fail" and no entry exists to attach to, program |
---|
176 | # logs an error message and aborts. |
---|
177 | # if action is not set, the default value is "fail". |
---|
178 | # |
---|
179 | # a possible value: newuser: attach(posixAccount, warn) |
---|
180 | # |
---|
181 | #newuser : below |
---|
182 | #newgroup : below |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | # LDAP attribute which stores the user's email address |
---|
187 | # |
---|
188 | #usermail : mail |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | # Choose what attribute contains the list of group members |
---|
193 | # common values are : memberUid, uniqueMember, member |
---|
194 | # |
---|
195 | #groupmembers: memberUid |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | # Activate low-level LDAP cache yes/no |
---|
200 | # Nothing to do with "storagecaching" which is higher level |
---|
201 | # and database independant. |
---|
202 | # This saves some search queries and may help with heavily |
---|
203 | # loaded LDAP servers. |
---|
204 | # This is EXPERIMENTAL. |
---|
205 | # |
---|
206 | # BEWARE : SETTING THIS TO 'YES' CAUSES PROBLEMS FOR NOW |
---|
207 | # BETTER TO LET IT SET TO 'NO' |
---|
208 | # |
---|
209 | # ldapcache: no |
---|
210 | |
---|
211 | #################################################################### |
---|
212 | |
---|
213 | ############################################################# |
---|
214 | # END of database specific directives # |
---|
215 | ############################################################# |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | # Should the database caching mechanism be enabled or not ? |
---|
220 | # If unset, caching is disabled. Possible values Y/N/YES/NO |
---|
221 | # caching mechanism works with both relationnal and OpenLDAP backends |
---|
222 | # but may be really interesting only with OpenLDAP. |
---|
223 | # |
---|
224 | # ACTIVATING CACHE MAY CAUSE PRECISION PROBLEMS IN PRINT ACCOUNTING |
---|
225 | # IF AN USER PRINTS ON SEVERAL PRINTERS AT THE SAME TIME. |
---|
226 | # YOU MAY FIND IT INTERESTING ANYWAY, ESPECIALLY FOR LDAP. |
---|
227 | # |
---|
228 | # THERE'S NO GUARANTEE THAT THIS CACHING MECHANISM WILL IMPROVE |
---|
229 | # PERFORMANCE WITH RELATIONNAL BACKENDS. IT MIGHT EVEN MAKE |
---|
230 | # PERFORMANCE DECREASE. AS ALWAYS : YMMV. |
---|
231 | # |
---|
232 | # FYI, I ALWAYS SET IT TO YES ! |
---|
233 | # |
---|
234 | storagecaching: No |
---|
235 | |
---|
236 | |
---|
237 | |
---|
238 | # Should full job history be disabled ? |
---|
239 | # If unset or set to No, full job history is kept in the database. |
---|
240 | # Disabling the job history can be useful with heavily loaded |
---|
241 | # LDAP servers, to not make the LDAP tree grow out of control. |
---|
242 | # Disabling the job history with a relationnal backend works too |
---|
243 | # but it's probably less useful than with LDAP. |
---|
244 | # |
---|
245 | disablehistory: No |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | # Where to log ? |
---|
250 | # supported values : stderr, system (system means syslog, but don't use |
---|
251 | # 'syslog' here). if the value is not set then the default SYSTEM applies. |
---|
252 | # |
---|
253 | logger: system |
---|
254 | |
---|
255 | |
---|
256 | |
---|
257 | # Enable debugging ? Put YES or NO there. |
---|
258 | # debug is set to YES in this sample configuration file, so debugging |
---|
259 | # is activated when configuring PyKota, which helps a lot. After all |
---|
260 | # works, just put NO instead to save some disk space in your logs. |
---|
261 | # NB : When set to YES, there is a very significant impact on performance |
---|
262 | # when managing many users, printers or billing codes at once, because |
---|
263 | # hundreds of thousands of log lines can be generated. |
---|
264 | # When printing a job, typically around 250-300 log lines are generated, |
---|
265 | # so the impact per job is really minimal. Note however that this will |
---|
266 | # add up over a large number of jobs. |
---|
267 | # |
---|
268 | debug : Yes |
---|
269 | |
---|
270 | |
---|
271 | |
---|
272 | # The URL to PyKota's logo when used from the CGI scripts. |
---|
273 | # You can use your own logo by modifying the URL below. |
---|
274 | # If not defined, the default URL is the same as the |
---|
275 | # one defined below : |
---|
276 | # |
---|
277 | logourl : http://www.pykota.com/pykota.png |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | # The destination to which the web browser will be redirected |
---|
282 | # when you click on the logo defined above. |
---|
283 | # If not defined, the default URL is the same as the |
---|
284 | # one defined below : |
---|
285 | # |
---|
286 | logolink : http://www.pykota.com/ |
---|
287 | |
---|
288 | |
---|
289 | |
---|
290 | # Mail server to use to warn users |
---|
291 | # If the value is not set then localhost is used. |
---|
292 | # |
---|
293 | smtpserver: localhost |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | # Crash messages' recipient : in addition to the log files |
---|
298 | # each software crash can be sent to the author of PyKota |
---|
299 | # or any other person of your choice. By default this |
---|
300 | # is disabled for privacy concerns (see below). The address |
---|
301 | # pykotacrashed@librelogiciel.com reaches PyKota's author. |
---|
302 | # The 'adminmail' (defined a bit below) is CCed. |
---|
303 | # |
---|
304 | # Privacy concerns : what is sent is only : |
---|
305 | # |
---|
306 | # - a copy of the software's traceback |
---|
307 | # - a copy of the software's command line arguments |
---|
308 | # - a copy of the software's environment variables |
---|
309 | # |
---|
310 | # suggested value : |
---|
311 | # |
---|
312 | # crashrecipient: pykotacrashed@librelogiciel.com |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | # Email domain |
---|
317 | # If the value is not set, and the mail attribute for the user |
---|
318 | # is not set in the PyKota storage, be it LDAP (see usermail directive |
---|
319 | # above) or a relationnal one, then email messages are sent to |
---|
320 | # username@smtpserver |
---|
321 | # |
---|
322 | # If the value is set, then email messages are sent to |
---|
323 | # username@maildomain using the SMTP server defined above |
---|
324 | # |
---|
325 | # Set the appropriate value below, example.com set as per RFC2606. |
---|
326 | # |
---|
327 | maildomain: example.com |
---|
328 | |
---|
329 | |
---|
330 | |
---|
331 | # Should we force usernames to be all lowercase when printing ? |
---|
332 | # Default is No. |
---|
333 | # This is a [global] option only. |
---|
334 | # Some people reported that WinXP sends mixed case usernames |
---|
335 | # setting 'utolower: Yes' solves the problem. |
---|
336 | # Of course you have to use lowercase only when adding |
---|
337 | # users with edpykota, because ALL database accesses are |
---|
338 | # still case sensitive. |
---|
339 | # |
---|
340 | # If utolower is Yes, the usernames received from the printing |
---|
341 | # system is converted to lowercase at the start of printing, |
---|
342 | # BUT ONLY when printing. |
---|
343 | # |
---|
344 | # If utolower is No, which is the default, strict case checking |
---|
345 | # is done, this means that users 'Jerome' and 'jerome' are |
---|
346 | # different. Printer and groups names are ALWAYS case sensitive. |
---|
347 | # |
---|
348 | utolower: No |
---|
349 | |
---|
350 | |
---|
351 | |
---|
352 | # Should we split usernames on a specific separator when printing ? |
---|
353 | # Default is No, i.e. if the value is unset. |
---|
354 | # This is a [global] option only. |
---|
355 | # This option adds support for Samba's Winbind utility, which |
---|
356 | # prefixes usernames with domain name and separator character. |
---|
357 | # Of course if you set this then you have to use NO separator when |
---|
358 | # adding users with edpykota. |
---|
359 | # |
---|
360 | # If winbind_separator is set, the usernames received from the printing |
---|
361 | # system are split on the separator's value, and only the last part |
---|
362 | # (real username) is used. |
---|
363 | # |
---|
364 | # If winbind_separator is not set, which is the default, strict |
---|
365 | # username equality checking will be done (modulo the setting |
---|
366 | # of the 'utolower' directive), this means that users 'DOMAIN1/jerome', |
---|
367 | # 'Domain2/jerome' and 'jerome' are different. |
---|
368 | # |
---|
369 | # winbind_separator: / |
---|
370 | |
---|
371 | |
---|
372 | |
---|
373 | # When creating users or groups accounts, should we reject users |
---|
374 | # or groups which are unknown from the system ? |
---|
375 | # The default if unset is NO. This means that by default, you |
---|
376 | # can create users or groups for which `getent passwd username` |
---|
377 | # or `getent group groupname` returns nothing. |
---|
378 | # |
---|
379 | # Allowed values : Yes | No |
---|
380 | # Default value : No |
---|
381 | # |
---|
382 | # reject_unknown: No |
---|
383 | |
---|
384 | |
---|
385 | |
---|
386 | # Do we want to hide jobs' title, filename and options for privacy |
---|
387 | # reasons ? |
---|
388 | # This may be required in some countries (Italy comes to mind). |
---|
389 | # Allowed values are YES and NO. |
---|
390 | # If unset, the default value is NO, meaning that jobs' title, filename |
---|
391 | # and options will be saved into the history. |
---|
392 | # This option can't be set on a per printer basis, only into the |
---|
393 | # [global] section. |
---|
394 | # |
---|
395 | privacy : no |
---|
396 | |
---|
397 | |
---|
398 | |
---|
399 | # When the real CUPS backend fail, should we modify the |
---|
400 | # user's page counters and account balance or not ? |
---|
401 | # Also should we retry and if yes then how often and how many times ? |
---|
402 | # If you trust your users, set it to "nocharge". |
---|
403 | # If you think they found some mean to kill the real CUPS backend, |
---|
404 | # then set it to "charge". |
---|
405 | # If your print queues get regularly disabled by CUPS when the printers |
---|
406 | # are switched off, you might want to set it to "retry:N:S" where |
---|
407 | # N is the number of times the operation should be retried, and S is |
---|
408 | # the delay in seconds during which PyKota will sleep before trying again. |
---|
409 | # This 'retry' feature works in a way similar to Till Kamppeter's beh |
---|
410 | # backend wrapper which offers this functionnality but is actually not |
---|
411 | # compatible with PyKota (because of my own inability to master regular |
---|
412 | # expressions). |
---|
413 | # If N is 0, PyKota will retry indefinitely each S seconds until the |
---|
414 | # backend succeeds, so you should use this with caution. If N is 0, |
---|
415 | # of course neither "charge" nor "nocharge" will be honored. |
---|
416 | # You can combine "charge" or "nocharge" with "retry:N:S" if you want, |
---|
417 | # by separating the values with a comma as shown in the examples below. |
---|
418 | # If unset, the default value is "nocharge", meaning that users won't be |
---|
419 | # charged whenever a CUPS backend fails. This is the OPPOSITE |
---|
420 | # behavior compared to PyKota versions prior to 1.24alpha2. |
---|
421 | # This value can be set either globally or on a per printer basis |
---|
422 | # If both are defined, the printer option has priority. |
---|
423 | # |
---|
424 | # onbackenderror : charge,retry:5:60 |
---|
425 | # onbackenderror : retry:0:300 |
---|
426 | # onbackenderror : retry:3:300,nocharge |
---|
427 | # onbackenderror : charge |
---|
428 | onbackenderror : nocharge |
---|
429 | |
---|
430 | |
---|
431 | |
---|
432 | # Should we strip off some characters from the beginning of |
---|
433 | # print jobs' titles ? This can be used to remove smbprn.?????? |
---|
434 | # which sometimes appear when printing in raw mode from Windows |
---|
435 | # through Samba. |
---|
436 | # This setting only applies at printing time. |
---|
437 | # When not set, titles are used as received from the printing system. |
---|
438 | # The default is to not strip any character off of jobs' titles. |
---|
439 | # This value can be set either globally or on a per printer basis |
---|
440 | # If both are defined, the printer option has priority. |
---|
441 | # |
---|
442 | # striptitle : smbprn.?????? |
---|
443 | |
---|
444 | |
---|
445 | |
---|
446 | # Should we launch a command to overwrite the job's ticket ? |
---|
447 | # This allows a command to overwrite the username and/or the |
---|
448 | # billing code used, or to deny or cancel the job. |
---|
449 | # If unset no command is launched and the job's username and |
---|
450 | # billing code are used as they are received. |
---|
451 | # To overwrite the job's ticket, the command has to print |
---|
452 | # on its standard output one or more of the following lines, |
---|
453 | # without any prefix or space character : |
---|
454 | # |
---|
455 | # USERNAME=the_username_we_want_to_overwrite_with |
---|
456 | # BILLINGCODE=the_billingcode_we_want_to_overwrite_with |
---|
457 | # AUTH=NO (equivalent to DENY below) |
---|
458 | # DENY |
---|
459 | # CANCEL |
---|
460 | # |
---|
461 | # NB : the output of your command is entirely read, and the latest |
---|
462 | # value seen is used, so you command can output several usernames |
---|
463 | # or billing codes and only the latest ones will be used. |
---|
464 | # If only USERNAME= lines are printed, the billing code, |
---|
465 | # if any, is used unchanged. |
---|
466 | # If only BILLINGCODE= lines are printed, the username is |
---|
467 | # used unchanged. |
---|
468 | # If DENY or CANCEL is output, neither the username nor the |
---|
469 | # billing code can be overwritten. |
---|
470 | # |
---|
471 | # This value can be set either globally or on a per printer basis |
---|
472 | # If both are defined, the printer option has priority. |
---|
473 | # |
---|
474 | #�IMPORTANT : |
---|
475 | # |
---|
476 | # If you use this directive to interact with the end user in |
---|
477 | # some way, for example through pknotify+pykoticon or similar |
---|
478 | # tools, you have to keep in mind that this directive, as all |
---|
479 | # the directives in pykota*.conf, is processed at the time |
---|
480 | # the print job reaches the top of the print queue, and not |
---|
481 | # at the time it enters the print queue. For heavily loaded |
---|
482 | # systems where several jobs are in the print queue at a given |
---|
483 | # time, there may be a significant delay between the moment the |
---|
484 | # user submits the print job, and the moment this directive is |
---|
485 | # processed. |
---|
486 | # |
---|
487 | # examples : |
---|
488 | # |
---|
489 | # overwrite_jobticket : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 180 --denyafter 3 --checkauth --ask "Username:username:$PYKOTAUSERNAME" "Password:password:" "Billing code:billingcode:$PYKOTAJOBBILLING" |
---|
490 | # overwrite_jobticket : /path/to/some/script/or/command |
---|
491 | |
---|
492 | |
---|
493 | |
---|
494 | # Should we ask the end user for a confirmation about their print job ? |
---|
495 | # |
---|
496 | # Any script can be launched here. If your script prints CANCEL on |
---|
497 | # its standard output, the job is cancelled, else processing of the |
---|
498 | # job continues to next step. |
---|
499 | # |
---|
500 | # NB : the output of your command is read until CANCEL is found |
---|
501 | # or all lines have been read. |
---|
502 | # |
---|
503 | # This value can be set either globally or on a per printer basis |
---|
504 | # If both are defined, the printer option has priority. |
---|
505 | # |
---|
506 | # examples : |
---|
507 | # |
---|
508 | # askconfirmation : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 120 --confirm "Hello $PYKOTAUSERNAME.\nPrint job $PYKOTAJOBID send to printer $PYKOTAPRINTERNAME is $PYKOTAPRECOMPUTEDJOBSIZE pages long\nand will cost you $PYKOTAPRECOMPUTEDJOBPRICE credits.\n\nYou currently have $PYKOTABALANCE credits.\n\nDo you really want to print ?" |
---|
509 | |
---|
510 | |
---|
511 | |
---|
512 | # What should we do when we print and the billing code used is |
---|
513 | # not present in the database ? |
---|
514 | # The default value is 'create' which adds the billing code to the |
---|
515 | # database. |
---|
516 | # Other values can be : |
---|
517 | # deny |
---|
518 | # which silently rejects the job. |
---|
519 | # or : |
---|
520 | # deny(your script here) |
---|
521 | # if you put the path to a script or command here, it is executed, for |
---|
522 | # example you can open a popup window explaining why the job was |
---|
523 | # rejected. |
---|
524 | # |
---|
525 | # This value can be set either globally or on a per printer basis |
---|
526 | # If both are defined, the printer option has priority. |
---|
527 | # |
---|
528 | # unknown_billingcode : deny |
---|
529 | # unknown_billingcode : deny(/usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 60 --notify "The billing code specified is not allowed") |
---|
530 | # unknown_billingcode : deny(/path/to/some/script) |
---|
531 | # unknown_billingcode : create |
---|
532 | |
---|
533 | |
---|
534 | |
---|
535 | # Where should we store our (temporary) files when printing ? |
---|
536 | # if unset, defaults to a system directory dedicated to temporary |
---|
537 | # files and evaluated at runtime (see Python's documentation |
---|
538 | # for the tempfile.gettempdir() function). |
---|
539 | # This value can be set either globally or on a per printer basis |
---|
540 | # If both are defined, the printer option has priority. |
---|
541 | # On my system, when not set, the /var/spool/cups/tmp directory is used. |
---|
542 | # directory : /tmp |
---|
543 | # directory : /var/spool/cups |
---|
544 | |
---|
545 | |
---|
546 | |
---|
547 | # Should we keep our work files on disk after printing ? |
---|
548 | # If unset, temporary files are deleted once the work is finished. |
---|
549 | # If set to yes, files are kept on disk in the 'directory' |
---|
550 | # named with the previous directive. |
---|
551 | # This value can be set either globally or on a per printer basis |
---|
552 | # If both are defined, the printer option has priority. |
---|
553 | # Default value is No, meaning temporary files are deleted |
---|
554 | # You should set it to yes only during installation to not |
---|
555 | # waste disk space during normal use. |
---|
556 | # |
---|
557 | # keepfiles : yes |
---|
558 | keepfiles : no |
---|
559 | |
---|
560 | |
---|
561 | |
---|
562 | # What is the accounting backend to use : this defines the way PyKota |
---|
563 | # will compute the number of pages printed. This directive is the most |
---|
564 | # important one in PyKota's configuration. |
---|
565 | # |
---|
566 | # NB : This directive is MANDATORY, there's no default value when not set. |
---|
567 | # |
---|
568 | # Supported values : |
---|
569 | # |
---|
570 | # - software([/path/to/some/script[ --with-args]]) |
---|
571 | # - hardware(snmp[:community]|pjl[:port]|/path/to/some/script[ --with-args]) |
---|
572 | # |
---|
573 | # Hardware asks the printer for its lifetime page counter through either |
---|
574 | # SNMP, PJL-over-TCP, or through any command of your choice. This is |
---|
575 | # the recommended way to use PyKota, although it might not work with some |
---|
576 | # printers. The page counter is asked twice per job : before the job |
---|
577 | # is sent to the printer, and after it has been entirely sent. |
---|
578 | # The big advantages of hardware accounting are lighter CPU usage compared |
---|
579 | # to software accounting described below, although it can take more time |
---|
580 | # because of necessary internal counter stabilization delays, and the fact |
---|
581 | # that paper jams don't cause users to be charged for pages they couldn't |
---|
582 | # print. |
---|
583 | # For hardware accounting, two special values are accepted in addition |
---|
584 | # to a script name : snmp and pjl. 'snmp' asks PyKota to use its internal |
---|
585 | # SNMP code, 'pjl' asks PyKota to internally send a specially crafter PJL |
---|
586 | # job to the printer's TCP port 9100 (by default). |
---|
587 | # |
---|
588 | # Software counts pages by parsing the print job's datas, either internally |
---|
589 | # when no script is specified, or through any script of your choice. |
---|
590 | # This works with ALL printers, provided you've got a script to parse |
---|
591 | # datas produced by your printer driver. PyKota's internal parser, also |
---|
592 | # available under the name 'pkpgcounter', recognizes several page description |
---|
593 | # languages, but may occasionally fail for some printer drivers. |
---|
594 | # You can however use any other command, provided it can read the datas to |
---|
595 | # parse from its standard input, and prints a single integer on its standard |
---|
596 | # output, representing the number of pages in the print job. |
---|
597 | # Software accounting unfortunately may overcharge users in case of paper |
---|
598 | # jams. |
---|
599 | # |
---|
600 | # Ink computes the price of a print job by parsing the job's datas |
---|
601 | # through pkpgcounter, and using the percents of ink coverage returned |
---|
602 | # for each color in the specified colorspace. |
---|
603 | |
---|
604 | # Supported colorspaces for ink accounting currently are : |
---|
605 | # |
---|
606 | # bw ===> Black & White |
---|
607 | # cmyk ===> Cyan, Magenta, Yellow, Black |
---|
608 | # cmy ===> Cyan, Magenta, Yellow |
---|
609 | # rgb ===> Red, Green, Blue |
---|
610 | # gc ===> Grayscale, Colored : this is a pseudo colorspace useful |
---|
611 | # if all you need is differentiating grayscale from |
---|
612 | # colored pages. |
---|
613 | # |
---|
614 | # Supported resolutions for ink accounting are any number of dots |
---|
615 | # per inch comprised between 72 and 1200. |
---|
616 | # IMPORTANT : increasing the resolution increases precision, but |
---|
617 | # increase CPU load a lot at the same time. The default resolution |
---|
618 | # if unset is 72, for 72 dpi. |
---|
619 | # If you want to use ink accounting, you have to define a set of |
---|
620 | # coefficients for each color in the colorspace, as explained |
---|
621 | # further below in this file. |
---|
622 | # |
---|
623 | # You can get hints on which configuration is best for your printers by |
---|
624 | # typing : pkturnkey --doconf |
---|
625 | # |
---|
626 | # In the lines below "%(printer)s" is automatically replaced at run time |
---|
627 | # with your printer's Fully Qualified Domain Name for network printers, |
---|
628 | # if PyKota can extract it from its environment. |
---|
629 | # |
---|
630 | # Examples : |
---|
631 | # |
---|
632 | # accounter : hardware(snmp) |
---|
633 | # accounter : hardware(snmp:private) |
---|
634 | # accounter : hardware(pjl) |
---|
635 | # accounter : hardware(pjl:9101) |
---|
636 | # 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 " ") |
---|
637 | # accounter : hardware(/usr/bin/npadmin --pagecount %(printer)s) |
---|
638 | # 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) |
---|
639 | # accounter : hardware(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1) |
---|
640 | # 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) |
---|
641 | # 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) |
---|
642 | # accounter : software(/usr/bin/pkpgcounter) |
---|
643 | # accounter : software() |
---|
644 | # accounter : ink(cmyk, 150) |
---|
645 | # accounter : ink(bw, 300) |
---|
646 | # accounter : ink(bw) |
---|
647 | # accounter : ink(cmy, 72) |
---|
648 | # accounter : ink(gc, 72) |
---|
649 | # |
---|
650 | # This directive can be set either globally or per printer or both. |
---|
651 | # If both are defined, the printer option has priority. |
---|
652 | # |
---|
653 | # IF YOU PLAN TO USE YOUR OWN SCRIPTS FOR HARDWARE ACCOUNTING, |
---|
654 | # YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE |
---|
655 | # PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER. |
---|
656 | # |
---|
657 | # PYKOTA'S 'snmp' and 'pjl' HARDWARE ACCOUNTING METHODS DO THE CORRECT WORK |
---|
658 | # INTERNALLY, BUT SOME OF THE EXAMPLES ABOVE DON'T, YOU HAVE BEEN WARNED. |
---|
659 | # |
---|
660 | # WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA |
---|
661 | # TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE |
---|
662 | # TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU, |
---|
663 | # AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE |
---|
664 | # YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS. |
---|
665 | # |
---|
666 | # Sane default : |
---|
667 | # |
---|
668 | accounter: software() |
---|
669 | |
---|
670 | |
---|
671 | |
---|
672 | # What is the "pre"-accounter used for precomputing the job's size. |
---|
673 | # |
---|
674 | # Supported values are : |
---|
675 | # |
---|
676 | # preaccounter: software() |
---|
677 | # preaccounter: software(/path/to/your/script) |
---|
678 | # preaccounter: ink(colorspace, resolution) |
---|
679 | # |
---|
680 | # NB : the preaccounter directive doesn't support hardware() for obvious |
---|
681 | # reasons. If unset, "software()" is assumed. If you use your own script, |
---|
682 | # ensure that it only prints the job's number of pages (or an estimation |
---|
683 | # of it) on its standard output. |
---|
684 | # |
---|
685 | # You may want to define for example 'preaccounter : software(/bin/echo 1)' |
---|
686 | # in the case your printer supports an hardware accounter but pkpgcounter |
---|
687 | # can't parse your printer driver's datas. |
---|
688 | # |
---|
689 | # Supported colorspaces for ink accounting currently are : |
---|
690 | # |
---|
691 | # bw ===> Black & White |
---|
692 | # cmyk ===> Cyan, Magenta, Yellow, Black |
---|
693 | # cmy ===> Cyan, Magenta, Yellow |
---|
694 | # rgb ===> Red, Green, Blue |
---|
695 | # gc ===> Grayscale, Colored : this is a pseudo colorspace useful |
---|
696 | # if all you need is differentiating grayscale from |
---|
697 | # colored pages. |
---|
698 | # |
---|
699 | # Supported resolutions for ink accounting are any number of dots |
---|
700 | # per inch comprised between 72 and 1200. |
---|
701 | # IMPORTANT : increasing the resolution increases precision, but |
---|
702 | # increase CPU load a lot at the same time. The default resolution |
---|
703 | # if unset is 72, for 72 dpi. |
---|
704 | # |
---|
705 | # This value can be set either globally or on a per printer basis |
---|
706 | # If both are defined, the printer option has priority. |
---|
707 | # |
---|
708 | # Sane default : |
---|
709 | # |
---|
710 | preaccounter: software() |
---|
711 | |
---|
712 | |
---|
713 | |
---|
714 | # What should we do if the accounter's subprocess doesn't return |
---|
715 | # a valid result (for example doesn't return an integer on its stdout) |
---|
716 | # |
---|
717 | # Valid values are : 'continue' and 'stop'. 'stop' is the default |
---|
718 | # if unset. |
---|
719 | # |
---|
720 | # 'continue' means try to process as usual, this may introduce |
---|
721 | # accounting errors and free jobs. This was the default behavior |
---|
722 | # until v1.20alpha5. |
---|
723 | # |
---|
724 | # 'stop' means fail and stop the print queue. If an accounter |
---|
725 | # error occurs, most of the time this is a misconfiguration, so |
---|
726 | # stopping the print queue is usually the better thing to do |
---|
727 | # until the admin has fixed the configuration. |
---|
728 | # |
---|
729 | # This value can be set either globally or on a per printer basis |
---|
730 | # If both are defined, the printer option has priority. |
---|
731 | # |
---|
732 | # NB : This directive shouldn't do much now because in case |
---|
733 | # of external accounter error, PyKota just loops. |
---|
734 | # |
---|
735 | # onaccountererror: continue |
---|
736 | onaccountererror: stop |
---|
737 | |
---|
738 | |
---|
739 | |
---|
740 | # Print Quota administrator |
---|
741 | # These values can be set either globally or per printer or both. |
---|
742 | # If both are defined, the printer option has priority. |
---|
743 | # If these values are not set, the default admin root |
---|
744 | # and the default adminmail root@localhost are used. |
---|
745 | admin: John Doe |
---|
746 | adminmail: root@localhost |
---|
747 | |
---|
748 | |
---|
749 | |
---|
750 | # Who should we send an email to in case a quota is reached ? |
---|
751 | # possible values are : DevNull, User, Admin, Both, External(some command) |
---|
752 | # The Both value means that the User and the Admin will receive |
---|
753 | # an email message. |
---|
754 | # The DevNull value means no email message will be sent. |
---|
755 | # This value can be set either globally or per printer or both. |
---|
756 | # If both are defined, the printer option has priority. |
---|
757 | # If the value is not set, then the default BOTH applies. |
---|
758 | # |
---|
759 | # Format of the external syntax : |
---|
760 | # |
---|
761 | # mailto: external(/usr/bin/mycommand >/dev/null) |
---|
762 | # |
---|
763 | # You can use : |
---|
764 | # |
---|
765 | # '%(action)s' will contain either WARN or DENY |
---|
766 | # '%(username)s' will contain the user's name |
---|
767 | # '%(printername)s' will contain the printer's name |
---|
768 | # '%(email)s' will contain the user's email address |
---|
769 | # '%(message)s' will contain the message if you want |
---|
770 | # to use it. |
---|
771 | # |
---|
772 | # on your command line, to pass arguments to your command. |
---|
773 | # Examples : |
---|
774 | # |
---|
775 | # mailto: external(/usr/bin/callpager %(username)s "Quota problem on %(printername)s" >/dev/null) |
---|
776 | # |
---|
777 | # To automatically send a WinPopup message (this may only work with a PDC, |
---|
778 | # here the same machine does Samba as PDC + CUPS) : |
---|
779 | # |
---|
780 | # 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) |
---|
781 | # |
---|
782 | # NB : I use ISO-8859-15, but Windows expects UTF-8, so we pipe the message |
---|
783 | # into iconv before sending it to the Windows user. |
---|
784 | # |
---|
785 | # or more simply : |
---|
786 | # |
---|
787 | # mailto: external(/usr/share/pykota/mailandpopup.sh %(username)s %(printername)s "%(email)s" "%(message)s" 2>&1 >/dev/null) |
---|
788 | # |
---|
789 | # NB : The mailandpopup.sh shell script is now included in PyKota |
---|
790 | # |
---|
791 | # NB : in ANY case, don't forget to redirect your command's standard output |
---|
792 | # somewhere (e.g. >/dev/null) so that there's no perturbation to the |
---|
793 | # underlying layer (filter or backend) |
---|
794 | # |
---|
795 | mailto : both |
---|
796 | |
---|
797 | |
---|
798 | |
---|
799 | # The value of the zero for account balance limitations. |
---|
800 | # If an user his limited by balance, he can print until |
---|
801 | # his balance reaches the value defined here. If unset, |
---|
802 | # the default value is 0. Any floating point value |
---|
803 | # is accepted. |
---|
804 | # You'll want to use this to give free credits to your users |
---|
805 | # at the start of the year for example. |
---|
806 | # |
---|
807 | # This option can only appear in the global section |
---|
808 | # |
---|
809 | # balancezero : -0.25 |
---|
810 | # |
---|
811 | balancezero: 0.0 |
---|
812 | |
---|
813 | |
---|
814 | |
---|
815 | # Grace delay in days |
---|
816 | # This value can be set either globally or per printer or both. |
---|
817 | # If both are defined, the printer option has priority. |
---|
818 | # If the value is not set then the default seven (7) days applies. |
---|
819 | # |
---|
820 | gracedelay : 7 |
---|
821 | |
---|
822 | |
---|
823 | |
---|
824 | # Poor man's threshold |
---|
825 | # If account balance reaches below this amount, a warning message |
---|
826 | # is sent through the 'mailto' directive above. |
---|
827 | # |
---|
828 | # If unset, default poor man's threshold is 1.0. |
---|
829 | # This option can only appear in the global section |
---|
830 | # |
---|
831 | poorman : 1.0 |
---|
832 | |
---|
833 | |
---|
834 | |
---|
835 | # Poor man's warning message |
---|
836 | # The warning message that is sent if the "poorman" value is reached |
---|
837 | # Again this must appear in the global section |
---|
838 | # |
---|
839 | poorwarn : Your Print Quota account balance is low. |
---|
840 | Soon you'll not be allowed to print anymore. |
---|
841 | |
---|
842 | |
---|
843 | |
---|
844 | # Soft limit reached warning message |
---|
845 | # The warning message that is sent if the soft quota limit is reached |
---|
846 | # May appear either globally or on a per-printer basis |
---|
847 | # |
---|
848 | softwarn: Your Print Quota Soft Limit is reached. |
---|
849 | This means that you may still be allowed to print for some |
---|
850 | time, but you must contact your administrator to purchase |
---|
851 | more print quota. |
---|
852 | |
---|
853 | |
---|
854 | |
---|
855 | # Hard limit reached error message |
---|
856 | # The error message that is sent if the hard quota limit is reached |
---|
857 | # May appear either globally or on a per-printer basis |
---|
858 | # |
---|
859 | hardwarn: Your Print Quota Hard Limit is reached. |
---|
860 | This means that you are not allowed to print anymore. |
---|
861 | Please contact your administrator at root@localhost |
---|
862 | as soon as possible to solve the problem. |
---|
863 | |
---|
864 | |
---|
865 | |
---|
866 | # Default policy to apply when either : |
---|
867 | # |
---|
868 | # - Printer doesn't exist in PyKota's database |
---|
869 | # - User doesn't exist in PyKota's database |
---|
870 | # - User has no quota entry for this Printer in PyKota's database |
---|
871 | # |
---|
872 | # Value can be either allow or deny or external(some command here) |
---|
873 | # |
---|
874 | # This value can be set either globally or per printer or both. |
---|
875 | # If both are defined, the printer option has priority. |
---|
876 | # If the value is not set then the default policy DENY applies. |
---|
877 | # There's no policy wrt inexistant groups, they are ignored. |
---|
878 | # |
---|
879 | # external policy can be used to launch any external command of your choice, |
---|
880 | # for example to automatically add the user to the quota database, and set |
---|
881 | # page limits on the current printer if he is unknown : |
---|
882 | # |
---|
883 | # policy: external(/usr/bin/pkusers --add --skipexisting %(username)s && /usr/bin/edpykota --add --skipexisting --printer %(printername)s --softlimit 50 --hardlimit 60 %(username)s) |
---|
884 | # |
---|
885 | # NB : If you want to limit users by their account balance value, it is preferable to |
---|
886 | # use the following policy to automate user account creation on first print : |
---|
887 | # |
---|
888 | # policy: external(/usr/bin/autopykota --initbalance 25.0) |
---|
889 | # |
---|
890 | # This will automatically add the user if he doesn't already exist, and |
---|
891 | # set his initial balance value to 25.0 (for example). If the user already |
---|
892 | # exists then his balance value will not be modified. |
---|
893 | # Please don't use autopykota if you want to limit your users by page |
---|
894 | # quota, and in any case, carefully read autopykota's help or manpage |
---|
895 | # and understand its goal before using it in your own configuration. |
---|
896 | # |
---|
897 | # Of course you can launch any command of your choice with this, e.g. : |
---|
898 | # |
---|
899 | # policy: external(/usr/local/bin/myadminscript.sh %(username)s) |
---|
900 | # |
---|
901 | # You can use : |
---|
902 | # |
---|
903 | # '%(username)s' will contain the user's name |
---|
904 | # '%(printername)s' will contain the printer's name |
---|
905 | # |
---|
906 | # On your command line, to pass arguments to your command. |
---|
907 | # |
---|
908 | # If the printer, user, or user quota entry still doesn't exist after |
---|
909 | # external policy command was launched (the external command didn't add it), |
---|
910 | # or if an error occured during the execution of the external policy |
---|
911 | # command, then the job is rejected. |
---|
912 | # |
---|
913 | # By default, we reject all jobs from users not in the database : |
---|
914 | # |
---|
915 | policy: deny |
---|
916 | |
---|
917 | |
---|
918 | |
---|
919 | # Pre and Post Hooks |
---|
920 | # These directives allow the easy plug-in of any command of your choice |
---|
921 | # at different phases of PyKota's execution. |
---|
922 | # Pre and Post Hooks can access some of PyKota's internal information |
---|
923 | # by reading environment variables as described below. |
---|
924 | # The actual phase of PyKota's execution is available in the |
---|
925 | # PYKOTAPHASE environment variable. |
---|
926 | # Pre and Post Hooks can be defined either globally, per printer, |
---|
927 | # or both. If both are defined, the printer specific hook has |
---|
928 | # priority. |
---|
929 | # |
---|
930 | # List of available environment variables : |
---|
931 | # NB : Most of these variables are also available during the execution |
---|
932 | # of external commands defined in the accounter and mailto |
---|
933 | # directives. |
---|
934 | # |
---|
935 | # PYKOTADIRECTORY : The directory containing cupspykota's temporary files |
---|
936 | # PYKOTADATAFILE : The name of the temporary file which contains the |
---|
937 | # job's datas |
---|
938 | # PYKOTAFILENAME : The name of the file which contains the job's datas or |
---|
939 | # empty if datas come from stdin |
---|
940 | # PYKOTACONTROLFILE : The name of the IPP message file |
---|
941 | # PYKOTAMD5SUM : Contains an hexadecimal digest of the md5 sum of the job's datas |
---|
942 | # PYKOTAPHASE : BEFORE or AFTER the job is sent to the printer |
---|
943 | # PYKOTAACTION : ALLOW or DENY or WARN for current print job |
---|
944 | # PYKOTAUSERNAME : user's name, possibly modified through the overwrite_jobticket directive. |
---|
945 | # PYKOTAORIGINALUSERNAME : user's name, unmodified. |
---|
946 | # PYKOTAPRINTERNAME : printer's name |
---|
947 | # PYKOTAPGROUPS : list of printers groups the current printer is a member of |
---|
948 | # PYKOTAJOBID : job's id |
---|
949 | # PYKOTATITLE : job's title |
---|
950 | # PYKOTACOPIES : number of copies |
---|
951 | # PYKOTAOPTIONS : job's options |
---|
952 | # PYKOTABALANCE : user's account balance |
---|
953 | # PYKOTALIFETIMEPAID : user's grand total paid |
---|
954 | # PYKOTALIMITBY : user print limiting factor, for example 'quota' or 'balance' |
---|
955 | # PYKOTAPAGECOUNTER : user's page counter on this printer |
---|
956 | # PYKOTALIFEPAGECOUNTER : user's life time page counter on this printer |
---|
957 | # PYKOTASOFTLIMIT : user's soft page limit on this printer |
---|
958 | # PYKOTAHARDLIMIT : user's hard page limit on this printer |
---|
959 | # PYKOTADATELIMIT : user's soft to hard limit date limit on this printer |
---|
960 | # PYKOTASTATUS : contains "CANCELLED" when SIGTERM was received by PyKota |
---|
961 | # else is not set. |
---|
962 | # PYKOTAJOBSIZEBYTES : contains the job's size in bytes. Always available. |
---|
963 | # PYKOTAPRECOMPUTEDJOBSIZE : contains the precomputed job's size |
---|
964 | # PYKOTAPRECOMPUTEDJOBPRICE : contains the precomputed job's price |
---|
965 | # PYKOTAJOBORIGINATINGHOSTNAME : contains the client's hostname if |
---|
966 | # it is possible to retrieve it. |
---|
967 | # PYKOTAPRINTERHOSTNAME : the printer's hostname or IP address for network |
---|
968 | # printers, or "localhost" if not defined or not |
---|
969 | # meaningful. |
---|
970 | # PYKOTAWARNCOUNT : the number of times the user was forbidden to print but a banner |
---|
971 | # page was still printed on the current printer. |
---|
972 | # PYKOTAOVERCHARGE : user's overcharging factor. |
---|
973 | # PYKOTAJOBBILLING : Job's billing code if present, possibly modified through the overwrite_jobticket directive. |
---|
974 | # PYKOTAORIGINALJOBBILLING : Job's billing code if present, unmodified. |
---|
975 | # PYKOTAREASON : if the job was denied or a warning needs to be issued, contains |
---|
976 | # the message to send to the user. |
---|
977 | # PYKOTAUSERDESCRIPTION : the user's textual description |
---|
978 | # PYKOTAPRINTERDESCRIPTION : the printer's textual description |
---|
979 | # PYKOTAPRINTERPASSTHROUGHMODE : the printer's passthrough mode |
---|
980 | # PYKOTAPRINTERMAXJOBSIZE : the printer's maximal job size |
---|
981 | # PYKOTAPRICEPERJOB : the printer's price per job |
---|
982 | # PYKOTAPRICEPERPAGE : the printer's price per page |
---|
983 | # |
---|
984 | |
---|
985 | |
---|
986 | # PreHook : gets executed after being sure the user, printer and user quota |
---|
987 | # entry on the printer both exist in the PyKota database, and after |
---|
988 | # checking if the user is allowed to print or not, but just before |
---|
989 | # the job is sent to the printer (if allowed) |
---|
990 | # prehook has access to many environment variables : |
---|
991 | # |
---|
992 | # PYKOTAACTION contains either "ALLOW", "WARN" or "DENY" and |
---|
993 | # represents the action which is to be done wrt the print job. |
---|
994 | # PYKOTAPHASE contains 'BEFORE' during execution of prehook |
---|
995 | # |
---|
996 | # uncomment the line below to see what environment variables are available |
---|
997 | # prehook: /usr/bin/printenv >/tmp/before |
---|
998 | |
---|
999 | |
---|
1000 | |
---|
1001 | # PostHook : gets executed after the job has been added to the history. |
---|
1002 | # posthook has access to all the environment variables defined above, |
---|
1003 | # as well as two additionnal environment variables : PYKOTAJOBPRICE |
---|
1004 | # and PYKOTAJOBSIZE. |
---|
1005 | # PYKOTAPHASE contains 'AFTER' during execution of posthook. |
---|
1006 | # |
---|
1007 | # uncomment the line below to see what environment variables are available |
---|
1008 | # posthook: /usr/bin/printenv >/tmp/after |
---|
1009 | |
---|
1010 | |
---|
1011 | |
---|
1012 | # AccountBanner : how should banner accounting be done ? |
---|
1013 | # |
---|
1014 | # If enabled, banner pages printed from StartingBanner and/or EndingBanner |
---|
1015 | # (depending on the value) will be included in the accounting for the |
---|
1016 | # print job |
---|
1017 | # |
---|
1018 | # If disabled, banner pages printed from StartingBanner and EndingBanner will |
---|
1019 | # *not* be included in the accounting for the print job |
---|
1020 | # |
---|
1021 | # IMPORTANT : CUPS generated banners are ALWAYS accounted for, although you |
---|
1022 | # can refund them by using negative prices on printers. |
---|
1023 | # |
---|
1024 | # Allowed values : Starting | Ending | None | Both |
---|
1025 | # |
---|
1026 | # - Starting : only the starting banner will be accounted for. |
---|
1027 | # - Ending : only the ending banner will be accounted for. |
---|
1028 | # - Both : both starting and ending banners will be accounted for. |
---|
1029 | # - None : banners will not be accounted for. |
---|
1030 | # |
---|
1031 | # Default value : |
---|
1032 | # accountbanner: Both |
---|
1033 | |
---|
1034 | |
---|
1035 | |
---|
1036 | # Maximal number of times the banner will still be printed if |
---|
1037 | # the user is forbidden to print. |
---|
1038 | # |
---|
1039 | # This option can be set either globally or on a per printer basis. |
---|
1040 | # Allowed values are 0 or any positive integer. |
---|
1041 | # Default value is 0, which means that the banner won't be printed |
---|
1042 | # at all if the user is forbidden to print. |
---|
1043 | # |
---|
1044 | maxdenybanners: 0 |
---|
1045 | |
---|
1046 | |
---|
1047 | |
---|
1048 | # If a job is cancelled, should any start or end banners still be printed |
---|
1049 | # |
---|
1050 | # This option can be set either globally or on a per printer basis. |
---|
1051 | # If set to yes, any defined banners will be printed |
---|
1052 | # If set to no, no banners will be printed |
---|
1053 | # |
---|
1054 | # This value defaults to yes |
---|
1055 | # printcancelledbanners: yes |
---|
1056 | |
---|
1057 | |
---|
1058 | # StartingBanner : if defined will print a banner before the rest of the job |
---|
1059 | # is printed. The argument can be a printable file, or an executable file. |
---|
1060 | # If not executable, the file will be printed as is. If executable, the |
---|
1061 | # file will be executed and its standard output will be sent to the printer. |
---|
1062 | # |
---|
1063 | # In any case, the banner content which will be sent to the printer |
---|
1064 | # MUST be in a format your printer will accept !!! |
---|
1065 | # |
---|
1066 | # The pkbanner command included in PyKota can automatically generate |
---|
1067 | # starting and ending banners in the PostScript format. You can use |
---|
1068 | # this command in a pipe through GhostScript if your printer doesn't |
---|
1069 | # accept PostScript as an input format. |
---|
1070 | # NB : pkbanner's default page size is A4 |
---|
1071 | # |
---|
1072 | # startingbanner: /home/joe/mystaticbanner.ps |
---|
1073 | # startingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
1074 | # startingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
1075 | # startingbanner: /usr/bin/pkbanner |
---|
1076 | |
---|
1077 | |
---|
1078 | |
---|
1079 | # EndingBanner : if defined will print a banner after the job |
---|
1080 | # has been printed. The argument can be a printable file, or an executable file. |
---|
1081 | # If not executable, the file will be printed as is. If executable, the |
---|
1082 | # file will be executed and its standard output will be sent to the printer. |
---|
1083 | # |
---|
1084 | # In any case, the banner content which will be sent to the printer |
---|
1085 | # MUST be in a format your printer will accept !!! |
---|
1086 | # |
---|
1087 | # The pkbanner command included in PyKota can automatically generate |
---|
1088 | # starting and ending banners in the PostScript format. You can use |
---|
1089 | # this command in a pipe through GhostScript if your printer doesn't |
---|
1090 | # accept PostScript as an input format. |
---|
1091 | # NB : pkbanner's default page size is A4 |
---|
1092 | # |
---|
1093 | # A static banner page |
---|
1094 | # endingbanner: /home/joe/mystaticbanner.ps |
---|
1095 | # |
---|
1096 | # A banner with personnalized logo and url |
---|
1097 | # endingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
1098 | # |
---|
1099 | # A banner in the format accepted by the printer |
---|
1100 | # endingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
1101 | # |
---|
1102 | # A banner with more info on it, extracted from the yellow pages. |
---|
1103 | # the string "Phone 111222333444" will be added to the banner page |
---|
1104 | # if extractphone.sh returns 111222333444 for the current user. |
---|
1105 | # endingbanner: /usr/bin/pkbanner Phone `extractphone.sh $PYKOTAUSERNAME` |
---|
1106 | # |
---|
1107 | # Default PyKota banner |
---|
1108 | # endingbanner: /usr/bin/pkbanner |
---|
1109 | |
---|
1110 | |
---|
1111 | |
---|
1112 | # How should enforcement be done for this printer ? |
---|
1113 | # |
---|
1114 | # "laxist" is the default if value is not set, and allows users |
---|
1115 | # to be over quota on their last job. |
---|
1116 | # |
---|
1117 | # "strict" tries to prevent users from ever being over quota. |
---|
1118 | # |
---|
1119 | # Enforcement can be defined either globally, per printer, |
---|
1120 | # or both. If both are defined, the printer specific enforcement |
---|
1121 | # setting has priority. |
---|
1122 | # |
---|
1123 | # valid values : "strict" or "laxist" |
---|
1124 | # |
---|
1125 | # default value when not set is "laxist" |
---|
1126 | # |
---|
1127 | # enforcement : laxist |
---|
1128 | enforcement : strict |
---|
1129 | |
---|
1130 | |
---|
1131 | |
---|
1132 | # Should we trust the job size on this printer ? |
---|
1133 | # |
---|
1134 | # "trustjobsize : yes" is the default, the jobsize, either computed |
---|
1135 | # by the hardware or by software is trusted. |
---|
1136 | # |
---|
1137 | # "trustjobsize : >N:precomputed" : uses the precomputed value |
---|
1138 | # if jobsize > N pages |
---|
1139 | # "trustjobsize : >N:25" : uses 25 if jobsize is >N pages |
---|
1140 | # |
---|
1141 | # General form : ">n:m" where n is a positive integer, and m is |
---|
1142 | # either the word 'precomputed' or a positive integer. |
---|
1143 | # The special form "yes" is also accepted and is the default. |
---|
1144 | # |
---|
1145 | # This directive can be set either globally or on a per printer |
---|
1146 | # basis. Use this directive when hardware accounting for a particular |
---|
1147 | # printer produces some glitches due to the printer returning |
---|
1148 | # incorrect answers. |
---|
1149 | # |
---|
1150 | # NB : DON'T MODIFY THIS IF YOU DON'T NEED TO. THIS IS ONLY TO BE USED |
---|
1151 | # AS A WORKAROUND FOR SOME PRINTERS. IT'S PROBABLY BETTER TO ALWAYS |
---|
1152 | # SET THIS DIRECTIVE TO 'yes'. THIS DIRECTIVE WILL ONLY BE HONORED |
---|
1153 | # IF PYKOTA DETECTS A DIFFERENCE BETWEEN THE PRECOMPUTED JOB SIZE |
---|
1154 | # AND THE JOB SIZE AS COMPUTED BY PYKOTA EITHER USING HARDWARE OR |
---|
1155 | # SOFTWARE. |
---|
1156 | # |
---|
1157 | trustjobsize : yes |
---|
1158 | |
---|
1159 | |
---|
1160 | |
---|
1161 | # Should we deny duplicate jobs ? |
---|
1162 | # |
---|
1163 | # A duplicate is a job sent twice (or more) in a row to the same printer |
---|
1164 | # by the same user. |
---|
1165 | # |
---|
1166 | # This can be defined either globally or on a per printer basis |
---|
1167 | # The default value is 'no', meaning that duplicate jobs are |
---|
1168 | # allowed. |
---|
1169 | # |
---|
1170 | # NB : if an user prints a job, a second user prints another |
---|
1171 | # job, and the first user prints the first job again, |
---|
1172 | # this is NOT considered as a duplicate since the two |
---|
1173 | # identical jobs printed by the first user are not |
---|
1174 | # one just after the other. |
---|
1175 | # |
---|
1176 | # Possible values are 'yes', 'no', or any other string. |
---|
1177 | # If the string is not recognized as a truth value, |
---|
1178 | # it is considered to be a command to launch. |
---|
1179 | # PyKota launches the command and parses its standard |
---|
1180 | # output. The special keywords 'ALLOW' and 'DENY' are |
---|
1181 | # recognized, allowing an external tool to decide if |
---|
1182 | # the job is to be allowed or denied. |
---|
1183 | # |
---|
1184 | # denyduplicates : /usr/bin/myowncommand with some arguments |
---|
1185 | # denyduplicates : yes |
---|
1186 | denyduplicates : no |
---|
1187 | |
---|
1188 | |
---|
1189 | |
---|
1190 | # Sets the delay in seconds after which two identical jobs are |
---|
1191 | # not considered as being a duplicate. |
---|
1192 | # |
---|
1193 | # This can be defined either globally or on a per printer basis |
---|
1194 | # The default value if not set is 0, for 0 seconds. |
---|
1195 | # duplicatesdelay : 300 |
---|
1196 | duplicatesdelay : 0 |
---|
1197 | |
---|
1198 | |
---|
1199 | |
---|
1200 | # Sets the maximum number of seconds to wait for the printer |
---|
1201 | # being in 'printing' mode once the job has been sent to it. |
---|
1202 | # Once this delay is expired, PyKota will consider this job |
---|
1203 | # will never be printed, aborts the hardware accounting |
---|
1204 | # process, and uses the latest internal page counter value seen. |
---|
1205 | # |
---|
1206 | # Increasing this value, or setting it to 0, may help with some |
---|
1207 | # printers which don't conform to RFC3805. Problem reported on a |
---|
1208 | # Samsung ML2551n gave a way for clever students to bypass |
---|
1209 | # hardware accounting entirely by removing the paper from |
---|
1210 | # the paper tray before the job had begun to print, then |
---|
1211 | # waiting 60 seconds, and putting the paper back in the tray... |
---|
1212 | # |
---|
1213 | # IMPORTANT : always ensure that your printers' firmware is up |
---|
1214 | # to date. |
---|
1215 | # |
---|
1216 | # This directive can be set either globally or on a per printer |
---|
1217 | # basis. |
---|
1218 | # |
---|
1219 | # When not set, an hardcoded value of 60 seconds is used. |
---|
1220 | # When set to 0, PyKota will wait indefinitely until the |
---|
1221 | # printer switches to the 'printing' status. |
---|
1222 | noprintingmaxdelay : 60 |
---|
1223 | |
---|
1224 | |
---|
1225 | |
---|
1226 | # Defines a set of coefficients for ink accounting. |
---|
1227 | # |
---|
1228 | # Each ink coefficient is the factor of the price per page |
---|
1229 | # you set with pkprinters which would represent the cost |
---|
1230 | # of a page covered at 100% with ink in this particular color. |
---|
1231 | # |
---|
1232 | # With these coefficients, the exact cost of each page |
---|
1233 | # can be computed : for each ink color in the colorspace specified |
---|
1234 | # in the preaccounter and/or accounter directives, we multiply the |
---|
1235 | # base cost per page set with pkprinters by this ink color's coefficient |
---|
1236 | # and by the percent of that page covered with such ink. Then we |
---|
1237 | # sum the values, and repeat the operation for each page. We then |
---|
1238 | # add the base cost per job set with pkprinters, and repeat |
---|
1239 | # the operation recursively in case of nested printers groups. |
---|
1240 | # |
---|
1241 | # The names of the coefficients you should set depend on the colorspace |
---|
1242 | # you want to use for ink accounting : |
---|
1243 | # |
---|
1244 | # cmyk : |
---|
1245 | # coefficient_cyan |
---|
1246 | # coefficient_magenta |
---|
1247 | # coefficient_yellow |
---|
1248 | # coefficient_black |
---|
1249 | # |
---|
1250 | # cmy : |
---|
1251 | # coefficient_cyan |
---|
1252 | # coefficient_magenta |
---|
1253 | # coefficient_yellow |
---|
1254 | # |
---|
1255 | # rgb : |
---|
1256 | # coefficient_red |
---|
1257 | # coefficient_green |
---|
1258 | # coefficient_blue |
---|
1259 | # |
---|
1260 | # bw : |
---|
1261 | # coefficient_black |
---|
1262 | # |
---|
1263 | # gc : |
---|
1264 | # coefficient_grayscale |
---|
1265 | # coefficient_colored |
---|
1266 | # |
---|
1267 | # Any coefficient which is not set is considered to be equal to 1.0 |
---|
1268 | # |
---|
1269 | # Coefficients can be set either in the [global] section or in any |
---|
1270 | # [printqueuename] section. The latter taking precedence, as always. |
---|
1271 | # |
---|
1272 | #coefficient_cyan : 1.2 |
---|
1273 | #coefficient_magenta : 3 |
---|
1274 | #coefficient_yellow : 1.1 |
---|
1275 | #coefficient_black : 1.0 |
---|