]> git.ipfire.org Git - thirdparty/squid.git/blobdiff - QUICKSTART
Source Format Enforcement (#532)
[thirdparty/squid.git] / QUICKSTART
index d274f6b51f1f91c4de145b1e295c767cf02b9e9b..e5299b475ab4e7467e371f6dd2cf3b2082f830d1 100644 (file)
@@ -1,8 +1,6 @@
 
 Squid QUICKSTART
 
-$Id: QUICKSTART,v 1.9 2007/12/18 12:15:34 amosjeffries Exp $
-
 This document is intended only for people who want to get Squid running
 quickly It is not a substitute for the real documentation.  Squid has
 many features, but only a few of them are useful at the beginning.  Use
@@ -19,57 +17,72 @@ Uncomment and edit the following lines in /usr/local/squid/etc/squid.conf:
 
 ==============================================================================
 
-cache_peer, never_direct/always_direct
+acl, http_access
 
-    If you have a parent cache, put it here.  The administrators of the
-    parent cache typically provided you with instructions.  You should
-    always ask permission before adding a parent cache. See also the
-    never_direct/always_direct directives.
+    Access control lists.  This is important because it prevents people
+    from stealing your network resources.
 
-cache_dir ufs /usr/local/squid/var/cache 100 16 256
+    Edit the "localnet" ACL definition to be your LAN network address
+    ranges in CIDR format. For instance:
 
-    Add here (first number, here 100) the amount of hard disk space 
-    (in megabytes) to devote to caching.
+        acl localnet src 192.168.10.0/24
 
-acl, http_access, icp_access
+    Add any other ACLs and edit the http_access lines to match your policy
+    requirements for use of the proxy. See Squid FAQ for more details.
 
-    Access control lists.  This is important because it prevents people
-    from stealing your network resources.  To fill in the
-    "allowed_hosts" ACL, use your network address (for instance
-    192.168.10.0 and your network mask (for instance 255.255.255.0):
+cache_mgr
 
-        acl manager proto cache_object
-        acl localhost src 127.0.0.1/255.255.255.255
-        acl all src 0.0.0.0/0.0.0.0
-        acl allowed_hosts src 192.168.10.0/255.255.255.0
+    Put here the e-mail address of the manager.
 
-        http_access deny manager all
-        http_access allow allowed_hosts
-        http_access deny all
+==============================================================================
 
-        icp_access  allow  allowed_hosts
-        icp_access deny all
+Some configuration lines which are optional but may be needed.
 
-cache_mgr
+visible_hostname
 
-    Put here the e-mail address of the manager:
+    The publicly visible host name advertised for the cache. This will
+    be used for URLs generated by Squid for clients to fetch certain
+    objects from.
 
 cache_effective_user
 
-    If you must start Squid as root, find a safe user and group to run
+    If building your own squid; use ./configure --with-default-user=X
+
+    You must start Squid as root, with a safe user and group to run
     as after startup (typically "nobody" and "nogroup").  Do not use
     "root", for security reasons.
 
-visible_hostname
+cache_dir ufs /usr/local/squid/var/cache 100 16 256
+
+    Add here (first number, here 100) the amount of hard disk space 
+    (in megabytes) to devote to caching.
+    The default is to store files in 256 MB of memory instead of disk
+
+    Linux :  use aufs instead of ufs
+    BSD   :  use diskd instead of ufs
+
+cache_mem 256 MB
+
+    How much memory to allocate for cached files in-memory.
+    The default is shown.
+
+cache_peer, never_direct/always_direct
+
+    If you have a parent cache, put it here.  The administrators of the
+    parent cache typically provided you with instructions.  You should
+    always ask permission before adding a parent cache. See also the
+    never_direct/always_direct directives.
 
-    The host name you advertise for the cache.
 
 ==============================================================================
 
 After editing squid.conf to your liking, run Squid from the command
 line TWICE:
 
+To create any disk cache_dir configured:
     % /usr/local/squid/sbin/squid -z
+
+To start squid:
     % /usr/local/squid/sbin/squid 
 
 Check in the cache.log (/usr/local/squid/var/logs/cache.log) that
@@ -83,5 +96,15 @@ Once you have Squid working from the command line, tell your Unix to
 start Squid at startup (it depends heavily on the Unix you use, you'll
 typically have to modify something in a /etc/rc_something).
 
-This quick start file written by: Stephane Bortzmeyer and Duane
-Wessels.
+==============================================================================
+
+/*
+ * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
+This quick start file written by:
+    Stephane Bortzmeyer and Duane Wessels.