root / pykota / trunk / conf / pykota.conf.sample @ 2467

Revision 2445, 37.5 kB (checked in by jerome, 19 years ago)

Removed undefined environment variable

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
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 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[global]
49# Storage backend for quotas
50# only PGStorage (PostgreSQL) and LDAPStorage (OpenLDAP) are supported.
51# MySQL and BerkeleyDB are planned.
52
53# the 'postgresql' value is deprecated, use 'pgstorage' instead.
54storagebackend: pgstorage
55
56# Quota Storage Server hostname (and optional port)
57# e.g. db.example.com:5432
58storageserver: localhost
59
60#
61# name of the Quota Storage Database
62storagename: pykota
63
64#
65# Quota Storage normal user's name and password
66# These two fields contain a username and optional password
67# which may give readonly access to your print quota database.
68#
69# PLEASE ENSURE THAT THIS USER CAN'T WRITE TO YOUR PRINT QUOTA
70# DATABASE, OTHERWISE ANY USER WHO COULD READ THIS CONFIGURATION
71# FILE COULD CHANGE HIS PRINT QUOTA.
72#
73storageuser: pykotauser
74# storageuserpw: Comment out if unused, or set to Quota Storage user password
75
76# Should the database caching mechanism be enabled or not ?
77# If unset, caching is disabled. Possible values Y/N/YES/NO
78# caching mechanism works with both PostgreSQL and OpenLDAP backends
79# but may be really interesting only with OpenLDAP.
80#
81# ACTIVATING CACHE MAY CAUSE PRECISION PROBLEMS IN PRINT ACCOUNTING
82# IF AN USER PRINTS ON SEVERAL PRINTERS AT THE SAME TIME.
83# YOU MAY FIND IT INTERESTING ANYWAY, ESPECIALLY FOR LDAP.
84#
85# FYI, I ALWAYS SET IT TO YES !
86#
87storagecaching: No
88
89# Should full job history be disabled ?
90# If unset or set to No, full job history is kept in the database.
91# This will be useful in the future when the report generator
92# will be written.
93# Disabling the job history can be useful with heavily loaded
94# LDAP servers, to not make the LDAP tree grow out of control.
95# Disabling the job history with the PostgreSQL backend works too
96# but it's probably less useful than with LDAP.
97disablehistory: No
98
99# LDAP example, uncomment and adapt it to your own configuration :
100#storagebackend: ldapstorage
101#storageserver: ldap://ldap.example.com:389
102#storagename: dc=example,dc=com
103#storageuser: cn=notadmin,dc=example,dc=com
104#storageuserpw: abc.123
105#
106# TLS support for LDAP
107#
108# ldaptls can be set to either Yes or No
109# the default value when not set is No, meaning that TLS won't be used.
110#ldaptls: No
111#
112# cacert points to the CA Certificate file to use for TLS.
113# Ensure that every user who can launch PyKota commands can read this file.
114# There's NO default value for this directive.
115#cacert: /etc/pykota/mycertfile
116#
117#
118# Here we define some helpers to know where
119# to plug into an existing LDAP directory
120#userbase: ou=People,dc=example,dc=com
121#userrdn: uid
122#balancebase: ou=People,dc=example,dc=com
123#balancerdn: uid
124#groupbase: ou=Groups,dc=example,dc=com
125#grouprdn: cn
126#printerbase: ou=Printers,ou=PyKota,dc=example,dc=com
127#printerrdn: cn
128#jobbase: ou=Jobs,ou=PyKota,dc=example,dc=com
129#lastjobbase: ou=LastJobs,ou=PyKota,dc=example,dc=com
130#billingcodebase: ou=BillingCodes,ou=PyKota,dc=example,dc=com
131
132# These two fields are special, they either accept a branch
133# dn, like an ou for example, or the special keywords 'user'
134# and 'group'. If 'user' or 'group' is used, the print quota
135# entries will be created below the user or group entry itself,
136# which will then be used like a branch (you can mix and match
137# different values depending on what you want to do).
138#userquotabase: user
139#userquotabase: ou=UQuotas,ou=PyKota,dc=example,dc=com
140#groupquotabase: group
141#groupquotabase: ou=GQuotas,ou=PyKota,dc=example,dc=com
142
143#
144# How to create new accounts and groups
145# authorized values are "below" and "attach(objectclass name [, fail|warn])"
146#
147# "below" creates the new accounts/groups as standalone entries
148# below the above defined 'userbase' ou
149#
150# attach(objectclass name [, action]) tries to find some existing user/group
151# using the above defined 'userrdn' or 'grouprdn' and 'userbase'
152# 'groupbase', and attach the PyKota specific entries to it.
153# if action is "warn" and no entry exists to attach to, a new
154# entry is created, and a message is logged.
155# if action is "fail" and no entry exists to attach to, program
156# logs an error message and aborts.
157# if action is not set, the default value is "fail".
158#
159# a possible value:  newuser: attach(posixAccount, warn)
160#newuser : below
161#newgroup : below
162#
163# LDAP attribute which stores the user's email address
164#usermail : mail
165
166#
167# Choose what attribute contains the list of group members
168# common values are : memberUid, uniqueMember, member
169#groupmembers: memberUid
170
171# Activate low-level LDAP cache yes/no
172# Nothing to do with "storagecaching" which is higher level
173# and database independant.
174# This saves some search queries and may help with heavily
175# loaded LDAP servers.
176# This is EXPERIMENTAL.
177#
178# BEWARE : SETTING THIS TO 'YES' CAUSES PROBLEMS FOR NOW
179# BETTER TO LET IT SET TO 'NO'
180# ldapcache: no
181
182# Where to log ?
183# supported values : stderr, system (system means syslog, but don't use 'syslog' here)
184# if the value is not set then the default SYSTEM applies.
185logger: system
186
187# Enable debugging ? Put YES or NO there.
188# debug is set to yes in this sample
189# configuration file, so debugging is activated
190# when configuring PyKota. After all works, just
191# put NO instead to save some disk space in your
192# logs.
193debug : Yes
194
195#
196# The URL to PyKota's logo when used from the CGI scripts.
197# You can use your own logo by modifying the URL below.
198# If not defined, the default URL is the same as the
199# one defined below
200logourl : http://www.librelogiciel.com/software/PyKota/pykota.png
201
202#
203# The destination to which the web browser will be redirected
204# when you click on the logo defined above.
205# If not defined, the default URL is the same as the
206# one defined below
207logolink : http://www.librelogiciel.com/software/
208
209#
210# Mail server to use to warn users
211# If the value is not set then localhost is used.
212smtpserver: localhost
213
214# Crash messages' recipient : in addition to the log files
215# each software crash can be sent to the author of PyKota
216# or any other person of your choice. By default this
217# is disabled. The recipient pykotacrashed@librelogiciel.com
218# reaches PyKota's author.
219# The 'adminmail' (defined a bit below) is CCed.
220#
221# Privacy concerns : what is sent is only :
222#
223#        - a copy of the software's traceback
224#        - a copy of the software's command line arguments
225#        - a copy of the software's environment variables
226#
227# suggested value
228# crashrecipient: pykotacrashed@librelogiciel.com
229
230# Email domain
231# If the value is not set, and the mail attribute for the user
232# is not set in the PyKota storage, be it LDAP (see usermail directive
233# above) or PostgreSQL, then email messages are sent to
234# username@smtpserver
235#
236# If the value is set, then email messages are sent to
237# username@maildomain using the SMTP server defined above
238#
239# Set the appropriate value below, example.com set as per RFC2606.
240maildomain: example.com
241
242# Should we force usernames to be all lowercase when printing ?
243# Default is No.
244# This is a global option only.
245# Some people reported that WinXP sends mixed case usernames
246# setting 'utolower: Yes' solves the problem.
247# Of course you have to use lowercase only when adding
248# users with edpykota, because ALL database accesses are
249# still case sensitive.
250#
251# If utolower is Yes, the usernames received from the printing
252# system is converted to lowercase at the start of the cupspykota
253# backend or of the lprngpykota filter.
254#
255# If utolower is No, which is the default, strict case checking
256# is done, this means that users 'Jerome' and 'jerome' are
257# different. Printer and groups names are ALWAYS case sensitive.
258utolower: No
259
260# Should we split usernames on a specific separator when printing ?
261# Default is No, i.e. if the value is unset.
262# This is a global option only.
263# This option adds support for Samba's Winbind utility, which
264# prefixes usernames with domain name and separator character.
265# Of course if you set this then you have to use NO separator when
266# adding users with edpykota.
267#
268# If winbind_separator is set, the usernames received from the printing
269# system are split on the separator's value, and only the last part
270# (real username) is used.
271#
272# If winbind_separator is not set, which is the default, strict
273# username equality checking will be done (modulo the setting
274# of the 'utolower' directive), this means that users 'DOMAIN1/jerome',
275# 'Domain2/jerome' and 'jerome' are different.
276# winbind_separator: /
277
278# When creating users or groups accounts, should we reject users
279# or groups which are unknown from the system ?
280# The default if unset is NO. This means that by default, you
281# can create users or groups for which `getent passwd username`
282# or `getent group groupname` returns nothing.
283#
284# Allowed values : Yes | No
285# Default value : No
286#
287# reject_unknown: No
288
289# Do we want to hide jobs' title, filename and options for privacy
290# reasons ?
291# This may be required in some countries (Italy comes to mind).
292# Allowed values are YES and NO.
293# If unset, the default value is NO, meaning that jobs' title, filename
294# and options will be saved into the history.
295# This option can't be set on a per printer basis, only into the
296# [global] section.
297privacy : no
298
299# Should we strip off some characters from the beginning of
300# print jobs' titles ? This can be used to remove smbprn.??????
301# which sometimes appear when printing in raw mode from Windows
302# through Samba.
303# This setting only applies at printing time.
304# When not set, titles are used as received from the printing system.
305# The default is to not strip any character off of jobs' titles.
306# This value can be set either globally or on a per printer basis
307# If both are defined, the printer option has priority.
308# striptitle : smbprn.??????
309
310# Should we launch a command to overwrite the job's ticket ?
311# This allows a command to overwrite the username and/or the
312# billing code used, or to deny the job.
313# If unset no command is launched and the job's username and
314# billing code are used as they are received.
315# To overwrite the job's ticket, the command has to print
316# on its standard output one or more of the following lines,
317# without any prefix or space character :
318#
319#    USERNAME=the_username_we_want_to_overwrite_with
320#    BILLINGCODE=the_billingcode_we_want_to_overwrite_with
321#    DENY
322#
323# NB : the output is entirely read, and the latest value
324# seen is used, so you command can output several usernames
325# or billing codes and only the latest ones will be used.
326# If only USERNAME= lines are printed, the billing code,
327# if any, is used unchanged.
328# If only BILLINGCODE= lines are printed, the username is
329# used unchanged.
330# If DENY is output, but is followed by new USERNAME= or
331# BILLINGCODE= lines, the job is not denied.
332#
333# This value can be set either globally or on a per printer basis
334# If both are defined, the printer option has priority.
335#
336# overwrite_jobticket : /path/to/some/script/or/command
337
338# What should we do when we print and the billing code used is
339# not present in the database ?
340# The default value is 'create' which adds the billing code to the
341# database.
342# Other values can be :
343#       deny
344#     which silently rejects the job.
345# or :
346#       deny(your script here)
347#     if you put the path to a script or command here, it is executed, for
348#     example you can open a popup window explaining why the job was
349#     rejected.
350#
351# This value can be set either globally or on a per printer basis
352# If both are defined, the printer option has priority.
353#
354# unknown_billingcode : create
355
356# Where should we store our (temporary) files when printing ?
357# if unset, defaults to a system directory dedicated to temporary
358# files and evaluated at runtime (see Python's documentation
359# for the tempfile.gettempdir() function).
360# This value can be set either globally or on a per printer basis
361# If both are defined, the printer option has priority.
362# On my system, when not set, the /var/spool/cups/tmp directory is used.
363# directory : /tmp
364# directory : /var/spool/cups
365
366# Should we keep our work files on disk after printing ?
367# If unset, temporary files are deleted once the work is finished.
368# If set to yes, files are kept on disk in the 'directory'
369# named with the previous directive.
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# Default value is No, meaning temporary files are deleted
373# keepfiles : yes
374keepfiles : no
375
376
377# What is the accounting backend to use
378#
379# supported values :
380#
381#    - hardware : asks the printer for its lifetime page counter
382#                 via either SNMP, AppleTalk, or any external
383#                 command. This method is the recommended one
384#                 in PyKota since its beginning.
385#
386#                 In the lines below "%(printer)s" is automatically replaced
387#                 at run time with your printer's Fully Qualified Domain Name
388#                 for network printers, if PyKota can extract it from its
389#                 environment.
390#                 e.g. myprinter.example.com
391#
392#         Recommended values :
393#
394#             accounter: hardware(snmp)
395#
396#               Extracts the printer's internal page counter via SNMP.
397#
398#         Or :
399#
400#             accounter: hardware(pjl)
401#
402#               Extracts the printer's internal page counter via PJL queries over port tcp/9100.
403#
404#         Advanced uses :
405#
406#             accounter: hardware(snmp:MyCommunity)
407#
408#               To use a different SNMP community name than the default one (which is 'public')
409#
410#             accounter: hardware(pjl:9101)
411#
412#               To use a different port than the default one (which is 9100)
413#
414#
415#         Other Examples :
416#         
417#             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 " ")
418#         
419#         Another untested example, using npadmin :
420#         
421#             accounter: hardware(/usr/bin/npadmin --pagecount %(printer)s)
422#         
423#         Another example, for AppleTalk printers which works fine :
424#         (You may need the pap CUPS backend installed, and copy the
425#         pagecount.ps file from untested/netatalk into /etc or any
426#         appropriate location)
427#         
428#             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)
429#         
430#         An example for parallel printers like the HP Laserjet 5MP :
431#         
432#             accounter: hardware(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1)
433#         
434#         This value can be set either globally or per printer or both.
435#         If both are defined, the printer option has priority.
436#         
437#         Some examples and comments provided by Bob Martel from csuohio.edu
438#         
439#         For several printers I could not get the page count using snmpget.  I
440#         resorted to snmpwalk:
441#         
442#             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)
443#         
444#         The last example is still more ugly, some of the printers only provided
445#         their counters without names, but at least always on the same line:
446#         
447#             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)
448#         
449#         An example using netcat and a preformatted PJL job which you can find
450#         in the untested/pjl directory, which is sent to a JetDirect print
451#         server on port 9100 :
452#         
453#             accounter: hardware(/bin/nc -w 2 %(printer)s 9100 </usr/share/pykota/pagecount.pjl | /usr/bin/tail -2)
454#         
455#         An example using the contributed pagecount.pl script which does
456#         the same as above, but should work on more printers :
457#         
458#             accounter: hardware(LC_ALL=C /usr/share/pykota/pagecount.pl %(printer)s 9100)
459#         
460#         NB : the LC_ALL=C is used because sometimes Perl can correctly set locale and is verbose
461#              about it, causing PyKota to miss the correct answer.
462#
463#         WARNING : In any case, when using an hardware accounter, please test the command line outside
464#                   of PyKota before. This will save you some headaches in case it doesn't work as expected.
465#         
466#         The waitprinter.sh is there to wait until the printer is idle again.
467#         This should prevent a job to be sent to the printer while another one is
468#         not yet finished (not all pages are printed, but the complete job is in
469#         the printer)
470#         
471#   YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE
472#   PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER.
473#         
474#   PYKOTA INCLUDES SUCH SCRIPTS FOR SNMP AND APPLETALK PRINTERS, MORE TO COME
475#
476#   SOME OF THE ABOVE EXAMPLES DON'T USE SUCH A SCRIPT, YOU HAVE BEEN WARNED
477#
478#
479#   WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA
480#   TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE
481#   TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU,
482#   AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE
483#   YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS.
484#         
485#
486#    - software : delegates the job's size computation to any
487#                 external command of your choice.
488#
489#                 best choice for this is probably to set it
490#                 this way :
491#
492#                   accounter: software()
493#
494#                 which uses pkpgcounter's code internally to compute
495#                 the size of the job.
496#                 NB : YOU MUST NOW INSTALL pkpgcounter FOR PyKota TO WORK.
497#
498#                 You could obtain exactly the same result with :
499#
500#                   accounter: software(/usr/bin/pkpgcounter)
501#
502#                 But in this case the job would be passed through
503#                 pkpgcounter's parser a second time.
504#
505#                 pkpgcounter is a command line tool which was
506#                 part of PyKota and which can handle several types
507#                 of documents. It is now distributed separately.
508#
509#                 while pkpgcounter is the recommended value if you want
510#                 to use an external command here, you can use whatever
511#                 command you want provided your command accepts the job's
512#                 data on its standard input and prints the job's size in
513#                 pages as a single integer on its standard output.
514#
515# This value can be set either globally or on a per printer basis
516# If both are defined, the printer option has priority.
517#
518# 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 " ")
519# accounter: hardware(snmp)
520# accounter: hardware(pjl)
521# accounter: software(/usr/bin/pkpgcounter)
522#
523# The following, software without any argument, works since PyKota 1.21
524# and uses pkpgcounter's code internally.
525accounter: software()
526
527# What should we do if the accounter's subprocess doesn't return
528# a valid result (for example doesn't return an integer on its stdout)
529#
530# Valid values are : 'continue' and 'stop'. 'stop' is the default
531# if unset.
532#
533# 'continue' means try to process as usual, this may introduce
534# accounting errors and free jobs. This was the default behavior
535# until v1.20alpha5.
536#
537# 'stop' means fail and stop the print queue. If an accounter
538# error occurs, most of the time this is a misconfiguration, so
539# stopping the print queue is usually the better thing to do
540# until the admin has fixed the configuration.
541#
542# This value can be set either globally or on a per printer basis
543# If both are defined, the printer option has priority.
544#
545# NB : This directive shouldn't do much now because in case
546# of external accounter error, PyKota just loops.
547#
548# onaccountererror: continue
549onaccountererror: stop
550
551# Print Quota administrator
552# These values can be set either globally or per printer or both.
553# If both are defined, the printer option has priority.
554# If these values are not set, the default admin root
555# and the default adminmail root@localhost are used.
556admin: John Doe
557adminmail: root@localhost
558
559#
560# Who should we send an email to in case a quota is reached ?
561# possible values are : DevNull, User, Admin, Both, External(some command)
562# The Both value means that the User and the Admin will receive
563# an email message.
564# The DevNull value means no email message will be sent.
565# This value can be set either globally or per printer or both.
566# If both are defined, the printer option has priority.
567# If the value is not set, then the default BOTH applies.
568#
569#   Format of the external syntax :
570#
571#       mailto: external(/usr/bin/mycommand >/dev/null)
572#
573#   You can use :
574#
575#       '%(action)s'            will contain either WARN or DENY
576#       '%(username)s'          will contain the user's name
577#       '%(printername)s'       will contain the printer's name
578#       '%(email)s'             will contain the user's email address
579#       '%(message)s'           will contain the message if you want
580#                               to use it.
581#
582#   On your command line, to pass arguments to your command.
583#   Example :
584#
585#       mailto: external(/usr/bin/callpager %(username)s "Quota problem on %(printername)s" >/dev/null)
586#
587#   To automatically send a WinPopup message (this may only work with a PDC,
588#   here the same machine does Samba as PDC + CUPS) :
589#
590#       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)
591#
592#   NB : I use ISO-8859-15, but Windows expects UTF-8, so we pipe the message
593#        into iconv before sending it to the Windows user.
594#
595# or more simply :
596#
597#       mailto: external(/usr/share/pykota/mailandpopup.sh %(username)s %(printername)s "%(email)s" "%(message)s" 2>&1 >/dev/null)
598#
599#   NB : The mailandpopup.sh shell script is now included in PyKota
600#
601#   NB : in ANY case, don't forget to redirect your command's standard output
602#        somewhere (e.g. >/dev/null) so that there's no perturbation to the
603#        underlying layer (filter or backend)
604#
605mailto: both
606
607#
608# Grace delay in days
609# This value can be set either globally or per printer or both.
610# If both are defined, the printer option has priority.
611# If the value is not set then the default seven (7) days applies.
612gracedelay: 7
613
614#
615# Poor man's threshold
616# If account balance reaches below this amount,
617# a warning message is sent by email
618#
619# If unset, default poor man's threshold is 1.0.
620# This option can only appear in the global section
621poorman: 2.0
622
623# Poor man's warning message
624# The warning message that is sent if the "poorman" value is reached
625# Again this must appear in the global section
626poorwarn: Your Print Quota account balance is low.
627 Soon you'll not be allowed to print anymore.
628
629# Soft limit reached warning message
630# The warning message that is sent if the soft quota limit is reached
631# May appear either globally or on a per-printer basis
632softwarn: Your Print Quota Soft Limit is reached.
633 This means that you may still be allowed to print for some
634 time, but you must contact your administrator to purchase
635 more print quota.
636 
637# Hard limit reached error message
638# The error message that is sent if the hard quota limit is reached
639# May appear either globally or on a per-printer basis
640hardwarn: Your Print Quota Hard Limit is reached.
641 This means that you are not allowed to print anymore.
642 Please contact your administrator at root@localhost
643 as soon as possible to solve the problem.
644
645# one section per printer, or no other section at all if all options
646# are defined globally.
647# Each section's name must be the same as the printer's queue name as defined
648# in your printing system, be it CUPS or LPRng, between square brackets, for
649# example a print queue named 'hpmarketing' would appear in this file as
650# [hpmarketing]
651
652
653# Default policy to apply when either :
654#
655#       - Printer doesn't exist in PyKota's database
656#       - User doesn't exist in PyKota's database
657#       - User has no quota entry for this Printer in PyKota's database
658#
659# Value can be either allow or deny or external(some command here)
660#
661# This value can be set either globally or per printer or both.
662# If both are defined, the printer option has priority.
663# If the value is not set then the default policy DENY applies.
664# There's no policy wrt inexistant groups, they are ignored.
665#
666# external policy can be used to launch any external command of your choice,
667# for example to automatically add the user to the quota storage
668# if he is unknown. Example :
669#
670#   policy: external(/usr/bin/edpykota --add --printer %(printername)s --softlimit 50 --hardlimit 60 %(username)s >/dev/null)
671#
672# NB : If you want to limit users by their account balance value, it is preferable to
673# use the following policy to automate user account creation on first print :
674#
675#   policy: external(/usr/bin/autopykota --initbalance 25.0 >/dev/null)
676#
677#   This will automatically add the user if he doesn't already exist, and
678#   set his initial balance value to 25.0 (for example). If the user already
679#   exists then his balance value will not be modified.
680#   Please don't use autopykota if you want to limit your users by page
681#   quota, and in any case, carefully read autopykota's help or manpage
682#   and understand its goal before using it in your own configuration.
683#
684# Of course you can launch any command of your choice with this, e.g. :
685#
686#   policy: external(/usr/local/bin/myadminscript.sh %(username)s >/dev/null)
687
688# You can use :
689#
690#       '%(username)s'          will contain the user's name
691#       '%(printername)s'       will contain the printer's name
692#
693#   On your command line, to pass arguments to your command.
694#
695#   NB : Don't forget to redirect your command's standard output somewhere
696#        (e.g. >/dev/null) so that there's no perturbation to the underlying
697#        layer (filter or backend)
698#
699# If the printer, user, or user quota entry still doesn't exist after
700# external policy command was launched (the external command didn't add it),
701# or if an error occured during the execution of the external policy
702# command, then the job is rejected.
703#
704policy: deny
705
706# Pre and Post Hooks
707# These directives allow the easy plug-in of any command of your choice
708# at different phases of PyKota's execution.
709# Pre and Post Hooks can access some of PyKota's internal information
710# by reading environment variables as described below.
711# The actual phase of PyKota's execution is available in the
712# PYKOTAPHASE environment variable.
713# Pre and Post Hooks can be defined either globally, per printer,
714# or both. If both are defined, the printer specific hook has
715# priority.
716#
717# List of available environment variables :
718# NB : Most of these variables are also available during the execution
719# of external commands defined in the accounter and mailto
720# directives.
721#
722# PYKOTADIRECTORY : The directory containing cupspykota's temporary files
723# PYKOTADATAFILE : The name of the temporary file which contains the
724#                  job's datas
725# PYKOTAFILENAME : The name of the file which contains the job's datas or
726#                  empty if datas come from stdin
727# PYKOTACONTROLFILE : The name of the IPP message file
728# PYKOTAMD5SUM : Contains an hexadecimal digest of the md5 sum of the job's datas
729# PYKOTAPHASE : BEFORE or AFTER the job is sent to the printer
730# PYKOTAACTION : ALLOW or DENY or WARN for current print job
731# PYKOTAUSERNAME : user's name
732# PYKOTAPRINTERNAME : printer's name
733# PYKOTAPGROUPS : list of printers groups the current printer is a member of
734# PYKOTAJOBID : job's id
735# PYKOTATITLE : job's title
736# PYKOTACOPIES : number of copies
737# PYKOTAOPTIONS : job's options
738# PYKOTABALANCE : user's account balance
739# PYKOTALIFETIMEPAID : user's grand total paid
740# PYKOTALIMITBY : user print limiting factor, for example 'quota' or 'balance'
741# PYKOTAPAGECOUNTER : user's page counter on this printer
742# PYKOTALIFEPAGECOUNTER : user's life time page counter on this printer
743# PYKOTASOFTLIMIT : user's soft page limit on this printer
744# PYKOTAHARDLIMIT : user's hard page limit on this printer
745# PYKOTADATELIMIT : user's soft to hard limit date limit on this printer
746# PYKOTASTATUS : contains "CANCELLED" when SIGTERM was received by PyKota
747#                else is not set.
748# PYKOTAJOBSIZEBYTES : contains the job's size in bytes. Always available.
749# PYKOTAPRECOMPUTEDJOBSIZE : contains the precomputed job's size
750# PYKOTAPRECOMPUTEDJOBPRICE : contains the precomputed job's price
751# PYKOTAJOBORIGINATINGHOSTNAME : contains the client's hostname if
752#                                it is possible to retrieve it.
753# PYKOTAPRINTERHOSTNAME : the printer's hostname or IP address for network
754#                         printers, or "localhost" if not defined or not
755#                         meaningful.
756# PYKOTAWARNCOUNT : the number of times the user was forbidden to print but a banner
757#                   page was still printed on the current printer.                   
758# PYKOTAOVERCHARGE : user's overcharging factor.
759# PYKOTAJOBBILLING : Job's billing code if present (CUPS only)
760#
761
762# PreHook : gets executed after being sure the user, printer and user quota
763# entry on the printer both exist in the PyKota database, and after
764# checking if the user is allowed to print or not, but just before
765# the job is sent to the printer (if allowed)
766# prehook has access to many environment variables :
767#
768# PYKOTAACTION contains either "ALLOW", "WARN" or "DENY" and
769# represents the action which is to be done wrt the print job.
770# PYKOTAPHASE contains 'BEFORE' during execution of prehook
771#
772# uncomment the line below to see what environment variables are available
773# prehook: /usr/bin/printenv >/tmp/before
774
775# PostHook : gets executed after the job has been added to the history.
776# posthook has access to all the environment variables defined above,
777# as well as two additionnal environment variables : PYKOTAJOBPRICE
778# and PYKOTAJOBSIZE.
779# PYKOTAPHASE contains 'AFTER' during execution of posthook.
780#
781# uncomment the line below to see what environment variables are available
782# posthook: /usr/bin/printenv >/tmp/after
783
784# AccountBanner : how should banner accounting be done ?
785#
786# NB : CUPS ONLY FOR NOW !
787#
788# If enabled, banner pages printed from StartingBanner and/or EndingBanner
789# (depending on the value) will be included in the accounting for the
790# print job
791#
792# If disabled, banner pages printed from StartingBanner and EndingBanner will
793# *not* be included in the accounting for the print job
794#
795# IMPORTANT : CUPS generated banners are ALWAYS accounted for, although you
796#             can refund them by using negative prices on printers.
797#
798# Allowed values : Starting | Ending | None | Both
799#
800#       - Starting : only the starting banner will be accounted for.
801#       - Ending : only the ending banner will be accounted for.
802#       - Both : both starting and ending banners will be accounted for.
803#       - None : banners will not be accounted for.
804#
805# Default value :
806# accountbanner: Both
807
808# Maximal number of times the banner will still be printed if
809# the user is forbidden to print.
810#
811# NB : CUPS ONLY FOR NOW !
812#
813# This option can be set either globally or on a per printer basis.
814# Allowed values are 0 or any positive integer.
815# Default value is 0, which means that the banner won't be printed
816# at all if the user is forbidden to print.
817maxdenybanners: 0
818
819# StartingBanner : if defined will print a banner before the rest of the job
820# is printed. The argument can be a printable file, or an executable file.
821# If not executable, the file will be printed as is. If executable, the
822# file will be executed and its output will be printed.
823#
824# NB : CUPS ONLY FOR NOW !
825#
826# In any case, the banner content which will be sent to the printer
827# MUST be in a format your printer will accept !!!
828#
829# The pkbanner command included in PyKota can automatically generate
830# starting and ending banners in the PostScript format. You can use
831# this command in a pipe through GhostScript if your printer doesn't
832# accept PostScript as an input format.
833# NB : pkbanner's default page size is A4
834#
835# startingbanner: /home/joe/mystaticbanner.ps
836# startingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com"
837# startingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono -
838# startingbanner: /usr/bin/pkbanner
839
840# EndingBanner : if defined will print a banner after the job
841# has been printed. The argument can be a printable file, or an executable file.
842# If not executable, the file will be printed as is. If executable, the
843# file will be executed and its output will be printed.
844#
845# NB : CUPS ONLY FOR NOW !
846#
847# In any case, the banner content which will be sent to the printer
848# MUST be in a format your printer will accept !!!
849#
850# The pkbanner command included in PyKota can automatically generate
851# starting and ending banners in the PostScript format. You can use
852# this command in a pipe through GhostScript if your printer doesn't
853# accept PostScript as an input format.
854# NB : pkbanner's default page size is A4
855#
856# A static banner page
857# endingbanner: /home/joe/mystaticbanner.ps
858#
859# A banner with personnalized logo and url
860# endingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com"
861#
862# A banner in the format accepted by the printer
863# endingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono -
864#
865# A banner with more info on it, extracted from the yellow pages.
866# the string "Phone 111222333444" will be added to the banner page
867# if extractphone.sh returns 111222333444 for the current user.
868# endingbanner: /usr/bin/pkbanner Phone `extractphone.sh $PYKOTAUSERNAME`
869#
870# Default PyKota banner
871# endingbanner: /usr/bin/pkbanner
872
873# How should enforcement be done for this printer ?
874#
875# "laxist" is the default if value is not set, and allows users
876# to be over quota on their last job.
877#
878# "strict" tries to prevent users from ever being over quota.
879#
880# Enforcement can be defined either globally, per printer,
881# or both. If both are defined, the printer specific enforcement
882# setting has priority.
883#
884# valid values : "strict" or "laxist"
885#
886# default value
887# enforcement : laxist
888enforcement : strict
889
890# Should we trust the job size on this printer ?
891#
892# "trustjobsize : yes" is the default, the jobsize, either computed
893# by the hardware or by software is trusted.
894#
895# "trustjobsize : >N:precomputed" : uses the precomputed value if jobsize > N pages
896# "trustjobsize : >N:25" : uses 25 if jobsize is >N pages
897#
898# General form : ">n:m" where n is a positive integer, and m is
899# either the word 'precomputed' or a positive integer.
900# The special form "yes" is also accepted and is the default.
901#
902# This directive can be set either globally or on a per printer
903# basis. Use this directive when hardware accounting for a particular
904# printer produces some glitches due to the printer returning
905# incorrect answers.
906#
907# NB : DON'T MODIFY THIS IF YOU DON'T NEED TO. THIS IS ONLY TO BE USED
908# AS A WORKAROUND FOR SOME PRINTERS. IT'S PROBABLY BETTER TO ALWAYS
909# SET THIS DIRECTIVE TO 'yes'. THIS DIRECTIVE WILL ONLY BE HONORED
910# IF PYKOTA DETECTS A DIFFERENCE BETWEEN THE PRECOMPUTED JOB SIZE
911# AND THE JOB SIZE AS COMPUTED BY PYKOTA EITHER USING HARDWARE OR
912# SOFTWARE.
913trustjobsize : yes
914
915# Should we deny duplicate jobs ?
916#
917# A duplicate is a job sent twice (or more) in a row to the same printer
918# by the same user.
919#
920# This can be defined either globally or on a per printer basis
921# The default value is 'no', meaning that duplicate jobs are
922# allowed.
923#
924# NB : if an user prints a job, a second user prints another
925#      job, and the first user prints the first job again,
926#      this is NOT considered as a duplicate since the two
927#      identical jobs printed by the first user are not
928#      one just after the other.
929#
930# Possible values are 'yes', 'no', or any other string.
931# If the string is not recognized as a truth value,
932# it is considered to be a command to launch.
933# PyKota launches the command and parses its standard
934# output. The special keywords 'ALLOW' and 'DENY' are
935# recognized, allowing an external tool to decide if
936# the job is to be allowed or denied.
937#
938# denyduplicates : /usr/bin/myowncommand with some arguments
939# denyduplicates : yes
940denyduplicates : no
Note: See TracBrowser for help on using the browser.