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

Revision 1002, 6.5 kB (checked in by jalet, 21 years ago)

Now suggests that people tests the external requester's command line before
using it in PyKota.

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