tools/cachemgr.cgi.8.in

   1 .if !'po4a'hide' .TH cachemgr.cgi 8
   2 .
   3 .SH NAME
   4 cachemgr.cgi \- Squid HTTP proxy manager CGI web interface
   5 .
   6 .SH SYNOPSIS
   7 .if !'po4a'hide' .B http://your.server/cgi-bin/cachemgr.cgi
   8 .
   9 .SH DESCRIPTION
  10 The cache manager (
  11 .B cachemgr.cgi
  12 ) is a CGI utility for displaying statistics
  13 about the Squid HTTP proxy process as it runs. The cache manager is a
  14 convenient way to manage the cache and view statistics without logging
  15 into the server.
  16 .
  17 .SH CONFIGURATION
  18 Configuration examples for many common web servers can be found in the
  19 Squid FAQ wiki.
  20 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
  21 .PP
  22 .if !'po4a'hide' .I ./cachemgr.conf
  23 .br
  24 .if !'po4a'hide' .I @SYSCONFDIR@/cachemgr.conf
  25 .RS
  26 The access configuration file defining which Squid servers may
  27 be managed via this
  28 .B cachemgr.cgi
  29 program. Each line specifies a
  30 .BR server : port
  31 followed by an optional description
  32 .PP
  33 The server name may contain shell wildcard characters such as *, [] etc.
  34 A quick selection dropdown menu is automatically constructed from the simple
  35 server names.
  36 .PP
  37 Specifying :port is optional. If not specified then
  38 the default proxy port is assumed. :* or :any matches
  39 any port on the target server.
  40 .
  41 .SH SECURITY
  42 .B cachemgr.cgi
  43 calls the requested server on the requested port using HTTP
  44 and returns a formatted version of the response. To avoid abuse it is
  45 recommended to configure your web server to restrict access to the
  46 .B cachemgr.cgi
  47 program.
  48 .
  49 .SH AUTHOR
  50 Derived from Harvest. Further developed by numerous individuals from
  51 the internet community. Development is led by Duane Wessels of the
  52 National Laboratory for Applied Network Research and funded by
  53 the National Science Foundation.
  54 .
  55 .SH COPYRIGHT
  56 .PP
  57  * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
  58  *
  59  * Squid software is distributed under GPLv2+ license and includes
  60  * contributions from numerous individuals and organizations.
  61  * Please see the COPYING and CONTRIBUTORS files for details.
  62 .
  63 .SH QUESTIONS
  64 Questions on the usage of this program can be sent to the
  65 .I Squid Users mailing list
  66 .if !'po4a'hide' <squid-users@lists.squid-cache.org>
  67 .
  68 .SH REPORTING BUGS
  69 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
  70 .PP
  71 Report bugs or bug fixes using http://bugs.squid-cache.org/
  72 .PP
  73 Report serious security bugs to
  74 .I Squid Bugs <squid-bugs@lists.squid-cache.org>
  75 .PP
  76 Report ideas for new improvements to the
  77 .I Squid Developers mailing list
  78 .if !'po4a'hide' <squid-dev@lists.squid-cache.org>
  79 .
  80 .SH SEE ALSO
  81 .if !'po4a'hide' .BR squid "(8), "
  82 .if !'po4a'hide' .BR squidclient "(1)"