4 $Id: QUICKSTART,v 1.9 2007/12/18 12:15:34 amosjeffries Exp $
6 This document is intended only for people who want to get Squid running
7 quickly It is not a substitute for the real documentation. Squid has
8 many features, but only a few of them are useful at the beginning. Use
9 this only if you have quite a simple setup.
11 After you retrieved, compiled and installed the Squid software (see
12 INSTALL in the same directory), you have to configure the squid.conf
13 file. This is the list of the values you *need* to change, because no
14 sensible defaults could be defined. Do not touch the other variables
15 for now. We assume you have installed Squid in the default location:
18 Uncomment and edit the following lines in /usr/local/squid/etc/squid.conf:
20 ==============================================================================
24 Access control lists. This is important because it prevents people
25 from stealing your network resources. To fill in the
26 "localnet" ACL, use your network address (for instance 192.168.10.0
27 your CIDR network mask (for instance 255.255.255.0 or /24):
29 acl manager proto cache_object
30 acl localhost src 127.0.0.1
31 acl localnet src 192.168.10.0/24
33 http_access deny manager all
34 http_access allow localnet
39 Put here the e-mail address of the manager:
43 The host name you advertise for the cache.
47 If building your own squid; use ./configure --with-default-user=X
49 If you must start Squid as root, find a safe user and group to run
50 as after startup (typically "nobody" and "nogroup"). Do not use
51 "root", for security reasons.
54 ==============================================================================
56 Some configuration lines which are optional but may be needed.
59 cache_dir ufs /usr/local/squid/var/cache 100 16 256
61 Add here (first number, here 100) the amount of hard disk space
62 (in megabytes) to devote to caching.
63 The default is to store files in 256 MB of memory instead of disk
65 Linux : use aufs instead of ufs
66 BSD : use diskd instead of ufs
70 How much memory to allocate for cached files in-memory.
73 cache_peer, never_direct/always_direct
75 If you have a parent cache, put it here. The administrators of the
76 parent cache typically provided you with instructions. You should
77 always ask permission before adding a parent cache. See also the
78 never_direct/always_direct directives.
81 ==============================================================================
83 After editing squid.conf to your liking, run Squid from the command
86 To create any disk cache_dir configured:
87 % /usr/local/squid/sbin/squid -z
90 % /usr/local/squid/sbin/squid
92 Check in the cache.log (/usr/local/squid/var/logs/cache.log) that
93 everything is all right.
95 Once Squid created all its files (it can take several minutes on some
96 systems), test it with echoping or a regular Web client. By default,
97 your Squid will run on port 3128. See the Squid FAQ for more details.
99 Once you have Squid working from the command line, tell your Unix to
100 start Squid at startup (it depends heavily on the Unix you use, you'll
101 typically have to modify something in a /etc/rc_something).
103 This quick start file written by: Stephane Bortzmeyer and Duane