Changeset 1166 for pykota/trunk

Show
Ignore:
Timestamp:
10/12/03 22:47:51 (21 years ago)
Author:
jalet
Message:

Doc enhanced.

Location:
pykota/trunk/docs
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/docs/pykotme.sgml

    r1103 r1166  
    3131    option followed with either a printer's name or a wildcard 
    3232    which will be used to search all printers which name matches. 
     33    You can pass more than one printer name wildcard, separating 
     34    them with commas. 
    3335  </para> 
    3436   
     
    8991 
    9092$Log$ 
     93Revision 1.5  2003/10/12 20:47:51  jalet 
     94Doc enhanced. 
     95 
    9196Revision 1.4  2003/07/25 13:18:44  jalet 
    9297Typos 
  • pykota/trunk/docs/repykota.sgml

    r1101 r1166  
    1818      with which you can print the current state of the quota database. 
    1919    </para> 
     20     
     21    <para> 
     22      <application>repykota</application> behaves differently when it is launched by the  
     23      <literal>root</literal> user, compared to when it is launched by a normal user. 
     24    </para>   
     25     
     26    <para> 
     27      In the first case, the print quota report will contain current account balance,  
     28      soft and hard limits, number of pages printed since last reset, total number 
     29      of pages printed, total paid, for possibly all users or all groups, depending 
     30      on command line options. 
     31    </para> 
     32     
     33    <para> 
     34      In the second case, i.e. when <application>repykota</application> is launched by 
     35      a normal user, the user will only be allowed to see informations about himself or  
     36      the groups he his a member of. 
     37    </para> 
    2038   
     39    <para> 
     40      Any user can limit the report to only one or more printers, by specifying the 
     41      <literal>-P</literal> or <literal>--printer</literal> command line option,  
     42      followed by one or more printer name or wildcard. If more than one printer name 
     43      or wildcard is used, they must be separated by commas. 
     44    </para> 
     45     
     46    <para> 
     47      Launching <application>repykota</application> with no arguments will generate 
     48      a complete print quota report, depending on what you are allowed to see. 
     49    </para> 
     50     
     51    <para> 
     52      Use the <literal>--help</literal> command line argument to learn what are 
     53      the different command line options available. 
     54    </para> 
     55     
    2156    <sect2> 
    2257      <title>Reference</title> 
     
    4883    <para> 
    4984      <application>PyKota</application> also features a CGI script to remotely access 
    50       to print quota reports with a web browser, it is called <application>printquota.cgi</application> 
     85      to print quota reports with a web browser, it is called <filename>printquota.cgi</filename> 
    5186      and you can put it in your web server's <filename>cgi-bin</filename> directory if a web server is installed on 
    5287      any machine on which <application>PyKota</application> is also installed and configured 
     
    72107      </note>   
    73108    </para> 
     109     
     110    <para> 
     111      If you install the CGI script as described above, any user will be allowed to view the complete print 
     112      quota report, for all users, groups and printers. This is then a different behavior compared to when 
     113      a normal user wants a print quota report from the command line through <application>repykota</application>. 
     114      If you find this disturbing, then the best is to ask for user authentication whenever the <application>printquota.cgi</application> 
     115      CGI script is accessed. This CGI script will then automatically behave as expected, showing in the print quota 
     116      report only what the authenticated user is allowed to see, just like when he launches <application>repykota</application> 
     117      from the command line. As a special case, if the user authenticates using the <literal>root</literal> username, 
     118      then there's no restriction on what may appear on the print quota report. 
     119    </para> 
     120     
     121    <para> 
     122      To automatically ask for an authentication dialog whenever the CGI script is accessed, you have to configure 
     123      your web server to do so. If your webserver is <ulink url="http://httpd.apache.org"><application>Apache</application></ulink>, then it's relatively easy. First you have to put  
     124      <application>printquota.cgi</application> in its own subdirectory below your web server's <filename>cgi-bin</filename> 
     125      directory, for example in <filename>cgi-bin/PyKota/</filename>. Then use the <application>htpasswd</application> 
     126      command line tool to create a file which contains usernames and passwords for all your users allowed to see 
     127      the print quota report from a web browser, and put this file outside of the directories served by <application>Apache</application> 
     128      so that nobody could retrieve it. Finally create a file named <filename>.htaccess</filename> in 
     129      <filename>cgi-bin/PyKota/</filename> with appropriate content in it. This file should tell <application>Apache</application> to automatically ask 
     130      for an authentication whenever something from this directory is accessed, and to use the password file previously 
     131      created to match usernames and passwords. 
     132      You may also have to tweak <application>Apache</application>'s default configuration to allow the 
     133      authentication mechanism. 
     134    </para> 
     135     
     136    <para> 
     137      The detailed procedure to do all this is out of the scope of the present document, please refer to 
     138      <application>Apache</application>'s <ulink url="http://httpd.apache.org/docs-project/">documentation</ulink>  
     139      for all the gory details. 
     140    </para> 
    74141  </sect1> 
    75142</chapter> 
     
    78145 
    79146$Log$ 
     147Revision 1.6  2003/10/12 20:47:51  jalet 
     148Doc enhanced. 
     149 
    80150Revision 1.5  2003/07/25 13:10:58  jalet 
    81151Improved documentation