[753] | 1 | <!-- $Id$ --> |
---|
| 2 | |
---|
| 3 | <chapter> |
---|
[865] | 4 | <title id="installation">Installation</title> |
---|
[860] | 5 | |
---|
| 6 | <para>Last modified on $Date$</para> |
---|
| 7 | |
---|
[753] | 8 | <para> |
---|
[856] | 9 | Before being able to use <application>PyKota</application>, you have of course to |
---|
| 10 | install it first. But before installing, you must carefully plan your installation. |
---|
[753] | 11 | </para> |
---|
[856] | 12 | |
---|
| 13 | <para> |
---|
| 14 | First you have to determine which machine will be the <application>PyKota</application> |
---|
[860] | 15 | <firstterm>Storage Server</firstterm>. The Storage Server is the host responsible |
---|
[856] | 16 | for keeping a centralized database of print usage for all your printers, users and groups. |
---|
| 17 | </para> |
---|
| 18 | |
---|
| 19 | <para> |
---|
[860] | 20 | Then you have to list all the <firstterm>Print Servers</firstterm> for which |
---|
| 21 | you plan to use <firstterm>print quota</firstterm> facilities. |
---|
[856] | 22 | </para> |
---|
| 23 | |
---|
| 24 | <para> |
---|
[861] | 25 | Finally you have to download <application>PyKota</application>'s latest version |
---|
| 26 | or buy an official package, from |
---|
| 27 | <ulink url="http://www.librelogiciel.com/software/">http://www.librelogiciel.com/software/</ulink>. |
---|
| 28 | If you've just bought an official package, then as soon as you've receive it you |
---|
| 29 | have to decompress and visit its archive, to do so just type the following commands : |
---|
| 30 | <screen> |
---|
[2556] | 31 | jerome@nordine:~$ tar -zxf pykota-1.23_official.tar.gz |
---|
| 32 | jerome@nordine:~$ cd pykota-1.23_official |
---|
| 33 | jerome@nordine:~/pykota-1.23_official$ |
---|
[861] | 34 | </screen> |
---|
| 35 | </para> |
---|
| 36 | |
---|
| 37 | <para> |
---|
| 38 | You can see many files in this directory, the first ones to read are <filename>README</filename>, |
---|
| 39 | then <filename>COPYING</filename> and <filename>LICENSE</filename>. They will give you |
---|
| 40 | basic installation instructions and explain the licensing terms under which |
---|
| 41 | <application>PyKota</application> is distributed. Of course they are also mostly |
---|
| 42 | boring to read ! Detailed installation and operating instructions are defined |
---|
| 43 | in the <filename>./docs</filename> directory, in the form of <acronym>SGML</acronym> |
---|
| 44 | documentation in the <ulink url="http://www.docbook.org">DocBook</ulink> format. |
---|
| 45 | You have to compile these files into readable documentation like the <acronym>HTML</acronym> |
---|
| 46 | or <acronym>PDF</acronym> formats, or buy an official <application>PyKota</application> package |
---|
[1168] | 47 | which already contains these compiled forms of the documentation. Of course you already |
---|
| 48 | know this because that's what you are currently reading ! |
---|
[861] | 49 | </para> |
---|
| 50 | |
---|
| 51 | <para> |
---|
| 52 | Now we will see what has to be done on each of the servers we are planning to use. |
---|
[856] | 53 | <note> |
---|
| 54 | <title>Note</title> |
---|
| 55 | <para> |
---|
| 56 | Of course, depending on the size of your network, you may very well |
---|
| 57 | use the same machine as both a Print Server and a Storage Server. |
---|
| 58 | This is especially the case if you've got only one server. |
---|
| 59 | </para> |
---|
| 60 | </note> |
---|
| 61 | </para> |
---|
| 62 | |
---|
| 63 | <sect1> |
---|
| 64 | <title>Storage Server Installation</title> |
---|
| 65 | |
---|
| 66 | <para> |
---|
| 67 | Depending on <application>PyKota</application>'s version number, different |
---|
| 68 | types of storage backends may be supported, so we will see for each one of |
---|
| 69 | them how to configure it. |
---|
| 70 | </para> |
---|
| 71 | |
---|
| 72 | <sect2> |
---|
| 73 | <title>PostgreSQL</title> |
---|
| 74 | |
---|
| 75 | <para> |
---|
[860] | 76 | <application>PostgreSQL</application> is an <firstterm>Object Relationnal DataBase |
---|
| 77 | Management System</firstterm> distributed under a <firstterm>Free Software</firstterm> |
---|
[856] | 78 | license from the |
---|
| 79 | <ulink url="http://www.postgresql.org">http://www.postgresql.org</ulink> |
---|
| 80 | web site. It certainely is the free <acronym>RDBMS</acronym> which has the most advanced |
---|
| 81 | features, and is widely used all over the world. |
---|
| 82 | </para> |
---|
| 83 | |
---|
| 84 | <para> |
---|
| 85 | To configure your Storage Server, you must have PostgreSQL already working. |
---|
| 86 | The complete installation of <application>PostgreSQL</application> is not covered by |
---|
| 87 | the present manual, please refer to your system's documentation or to |
---|
| 88 | <ulink url="http://www.postgresql.org">http://www.postgresql.org</ulink> for |
---|
| 89 | details. |
---|
| 90 | </para> |
---|
| 91 | |
---|
| 92 | <para> |
---|
| 93 | One thing you have to check, though, is that every Print Server on which you |
---|
[863] | 94 | want to install the print quota mechanism, must be able to connect to the |
---|
[856] | 95 | <application>PostgreSQL</application> server. In the default installation of |
---|
| 96 | <application>PostgreSQL</application> this may not be the case for security reasons, except if both |
---|
| 97 | servers are in fact the same machine. In any case, it is recommended that you |
---|
[862] | 98 | check the <filename>/etc/postgresql/pg_hba.conf</filename> file and modify it if |
---|
[856] | 99 | needed. This file is self documented and its modification is straightforward. |
---|
[858] | 100 | You also have to make sure that <application>PostgreSQL</application> accepts <acronym>TCP/IP</acronym> connections. |
---|
| 101 | To do so you either have to launch it with the <option>-i</option> option or |
---|
[862] | 102 | modify the <filename>/etc/postgresql/postgresql.conf</filename> file, which is |
---|
[1168] | 103 | self documented and easy to modify too. Allowing <acronym>TCP/IP</acronym> connections |
---|
| 104 | is not necessary though if your Quota Storage Server and your Print Server are |
---|
| 105 | the very same host. |
---|
[2116] | 106 | </para> |
---|
| 107 | |
---|
| 108 | <para> |
---|
| 109 | Here's an excerpt from a <filename>pg_hba.conf</filename> file. This one rejects all |
---|
| 110 | connections to PyKota's database excepted when made from the same host by <application>PostgreSQL</application> users |
---|
| 111 | <literal>pykotauser</literal> or <literal>pykotaadmin</literal> with the correct password. |
---|
| 112 | <screen> |
---|
| 113 | local all postgres ident sameuser |
---|
| 114 | local all all reject |
---|
| 115 | host pykota pykotauser 127.0.0.1 255.255.255.255 crypt |
---|
| 116 | host pykota pykotaadmin 127.0.0.1 255.255.255.255 crypt |
---|
| 117 | host pykota all 127.0.0.1 255.255.255.255 reject |
---|
| 118 | </screen> |
---|
| 119 | </para> |
---|
| 120 | |
---|
| 121 | <para> |
---|
| 122 | Of course if your print server and your database servers have different <acronym>IP</acronym> |
---|
| 123 | addresses, you have to replace the <literal>127.0.0.1</literal> address above with your print |
---|
[2126] | 124 | server's <acronym>IP</acronym> address. As an alternative, you could still keep these |
---|
[2169] | 125 | lines and add similar lines with other <acronym>IP</acronym> addresses if you have several |
---|
[2126] | 126 | print servers for which you want a single centralized database. |
---|
[856] | 127 | <tip> |
---|
| 128 | <title>Tip</title> |
---|
| 129 | <para> |
---|
| 130 | Don't forget to restart <application>PostgreSQL</application> if you modify |
---|
| 131 | any of its configuration files, in order for the changes to take effect. |
---|
| 132 | </para> |
---|
| 133 | </tip> |
---|
| 134 | </para> |
---|
| 135 | |
---|
| 136 | <para> |
---|
| 137 | Be careful, you may be unable to connect from a Print Server to the <application>PostgreSQL</application> |
---|
| 138 | server even if the configuration is correct. Sometimes your connections may be blocked by |
---|
| 139 | one or more network firewalls along the route from one machine to the other. If this |
---|
[860] | 140 | is the case, then the best thing you can do is to ask your <firstterm>Network Administrator</firstterm> |
---|
[856] | 141 | to not filter the IP port used by <application>PostgreSQL</application>, which is |
---|
[1099] | 142 | usually port <literal>5432/tcp</literal>. |
---|
[860] | 143 | <note> |
---|
| 144 | <title>Note</title> |
---|
[856] | 145 | <para> |
---|
| 146 | The TCP/IP network port used by PostgreSQL may be different. When in doubt, ask your |
---|
[860] | 147 | <firstterm>System Administrator</firstterm> for the correct value. |
---|
[856] | 148 | </para> |
---|
[860] | 149 | </note> |
---|
[856] | 150 | </para> |
---|
| 151 | |
---|
| 152 | <para> |
---|
[860] | 153 | Now that your <application>PostgreSQL</application> server is up and running, and |
---|
| 154 | is waiting for your connections, you have to create the Quota Storage DataBase. |
---|
| 155 | To do so, you'll have to feed <application>PostgreSQL</application> with the |
---|
[2556] | 156 | <filename>pykota-1.23/initscripts/postgresql/pykota-postgresql.sql</filename> file. |
---|
[1021] | 157 | This file will create a Quota DataBase administrator in the <application>PostgreSQL</application> system, then create an empty |
---|
[862] | 158 | Quota DataBase and set some permissions on it. The Quota DataBase administrator |
---|
[1021] | 159 | is the <application>PostgreSQL</application>'s user used to manage the Quota database. |
---|
| 160 | The Quota DataBase Administrator is not present in the Quota Database |
---|
| 161 | itself, he is only defined in <application>PostgreSQL</application> and don't |
---|
[1168] | 162 | have to exist on any system, nor in the Quota DataBase. His default name |
---|
[1021] | 163 | is <literal>pykotaadmin</literal>. |
---|
[1099] | 164 | A Quota Storage read-only user is also created under the name of <literal>pykotauser</literal>. |
---|
| 165 | This read-only user is used by <application>PyKota</application> to connect to the |
---|
[1783] | 166 | Quota Storage when an user who is not a <application>PyKota</application> administrator |
---|
[2116] | 167 | <footnote><para>a <application>PyKota</application> administrator is an user who can read the <filename>~pykota/pykotadmin.conf</filename> file.</para></footnote> |
---|
[1783] | 168 | launches a pykota command. This prevents normal |
---|
[1099] | 169 | users from being able to modify their own, or other users', quota information. |
---|
[1021] | 170 | The database which will be created will be named <literal>pykota</literal> by default. |
---|
[862] | 171 | <note> |
---|
| 172 | <title>Note</title> |
---|
| 173 | <para> |
---|
| 174 | You can choose other names if you want, just modify the |
---|
[1015] | 175 | <filename>initscripts/postgresql/pykota-postgresql.sql</filename> file |
---|
[864] | 176 | accordingly, and report your changes into <application>PyKota</application>'s |
---|
[1600] | 177 | configuration files. |
---|
[862] | 178 | </para> |
---|
| 179 | </note> |
---|
[856] | 180 | </para> |
---|
[860] | 181 | |
---|
| 182 | <para> |
---|
[2115] | 183 | To run this script, you can use the <command>psql</command> frontend to |
---|
[860] | 184 | <application>PostgreSQL</application>, but your priviledges must be sufficient |
---|
[2115] | 185 | to be allowed to create users and databases. You can launch <command>psql</command> |
---|
[860] | 186 | as the <literal>postgres</literal> user which is <application>PostgreSQL</application>'s |
---|
| 187 | default administrator, and connect to the default database named <literal>template1</literal>. |
---|
| 188 | From a command line interpreter (i.e. shell), type the following commands : |
---|
| 189 | <screen> |
---|
[2556] | 190 | jerome@nordine:~$ cd pykota-1.23_official/initscripts/postgresql |
---|
| 191 | jerome@nordine:~/pykota-1.23_official/initscripts$ psql -h localhost -U postgres template1 |
---|
[860] | 192 | Welcome to psql, the PostgreSQL interactive terminal. |
---|
| 193 | |
---|
| 194 | Type: \copyright for distribution terms |
---|
| 195 | \h for help with SQL commands |
---|
| 196 | \? for help on internal slash commands |
---|
| 197 | \g or terminate with semicolon to execute query |
---|
| 198 | \q to quit |
---|
| 199 | |
---|
| 200 | template1=# \i pykota-postgresql.sql |
---|
| 201 | ... a lot of output lines |
---|
[862] | 202 | pykota=# |
---|
[860] | 203 | </screen> |
---|
[1906] | 204 | <note> |
---|
| 205 | <title>Note</title> |
---|
| 206 | <para> |
---|
| 207 | If you use RPM or DEB packages, usually the |
---|
| 208 | <filename>pykota-postgresql.sql</filename> file gets installed into the |
---|
| 209 | <filename>/usr/share/pykota/postgresql</filename> directory, along |
---|
| 210 | with a README file. |
---|
| 211 | </para> |
---|
| 212 | </note> |
---|
[860] | 213 | </para> |
---|
| 214 | |
---|
| 215 | <para> |
---|
[862] | 216 | For security reasons, you may want to set passwords in |
---|
| 217 | <application>PostgreSQL</application> for the |
---|
[1099] | 218 | <literal>pykotaadmin</literal> and <literal>pykotauser</literal> users. |
---|
[1021] | 219 | Otherwise any user able to connect to |
---|
[862] | 220 | <application>PostgreSQL</application> on your Quota Storage Server |
---|
[1099] | 221 | could connect to the quota database, and either see it, or even modify it without problem. |
---|
[862] | 222 | </para> |
---|
| 223 | |
---|
| 224 | <para> |
---|
[2115] | 225 | To do so, just type the following lines while still being at the <command>psql</command> |
---|
[1099] | 226 | prompt (replace the password values by your own, and do the same for the <literal>pykotauser</literal> user) : |
---|
[862] | 227 | <screen> |
---|
| 228 | pykota=# ALTER USER pykotaadmin PASSWORD 'somepassword'; |
---|
| 229 | ALTER USER |
---|
| 230 | pykota=# \q |
---|
[2556] | 231 | jerome@nordine:~/pykota-1.23_official/initscripts/postgresql$ |
---|
[862] | 232 | </screen> |
---|
| 233 | </para> |
---|
| 234 | |
---|
| 235 | <para> |
---|
[2115] | 236 | The <literal>\q</literal> command above will quit the <command>psql</command> |
---|
[862] | 237 | program and return you to the shell's command line prompt. |
---|
| 238 | </para> |
---|
| 239 | |
---|
| 240 | <para> |
---|
| 241 | To improve security further, you could encrypt your database connections, or |
---|
| 242 | take any other step as needed. Please refer to <application>PostgreSQL</application>'s |
---|
[2117] | 243 | documentation for details. |
---|
[862] | 244 | <warning> |
---|
| 245 | <title>Warning</title> |
---|
| 246 | <para> |
---|
| 247 | Defining passwords may not be sufficient if your database access rule is |
---|
| 248 | set to <literal>trust</literal> in the <filename>/etc/postgresql/pg_hba.conf</filename>. |
---|
| 249 | Again, please refer to <application>PostgreSQL</application>'s documentation |
---|
| 250 | for details. Also, passwords will fly unencrypted over the network by default, |
---|
| 251 | so be sure to take any necessary step to secure your database server from |
---|
| 252 | unauthorized use. This has nothing to do with <application>PyKota</application> |
---|
| 253 | though, it is just a general rule to keep in mind. |
---|
| 254 | </para> |
---|
| 255 | </warning> |
---|
| 256 | </para> |
---|
| 257 | |
---|
| 258 | <para> |
---|
[860] | 259 | If no error occured, then your Quota DataBase is ready to be used. |
---|
| 260 | Now you can let the Quota Storage Server alone, the remaining work |
---|
| 261 | will have to be done on each one of the print servers which will |
---|
| 262 | use this particular Quota Storage Server. |
---|
| 263 | <tip> |
---|
| 264 | <title>Tip</title> |
---|
| 265 | <para> |
---|
| 266 | If an error occured, maybe your PostgreSQL version is too old, or |
---|
[1168] | 267 | an unexpected problem (like a bug) happened. Please contact us via email so that we |
---|
[2117] | 268 | can try to fix the problem. Thanks in advance. |
---|
[860] | 269 | </para> |
---|
| 270 | </tip> |
---|
| 271 | </para> |
---|
[862] | 272 | |
---|
[856] | 273 | </sect2> |
---|
| 274 | |
---|
| 275 | <sect2> |
---|
[1906] | 276 | <title>LDAP</title> |
---|
[856] | 277 | |
---|
| 278 | <para> |
---|
[1906] | 279 | Any <acronym>LDAP</acronym> server, and particularly <application>OpenLDAP</application>, can be used |
---|
| 280 | as a Quota Storage Backend. |
---|
[1600] | 281 | Some other LDAP servers can be used, but this is currently untested in production. |
---|
[856] | 282 | </para> |
---|
[1052] | 283 | |
---|
| 284 | <para> |
---|
[1168] | 285 | <application>OpenLDAP</application> is a Lightweight Directory Access Protocol server |
---|
| 286 | implementation published as Free Software. |
---|
| 287 | You can download it from <ulink url="http://www.openldap.org">http://www.openldap.org</ulink>. |
---|
| 288 | </para> |
---|
| 289 | |
---|
| 290 | <para> |
---|
[1052] | 291 | To use <application>OpenLDAP</application> as your Quota Storage Backend, you have to copy the |
---|
[2117] | 292 | <filename>pykota/initscripts/ldap/pykota.schema</filename> into <application>OpenLDAP</application>'s |
---|
[1052] | 293 | schemas directory. |
---|
| 294 | Under Debian GNU/Linux, this is something like : |
---|
| 295 | <screen> |
---|
| 296 | $ cp pykota.schema /etc/ldap/schema |
---|
| 297 | </screen> |
---|
[1906] | 298 | <note> |
---|
| 299 | <title>Note</title> |
---|
| 300 | <para> |
---|
[2126] | 301 | If you use RPM or DEB packages, the |
---|
| 302 | <filename>pykota.schema</filename> file is usually installed into the |
---|
| 303 | <filename>/usr/share/pykota/ldap</filename> directory, along |
---|
| 304 | with a README file, and may also be installed automatically in |
---|
| 305 | your <acronym>LDAP</acronym> server's schemas directory. |
---|
[1906] | 306 | </para> |
---|
| 307 | </note> |
---|
[1052] | 308 | </para> |
---|
| 309 | <para> |
---|
| 310 | Then edit <filename>/etc/ldap/slapd.conf</filename> and add a line to |
---|
| 311 | include the PyKota schema. You should have something |
---|
| 312 | like : |
---|
| 313 | <screen> |
---|
| 314 | # Schema and objectClass definitions |
---|
| 315 | include /etc/ldap/schema/core.schema |
---|
| 316 | include /etc/ldap/schema/cosine.schema |
---|
| 317 | include /etc/ldap/schema/nis.schema |
---|
| 318 | include /etc/ldap/schema/inetorgperson.schema |
---|
| 319 | include /etc/ldap/schema/pykota.schema |
---|
| 320 | </screen> |
---|
| 321 | </para> |
---|
[1168] | 322 | |
---|
[1052] | 323 | <para> |
---|
[1168] | 324 | While this is not mandatory, it is recommended that you setup |
---|
| 325 | some indexes for some often accessed PyKota attributes. |
---|
[1600] | 326 | Here are the minimal indexes |
---|
[1168] | 327 | lines you may want to put in <filename>slapd.conf</filename> : |
---|
| 328 | <screen> |
---|
| 329 | # Indexes for PyKota |
---|
[1600] | 330 | index pykotaUserName pres,eq,sub |
---|
| 331 | index pykotaGroupName pres,eq,sub |
---|
| 332 | index pykotaPrinterName pres,eq,sub |
---|
[2361] | 333 | index pykotaBillingCode pres,eq,sub |
---|
[1168] | 334 | index pykotaLastJobIdent eq |
---|
| 335 | </screen> |
---|
| 336 | </para> |
---|
| 337 | |
---|
| 338 | <para> |
---|
[1600] | 339 | Now you must ensure that the DNs you'll use to bind to |
---|
| 340 | your OpenLDAP server don't have search queries size limits, |
---|
| 341 | which gives for example (OpenLDAP 2.1.x or above) : |
---|
| 342 | |
---|
| 343 | <screen> |
---|
| 344 | # No Limits for PyKota's administrator and read-only user |
---|
[2577] | 345 | limits dn="cn=pykotaadmin,dc=example,dc=com" size.soft=-1 size.hard=soft |
---|
| 346 | limits dn="cn=pykotauser,dc=example,dc=com" size.soft=-1 size.hard=soft |
---|
[1600] | 347 | </screen> |
---|
| 348 | |
---|
[2577] | 349 | Where pykotaadmin and pykotauser are the usernames used to bind to your |
---|
[1600] | 350 | OpenLDAP server within PyKota, respectively in ReadWrite mode |
---|
| 351 | (as set in pykotadmin.conf) and in ReadOnly mode (as set in pykota.conf). |
---|
| 352 | </para> |
---|
| 353 | |
---|
| 354 | <para> |
---|
[2577] | 355 | Finally, stop the <application>OpenLDAP</application> server, generate |
---|
| 356 | the index files, and restart <application>OpenLDAP</application> |
---|
[1052] | 357 | <screen> |
---|
[2577] | 358 | $ /etc/init.d/slapd stop |
---|
| 359 | $ slapindex |
---|
| 360 | $ /etc/init.d/slapd start |
---|
[1052] | 361 | </screen> |
---|
| 362 | </para> |
---|
| 363 | |
---|
| 364 | <para> |
---|
[1168] | 365 | With an <acronym>LDAP</acronym> backend, PyKota will need some branches |
---|
| 366 | in your <acronym>LDAP</acronym> directory to put its own datas. |
---|
| 367 | You can configure PyKota to either attach its datas to your existing |
---|
| 368 | users and groups, or to put them in their own <literal>ou</literal>. |
---|
| 369 | But some <literal>ou</literal>s dedicated to PyKota are needed in any case, |
---|
| 370 | so the best bet may be to put all PyKota's datas below an <literal>ou=PyKota</literal> |
---|
| 371 | branch. While this will separate these datas from your existing users and groups |
---|
| 372 | entries, this may ease the maintainance. |
---|
| 373 | </para> |
---|
| 374 | |
---|
| 375 | <para> |
---|
| 376 | PyKota needs at least an <literal>ou</literal> for printers, for users quotas, for |
---|
[2361] | 377 | groups quotas, for print jobs, for billing codes, and for pointers to the last job of each printer. |
---|
[1168] | 378 | In the future, this last <literal>ou</literal> may disappear as its content |
---|
| 379 | will probably be attached to each printer. |
---|
| 380 | </para> |
---|
| 381 | |
---|
| 382 | <para> |
---|
| 383 | Actually PyKota doesn't create these <literal>ou</literal>s for you, because it's |
---|
| 384 | difficult to guess what is the best configuration for you. So you have to |
---|
| 385 | create them by yourself, either directly with a text editor and the |
---|
[2115] | 386 | <command>ldapadd</command> command, or with some specialized tool |
---|
| 387 | like <command>gq</command>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename> |
---|
[2126] | 388 | file to see which minimal branches are necessary. |
---|
[1906] | 389 | <note> |
---|
| 390 | <title>Note</title> |
---|
| 391 | <para> |
---|
| 392 | If you use RPM or DEB packages, usually the |
---|
[2126] | 393 | <filename>pykota-sample.ldif</filename> file is installed into the |
---|
[1906] | 394 | <filename>/usr/share/pykota/ldap</filename> directory, along |
---|
| 395 | with a README file. |
---|
| 396 | </para> |
---|
| 397 | </note> |
---|
[1168] | 398 | </para> |
---|
| 399 | |
---|
| 400 | <para> |
---|
[2117] | 401 | If no error occured, then your Quota DataBase is ready to be used. |
---|
| 402 | Now you can let the Quota Storage Server alone, the remaining work |
---|
| 403 | will have to be done on each one of the print servers which will |
---|
| 404 | use this particular Quota Storage Server. |
---|
| 405 | <tip> |
---|
| 406 | <title>Tip</title> |
---|
| 407 | <para> |
---|
| 408 | If an error occured, maybe your OpenLDAP version is too old, or |
---|
| 409 | an unexpected problem (like a bug) happened. Please contact us via email so that we |
---|
| 410 | can try to fix the problem. Thanks in advance. |
---|
| 411 | </para> |
---|
| 412 | </tip> |
---|
[1052] | 413 | </para> |
---|
[856] | 414 | </sect2> |
---|
| 415 | |
---|
| 416 | <sect2> |
---|
[1038] | 417 | <title>MySQL</title> |
---|
[856] | 418 | |
---|
| 419 | <para> |
---|
[1038] | 420 | A <application>MySQL</application> Storage Backend is planned, but it actually |
---|
| 421 | doesn't exist. |
---|
[856] | 422 | </para> |
---|
| 423 | </sect2> |
---|
| 424 | |
---|
| 425 | <sect2> |
---|
| 426 | <title>Berkeley DB</title> |
---|
| 427 | |
---|
| 428 | <para> |
---|
[857] | 429 | A <application>Berkeley DB</application> Storage Backend is planned, but it actually |
---|
| 430 | doesn't exist. It seems that remote storage won't be possible with such a backend, |
---|
| 431 | so in other terms this means that you will have a different quota database on |
---|
| 432 | each print server. This may still prove to be useful for small configurations. |
---|
[856] | 433 | </para> |
---|
| 434 | </sect2> |
---|
| 435 | </sect1> |
---|
| 436 | |
---|
| 437 | <sect1> |
---|
| 438 | <title>Print Server Installation</title> |
---|
| 439 | |
---|
| 440 | <para> |
---|
| 441 | For each Print Server on which you plan to implement the print quota |
---|
| 442 | mechanism, you have, of course, to have an already working printing environment. |
---|
[2478] | 443 | Currently <application>PyKota</application> works with |
---|
[959] | 444 | <ulink url="http://www.cups.org"><application>CUPS</application></ulink> |
---|
[2478] | 445 | but older releases also supported <ulink url="http://lprng.sourceforge.net"><application>LPRng</application></ulink>. |
---|
| 446 | <application>LPRng</application> support might be re-added in the future. |
---|
[856] | 447 | </para> |
---|
| 448 | |
---|
| 449 | <para> |
---|
[959] | 450 | Here's the list of software you have to install on each Print Server, version numbers |
---|
| 451 | are given as an indication of which was successfully tested, but older versions may |
---|
| 452 | work too. |
---|
[862] | 453 | <itemizedlist> |
---|
| 454 | <listitem> |
---|
| 455 | <para> |
---|
[2478] | 456 | <application>CUPS</application> version 1.1.14 or above. |
---|
| 457 | You can download it from <ulink url="http://www.cups.org">http://www.cups.org</ulink> |
---|
[862] | 458 | </para> |
---|
| 459 | </listitem> |
---|
| 460 | <listitem> |
---|
| 461 | <para> |
---|
[2126] | 462 | <application>Python</application> version 2.1 or above. |
---|
[862] | 463 | You can download it from <ulink url="http://www.python.org">http://www.python.org</ulink>. |
---|
[2126] | 464 | While <application>PyKota</application> itself will try to preserve compatibility |
---|
| 465 | with <application>Python</application> version 2.1 for the near future, some <application>Python</application> |
---|
| 466 | modules which are needed by <application>PyKota</application> may mandate the use of a more recent version |
---|
| 467 | of this language. |
---|
[862] | 468 | </para> |
---|
| 469 | </listitem> |
---|
| 470 | <listitem> |
---|
| 471 | <para> |
---|
| 472 | Quota Storage client libraries, depending on your Quota Storage Backend : |
---|
| 473 | <itemizedlist> |
---|
| 474 | <listitem> |
---|
| 475 | <para> |
---|
| 476 | PostgreSQL backend : |
---|
| 477 | <itemizedlist> |
---|
| 478 | <listitem> |
---|
| 479 | <para> |
---|
| 480 | <application>PostgreSQL</application> client libraries. They must match the <application>PostgreSQL</application> |
---|
| 481 | version used on your Quota Storage Server. |
---|
| 482 | </para> |
---|
| 483 | </listitem> |
---|
| 484 | <listitem> |
---|
| 485 | <para> |
---|
| 486 | The <application>PygreSQL</application> python module. |
---|
[1168] | 487 | It must have been compiled against the same |
---|
| 488 | <application>PostgreSQL</application> client libraries. |
---|
| 489 | <application>PygreSQL</application> is normally included in |
---|
| 490 | <application>PostgreSQL</application>, but you may want to |
---|
| 491 | download it from <ulink url="http://www.pygresql.org">http://www.pygresql.org</ulink> |
---|
[862] | 492 | </para> |
---|
| 493 | </listitem> |
---|
| 494 | </itemizedlist> |
---|
| 495 | </para> |
---|
| 496 | </listitem> |
---|
| 497 | <listitem> |
---|
| 498 | <para> |
---|
[1168] | 499 | OpenLDAP backend : |
---|
| 500 | <itemizedlist> |
---|
| 501 | <listitem> |
---|
| 502 | <para> |
---|
| 503 | <application>OpenLDAP</application> client libraries. They must match |
---|
| 504 | the <application>OpenLDAP</application> version used on your Quota Storage Server. |
---|
| 505 | </para> |
---|
| 506 | </listitem> |
---|
| 507 | <listitem> |
---|
| 508 | <para> |
---|
| 509 | The <application>Python-LDAP</application> python module. |
---|
| 510 | It must have been compiled against the same |
---|
| 511 | <application>OpenLDAP</application> client libraries. |
---|
| 512 | You may download this module from <ulink url="http://python-ldap.sourceforge.net">http://python-ldap.sourceforge.net</ulink> |
---|
| 513 | </para> |
---|
| 514 | </listitem> |
---|
| 515 | </itemizedlist> |
---|
[862] | 516 | </para> |
---|
| 517 | </listitem> |
---|
| 518 | <listitem> |
---|
| 519 | <para> |
---|
[2478] | 520 | MySQL backend : Not supported yet. |
---|
[862] | 521 | </para> |
---|
| 522 | </listitem> |
---|
| 523 | <listitem> |
---|
| 524 | <para> |
---|
[2478] | 525 | Berkeley DB backend : Not supported yet. |
---|
[862] | 526 | </para> |
---|
| 527 | </listitem> |
---|
| 528 | </itemizedlist> |
---|
| 529 | </para> |
---|
| 530 | </listitem> |
---|
| 531 | <listitem> |
---|
| 532 | <para> |
---|
| 533 | <application>ucd-snmp</application> or <application>net-snmp</application> tools, version 4.2.5 or above. You only need |
---|
[2115] | 534 | the <command>snmpget</command> command. |
---|
[1168] | 535 | You can download this software from <ulink url="http://www.sourceforge.net/projects/net-snmp/">http://www.sourceforge.net/projects/net-snmp/</ulink>. |
---|
[959] | 536 | You only need this if you plan to query your printers for their internal page counter via SNMP. |
---|
[862] | 537 | </para> |
---|
| 538 | </listitem> |
---|
| 539 | <listitem> |
---|
| 540 | <para> |
---|
[959] | 541 | <application>netatalk</application> version 1.6.1 or above. You only need |
---|
[2115] | 542 | the <command>pap</command> command. |
---|
[1168] | 543 | You can download this software from <ulink url="http://netatalk.sourceforge.net/">http://netatalk.sourceforge.net/</ulink>. |
---|
[959] | 544 | You only need this if you plan to query your printers for their internal page counter via AppleTalk. |
---|
| 545 | </para> |
---|
| 546 | </listitem> |
---|
| 547 | <listitem> |
---|
| 548 | <para> |
---|
| 549 | eGenix' mxDateTime Python module version 2.0.3 or above. It must match your default Python version. |
---|
[862] | 550 | You can download it from <ulink url="http://www.egenix.com">http://www.egenix.com</ulink>. |
---|
| 551 | </para> |
---|
| 552 | </listitem> |
---|
[2117] | 553 | <listitem> |
---|
| 554 | <para> |
---|
| 555 | The Python acccelerator <application>Psyco</application>. It must match your default Python version. |
---|
| 556 | You can download it from <ulink url="http://psyco.sourceforge.net">http://psyco.sourceforge.net</ulink>. |
---|
| 557 | You only need this if you run on the <literal>x86</literal> architecture because |
---|
| 558 | <application>Psyco</application> doesn't yet exist on other architectures. |
---|
| 559 | </para> |
---|
| 560 | </listitem> |
---|
| 561 | <listitem> |
---|
| 562 | <para> |
---|
[2478] | 563 | The <application>pysnmp</application> Python module version 3.4.2, 3.4.3 or 3.4.4 exclusively. |
---|
[2117] | 564 | You can download it from <ulink url="http://pysnmp.sourceforge.net">http://pysnmp.sourceforge.net</ulink>. |
---|
| 565 | </para> |
---|
| 566 | </listitem> |
---|
| 567 | <listitem> |
---|
| 568 | <para> |
---|
| 569 | The <application>JAXML</application> Python module. |
---|
| 570 | You can download it from <ulink url="http://www.librelogiciel.com/software/">http://www.librelogiciel.com/software/</ulink>. |
---|
| 571 | </para> |
---|
| 572 | </listitem> |
---|
| 573 | <listitem> |
---|
| 574 | <para> |
---|
| 575 | The <application>ReportLab</application> Toolkit Python module. |
---|
| 576 | You can download it from <ulink url="http://www.reportlab.org">http://www.reportlab.org</ulink>. |
---|
| 577 | </para> |
---|
| 578 | </listitem> |
---|
| 579 | <listitem> |
---|
| 580 | <para> |
---|
[2126] | 581 | The <application>Python Imaging Library - PIL</application> module. |
---|
| 582 | You can download it from <ulink url="http://www.pythonware.com">http://www.pythonware.com</ulink>. |
---|
| 583 | </para> |
---|
| 584 | </listitem> |
---|
| 585 | <listitem> |
---|
| 586 | <para> |
---|
[2117] | 587 | The <application>PyOSD</application> Python module. |
---|
| 588 | You can download it from <ulink url="http://repose.cx/pyosd/">http://repose.cx/pyosd/</ulink>. |
---|
| 589 | </para> |
---|
| 590 | </listitem> |
---|
[2478] | 591 | <listitem> |
---|
| 592 | <para> |
---|
| 593 | The <application>pkpgcounter</application> Generic Page Description Language parser. |
---|
| 594 | You can download it from <ulink url="http://www.librelogiciel.com/software/">http://www.librelogiciel.com/software/</ulink>. |
---|
| 595 | </para> |
---|
| 596 | </listitem> |
---|
[862] | 597 | </itemizedlist> |
---|
[856] | 598 | </para> |
---|
[1168] | 599 | |
---|
| 600 | <para> |
---|
| 601 | Instead of downloading all these programs' sources and compiling them, which really |
---|
| 602 | is a boring task considering that many software are needed, you may prefer to look |
---|
| 603 | into the packages included with your GNU/Linux distribution of choice (if you use |
---|
| 604 | this operating system of course). Most, if not all, GNU/Linux distributions include |
---|
| 605 | all the software mentionned above, in the form of packages which are easier to |
---|
| 606 | install than sources tarballs. This is probably the same for the many *BSD |
---|
| 607 | distributions. |
---|
| 608 | </para> |
---|
| 609 | |
---|
| 610 | <para> |
---|
[2551] | 611 | You can check that all needed software is installed by launching the <command>checkdeps.py</command> |
---|
[1906] | 612 | command : |
---|
| 613 | <screen> |
---|
| 614 | $ python checkdeps.py |
---|
| 615 | </screen> |
---|
| 616 | </para> |
---|
| 617 | |
---|
| 618 | <para> |
---|
[1168] | 619 | Once all these software are installed, installing PyKota itself is a breeze. |
---|
| 620 | PyKota being written entirely in the Python language, which is interpreted, |
---|
| 621 | there's no need to compile anything. You just have to execute the installation |
---|
| 622 | script : |
---|
| 623 | <screen> |
---|
| 624 | $ python setup.py install |
---|
| 625 | </screen> |
---|
| 626 | </para> |
---|
| 627 | |
---|
| 628 | <para> |
---|
[1906] | 629 | The setup script will automatically create the |
---|
| 630 | <filename>/usr/share/pykota/conf</filename> directory and put the sample |
---|
| 631 | configuration files <filename>conf/pykota.conf.sample</filename> and |
---|
| 632 | <filename>conf/pykotadmin.conf.sample</filename> there, along with |
---|
| 633 | a <filename>README</filename> file explaining their purpose. |
---|
[1168] | 634 | </para> |
---|
[2117] | 635 | |
---|
[1168] | 636 | <para> |
---|
[2117] | 637 | Now you have to create a <literal>pykota</literal> system user and group. The <application>PyKota</application> |
---|
| 638 | software will automatically search its configuration files in user <literal>pykota</literal>'s |
---|
| 639 | home directory. For example we could create the user and group, and set <filename>/etc/pykota</filename> |
---|
| 640 | as the home directory, but any other home directory will do : |
---|
| 641 | <screen> |
---|
| 642 | adduser --system --group --home /etc/pykota --gecos PyKota pykota |
---|
| 643 | </screen> |
---|
| 644 | </para> |
---|
| 645 | |
---|
| 646 | <para> |
---|
| 647 | You now have to copy the sample configuration files into the <filename>~pykota</filename> |
---|
| 648 | directory, under the respective names <filename>pykota.conf</filename> and |
---|
[1168] | 649 | <filename>pykotadmin.conf</filename>. Once copied there, you just |
---|
| 650 | have to modify these files to adapt them to your own setup. |
---|
| 651 | These files are heavily commented, so you should have no problem. |
---|
| 652 | Also their format is quite common, because it's the one used by |
---|
| 653 | <application>Samba</application> for example, or by <literal>.ini</literal> |
---|
| 654 | files under <application>MS-Windows</application>, so you may already |
---|
| 655 | be familiar with this syntax. |
---|
| 656 | In a future release, this documentation will include the complete |
---|
| 657 | reference for all configuration fields available. Keep in mind that |
---|
[2126] | 658 | <application>PyKota</application> can be really heavily customized, and can delegate some work |
---|
[1168] | 659 | to any external command of your choice. |
---|
| 660 | </para> |
---|
| 661 | |
---|
| 662 | <para> |
---|
[2116] | 663 | Please create a backup copy of the <filename>~pykota</filename> |
---|
[1906] | 664 | directory before modifying a working installation. |
---|
[1168] | 665 | </para> |
---|
| 666 | |
---|
| 667 | <para> |
---|
| 668 | PyKota features some interesting possibilities which allow you to |
---|
| 669 | define options either globally so that they apply to all printers, |
---|
| 670 | or on a per printer basis. Please see the sample configuration files |
---|
[2126] | 671 | to see what I mean. In the simplest form, only a <literal>[global]</literal> section is |
---|
[1168] | 672 | needed. In more complex configurations, you will have to create |
---|
| 673 | one section per printer. Each section in the configuration files |
---|
| 674 | begins with a name between square brackets <literal>[]</literal>. |
---|
| 675 | The name to use to define a particular printer section is the name |
---|
| 676 | of the print queue on which you want to set quotas. |
---|
| 677 | </para> |
---|
| 678 | |
---|
| 679 | <para> |
---|
[2126] | 680 | After you have modified <application>PyKota</application>'s configuration files, you have to |
---|
[1168] | 681 | double check their permissions, otherwise your installation may be |
---|
| 682 | insecure or may not work at all. |
---|
[2116] | 683 | The main configuration file <filename>~pykota/pykota.conf</filename> |
---|
[1168] | 684 | doesn't contain much sensitive information, so it can be made |
---|
| 685 | readable by anyone. If normal users read this file, at best they |
---|
| 686 | will learn the username and optional password of the read-only |
---|
[2126] | 687 | database user. This means that beside being allowed to read all the contents of |
---|
| 688 | the quota database, they won't be allowed to modify or delete it. |
---|
[2116] | 689 | On the other hand, the <filename>~pykota/pykotadmin.conf</filename> |
---|
[1168] | 690 | file contains the read-write user's identity and password. You must then |
---|
| 691 | ensure that no normal user can read this file. It should only be readable |
---|
[2117] | 692 | by the <literal>root</literal> user, which is always the case, and by |
---|
[2478] | 693 | <application>PyKota</application> administrators. In addition, |
---|
| 694 | users for which <application>CUPS</application> doesn't run as user <literal>root</literal> will |
---|
[2117] | 695 | have to ensure that the user their printing system is run as |
---|
| 696 | can read both of these files. An easy way to do so is to put the <literal>lp</literal> user |
---|
| 697 | (for example) into the <literal>pykota</literal> system group, then |
---|
| 698 | to give the correct permissions to <application>PyKota</application>'s configuration files : |
---|
[1168] | 699 | <screen> |
---|
[2117] | 700 | $ chown pykota.pykota ~pykota/pykota.conf |
---|
[2116] | 701 | $ chmod 644 ~pykota/pykota.conf |
---|
[2117] | 702 | $ chown pykota.pykota ~pykota/pykotadmin.conf |
---|
[2116] | 703 | $ chmod 640 ~pykota/pykotadmin.conf |
---|
[1168] | 704 | </screen> |
---|
[1783] | 705 | |
---|
| 706 | <warning> |
---|
| 707 | <title>Warning</title> |
---|
| 708 | <para> |
---|
[2116] | 709 | All the users allowed to read the <filename>~pykota/pykotadmin.conf</filename> |
---|
[1783] | 710 | are considered to be <application>PyKota</application> administrators. So be |
---|
| 711 | careful with these files permissions. |
---|
| 712 | </para> |
---|
| 713 | </warning> |
---|
[1168] | 714 | </para> |
---|
| 715 | |
---|
[2126] | 716 | <para> |
---|
[2261] | 717 | On some systems, you may be able to strenghten permissions like this : |
---|
| 718 | <screen> |
---|
| 719 | $ chown pykota.pykota ~pykota/pykota.conf |
---|
| 720 | $ chmod 640 ~pykota/pykota.conf |
---|
| 721 | $ chown pykota.pykota ~pykota/pykotadmin.conf |
---|
| 722 | $ chmod 600 ~pykota/pykotadmin.conf |
---|
| 723 | </screen> |
---|
| 724 | </para> |
---|
| 725 | |
---|
| 726 | <para> |
---|
| 727 | And on other ones, you may need to relax them, and change the files' owner : |
---|
| 728 | <screen> |
---|
| 729 | $ chown lp.pykota ~pykota/pykota.conf |
---|
| 730 | $ chmod 640 ~pykota/pykota.conf |
---|
| 731 | $ chown lp.pykota ~pykota/pykotadmin.conf |
---|
| 732 | $ chmod 640 ~pykota/pykotadmin.conf |
---|
| 733 | </screen> |
---|
| 734 | </para> |
---|
| 735 | |
---|
| 736 | <para> |
---|
| 737 | This all depends on the printing system you are using, and the user the |
---|
| 738 | printing system is usually running as. You need to remember two things : |
---|
| 739 | |
---|
| 740 | <itemizedlist> |
---|
| 741 | <listitem> |
---|
| 742 | <para> |
---|
| 743 | The user your printing system runs as MUST be allowed to read |
---|
| 744 | both <application>PyKota</application>'s configuration files. |
---|
| 745 | </para> |
---|
| 746 | </listitem> |
---|
| 747 | <listitem> |
---|
| 748 | <para> |
---|
| 749 | Any user who can read <filename>pykotadmin.conf</filename> |
---|
| 750 | is a <application>PyKota</application> administrator, and |
---|
| 751 | can do whatever he wants to the print quota database. |
---|
| 752 | </para> |
---|
| 753 | </listitem> |
---|
| 754 | </itemizedlist> |
---|
| 755 | </para> |
---|
| 756 | |
---|
| 757 | <para> |
---|
[2126] | 758 | Don't forget to restart your print server sofware if you changed group membership for the user it runs |
---|
| 759 | as, otherwise your change wouldn't be taken into account. |
---|
| 760 | </para> |
---|
[1783] | 761 | |
---|
[1168] | 762 | <para> |
---|
| 763 | Now depending on your printing system, the configuration to do is particular. |
---|
| 764 | We will now see how to plug PyKota into your printing system. |
---|
| 765 | </para> |
---|
| 766 | |
---|
| 767 | <sect2> |
---|
| 768 | <title>With CUPS</title> |
---|
| 769 | |
---|
| 770 | <para> |
---|
[2126] | 771 | From version 1.16alpha7 on, configuring <application>PyKota</application> to integrate |
---|
| 772 | within <application>CUPS</application> is more than easy. |
---|
[1187] | 773 | </para> |
---|
[1168] | 774 | |
---|
| 775 | <para> |
---|
[2551] | 776 | You just have to create a symbolic link to the <command>cupspykota</command> |
---|
[2126] | 777 | command in <application>CUPS</application>' backend directory : |
---|
[1187] | 778 | <screen> |
---|
| 779 | $ cd /usr/lib/cups/backend |
---|
[1347] | 780 | $ ln -s /usr/share/pykota/cupspykota cupspykota |
---|
[1187] | 781 | </screen> |
---|
[1168] | 782 | </para> |
---|
| 783 | |
---|
| 784 | <para> |
---|
| 785 | You have to restart <application>CUPS</application> for this modification to |
---|
| 786 | take effect : |
---|
| 787 | <screen> |
---|
| 788 | $ /etc/init.d/cupsys restart |
---|
| 789 | </screen> |
---|
| 790 | </para> |
---|
| 791 | |
---|
| 792 | <para> |
---|
[1187] | 793 | Now point your web browser to CUPS configuration page, usually at |
---|
| 794 | <ulink url="http://localhost:631">http://localhost:631</ulink> on |
---|
| 795 | your print server. |
---|
| 796 | </para> |
---|
| 797 | |
---|
| 798 | <para> |
---|
| 799 | Then when creating new printers or reconfiguring existing ones, just |
---|
[1600] | 800 | choose devices which are <literal>PyKota managed</literal> |
---|
| 801 | <footnote> |
---|
| 802 | <para> |
---|
| 803 | Debian 3.0 Woody is known to have problems : CUPS 1.1.14 doesn't automatically |
---|
| 804 | detect <literal>PyKota managed</literal> devices. So you have to manually |
---|
| 805 | modify CUPS' <filename>printers.conf</filename> file as explained in |
---|
| 806 | PyKota's toplevel <filename>README</filename> file. |
---|
| 807 | </para> |
---|
| 808 | </footnote> |
---|
| 809 | instead of |
---|
[1187] | 810 | normal devices. You've got one <literal>PyKota managed</literal> device |
---|
| 811 | for each regular device available from CUPS, so just choose the appropriate |
---|
| 812 | one. |
---|
| 813 | </para> |
---|
| 814 | |
---|
| 815 | <para> |
---|
[1168] | 816 | Repeat the above procedure for each print queue on which you want to use |
---|
| 817 | PyKota. That's all ! |
---|
| 818 | </para> |
---|
| 819 | |
---|
| 820 | <sect3> |
---|
| 821 | <title>Troubleshooting</title> |
---|
| 822 | <para> |
---|
| 823 | In case of problem, the simplest way to solve it is currently |
---|
| 824 | to ask on PyKota's mailing list, describing the symptoms, as |
---|
| 825 | well as the hardware and software you use. |
---|
| 826 | In a future release of this document, a section dedicated to |
---|
| 827 | Frequently Asked Questions will be included. |
---|
| 828 | </para> |
---|
[1187] | 829 | |
---|
| 830 | <para> |
---|
| 831 | You can now also ask us questions on IRC : |
---|
| 832 | <screen> |
---|
| 833 | /server irc.freenode.net |
---|
| 834 | /join #pykota |
---|
| 835 | </screen> |
---|
| 836 | </para> |
---|
[1168] | 837 | </sect3> |
---|
| 838 | |
---|
| 839 | </sect2> |
---|
| 840 | |
---|
[856] | 841 | </sect1> |
---|
[753] | 842 | </chapter> |
---|
| 843 | |
---|