1squid(8) System Manager's Manual squid(8)
2
6 squid - HTTP web proxy caching server
7
9 squid [-dhisrvzCFNRSVYX] [-l facility ] [-f config-file ] [-[au] port ]
10 [-k signal ] [-n service-name ] [-O command-line ]
11
13 squid is a high-performance proxy caching server for web clients, sup‐
14 porting FTP, gopher, ICAP, ICP, HTCP and HTTP data objects. Unlike
15 traditional caching software, Squid handles all requests in a single,
16 non-blocking process.
17 Squid keeps meta data and especially hot objects cached in RAM, caches
19 DNS lookups, supports non-blocking DNS lookups, and implements negative
20 caching of failed requests.
21 Squid supports SSL, extensive access controls, and full request log‐
23 ging. By using the lightweight Internet Cache Protocols ICP, HTCP or
24 CARP, Squid caches can be arranged in a hierarchy or mesh for addi‐
25 tional bandwidth savings.
26 Squid consists of a main server program squid , some optional programs
28 for custom processing and authentication, and some management and
29 client tools. When squid starts up, it spawns a configurable number of
30 helper processes, each of which can perform parallel lookups. This
31 reduces the amount of time the cache waits for results.
32 Squid is derived from the ARPA-funded Harvest Project.
34 This manual page only lists the command line arguments. For details on
36 how to configure Squid see the file /etc/squid/squid.conf.documented,
37 the Squid wiki FAQ and examples at http://wiki.squid-cache.org/ , or
38 the configuration manual on the Squid home page http://www.squid-
39 cache.org/Doc/config/
40
42 -a port Specify HTTP port number where Squid should listen for
43 requests, in addition to any http_port specifications in
44 squid.conf
45 -C Do not catch fatal signals.
47 -d level Write debugging to stderr also.
49 -f file Use the given config-file instead of /etc/squid/squid.conf
51 . If the file name starts with a ! or | then it is
52 assumed to be an external command or command line. Can for
53 example be used to pre-process the configuration before it
54 is being read by Squid. To facilitate this Squid also
55 understands the common #line notion to indicate the real
56 source file.
57 -F Don't serve any requests until store is rebuilt.
59 -h Print help message.
61 -i Install as a Windows Service (see -n option).
63 -k reconfigure | rotate | shutdown | interrupt | kill | debug | check |
65 parse
66 Parse configuration file, then send signal to running copy
67 (except -k parse ) and exit.
68 -l facility Use specified syslog facility. Implies -s
70 -n name Specify Windows Service name to use for service operations,
72 default is: Squid
73 -N No daemon mode.
75 -O options Set Windows Service Command line options in Registry.
77 -r Remove a Windows Service (see -n option).
79 -R Do not set REUSEADDR on port.
81 -s Enable logging to syslog. Also configurable in
83 /etc/squid/squid.conf
84 -S Double-check swap during rebuild.
86 -u port Specify ICP port number (default: 3130), disable with 0.
88 -v Print version and build details.
90 -X Force full debugging.
92 -Y Only return UDP_HIT or UDP_MISS_NOFETCH during fast reload.
94 -z Create missing swap directories and other missing cache_dir
96 structures, then exit. All cache_dir types create the con‐
97 figured top-level directory if it is missing. Other actions
98 are type-specific. For example, ufs-based storage systems
99 create missing L1 and L2 directories while Rock creates the
100 missing database file.
101 This option does not enable validation of any present swap
103 structures. Its focus is on creation of missing pieces. If
104 nothing is missing, squid -z just exits. If you suspect
105 cache_dir corruption, you must delete the top-level
106 cache_dir directory before running squid -z.
107 By default, squid -z runs in daemon mode (so that configu‐
109 ration macros and other SMP features work as expected). Use
110 -N option to overwrite this.
111
113 Squid configuration files located in /etc/squid/:
114 squid.conf
116 The main configuration file. You must initially make changes to
117 this file for squid to work. For example, the default configura‐
118 tion only allows access from RFC private LAN networks. Some
119 packaging distributions block even that.
120 squid.conf.default
122 Reference copy of the configuration file. Always kept up to date
123 with the version of Squid you are using.
124 Use this to look up the default configuration settings and syn‐
126 tax after upgrading.
127 squid.conf.documented
129 Reference copy of the configuration file. Always kept up to date
130 with the version of Squid you are using.
131 Use this to read the documentation for configuration options
133 available in your build of Squid. The online configuration man‐
134 ual is also available for a full reference of options. see‐
135 http://www.squid-cache.org/Doc/config/
136 cachemgr.conf
138 The main configuration file for the web cachemgr.cgi tools.
139 msntauth.conf
141 The main configuration file for the Sample MSNT authenticator.
142 errorpage.css
144 CSS Stylesheet to control the display of generated error pages.
145 Use this to set any company branding you need, it will apply to
146 every language Squid provides error pages for.
147 Some files also located elsewhere:
149 /etc/squid/mime.conf (mime_table)
151 MIME type mappings for FTP gatewaying
152 /usr/share/squid/errors
154 Location of Squid error pages and templates.
155
157 Squid was written over many years by a changing team of developers and
158 maintained in turn by Duane Wessels <duane@squid-cache.org> Henrik
159 Nordstrom <hno@squid-cache.org> Amos Jeffries <amosjeffries@squid-
160 cache.org>
161 With contributions from many others in the Squid community. see CON‐
163 TRIBUTORS for a full list of individuals who contributed code. see
164 CREDITS for a list of major code contributing copyright holders.
165
167 This software product, SQUID, is developed by a team of individuals,
168 and copyrighted (C) 2001 by the Regents of the University of Califor‐
169 nia, with all rights reserved. UCSD administered the NLANR Cache
170 grants, NCR 9616602 and NCR 9521745 under which most of this code was
171 developed.
172 This program is free software; you can redistribute it and/or modify it
174 under the terms of the GNU General Public License (version 2) as pub‐
175 lished by the Free Software Foundation. It is distributed in the hope
176 that it will be useful, but WITHOUT ANY WARRANTY; without even the
177 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
178 POSE. See the GNU General Public License for more details.
179 see the CREDITS file for further copyright licensing of third-party
181 code contributions.
182
184 Questions on the usage of this program can be sent to the Squid Users
185 mailing list <squid-users@squid-cache.org>
186
188 Bug reports need to be made in English. See http://wiki.squid-
189 cache.org/SquidFaq/BugReporting for details of what you need to include
190 with your bug report.
191 Report bugs or bug fixes using http://bugs.squid-cache.org/
193 Report serious security bugs to Squid Bugs <squid-bugs@squid-cache.org>
195 Report ideas for new improvements to the Squid Developers mailing list
197 <squid-dev@squid-cache.org>
198
200 cachemgr.cgi (8), squidclient (1), pam_auth (8), squid_ldap_auth (8),
201 squid_ldap_group (8), ext_session_acl (8), squid_unix_group (8),
202 The Squid FAQ wiki http://wiki.squid-cache.org/SquidFaq
203 The Squid Configuration Manual http://www.squid-cache.org/Doc/config/
204 squid(8)