[695] | 1 | # PyKota sample configuration file |
---|
| 2 | # |
---|
| 3 | # |
---|
[2204] | 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 | # |
---|
[952] | 28 | # PyKota - Print Quotas for CUPS and LPRng |
---|
[695] | 29 | # |
---|
[2622] | 30 | # (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com> |
---|
[873] | 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. |
---|
[695] | 35 | # |
---|
[873] | 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 |
---|
[2303] | 43 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
[695] | 44 | # |
---|
| 45 | # $Id$ |
---|
| 46 | # |
---|
| 47 | |
---|
[2837] | 48 | |
---|
| 49 | # |
---|
| 50 | # All directives must be placed below the following line |
---|
[695] | 51 | [global] |
---|
[859] | 52 | |
---|
[2837] | 53 | |
---|
| 54 | |
---|
[2593] | 55 | #################################################################### |
---|
| 56 | # SQLite3 : comment this section out if you use another backend # |
---|
| 57 | #################################################################### |
---|
| 58 | |
---|
| 59 | #storagebackend : sqlitestorage |
---|
| 60 | #storagename: /etc/pykota/pykota.db |
---|
| 61 | |
---|
[2837] | 62 | #################################################################### |
---|
| 63 | |
---|
| 64 | |
---|
| 65 | |
---|
[2638] | 66 | ############################################################################ |
---|
| 67 | # PostgreSQL or MySQL: comment this section out if you use another backend # |
---|
| 68 | ############################################################################ |
---|
[1021] | 69 | storagebackend: pgstorage |
---|
[2638] | 70 | # storagebackend: mysqlstorage |
---|
[1021] | 71 | |
---|
[952] | 72 | # Quota Storage Server hostname (and optional port) |
---|
[2875] | 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) |
---|
[695] | 75 | storageserver: localhost |
---|
[859] | 76 | |
---|
| 77 | # |
---|
| 78 | # name of the Quota Storage Database |
---|
[695] | 79 | storagename: pykota |
---|
[859] | 80 | |
---|
[1087] | 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 | # |
---|
[2819] | 90 | storageuser : pykotauser |
---|
| 91 | # In the line below change the password's value if needed. |
---|
| 92 | storageuserpw : readonlypw |
---|
[695] | 93 | |
---|
[2837] | 94 | ############################################################################ |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
[2593] | 98 | #################################################################### |
---|
| 99 | # LDAP : comment this section out if you use another backend # |
---|
| 100 | #################################################################### |
---|
[1038] | 101 | # LDAP example, uncomment and adapt it to your own configuration : |
---|
[2838] | 102 | # |
---|
[1016] | 103 | #storagebackend: ldapstorage |
---|
[2355] | 104 | #storageserver: ldap://ldap.example.com:389 |
---|
| 105 | #storagename: dc=example,dc=com |
---|
[2576] | 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. |
---|
[2838] | 110 | # |
---|
[2576] | 111 | #storageuser: cn=pykotauser,dc=example,dc=com |
---|
| 112 | #storageuserpw: ls88DT5j |
---|
[2838] | 113 | |
---|
| 114 | |
---|
| 115 | |
---|
[1968] | 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. |
---|
[2838] | 120 | # |
---|
[1968] | 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. |
---|
[2838] | 126 | # |
---|
[2442] | 127 | #cacert: /etc/pykota/mycertfile |
---|
[2838] | 128 | |
---|
| 129 | |
---|
| 130 | |
---|
[1025] | 131 | # Here we define some helpers to know where |
---|
| 132 | # to plug into an existing LDAP directory |
---|
[2838] | 133 | # NB : THE DIRECTIVES BELOW MUST BE PRESENT WITH AN LDAP BACKEND |
---|
| 134 | # BUT YOU ARE FREE TO CHANGE THE VALUES. |
---|
| 135 | # |
---|
[2355] | 136 | #userbase: ou=People,dc=example,dc=com |
---|
[1025] | 137 | #userrdn: uid |
---|
[2355] | 138 | #balancebase: ou=People,dc=example,dc=com |
---|
[1038] | 139 | #balancerdn: uid |
---|
[2355] | 140 | #groupbase: ou=Groups,dc=example,dc=com |
---|
[1025] | 141 | #grouprdn: cn |
---|
[2355] | 142 | #printerbase: ou=Printers,ou=PyKota,dc=example,dc=com |
---|
[1025] | 143 | #printerrdn: cn |
---|
[2355] | 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 |
---|
[1969] | 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). |
---|
[2838] | 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. |
---|
[1969] | 157 | #userquotabase: user |
---|
[2355] | 158 | #userquotabase: ou=UQuotas,ou=PyKota,dc=example,dc=com |
---|
[1969] | 159 | #groupquotabase: group |
---|
[2355] | 160 | #groupquotabase: ou=GQuotas,ou=PyKota,dc=example,dc=com |
---|
[1969] | 161 | |
---|
[2838] | 162 | |
---|
| 163 | |
---|
[1105] | 164 | # How to create new accounts and groups |
---|
[1510] | 165 | # authorized values are "below" and "attach(objectclass name [, fail|warn])" |
---|
[1105] | 166 | # |
---|
| 167 | # "below" creates the new accounts/groups as standalone entries |
---|
| 168 | # below the above defined 'userbase' ou |
---|
[1029] | 169 | # |
---|
[1510] | 170 | # attach(objectclass name [, action]) tries to find some existing user/group |
---|
[1105] | 171 | # using the above defined 'userrdn' or 'grouprdn' and 'userbase' |
---|
| 172 | # 'groupbase', and attach the PyKota specific entries to it. |
---|
[1510] | 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". |
---|
[1105] | 178 | # |
---|
[1510] | 179 | # a possible value: newuser: attach(posixAccount, warn) |
---|
[2838] | 180 | # |
---|
[1114] | 181 | #newuser : below |
---|
| 182 | #newgroup : below |
---|
[2838] | 183 | |
---|
| 184 | |
---|
| 185 | |
---|
[1111] | 186 | # LDAP attribute which stores the user's email address |
---|
[2837] | 187 | # |
---|
[1114] | 188 | #usermail : mail |
---|
[1105] | 189 | |
---|
[2838] | 190 | |
---|
| 191 | |
---|
[1029] | 192 | # Choose what attribute contains the list of group members |
---|
| 193 | # common values are : memberUid, uniqueMember, member |
---|
[2837] | 194 | # |
---|
[1029] | 195 | #groupmembers: memberUid |
---|
[1016] | 196 | |
---|
[2838] | 197 | |
---|
| 198 | |
---|
[1356] | 199 | # Activate low-level LDAP cache yes/no |
---|
| 200 | # Nothing to do with "storagecaching" which is higher level |
---|
| 201 | # and database independant. |
---|
[1357] | 202 | # This saves some search queries and may help with heavily |
---|
| 203 | # loaded LDAP servers. |
---|
| 204 | # This is EXPERIMENTAL. |
---|
[1368] | 205 | # |
---|
| 206 | # BEWARE : SETTING THIS TO 'YES' CAUSES PROBLEMS FOR NOW |
---|
| 207 | # BETTER TO LET IT SET TO 'NO' |
---|
[2837] | 208 | # |
---|
[1604] | 209 | # ldapcache: no |
---|
[1356] | 210 | |
---|
[2837] | 211 | #################################################################### |
---|
| 212 | |
---|
[2593] | 213 | ############################################################# |
---|
[2837] | 214 | # END of database specific directives # |
---|
[2593] | 215 | ############################################################# |
---|
| 216 | |
---|
[2837] | 217 | |
---|
| 218 | |
---|
[2593] | 219 | # Should the database caching mechanism be enabled or not ? |
---|
| 220 | # If unset, caching is disabled. Possible values Y/N/YES/NO |
---|
[2777] | 221 | # caching mechanism works with both relationnal and OpenLDAP backends |
---|
[2593] | 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 | # |
---|
[2777] | 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 | # |
---|
[2593] | 232 | # FYI, I ALWAYS SET IT TO YES ! |
---|
| 233 | # |
---|
| 234 | storagecaching: No |
---|
| 235 | |
---|
[2837] | 236 | |
---|
| 237 | |
---|
[2593] | 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. |
---|
[2777] | 242 | # Disabling the job history with a relationnal backend works too |
---|
[2593] | 243 | # but it's probably less useful than with LDAP. |
---|
[2837] | 244 | # |
---|
[2593] | 245 | disablehistory: No |
---|
| 246 | |
---|
[2837] | 247 | |
---|
| 248 | |
---|
[2876] | 249 | # Where to log ? |
---|
[2837] | 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 | # |
---|
[782] | 253 | logger: system |
---|
[695] | 254 | |
---|
[2837] | 255 | |
---|
| 256 | |
---|
[1186] | 257 | # Enable debugging ? Put YES or NO there. |
---|
[2681] | 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. |
---|
[2837] | 267 | # |
---|
[1240] | 268 | debug : Yes |
---|
[1021] | 269 | |
---|
[2837] | 270 | |
---|
| 271 | |
---|
[2262] | 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 |
---|
[2837] | 275 | # one defined below : |
---|
| 276 | # |
---|
[2262] | 277 | logourl : http://www.librelogiciel.com/software/PyKota/pykota.png |
---|
| 278 | |
---|
[2837] | 279 | |
---|
| 280 | |
---|
[2265] | 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 |
---|
[2837] | 284 | # one defined below : |
---|
| 285 | # |
---|
[2265] | 286 | logolink : http://www.librelogiciel.com/software/ |
---|
| 287 | |
---|
[2837] | 288 | |
---|
| 289 | |
---|
[695] | 290 | # Mail server to use to warn users |
---|
[853] | 291 | # If the value is not set then localhost is used. |
---|
[2837] | 292 | # |
---|
[695] | 293 | smtpserver: localhost |
---|
[806] | 294 | |
---|
[2837] | 295 | |
---|
| 296 | |
---|
[1517] | 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 |
---|
[2837] | 300 | # is disabled for privacy concerns (see below). The address |
---|
| 301 | # pykotacrashed@librelogiciel.com reaches PyKota's author. |
---|
[1517] | 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 | # |
---|
[2837] | 310 | # suggested value : |
---|
| 311 | # |
---|
[1517] | 312 | # crashrecipient: pykotacrashed@librelogiciel.com |
---|
| 313 | |
---|
[2837] | 314 | |
---|
| 315 | |
---|
[1353] | 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 |
---|
[2777] | 319 | # above) or a relationnal one, then email messages are sent to |
---|
[1353] | 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. |
---|
[2837] | 326 | # |
---|
[1353] | 327 | maildomain: example.com |
---|
| 328 | |
---|
[2837] | 329 | |
---|
| 330 | |
---|
[1227] | 331 | # Should we force usernames to be all lowercase when printing ? |
---|
| 332 | # Default is No. |
---|
[2837] | 333 | # This is a [global] option only. |
---|
[1227] | 334 | # Some people reported that WinXP sends mixed case usernames |
---|
| 335 | # setting 'utolower: Yes' solves the problem. |
---|
[1757] | 336 | # Of course you have to use lowercase only when adding |
---|
[1227] | 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 |
---|
[2476] | 341 | # system is converted to lowercase at the start of printing, |
---|
| 342 | # BUT ONLY when printing. |
---|
[1227] | 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. |
---|
[2837] | 347 | # |
---|
[1227] | 348 | utolower: No |
---|
| 349 | |
---|
[2837] | 350 | |
---|
| 351 | |
---|
[1757] | 352 | # Should we split usernames on a specific separator when printing ? |
---|
| 353 | # Default is No, i.e. if the value is unset. |
---|
[2837] | 354 | # This is a [global] option only. |
---|
[1757] | 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. |
---|
[2837] | 368 | # |
---|
[1757] | 369 | # winbind_separator: / |
---|
| 370 | |
---|
[2837] | 371 | |
---|
| 372 | |
---|
[1956] | 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 | |
---|
[2837] | 384 | |
---|
| 385 | |
---|
[1875] | 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. |
---|
[2837] | 394 | # |
---|
[1875] | 395 | privacy : no |
---|
| 396 | |
---|
[2837] | 397 | |
---|
| 398 | |
---|
[2583] | 399 | # When the real CUPS backend fail, should we modify the |
---|
| 400 | # user's page counters and account balance or not ? |
---|
[2759] | 401 | # Also should we retry and if yes then how often and how many times ? |
---|
[2583] | 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". |
---|
[2759] | 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. |
---|
[2764] | 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). |
---|
[2759] | 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. |
---|
[2583] | 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. |
---|
[2837] | 423 | # |
---|
[2759] | 424 | # onbackenderror : charge,retry:5:60 |
---|
| 425 | # onbackenderror : retry:0:300 |
---|
| 426 | # onbackenderror : retry:3:300,nocharge |
---|
[2583] | 427 | # onbackenderror : charge |
---|
| 428 | onbackenderror : nocharge |
---|
| 429 | |
---|
[2837] | 430 | |
---|
| 431 | |
---|
[2307] | 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. |
---|
[2837] | 441 | # |
---|
[2307] | 442 | # striptitle : smbprn.?????? |
---|
| 443 | |
---|
[2837] | 444 | |
---|
| 445 | |
---|
[2385] | 446 | # Should we launch a command to overwrite the job's ticket ? |
---|
| 447 | # This allows a command to overwrite the username and/or the |
---|
[2631] | 448 | # billing code used, or to deny or cancel the job. |
---|
[2385] | 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 |
---|
[2803] | 457 | # AUTH=NO (equivalent to DENY below) |
---|
[2392] | 458 | # DENY |
---|
[2631] | 459 | # CANCEL |
---|
[2385] | 460 | # |
---|
| 461 | # NB : the output is entirely read, and the latest value |
---|
| 462 | # 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. |
---|
[2803] | 468 | # If DENY or CANCEL is output, the username can't be overwritten. |
---|
[2385] | 469 | # |
---|
| 470 | # This value can be set either globally or on a per printer basis |
---|
| 471 | # If both are defined, the printer option has priority. |
---|
| 472 | # |
---|
[2837] | 473 | # examples : |
---|
| 474 | # |
---|
| 475 | # overwrite_jobticket : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 180 --denyafter 3 --checkauth --ask "Username:username:$PYKOTAUSERNAME" "Password:password:" |
---|
[2385] | 476 | # overwrite_jobticket : /path/to/some/script/or/command |
---|
| 477 | |
---|
[2837] | 478 | |
---|
| 479 | |
---|
[2385] | 480 | # What should we do when we print and the billing code used is |
---|
| 481 | # not present in the database ? |
---|
| 482 | # The default value is 'create' which adds the billing code to the |
---|
| 483 | # database. |
---|
| 484 | # Other values can be : |
---|
| 485 | # deny |
---|
| 486 | # which silently rejects the job. |
---|
| 487 | # or : |
---|
| 488 | # deny(your script here) |
---|
| 489 | # if you put the path to a script or command here, it is executed, for |
---|
| 490 | # example you can open a popup window explaining why the job was |
---|
| 491 | # rejected. |
---|
| 492 | # |
---|
| 493 | # This value can be set either globally or on a per printer basis |
---|
| 494 | # If both are defined, the printer option has priority. |
---|
| 495 | # |
---|
[2631] | 496 | # unknown_billingcode : deny |
---|
[2837] | 497 | # unknown_billingcode : deny(/usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 60 --notify "The billing code specified is not allowed") |
---|
[2631] | 498 | # unknown_billingcode : deny(/path/to/some/script) |
---|
[2385] | 499 | # unknown_billingcode : create |
---|
| 500 | |
---|
[2837] | 501 | |
---|
| 502 | |
---|
[2405] | 503 | # Where should we store our (temporary) files when printing ? |
---|
| 504 | # if unset, defaults to a system directory dedicated to temporary |
---|
| 505 | # files and evaluated at runtime (see Python's documentation |
---|
| 506 | # for the tempfile.gettempdir() function). |
---|
| 507 | # This value can be set either globally or on a per printer basis |
---|
| 508 | # If both are defined, the printer option has priority. |
---|
[2406] | 509 | # On my system, when not set, the /var/spool/cups/tmp directory is used. |
---|
[2405] | 510 | # directory : /tmp |
---|
| 511 | # directory : /var/spool/cups |
---|
| 512 | |
---|
[2837] | 513 | |
---|
| 514 | |
---|
[2405] | 515 | # Should we keep our work files on disk after printing ? |
---|
| 516 | # If unset, temporary files are deleted once the work is finished. |
---|
| 517 | # If set to yes, files are kept on disk in the 'directory' |
---|
| 518 | # named with the previous directive. |
---|
| 519 | # This value can be set either globally or on a per printer basis |
---|
| 520 | # If both are defined, the printer option has priority. |
---|
| 521 | # Default value is No, meaning temporary files are deleted |
---|
[2837] | 522 | # You should set it to yes only during installation to not |
---|
| 523 | # waste disk space during normal use. |
---|
| 524 | # |
---|
[2405] | 525 | # keepfiles : yes |
---|
| 526 | keepfiles : no |
---|
| 527 | |
---|
| 528 | |
---|
[2837] | 529 | |
---|
| 530 | # What is the accounting backend to use : this defines the way PyKota |
---|
| 531 | # will compute the number of pages printed. This directive is the most |
---|
| 532 | # important one in PyKota's configuration. |
---|
[974] | 533 | # |
---|
[2837] | 534 | # NB : This directive is MANDATORY, there's no default value when not set. |
---|
[974] | 535 | # |
---|
[2837] | 536 | # Supported values : |
---|
[976] | 537 | # |
---|
[2837] | 538 | # - software([/path/to/some/script[ --with-args]]) |
---|
| 539 | # - hardware(snmp[:community]|pjl[:port]|/path/to/some/script[ --with-args]) |
---|
[1483] | 540 | # |
---|
[2837] | 541 | # Hardware asks the printer for its lifetime page counter through either |
---|
| 542 | # SNMP, PJL-over-TCP, or through any command of your choice. This is |
---|
| 543 | # the recommended way to use PyKota, although it might not work with some |
---|
| 544 | # printers. The page counter is asked twice per job : before the job |
---|
| 545 | # is sent to the printer, and after it has been entirely sent. |
---|
| 546 | # The big advantages of hardware accounting are lighter CPU usage compared |
---|
| 547 | # to software accounting described below, although it can take more time |
---|
| 548 | # because of necessary internal counter stabilization delays, and the fact |
---|
| 549 | # that paper jams don't cause users to be charged for pages they couldn't |
---|
| 550 | # print. |
---|
| 551 | # For hardware accounting, two special values are accepted in addition |
---|
| 552 | # to a script name : snmp and pjl. 'snmp' asks PyKota to use its internal |
---|
| 553 | # SNMP code, 'pjl' asks PyKota to internally send a specially crafter PJL |
---|
| 554 | # job to the printer's TCP port 9100 (by default). |
---|
[1746] | 555 | # |
---|
[2837] | 556 | # Software counts pages by parsing the print job's datas, either internally |
---|
| 557 | # when no script is specified, or through any script of your choice. |
---|
| 558 | # This works with ALL printers, provided you've got a script to parse |
---|
| 559 | # datas produced by your printer driver. PyKota's internal parser, also |
---|
| 560 | # available under the name 'pkpgcounter', recognizes several page description |
---|
| 561 | # languages, but may occasionally fail for some printer drivers. |
---|
| 562 | # You can however use any other command, provided it can read the datas to |
---|
| 563 | # parse from its standard input, and prints a single integer on its standard |
---|
| 564 | # output, representing the number of pages in the print job. |
---|
| 565 | # Software accounting unfortunately may overcharge users in case of paper |
---|
| 566 | # jams. |
---|
[1746] | 567 | # |
---|
[2837] | 568 | # You can get hints on which configuration is best for your printers by |
---|
| 569 | # typing : pkturnkey --doconf |
---|
[1746] | 570 | # |
---|
[2837] | 571 | # In the lines below "%(printer)s" is automatically replaced at run time |
---|
| 572 | # with your printer's Fully Qualified Domain Name for network printers, |
---|
| 573 | # if PyKota can extract it from its environment. |
---|
[2425] | 574 | # |
---|
[2837] | 575 | # Examples : |
---|
[2425] | 576 | # |
---|
[2837] | 577 | # accounter : hardware(snmp) |
---|
| 578 | # accounter : hardware(snmp:private) |
---|
| 579 | # accounter : hardware(pjl) |
---|
| 580 | # accounter : hardware(pjl:9101) |
---|
| 581 | # 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 " ") |
---|
| 582 | # accounter : hardware(/usr/bin/npadmin --pagecount %(printer)s) |
---|
| 583 | # 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) |
---|
| 584 | # accounter : hardware(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1) |
---|
| 585 | # 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) |
---|
| 586 | # 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) |
---|
| 587 | # accounter : software(/usr/bin/pkpgcounter) |
---|
| 588 | # accounter : software() |
---|
[1483] | 589 | # |
---|
[2837] | 590 | # This directive can be set either globally or per printer or both. |
---|
| 591 | # If both are defined, the printer option has priority. |
---|
[1483] | 592 | # |
---|
[2837] | 593 | # IF YOU PLAN TO USE YOUR OWN SCRIPTS FOR HARDWARE ACCOUNTING, |
---|
| 594 | # YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE |
---|
| 595 | # PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER. |
---|
[1483] | 596 | # |
---|
[2837] | 597 | # PYKOTA'S 'snmp' and 'pjl' HARDWARE ACCOUNTING METHODS DO THE CORRECT WORK |
---|
| 598 | # INTERNALLY, BUT SOME OF THE EXAMPLES ABOVE DON'T, YOU HAVE BEEN WARNED. |
---|
[1587] | 599 | # |
---|
[2837] | 600 | # WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA |
---|
| 601 | # TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE |
---|
| 602 | # TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU, |
---|
| 603 | # AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE |
---|
| 604 | # YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS. |
---|
[1483] | 605 | # |
---|
[2837] | 606 | # Sane default : |
---|
[1483] | 607 | # |
---|
[2074] | 608 | accounter: software() |
---|
[806] | 609 | |
---|
[2837] | 610 | |
---|
| 611 | |
---|
[2635] | 612 | # What is the "pre"-accounter used for precomputing the job's size. |
---|
| 613 | # |
---|
| 614 | # Supported values are : |
---|
| 615 | # |
---|
| 616 | # preaccounter: software() |
---|
| 617 | # preaccounter: software(/path/to/your/script) |
---|
| 618 | # |
---|
[2837] | 619 | # NB : the preaccounter directive doesn't support hardware() for obvious |
---|
| 620 | # reasons. If unset, "software()" is assumed. If you use your own script, |
---|
| 621 | # ensure that it only prints the job's number of pages (or an estimation |
---|
| 622 | # of it) on its standard output. |
---|
[2635] | 623 | # |
---|
[2837] | 624 | # You may want to define for example 'preaccounter : software(/bin/echo 1)' |
---|
| 625 | # in the case your printer supports an hardware accounter but pkpgcounter |
---|
| 626 | # can't parse your printer driver's datas. |
---|
| 627 | # |
---|
[2635] | 628 | # This value can be set either globally or on a per printer basis |
---|
| 629 | # If both are defined, the printer option has priority. |
---|
| 630 | # |
---|
[2837] | 631 | # Sane default : |
---|
| 632 | # |
---|
[2635] | 633 | preaccounter: software() |
---|
| 634 | |
---|
| 635 | |
---|
[2837] | 636 | |
---|
[1687] | 637 | # What should we do if the accounter's subprocess doesn't return |
---|
| 638 | # a valid result (for example doesn't return an integer on its stdout) |
---|
| 639 | # |
---|
| 640 | # Valid values are : 'continue' and 'stop'. 'stop' is the default |
---|
| 641 | # if unset. |
---|
| 642 | # |
---|
| 643 | # 'continue' means try to process as usual, this may introduce |
---|
| 644 | # accounting errors and free jobs. This was the default behavior |
---|
| 645 | # until v1.20alpha5. |
---|
| 646 | # |
---|
| 647 | # 'stop' means fail and stop the print queue. If an accounter |
---|
| 648 | # error occurs, most of the time this is a misconfiguration, so |
---|
| 649 | # stopping the print queue is usually the better thing to do |
---|
| 650 | # until the admin has fixed the configuration. |
---|
| 651 | # |
---|
| 652 | # This value can be set either globally or on a per printer basis |
---|
| 653 | # If both are defined, the printer option has priority. |
---|
| 654 | # |
---|
[1826] | 655 | # NB : This directive shouldn't do much now because in case |
---|
| 656 | # of external accounter error, PyKota just loops. |
---|
| 657 | # |
---|
[1687] | 658 | # onaccountererror: continue |
---|
| 659 | onaccountererror: stop |
---|
| 660 | |
---|
[2837] | 661 | |
---|
| 662 | |
---|
[806] | 663 | # Print Quota administrator |
---|
| 664 | # These values can be set either globally or per printer or both. |
---|
| 665 | # If both are defined, the printer option has priority. |
---|
[853] | 666 | # If these values are not set, the default admin root |
---|
| 667 | # and the default adminmail root@localhost are used. |
---|
[1186] | 668 | admin: John Doe |
---|
| 669 | adminmail: root@localhost |
---|
[806] | 670 | |
---|
[2837] | 671 | |
---|
| 672 | |
---|
[852] | 673 | # Who should we send an email to in case a quota is reached ? |
---|
[1192] | 674 | # possible values are : DevNull, User, Admin, Both, External(some command) |
---|
[852] | 675 | # The Both value means that the User and the Admin will receive |
---|
| 676 | # an email message. |
---|
| 677 | # The DevNull value means no email message will be sent. |
---|
| 678 | # This value can be set either globally or per printer or both. |
---|
| 679 | # If both are defined, the printer option has priority. |
---|
[853] | 680 | # If the value is not set, then the default BOTH applies. |
---|
[1192] | 681 | # |
---|
[1231] | 682 | # Format of the external syntax : |
---|
[1192] | 683 | # |
---|
[1231] | 684 | # mailto: external(/usr/bin/mycommand >/dev/null) |
---|
| 685 | # |
---|
[1192] | 686 | # You can use : |
---|
| 687 | # |
---|
| 688 | # '%(action)s' will contain either WARN or DENY |
---|
| 689 | # '%(username)s' will contain the user's name |
---|
| 690 | # '%(printername)s' will contain the printer's name |
---|
| 691 | # '%(email)s' will contain the user's email address |
---|
| 692 | # '%(message)s' will contain the message if you want |
---|
[1230] | 693 | # to use it. |
---|
[1192] | 694 | # |
---|
[2837] | 695 | # on your command line, to pass arguments to your command. |
---|
| 696 | # Examples : |
---|
[1192] | 697 | # |
---|
[2837] | 698 | # mailto: external(/usr/bin/callpager %(username)s "Quota problem on %(printername)s" >/dev/null) |
---|
[1192] | 699 | # |
---|
[1233] | 700 | # To automatically send a WinPopup message (this may only work with a PDC, |
---|
| 701 | # here the same machine does Samba as PDC + CUPS) : |
---|
[1231] | 702 | # |
---|
[2837] | 703 | # 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) |
---|
[1231] | 704 | # |
---|
[1233] | 705 | # NB : I use ISO-8859-15, but Windows expects UTF-8, so we pipe the message |
---|
| 706 | # into iconv before sending it to the Windows user. |
---|
[1193] | 707 | # |
---|
[1240] | 708 | # or more simply : |
---|
| 709 | # |
---|
[2837] | 710 | # mailto: external(/usr/share/pykota/mailandpopup.sh %(username)s %(printername)s "%(email)s" "%(message)s" 2>&1 >/dev/null) |
---|
[1240] | 711 | # |
---|
| 712 | # NB : The mailandpopup.sh shell script is now included in PyKota |
---|
| 713 | # |
---|
[1233] | 714 | # NB : in ANY case, don't forget to redirect your command's standard output |
---|
| 715 | # somewhere (e.g. >/dev/null) so that there's no perturbation to the |
---|
| 716 | # underlying layer (filter or backend) |
---|
| 717 | # |
---|
[2837] | 718 | mailto : both |
---|
[852] | 719 | |
---|
[695] | 720 | |
---|
[1077] | 721 | |
---|
[2692] | 722 | # The value of the zero for account balance limitations. |
---|
| 723 | # If an user his limited by balance, he can print until |
---|
| 724 | # his balance reaches the value defined here. If unset, |
---|
| 725 | # the default value is 0. Any floating point value |
---|
| 726 | # is accepted. |
---|
[2837] | 727 | # You'll want to use this to give free credits to your users |
---|
| 728 | # at the start of the year for example. |
---|
[2692] | 729 | # |
---|
| 730 | # This option can only appear in the global section |
---|
[2837] | 731 | # |
---|
[2692] | 732 | # balancezero : -0.25 |
---|
[2837] | 733 | # |
---|
[2692] | 734 | balancezero: 0.0 |
---|
| 735 | |
---|
[2837] | 736 | |
---|
| 737 | |
---|
| 738 | # Grace delay in days |
---|
| 739 | # This value can be set either globally or per printer or both. |
---|
| 740 | # If both are defined, the printer option has priority. |
---|
| 741 | # If the value is not set then the default seven (7) days applies. |
---|
| 742 | # |
---|
| 743 | gracedelay : 7 |
---|
| 744 | |
---|
| 745 | |
---|
| 746 | |
---|
| 747 | # Poor man's threshold |
---|
| 748 | # If account balance reaches below this amount, a warning message |
---|
| 749 | # is sent through the 'mailto' directive above. |
---|
| 750 | # |
---|
| 751 | # If unset, default poor man's threshold is 1.0. |
---|
| 752 | # This option can only appear in the global section |
---|
| 753 | # |
---|
| 754 | poorman : 1.0 |
---|
| 755 | |
---|
| 756 | |
---|
| 757 | |
---|
[1077] | 758 | # Poor man's warning message |
---|
| 759 | # The warning message that is sent if the "poorman" value is reached |
---|
| 760 | # Again this must appear in the global section |
---|
[2837] | 761 | # |
---|
| 762 | poorwarn : Your Print Quota account balance is low. |
---|
[1077] | 763 | Soon you'll not be allowed to print anymore. |
---|
| 764 | |
---|
[2837] | 765 | |
---|
| 766 | |
---|
[1077] | 767 | # Soft limit reached warning message |
---|
| 768 | # The warning message that is sent if the soft quota limit is reached |
---|
| 769 | # May appear either globally or on a per-printer basis |
---|
[2837] | 770 | # |
---|
[1077] | 771 | softwarn: Your Print Quota Soft Limit is reached. |
---|
| 772 | This means that you may still be allowed to print for some |
---|
| 773 | time, but you must contact your administrator to purchase |
---|
| 774 | more print quota. |
---|
[2837] | 775 | |
---|
| 776 | |
---|
| 777 | |
---|
[1077] | 778 | # Hard limit reached error message |
---|
| 779 | # The error message that is sent if the hard quota limit is reached |
---|
| 780 | # May appear either globally or on a per-printer basis |
---|
[2837] | 781 | # |
---|
[1077] | 782 | hardwarn: Your Print Quota Hard Limit is reached. |
---|
| 783 | This means that you are not allowed to print anymore. |
---|
| 784 | Please contact your administrator at root@localhost |
---|
| 785 | as soon as possible to solve the problem. |
---|
| 786 | |
---|
[806] | 787 | |
---|
| 788 | |
---|
[1594] | 789 | # Default policy to apply when either : |
---|
| 790 | # |
---|
| 791 | # - Printer doesn't exist in PyKota's database |
---|
| 792 | # - User doesn't exist in PyKota's database |
---|
| 793 | # - User has no quota entry for this Printer in PyKota's database |
---|
| 794 | # |
---|
| 795 | # Value can be either allow or deny or external(some command here) |
---|
| 796 | # |
---|
[806] | 797 | # This value can be set either globally or per printer or both. |
---|
| 798 | # If both are defined, the printer option has priority. |
---|
[956] | 799 | # If the value is not set then the default policy DENY applies. |
---|
[1038] | 800 | # There's no policy wrt inexistant groups, they are ignored. |
---|
[1152] | 801 | # |
---|
| 802 | # external policy can be used to launch any external command of your choice, |
---|
[2837] | 803 | # for example to automatically add the user to the quota database, and set |
---|
| 804 | # page limits on the current printer if he is unknown : |
---|
[1152] | 805 | # |
---|
[2837] | 806 | # policy: external(/usr/bin/pkusers --add --skipexisting %(username)s && /usr/bin/edpykota --add --skipexisting --printer %(printername)s --softlimit 50 --hardlimit 60 %(username)s) |
---|
[1152] | 807 | # |
---|
[1759] | 808 | # NB : If you want to limit users by their account balance value, it is preferable to |
---|
| 809 | # use the following policy to automate user account creation on first print : |
---|
| 810 | # |
---|
[2837] | 811 | # policy: external(/usr/bin/autopykota --initbalance 25.0) |
---|
[1759] | 812 | # |
---|
| 813 | # This will automatically add the user if he doesn't already exist, and |
---|
| 814 | # set his initial balance value to 25.0 (for example). If the user already |
---|
| 815 | # exists then his balance value will not be modified. |
---|
| 816 | # Please don't use autopykota if you want to limit your users by page |
---|
| 817 | # quota, and in any case, carefully read autopykota's help or manpage |
---|
| 818 | # and understand its goal before using it in your own configuration. |
---|
| 819 | # |
---|
[1152] | 820 | # Of course you can launch any command of your choice with this, e.g. : |
---|
| 821 | # |
---|
[2837] | 822 | # policy: external(/usr/local/bin/myadminscript.sh %(username)s) |
---|
[2838] | 823 | # |
---|
[1196] | 824 | # You can use : |
---|
[1152] | 825 | # |
---|
[1196] | 826 | # '%(username)s' will contain the user's name |
---|
| 827 | # '%(printername)s' will contain the printer's name |
---|
| 828 | # |
---|
[1781] | 829 | # On your command line, to pass arguments to your command. |
---|
[1196] | 830 | # |
---|
[1594] | 831 | # If the printer, user, or user quota entry still doesn't exist after |
---|
| 832 | # external policy command was launched (the external command didn't add it), |
---|
| 833 | # or if an error occured during the execution of the external policy |
---|
| 834 | # command, then the job is rejected. |
---|
[1196] | 835 | # |
---|
[2837] | 836 | # By default, we reject all jobs from users not in the database : |
---|
| 837 | # |
---|
[956] | 838 | policy: deny |
---|
[695] | 839 | |
---|
[2837] | 840 | |
---|
| 841 | |
---|
[1372] | 842 | # Pre and Post Hooks |
---|
| 843 | # These directives allow the easy plug-in of any command of your choice |
---|
| 844 | # at different phases of PyKota's execution. |
---|
| 845 | # Pre and Post Hooks can access some of PyKota's internal information |
---|
| 846 | # by reading environment variables as described below. |
---|
| 847 | # The actual phase of PyKota's execution is available in the |
---|
| 848 | # PYKOTAPHASE environment variable. |
---|
| 849 | # Pre and Post Hooks can be defined either globally, per printer, |
---|
[1495] | 850 | # or both. If both are defined, the printer specific hook has |
---|
[1372] | 851 | # priority. |
---|
| 852 | # |
---|
| 853 | # List of available environment variables : |
---|
| 854 | # NB : Most of these variables are also available during the execution |
---|
[1483] | 855 | # of external commands defined in the accounter and mailto |
---|
[1372] | 856 | # directives. |
---|
| 857 | # |
---|
[2303] | 858 | # PYKOTADIRECTORY : The directory containing cupspykota's temporary files |
---|
| 859 | # PYKOTADATAFILE : The name of the temporary file which contains the |
---|
| 860 | # job's datas |
---|
[2445] | 861 | # PYKOTAFILENAME : The name of the file which contains the job's datas or |
---|
| 862 | # empty if datas come from stdin |
---|
[2303] | 863 | # PYKOTACONTROLFILE : The name of the IPP message file |
---|
[1767] | 864 | # PYKOTAMD5SUM : Contains an hexadecimal digest of the md5 sum of the job's datas |
---|
[1372] | 865 | # PYKOTAPHASE : BEFORE or AFTER the job is sent to the printer |
---|
[1422] | 866 | # PYKOTAACTION : ALLOW or DENY or WARN for current print job |
---|
[1372] | 867 | # PYKOTAUSERNAME : user's name |
---|
| 868 | # PYKOTAPRINTERNAME : printer's name |
---|
[1439] | 869 | # PYKOTAPGROUPS : list of printers groups the current printer is a member of |
---|
[1372] | 870 | # PYKOTAJOBID : job's id |
---|
| 871 | # PYKOTATITLE : job's title |
---|
| 872 | # PYKOTACOPIES : number of copies |
---|
| 873 | # PYKOTAOPTIONS : job's options |
---|
| 874 | # PYKOTABALANCE : user's account balance |
---|
| 875 | # PYKOTALIFETIMEPAID : user's grand total paid |
---|
[1421] | 876 | # PYKOTALIMITBY : user print limiting factor, for example 'quota' or 'balance' |
---|
[1372] | 877 | # PYKOTAPAGECOUNTER : user's page counter on this printer |
---|
| 878 | # PYKOTALIFEPAGECOUNTER : user's life time page counter on this printer |
---|
| 879 | # PYKOTASOFTLIMIT : user's soft page limit on this printer |
---|
| 880 | # PYKOTAHARDLIMIT : user's hard page limit on this printer |
---|
| 881 | # PYKOTADATELIMIT : user's soft to hard limit date limit on this printer |
---|
[1442] | 882 | # PYKOTASTATUS : contains "CANCELLED" when SIGTERM was received by PyKota |
---|
| 883 | # else is not set. |
---|
[1517] | 884 | # PYKOTAJOBSIZEBYTES : contains the job's size in bytes. Always available. |
---|
[2062] | 885 | # PYKOTAPRECOMPUTEDJOBSIZE : contains the precomputed job's size |
---|
| 886 | # PYKOTAPRECOMPUTEDJOBPRICE : contains the precomputed job's price |
---|
[1502] | 887 | # PYKOTAJOBORIGINATINGHOSTNAME : contains the client's hostname if |
---|
| 888 | # it is possible to retrieve it. |
---|
[1694] | 889 | # PYKOTAPRINTERHOSTNAME : the printer's hostname or IP address for network |
---|
| 890 | # printers, or "localhost" if not defined or not |
---|
| 891 | # meaningful. |
---|
[2054] | 892 | # PYKOTAWARNCOUNT : the number of times the user was forbidden to print but a banner |
---|
| 893 | # page was still printed on the current printer. |
---|
| 894 | # PYKOTAOVERCHARGE : user's overcharging factor. |
---|
[2217] | 895 | # PYKOTAJOBBILLING : Job's billing code if present (CUPS only) |
---|
[2474] | 896 | # PYKOTAREASON : if the job was denied or a warning needs to be issued, contains |
---|
| 897 | # the message to send to the user. |
---|
[2882] | 898 | # PYKOTAUSERDESCRIPTION : the user's textual description |
---|
| 899 | # PYKOTAPRINTERDESCRIPTION : the printer's textual description |
---|
| 900 | # PYKOTAPRINTERPASSTHROUGHMODE : the printer's passthrough mode |
---|
| 901 | # PYKOTAPRINTERMAXJOBSIZE : the printer's maximal job size |
---|
[2884] | 902 | # PYKOTAPRICEPERJOB : the printer's price per job |
---|
| 903 | # PYKOTAPRICEPERPAGE : the printer's price per page |
---|
[2054] | 904 | # |
---|
[1372] | 905 | |
---|
[2838] | 906 | |
---|
[1372] | 907 | # PreHook : gets executed after being sure the user, printer and user quota |
---|
[1373] | 908 | # entry on the printer both exist in the PyKota database, and after |
---|
| 909 | # checking if the user is allowed to print or not, but just before |
---|
| 910 | # the job is sent to the printer (if allowed) |
---|
[1372] | 911 | # prehook has access to many environment variables : |
---|
| 912 | # |
---|
| 913 | # PYKOTAACTION contains either "ALLOW", "WARN" or "DENY" and |
---|
| 914 | # represents the action which is to be done wrt the print job. |
---|
| 915 | # PYKOTAPHASE contains 'BEFORE' during execution of prehook |
---|
| 916 | # |
---|
| 917 | # uncomment the line below to see what environment variables are available |
---|
| 918 | # prehook: /usr/bin/printenv >/tmp/before |
---|
| 919 | |
---|
[2837] | 920 | |
---|
| 921 | |
---|
[1372] | 922 | # PostHook : gets executed after the job has been added to the history. |
---|
| 923 | # posthook has access to all the environment variables defined above, |
---|
| 924 | # as well as two additionnal environment variables : PYKOTAJOBPRICE |
---|
| 925 | # and PYKOTAJOBSIZE. |
---|
| 926 | # PYKOTAPHASE contains 'AFTER' during execution of posthook. |
---|
| 927 | # |
---|
| 928 | # uncomment the line below to see what environment variables are available |
---|
[1781] | 929 | # posthook: /usr/bin/printenv >/tmp/after |
---|
[1372] | 930 | |
---|
[2837] | 931 | |
---|
| 932 | |
---|
[1914] | 933 | # AccountBanner : how should banner accounting be done ? |
---|
[1915] | 934 | # |
---|
[1914] | 935 | # If enabled, banner pages printed from StartingBanner and/or EndingBanner |
---|
| 936 | # (depending on the value) will be included in the accounting for the |
---|
| 937 | # print job |
---|
| 938 | # |
---|
| 939 | # If disabled, banner pages printed from StartingBanner and EndingBanner will |
---|
| 940 | # *not* be included in the accounting for the print job |
---|
| 941 | # |
---|
| 942 | # IMPORTANT : CUPS generated banners are ALWAYS accounted for, although you |
---|
| 943 | # can refund them by using negative prices on printers. |
---|
| 944 | # |
---|
| 945 | # Allowed values : Starting | Ending | None | Both |
---|
| 946 | # |
---|
| 947 | # - Starting : only the starting banner will be accounted for. |
---|
| 948 | # - Ending : only the ending banner will be accounted for. |
---|
| 949 | # - Both : both starting and ending banners will be accounted for. |
---|
| 950 | # - None : banners will not be accounted for. |
---|
| 951 | # |
---|
| 952 | # Default value : |
---|
| 953 | # accountbanner: Both |
---|
| 954 | |
---|
[2837] | 955 | |
---|
| 956 | |
---|
[2054] | 957 | # Maximal number of times the banner will still be printed if |
---|
| 958 | # the user is forbidden to print. |
---|
| 959 | # |
---|
| 960 | # This option can be set either globally or on a per printer basis. |
---|
| 961 | # Allowed values are 0 or any positive integer. |
---|
| 962 | # Default value is 0, which means that the banner won't be printed |
---|
| 963 | # at all if the user is forbidden to print. |
---|
[2837] | 964 | # |
---|
[2054] | 965 | maxdenybanners: 0 |
---|
| 966 | |
---|
[2837] | 967 | |
---|
| 968 | |
---|
[1914] | 969 | # StartingBanner : if defined will print a banner before the rest of the job |
---|
| 970 | # is printed. The argument can be a printable file, or an executable file. |
---|
| 971 | # If not executable, the file will be printed as is. If executable, the |
---|
[2837] | 972 | # file will be executed and its standard output will be sent to the printer. |
---|
[1915] | 973 | # |
---|
[1914] | 974 | # In any case, the banner content which will be sent to the printer |
---|
[1931] | 975 | # MUST be in a format your printer will accept !!! |
---|
[1914] | 976 | # |
---|
| 977 | # The pkbanner command included in PyKota can automatically generate |
---|
| 978 | # starting and ending banners in the PostScript format. You can use |
---|
| 979 | # this command in a pipe through GhostScript if your printer doesn't |
---|
| 980 | # accept PostScript as an input format. |
---|
[1923] | 981 | # NB : pkbanner's default page size is A4 |
---|
[1914] | 982 | # |
---|
[1930] | 983 | # startingbanner: /home/joe/mystaticbanner.ps |
---|
[1923] | 984 | # startingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
[1931] | 985 | # startingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
[1923] | 986 | # startingbanner: /usr/bin/pkbanner |
---|
[1914] | 987 | |
---|
[2837] | 988 | |
---|
| 989 | |
---|
[2326] | 990 | # EndingBanner : if defined will print a banner after the job |
---|
| 991 | # has been printed. The argument can be a printable file, or an executable file. |
---|
[1914] | 992 | # If not executable, the file will be printed as is. If executable, the |
---|
[2837] | 993 | # file will be executed and its standard output will be sent to the printer. |
---|
[1914] | 994 | # |
---|
| 995 | # In any case, the banner content which will be sent to the printer |
---|
| 996 | # MUST be in a format your printer will accept !!! |
---|
| 997 | # |
---|
| 998 | # The pkbanner command included in PyKota can automatically generate |
---|
| 999 | # starting and ending banners in the PostScript format. You can use |
---|
| 1000 | # this command in a pipe through GhostScript if your printer doesn't |
---|
| 1001 | # accept PostScript as an input format. |
---|
[1923] | 1002 | # NB : pkbanner's default page size is A4 |
---|
[1914] | 1003 | # |
---|
[2193] | 1004 | # A static banner page |
---|
[1930] | 1005 | # endingbanner: /home/joe/mystaticbanner.ps |
---|
[2193] | 1006 | # |
---|
| 1007 | # A banner with personnalized logo and url |
---|
[1923] | 1008 | # endingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com" |
---|
[2193] | 1009 | # |
---|
| 1010 | # A banner in the format accepted by the printer |
---|
[1931] | 1011 | # endingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono - |
---|
[2193] | 1012 | # |
---|
| 1013 | # A banner with more info on it, extracted from the yellow pages. |
---|
| 1014 | # the string "Phone 111222333444" will be added to the banner page |
---|
| 1015 | # if extractphone.sh returns 111222333444 for the current user. |
---|
| 1016 | # endingbanner: /usr/bin/pkbanner Phone `extractphone.sh $PYKOTAUSERNAME` |
---|
| 1017 | # |
---|
| 1018 | # Default PyKota banner |
---|
| 1019 | # endingbanner: /usr/bin/pkbanner |
---|
[1914] | 1020 | |
---|
[2837] | 1021 | |
---|
| 1022 | |
---|
[1495] | 1023 | # How should enforcement be done for this printer ? |
---|
| 1024 | # |
---|
| 1025 | # "laxist" is the default if value is not set, and allows users |
---|
| 1026 | # to be over quota on their last job. |
---|
| 1027 | # |
---|
| 1028 | # "strict" tries to prevent users from ever being over quota. |
---|
| 1029 | # |
---|
| 1030 | # Enforcement can be defined either globally, per printer, |
---|
| 1031 | # or both. If both are defined, the printer specific enforcement |
---|
| 1032 | # setting has priority. |
---|
| 1033 | # |
---|
| 1034 | # valid values : "strict" or "laxist" |
---|
| 1035 | # |
---|
[2837] | 1036 | # default value when not set is "laxist" |
---|
| 1037 | # |
---|
[1495] | 1038 | # enforcement : laxist |
---|
| 1039 | enforcement : strict |
---|
[2062] | 1040 | |
---|
[2837] | 1041 | |
---|
| 1042 | |
---|
[2062] | 1043 | # Should we trust the job size on this printer ? |
---|
| 1044 | # |
---|
[2111] | 1045 | # "trustjobsize : yes" is the default, the jobsize, either computed |
---|
[2062] | 1046 | # by the hardware or by software is trusted. |
---|
| 1047 | # |
---|
[2837] | 1048 | # "trustjobsize : >N:precomputed" : uses the precomputed value |
---|
| 1049 | # if jobsize > N pages |
---|
[2111] | 1050 | # "trustjobsize : >N:25" : uses 25 if jobsize is >N pages |
---|
[2062] | 1051 | # |
---|
| 1052 | # General form : ">n:m" where n is a positive integer, and m is |
---|
| 1053 | # either the word 'precomputed' or a positive integer. |
---|
| 1054 | # The special form "yes" is also accepted and is the default. |
---|
| 1055 | # |
---|
| 1056 | # This directive can be set either globally or on a per printer |
---|
| 1057 | # basis. Use this directive when hardware accounting for a particular |
---|
| 1058 | # printer produces some glitches due to the printer returning |
---|
| 1059 | # incorrect answers. |
---|
| 1060 | # |
---|
| 1061 | # NB : DON'T MODIFY THIS IF YOU DON'T NEED TO. THIS IS ONLY TO BE USED |
---|
| 1062 | # AS A WORKAROUND FOR SOME PRINTERS. IT'S PROBABLY BETTER TO ALWAYS |
---|
| 1063 | # SET THIS DIRECTIVE TO 'yes'. THIS DIRECTIVE WILL ONLY BE HONORED |
---|
| 1064 | # IF PYKOTA DETECTS A DIFFERENCE BETWEEN THE PRECOMPUTED JOB SIZE |
---|
| 1065 | # AND THE JOB SIZE AS COMPUTED BY PYKOTA EITHER USING HARDWARE OR |
---|
| 1066 | # SOFTWARE. |
---|
[2837] | 1067 | # |
---|
[2062] | 1068 | trustjobsize : yes |
---|
[2066] | 1069 | |
---|
[2837] | 1070 | |
---|
| 1071 | |
---|
[2066] | 1072 | # Should we deny duplicate jobs ? |
---|
| 1073 | # |
---|
| 1074 | # A duplicate is a job sent twice (or more) in a row to the same printer |
---|
| 1075 | # by the same user. |
---|
| 1076 | # |
---|
| 1077 | # This can be defined either globally or on a per printer basis |
---|
| 1078 | # The default value is 'no', meaning that duplicate jobs are |
---|
| 1079 | # allowed. |
---|
| 1080 | # |
---|
| 1081 | # NB : if an user prints a job, a second user prints another |
---|
| 1082 | # job, and the first user prints the first job again, |
---|
| 1083 | # this is NOT considered as a duplicate since the two |
---|
| 1084 | # identical jobs printed by the first user are not |
---|
| 1085 | # one just after the other. |
---|
| 1086 | # |
---|
[2308] | 1087 | # Possible values are 'yes', 'no', or any other string. |
---|
| 1088 | # If the string is not recognized as a truth value, |
---|
| 1089 | # it is considered to be a command to launch. |
---|
| 1090 | # PyKota launches the command and parses its standard |
---|
| 1091 | # output. The special keywords 'ALLOW' and 'DENY' are |
---|
| 1092 | # recognized, allowing an external tool to decide if |
---|
| 1093 | # the job is to be allowed or denied. |
---|
[2066] | 1094 | # |
---|
[2308] | 1095 | # denyduplicates : /usr/bin/myowncommand with some arguments |
---|
| 1096 | # denyduplicates : yes |
---|
[2066] | 1097 | denyduplicates : no |
---|
| 1098 | |
---|
[2837] | 1099 | |
---|
| 1100 | |
---|
[2692] | 1101 | # Sets the delay in seconds after which two identical jobs are |
---|
| 1102 | # not considered as being a duplicate. |
---|
| 1103 | # |
---|
| 1104 | # This can be defined either globally or on a per printer basis |
---|
| 1105 | # The default value if not set is 0, for 0 seconds. |
---|
| 1106 | # duplicatesdelay : 300 |
---|
| 1107 | duplicatesdelay : 0 |
---|
| 1108 | |
---|
[2837] | 1109 | |
---|