home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 April / PCWorld_2001-04_cd.bin / Software / TemaCD / smartcache / samples / scache.cnf < prev   
Text File  |  2001-01-26  |  20KB  |  530 lines
  1. # Main Smart Cache Config File 
  2. # 
  3. # SEE ALSO
  4. #       gc.cnf - Smart Cache garbage collector config file
  5. #     fail.cnf - Blocked URL list
  6. #     pass.cnf - Allowed URL list
  7. #  cookies.cnf - Cookies filter set-up
  8. #
  9. # (C) Radim Kolar 1998-2000  (hsn@cybermail.net)
  10. #  http://home.worldonline.cz/~cz210552/
  11. #
  12. #  Smart Cache is Open Source Software.
  13. #           http://www.opensource.org/
  14. #
  15.  
  16. # lines starting with # are comments (how strange..)
  17. #
  18. # As you can see, this product is _VERY_ configurable. So enjoy with it.  Rule
  19. # of thumb: If you don't understand what you are doing, don't change it.
  20. #
  21. # Also make a look at gc.cnf, which configures garbage collector.
  22. #
  23. # YOU MUST RUN garbage collector BY HAND, Smart Cache didn't invoke it
  24. # when cache size is reached, because this can be very lengthy
  25. # (one hour on my 386/40) process on large (200MB+) caches. So it's
  26. # recommended to run GC in nights via scheduler (for example cron).
  27.  
  28.  
  29. #URL link for use in generated error messages. Used for
  30. # ever moving location of Smart Cache homepage, but feel free to set
  31. # it to your favourite page (for example to Hobbes Archive).
  32. visible_link http://home.worldonline.cz/~cz210552/
  33.  
  34. #hostname for use in error reports
  35. #This names has nothing to do with your IP address, real hostname or
  36. #something. This is just some text, which can be displayed in error
  37. #messages. 
  38. visible_hostname smart.cache
  39.  
  40. #TCP port for this cache. 
  41. # 8080 is old known proxy port, introduced by CERN httpd.
  42. # Some servers uses port 80, but because port 80 is used by standard
  43. # WWW service, you can not run web server and Smart Cache on the
  44. # same port. I use 8080 because it easy to remember.
  45. # Squid uses port 3128, so you can run both caches (Squid and SC).
  46. # You can not run more than ONE program on the same port! 
  47. port 8080
  48.  
  49. #IP address for binding socket, if entered * all local addresses are binded
  50. #
  51. #Note: Others computers can not connect to it when 127.0.0.1 is used, this
  52. # is very good for enhanced security. If you have intranet and want allow other
  53. # computers in intranet (but not from Internet) to use this proxy, enter your
  54. # intranet address here. Using * allows all computers (even from Internet) to
  55. # use this proxy, so setting some Fail directives to block your private data
  56. # may be wise. There are no known security holes.
  57. BindAddress 127.0.0.1
  58.  
  59. # *** storage setup ***
  60. #directory for storing cached objects. Use the shortest path possible
  61. #and don't end directory name with \ or /
  62. #DO NOT USE ROOT directory!!! (for example c:\)
  63. CacheRoot C:\scache
  64.  
  65. #default filename for directory index. Unix people doesn't like
  66. # ".welcome" standard because ls don't displays them. Some people
  67. # likes index.html or something. Smart Cache avoids local filename
  68. # clashes, so fee free to set it to any useful name.
  69. DefaultName dirindex.html
  70.  
  71. #URL directory CRC32 hashing, used for performance improvement
  72. #if you don't like dirs - don't set dirs to ZERO! use 1 instead.
  73. #
  74. # 4x4 is good for 100-150MB cache, for bigger cache size, set bigger
  75. # values.
  76. swap_level1_dirs 4
  77. swap_level2_dirs 4
  78. #NOTE: if you change swap_level_dirs values, you MUST reorder cache directory
  79. #by running Smart Cache with -rebalance command line option!
  80.  
  81. #parent proxy (if any). PORT NUMBER IS REQUIRED!
  82. #A parent proxy login and password may be specified in the "http_proxy"
  83. #configuration statement after the parent proxy port in a form login:password.
  84. #     Example:
  85. #             http_proxy my.cache.net 3128 mylogin:mypass
  86. #using IP address instead of DNS name is strongly recommended (workaround
  87. # for JVM DNS caching "feature", see main documentation for more info )
  88. #
  89. #parent proxy is ALSO required if you need support
  90. #for other protocols than HTTP (FTP, Gopher, ...). Parent proxy
  91. #must know how to support these protocols.
  92. #NOTE: Gatewaying of HTTPS/SSL via http_proxy is NOT supported.
  93. #
  94. #http_proxy 1.2.3.4 3128
  95.  
  96. #don't use parent proxy for this servers/domains. Wildcards ARE NOT ALLOWED!
  97. # string netmag.cz will act like *netmag.cz
  98. #no_proxy localhost
  99.  
  100. #file descriptor limit by your OS will still apply, so don't expect that if
  101. #you set it to 2000, that 2000 users will be able to connect to this proxy.
  102. #Smart Cache use 3 file descriptors per one client, Squid uses 2-3 descriptors
  103. #per one client (2 when sending data from memory-cache).
  104. max_clients 30
  105.  
  106. # The AllowCONNECT directive specifies a list of port numbers to which
  107. # the proxy CONNECT method may connect. Today's browsers use this method
  108. # when a https connection is requested and proxy tunneling over http is
  109. # in effect.
  110. # By default, only the default https port (443) and the default snews
  111. # port (563) are enabled. Use the AllowCONNECT directive to override
  112. # this default and allow connections to the listed ports only.
  113.  
  114. # If you want to disable CONNECT, comment next line.
  115.           
  116. allowconnect 443 563
  117.  
  118. # Proxy access control
  119. #
  120. #   Proxy access may be limited by using "allow" configuration statement
  121. #   with the host ip address as a parameter to grant access only to
  122. #   specified hosts. Hosts that are not allowed to access proxy server
  123. #   will receive "403 Cache access denied" response. If no "allow"
  124. #   statements are found then any host is allowed to access the proxy.
  125. #
  126. #   Example:
  127. #     allow proxy access only from computer it is running at and from addresses
  128. #     192.168.1.2 and 192.168.1.3
  129. #
  130. #    allow 127.0.0.1
  131. #    allow 192.168.1.2
  132. #    allow 192.168.1.3
  133.            
  134. #if you want to use this proxy as forwarder, enter it your primary
  135. #forwarding hostname (NOT URL!), which will be used if browser
  136. #do not supply Host: HTTP header.
  137. #If you are running transparent proxy, set it to host, where is
  138. #message ,,Your browser do not send Host: header, so you can not use
  139. #our network, because we has here transparent proxy set. Upgrade your
  140. #browser at least to Netscape 2.0''
  141. default_forward_for localhost
  142.  
  143. # ####################
  144. #  Control Flag Files
  145. # ####################
  146. #
  147. #flag file for clean cache shutdown
  148. #if this file exists cache will be stopped, without interrupting any
  149. #active transfers. Flag is checked every 3 minutes.
  150. #NOTE: If you are browsing off-line, simply press CTRL-C :) or
  151. #kill the task.
  152.  
  153. Shutdown_flag C:\stop
  154.  
  155. #flag file for immediate cache shutdown
  156. #if this file exists cache will be always stopped even if there are some
  157. #active transfers. Smart Cache will try to sync .cacheinfo before
  158. #exiting, so this is cleaner way to shutdown than killing the task.
  159.  
  160. Immediate_shutdown_flag C:\stop.now
  161.  
  162. #How often Smart Cache checks for `immediate_shutdown_flag` ?
  163. # time is in seconds
  164. flag_check_interval 20
  165.  
  166. # Should be flag files cleared when Smart Cache starts?
  167. clear_flags_on_start 1
  168.  
  169. # ###################
  170. #      Log files
  171. # ###################
  172. #
  173. # Log Hit/miss/block statistics
  174. # stat_log <filename>
  175.  
  176. #logging setup for common type of logs. You can have more than
  177. #one logfile of the same type.
  178. #Logs are masked (good for forwarder running multiple servers).
  179. #
  180. #access_log <URL mask> <file-name>
  181. #Example:
  182. #accesses to netmag.cz are loged to separate file, all other to cache.log
  183. #access_log http://netmag.cz/* netmag.access.log
  184. #access_log * cache.log
  185.  
  186. #Same thing goes here for other types of logs
  187. #referer_log * referer.log
  188. #agent_log * agent.log
  189.  
  190. # ################
  191. #  T i m e O u t s
  192. # ################
  193. #
  194. #timeouts in sec, 
  195. # input = reading request from client browser
  196. # proxyreadtimeout = reading response from remote server. This should
  197. #   be less than 6 minutes (2*SAVETIMER value in mgr.java)
  198. Inputtimeout 20
  199. proxyreadtimeout 210
  200.  
  201. #     Smart Cache allows control over the files to be cached in two ways:
  202. #
  203. #     First, you can specify a set of URLs which must never be cached,
  204. #     in which case all other URLs are candidates for caching. This uses
  205. #     the NoCaching directive to specify what URLs must never be cached.
  206. #
  207. #     In the second scheme, you can explicitly list all the URLs which
  208. #     will be considered for caching; URLs not in that list will never
  209. #     be cached. This uses the CacheOnly directive
  210. #
  211. #     Defaults: neither NoCaching nor CacheOnly are given
  212. #
  213. #      **** WARNING: YOU CAN NOT USE BOTH !!! ****
  214. #
  215. #     Syntax:   CacheOnly <URL pattern>
  216. #               NoCaching   <URL pattern>
  217. #
  218. #     Examples:
  219. #
  220. # CacheOnly http://www.ibm.com/*
  221. # NoCaching   http://never.cache.me.net/*
  222.  
  223. #NoCaching   http://localhost/*
  224. #CacheOnly http://cache.me.net/*
  225.  
  226. ###################
  227. ##  refresh rate ##
  228. ###################
  229. # default_refresh_pattern Reload_age Min_age Lastmod_factor max_age Expire_age Redirect_Age
  230. #
  231. #      All times (except Lastmod_factor) are float numbers in minutes
  232. #
  233. #reload_age:  if user wants reload but, object is younger than reload_age, old
  234. #copy is returned and reload request is ignored.
  235. #
  236. #min_age: all cacheable objects are considered fresh for XX minutes.
  237. #  but reload (if allowed) can be used for their refresh
  238. #expire_age: If object has expire time and this time > Expire_age, expire
  239. # is honored, otherwise it is ignored.
  240. #redirect_Age:
  241. # temporary redirect is valid only for XX minutes.
  242. #
  243. #
  244. # lastmod_factor:
  245. #
  246. #    AGE is how much the object has aged *since* it was retrieved:
  247. #                
  248. #    AGE = NOW - OBJECT_DATE
  249. #
  250. #    LM_AGE is how old the object was *when* it was retrieved:
  251. #
  252. #    LM_AGE = OBJECT_DATE - LAST_MODIFIED_TIME
  253. #
  254. #    LM_FACTOR is the ratio of AGE to LM_AGE:
  255. #
  256. #    LM_FACTOR = AGE / LM_AGE
  257. #
  258. # Max_age: if object is older than XX minutes, cache will reload it.
  259. # setting first number to non-zero value, makes auto-reload pages
  260. #   out of work, so set refresh_pattern for them.
  261. # all numbers can be floating point
  262. default_refresh_pattern 0.1 60 0.20 10080 10 0.5
  263.  
  264. #Specific refresh patters for some URLs
  265. #refresh_pattern http://technet.cz/* 0 60 0.30 10080
  266.  
  267. # ###############################################
  268. # Smart Cache special features. Have fun with it.
  269. # ###############################################
  270. #
  271. # @1
  272. #pragma:no cache handling, what to do with non-cacheable documents?
  273. #expires < now is the same as pragma: no-cache
  274. # 0 - standard setting, be nice - don't cache any uncacheable objects
  275. # 1 - cache all uncacheable documents
  276. # 2 - cache only uncacheable images (probably only adv and counters)
  277. # 3 - don't cache uncacheable text objects, but all others do
  278. # 4 - don't cache uncacheable redirects, but all others do
  279. #
  280. #Hint: if this cache use multiple users, using mode 1 may cause some troubles,
  281. #    but 2 or 3 are safe. (3 is better than 2)
  282. #If you have troubles with redirects try 4
  283.  
  284. pragma_no_cache 1
  285.  
  286. # @2
  287. #Keep deleted objects in cache (and send it to users) even if the
  288. #original page has been deleted (rc=404). Very useful.
  289. # 0=no, 1=yes
  290. keep_deleted 1
  291.  
  292. # @3
  293. #Generate Last-Modified header if object is cacheable and this header
  294. #doesn't exist. It helps HTTP-Clients make IMS Requests against your cache.
  295. #This is also good idea when running as forwarder.
  296. # 0 -don't generate
  297. # 1 - generate when sending objects from cache
  298. # 2 - generate always (not recommended due to bugs in browsers)
  299. #      Netscape is known to be buggy. Latest version tested is 4.5, which is
  300. #       still broken.
  301. generate_lastmod 1
  302.  
  303. # @4
  304. #Hide remote servers errors. If remote server returns some kind of error,
  305. #when we try to refresh page, return old page from cache.
  306. #This may helps to clean server busy messages and load_failed messages
  307. #from parent proxy. Return codes considered as errors are RC=400, 403 and 500+
  308. hide_errors 1
  309.  
  310. # @5
  311. #Customized error messages. If used we will send redirect to specified URL.
  312. #only rc=403 (Forbidden) and rc=500 (Load failed) are now supported.
  313. #
  314. # The best is to use '0' for displaying 1x1 empty GIF with transparent
  315. # background. 
  316. #RECOMMENDED: Or send 1x1 Blank gif image, faster than using redirect.
  317. #ErrorDocument 403 0
  318. #
  319. # There is also alternative to send 206 Return code (No content)
  320. # instead if '-' is used (see examples), but not in Netscape (if got image
  321. # without size specified in HTML, it does not render anything on page. 
  322. #ErrorDocument 403 -
  323. #
  324. #Other possibility is send empty HTML document instead.
  325. #ErrorDocument 403 !
  326. #
  327. #Or what about to Redirect to some interesting GIF ?
  328. #ErrorDocument 403 http://some.site.with.nice.images.com/images/nature/bluesky.gif
  329.  
  330. # @6
  331. #Remove Pragma: no-cache from clients requests. When sending
  332. #user's request to HTTP server (or HTTP proxy), remove this request line.
  333. #Some servers has workaround for some browsers bug and when receive
  334. #If-Modified-Since request with Pragma:no-cache, sends whole object
  335. #instead of 304 reply. Modern browsers don't have this bug, but servers
  336. #unfortunately doesn't recognize buggy and non-buggy browsers.
  337. #
  338. # Description of bug from Apache 0.8.5 documentation
  339. # *) Work around bogus behavior when reloading from Netscape.
  340. #    It's Netscape's bug --- for some reason they expect a request with
  341. #    If-modified-since: to not function as a conditional GET if it also
  342. #    comes with Pragma: no-cache, which is way out of line with the HTTP
  343. #    spec (according to Roy Fielding, the redactor).
  344. #
  345. #If you are using parent proxy, you will not be able to force it
  346. #to refresh page. 
  347. #
  348. #Hint: If you are NOT using parent proxy and don't have
  349. #historic browser (Netscape 2+ is OK), USE it.
  350. remove_pragma_no_cache 0
  351.  
  352. # @7
  353. # What to do with Referer header ?
  354. #  Referer header contains last visited URL. This allows webmasters
  355. #   to track your browsing path. If you want to protect your privacy
  356. #   set this to 3, which is the safest choice. When used, Smart Cache
  357. #   will send totally useless information for webmaster, but enough
  358. #   to fool any referer checks scripts.
  359. #
  360. #  0 - nothing, do not touch this!
  361. #  1 - remove it. Some applications (like counters) may stop working.
  362. #  2 - make is the same as requested URL
  363. #  3 - same as 2, but change it even after remaping by Redirect. Safest choice
  364. #      to protect your privacy.
  365. #
  366. # Warning: Some applications with heavy depending on referer header, may stop working.
  367. referer_hack 0
  368.  
  369. # @8
  370. # What about to send fake Referer header ?
  371. #  You can send anything. If used, option referer_hack will be ignored.
  372. #
  373. #fake_referer http://i.fall.down.from.spiritual.world/
  374.  
  375. # @9
  376. # What about to send fake user-agent (Browser id)? 
  377. # It you want to hide what browser and version are you using, this is for you.
  378. # Or you can make WWW logs somewhat more interesting...
  379. # fake_user_agent <String>
  380. #
  381.  
  382. #Tell server that we are using Netscape/3 under Linux
  383. #fake_user_agent Mozilla/3.0 (X11; U; Linux 1.2.13 i386)
  384. #or tell him anything other
  385. #fake_user_agent Lord Vishnu/Transcendental (Vaikuntha;Supreme Personality of Godness)
  386.  
  387. #Should be "via Smart Cache 0.XX" appended to your browser identification?
  388. #This confuses PHP-generated pages, PHP will generate slightly more
  389. #HTML conservative pages.
  390. #If yes webmasters will see that you are using Smart Cache.
  391. #If you are using fake_user_agent this option will simply do nothing.
  392.  
  393. append_via 1
  394.  
  395. # @10
  396. # What about to make 'referer.log' more useful and compact?
  397. # full_referer_log <0/1>
  398. # 
  399. # 1 - all referers are logged
  400. # 0 - referers must be from different servers to be logged. 
  401. #      Very good for recording your path in cyberspace. 
  402. #
  403.  
  404. full_referer_log 0
  405.  
  406. # @11
  407. # Smart Cache can cache password-protected documents. Of course, this opens
  408. # a security hole, because once password-protected document gets cached,
  409. # it can be received from proxy without knowing password.
  410.  
  411. # 0 - no, 1 - yes
  412. cache_password_protected 0
  413.  
  414. # @12
  415. # Are URL tests case sensitive? (see gc.cnf for example)
  416. # case sensitive matching is much faster. Use it if you have a lot of
  417. # URLs (about 200)
  418. # 1 - yes, 0 - no. 
  419. #
  420. case_sensitive_matching 0
  421.  
  422. # @13 
  423. # OUTGOING C00kies filter
  424. # Cookies block list is loaded from external file and reloaded when
  425. # changed.
  426. #
  427. allow_cookies_to_file cookies.cnf
  428.  
  429. # @14
  430. # You can also send fake cookies. When sending cookies out is not permitted
  431. # cookie will be replaced by fake_cookie instead of deleting.
  432. #
  433. #  format is name=value [ ; name=value ; ....]
  434. #  value can not contains spaces -> use underscores '_' instead.
  435. #  Smart Cache don't tests wafer for validity, just sends it out.
  436. #    RFC says that cookies must be shorter than 4k, but Smart Cache sends out
  437. #    String of any size, which is good for buffer overflow attacking on remote
  438. #    sites.
  439. #
  440. #fake_cookie NOTICE=HEY_GUYS!_DON'T_SEND_ME_YOUR_JUNK!
  441.  
  442. # @15
  443. # URL Filter
  444. #
  445. # Smart Cache allows to set-up URL filter. This filter is controlled by
  446. # two keywords.
  447. # First is Pass <URL pattern>. This marks URLs, which are always allowed
  448. #  even if Fail disables them.
  449. # Second is Fail <URL pattern> which marks not allowed URLs.
  450. #
  451. # Smart Cache has support only for '*' wildcard. You can use it in pattern
  452. # more times.
  453. #
  454. # You can also use external files for blocking URLs. These files can
  455. # be automagicaly reloaded when changed which eliminates need of restarting
  456. # Smart Cache as in case of hardcoded Fail or Pass directives in scache.cnf
  457. #
  458. # NOTE: If you are using these files, don't put any Fail/Pass directives into
  459. #       main Smart Cache config. If you do, it will be deleted (ignored)
  460. #       when Smart Cache reloads changed block files.
  461. Fail_file fail.cnf
  462. Pass_file pass.cnf
  463.  
  464. # Announce blocked URLs to console
  465. #
  466. # This is useful if you are using a complex "fail.cnf" with
  467. # a lot of entries and can't fiddle out if or why some request has
  468. # been blocked.
  469. fail_trace 0
  470.  
  471. # @16 
  472. # Redirecting specified URLs to another
  473. #   some redirect use examples. Smart Cache do not sends redirect to browser,
  474. #   it remaps request internally and continue with it. This allows to use SC
  475. #   as web forwarder (accelerator).
  476. # When '*' is used in redirect it must be the last character in pattern!
  477. # 1>
  478. #this redirect http://www.netmag.home.cz/sample.html to
  479. #              http://netmag.cz/sample.html
  480. #Redirect  http://www.netmag.home.cz/*        http://netmag.cz/*
  481.  
  482. # 2>
  483. #this redirect http://ncic.netmag.home.cz/sample.html to
  484. #              http://ncic.netmag.cz/
  485. #Redirect http://ncic.netmag.home.cz/*   http://ncic.netmag.cz/
  486.  
  487. #defining alias for webcrawler
  488. #Redirect http://www.webcrawler.com/*    http://webcrawler.com/*
  489.  
  490. # @17  Quick Abort Feature    
  491. #    what to do with aborted requests?
  492. #
  493. #    values min_kbytes, percent, max-kbytes
  494. #    When request is aborted by client, SmartCache may continue download
  495. #    the requested file into cache. Downloading is continued if
  496. #      * file size is known in the time, when request starts
  497. #        and
  498. #      * need to download < min_kbytes 
  499. #        or
  500. #      * > percent file is transfered and need to download < max_kbytes
  501. #
  502. #      if min_kbytes set to -1 for quick abort is disabled
  503. #                                  (always continue with downloads).
  504. #
  505.  
  506. #enable quick abort
  507. #quick_abort 20 0.5 100
  508.  
  509. #default is continue to download Aborted objects (disabled)
  510. quick_abort -1 0.5 100
  511.  
  512. # if quick_abort is *disabled*, all transfers will be continued.
  513. # Because you may download by mistake a very large unwanted file, I
  514. # implemented timeout for this type of downloads. 
  515. # Timeout time is in minutes. If quick abort is not disabled, this value
  516. # has no meaning.
  517.  
  518. #default is abort download of Aborted objects after 3 minutes.
  519. max_aborted_transfer_time 3
  520.  
  521. # @18
  522. #  Data compression support    
  523. #
  524. #    Smart Cache can store text data in gzip format. This saves diskspace.
  525. #    Data stored in Cache are sent to your browser in gzipped form, so your
  526. #    browser must know how to handle them or use auto_decompress.
  527. auto_compress 0
  528. #If your browser can not handle compressed data, Smart Cache can uncompress it.
  529. auto_decompress 0
  530.