X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=d9ee3ea0eccbd1238759b5a1ad91f95e9cda6095;hb=77d14e843e0f4c0ed64258f106804612a6359d70;hp=ece08171ee39a1d0eb6f76f383a38c92ba99edc5;hpb=a18f401e2bd560e00cece03d4a56d9e2a6f06ed5;p=privoxy.git
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index ece08171..d9ee3ea0 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -9,10 +9,12 @@
+
-
-
+
+
+
@@ -28,15 +30,11 @@
Privoxy">
]>
- Copyright &my-copy; 2001-2013 by
- Privoxy Developers
+ Copyright &my-copy; 2001-2020 by
+ Privoxy Developers
-$Id: user-manual.sgml,v 2.160 2013/01/12 12:20:29 fabiankeil Exp $
-
@@ -99,14 +95,11 @@ Hal.
You can find the latest version of the Privoxy User Manual at http://www.privoxy.org/user-manual/.
+ url="https://www.privoxy.org/user-manual/">https://www.privoxy.org/user-manual/.
Please see the Contact section on how to
contact the developers.
-
-
-
@@ -115,7 +108,7 @@ Hal.
Introduction
This documentation is included with the current &p-status; version of
- Privoxy, v.&p-version;Privoxy, &p-version;
Since this is a &p-status; version, not all new features are well tested. This
documentation may be slightly out of sync as a result (especially with
- CVS sources). And there may be bugs, though hopefully
+ git sources).
+ And there may be bugs, though hopefully
not many!
]]>
@@ -160,7 +154,7 @@ Hal.
Privoxy is available both in convenient pre-compiled
packages for a wide range of operating systems, and as raw source code.
For most users, we recommend using the packages, which can be downloaded from our
- Privoxy Project
+ Privoxy Project
Page.
@@ -216,1232 +210,316 @@ How to install the binary packages depends on your operating system:
-
- After invoking Privoxy with
- --install, you will need to bring up the
- Windows service console to assign the user you
- want Privoxy to run under, and whether or not you
- want it to run whenever the system starts. You can start the
- Windows services console with the following
- command: services.msc. If you do not take the manual step
- of modifying Privoxy's service settings, it will
- not start. Note too that you will need to give Privoxy a user account that
- actually exists, or it will not be permitted to
- write to its log and configuration files.
-
-
-
-
-
-OS/2
-
-
- First, make sure that no previous installations of
- Junkbuster and / or
- Privoxy are left on your
- system. Check that no Junkbuster
- or Privoxy objects are in
- your startup folder.
-
-
-
-
- Then, just double-click the WarpIN self-installing archive, which will
- guide you through the installation process. A shadow of the
- Privoxy executable will be placed in your
- startup folder so it will start automatically whenever OS/2 starts.
-
-
-
- The directory you choose to install Privoxy
- into will contain all of the configuration files.
-
-
-
-
-Mac OS X
-
- Installation instructions for the OS X platform depend upon whether
- you downloaded a ready-built installation package (.pkg or .mpkg) or have
- downloaded the source code.
-
-
-
-Installation from ready-built package
-
- The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
- .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
- installation will start; double-clicking the latter will unzip the .mpkg file
- which can then be double-clicked to commence the installation.
-
-
- The privoxy service will automatically start after a successful installation
- (and thereafter every time your computer starts up) however you will need to
- configure your web browser(s) to use it. To do so, configure them to use a
- proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
-
-
- To prevent the privoxy service from automatically starting when your computer
- starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
- (on OS X 10.5 and higher) or the folder named
- /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
-
-
- To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
- and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
- administrator account, using sudo.
-
-
- To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
- administrator account.
-
-
-
-Installation from source
-
- To build and install the Privoxy source code on OS X you will need to obtain
- the macsetup module from the Privoxy Sourceforge CVS repository (refer to
- Sourceforge help for details of how to set up a CVS client to have read-only
- access to the repository). This module contains scripts that leverage the usual
- open-source tools (available as part of Apple's free of charge Xcode
- distribution or via the usual open-source software package managers for OS X
- (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
- and associated files. The macsetup module's README file contains complete
- instructions for its use.
-
-
- The privoxy service will automatically start after a successful installation
- (and thereafter every time your computer starts up) however you will need to
- configure your web browser(s) to use it. To do so, configure them to use a
- proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
-
-
- To prevent the privoxy service from automatically starting when your computer
- starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
- (on OS X 10.5 and higher) or the folder named
- /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
-
-
- To manually start or stop the privoxy service, use the Privoxy Utility
- for Mac OS X (also part of the macsetup module). This application can start
- and stop the privoxy service and display its log and configuration files.
-
-
- To uninstall, run the macsetup module's uninstall.sh as sudo from an
- administrator account.
-
-
-
-
-FreeBSD
-
-
- Privoxy is part of FreeBSD's Ports Collection, you can build and install
- it with cd /usr/ports/www/privoxy; make install clean.
-
-
- If you don't use the ports, you can fetch and install
- the package with pkg_add -r privoxy.
-
-
- The port skeleton and the package can also be downloaded from the
- File Release
- Page, but there's no reason to use them unless you're interested in the
- beta releases which are only available there.
-
-
-
-
-
-
-Building from Source
-
-
- The most convenient way to obtain the Privoxy sources
- is to download the source tarball from our
- project download
- page.
-
-
-
- If you like to live on the bleeding edge and are not afraid of using
- possibly unstable development versions, you can check out the up-to-the-minute
- version directly from the
- CVS repository.
-
-
-
-
-&buildsource;
-
-
-
-
-Keeping your Installation Up-to-Date
-
-
- If you wish to receive an email notification whenever we release updates of
- Privoxy or the actions file, subscribe
- to our announce mailing list, ijbswa-announce@lists.sourceforge.net.
-
-
-
- In order not to lose your personal changes and adjustments when updating
- to the latest default.action file we strongly
- recommend that you use user.action and
- user.filter for your local
- customizations of Privoxy. See the Chapter on actions files for details.
-
-
-
-
-
-
-
-
-
-
-
-What's New in this Release
-
- Privoxy 3.0.19 is a stable release.
- The changes since 3.0.18 stable are:
-
-
-
-
-
-
- Bug fixes:
-
-
-
- Prevent a segmentation fault when de-chunking buffered content.
- It could be triggered by malicious web servers if Privoxy was
- configured to filter the content and running on a platform
- where SIZE_T_MAX isn't larger than UINT_MAX, which probably
- includes most 32-bit systems. On those platforms, all Privoxy
- versions before 3.0.19 appear to be affected.
- To be on the safe side, this bug should be presumed to allow
- code execution as proving that it doesn't seems unrealistic.
-
-
-
-
- Do not expect a response from the SOCKS4/4A server until it
- got something to respond to. This regression was introduced
- in 3.0.18 and prevented the SOCKS4/4A negotiation from working.
- Reported by qqqqqw in #3459781.
-
-
-
-
-
-
-
- General improvements:
-
-
-
- Fix an off-by-one in an error message about connect failures.
-
-
-
-
- Use a GNUMakefile variable for the webserver root directory and
- update the path. Sourceforge changed it which broke various
- web-related targets.
-
-
-
-
- Update the CODE_STATUS description.
-
-
-
-
-
-
-
-
-
- The following changes were made between 3.0.17 and 3.0.18:
-
-
-
-
-
-
- Bug fixes:
-
-
-
- If a generated redirect URL contains characters RFC 3986 doesn't
- permit, they are (re)encoded. Not doing this makes Privoxy versions
- from 3.0.5 to 3.0.17 susceptible to HTTP response splitting (CWE-113)
- attacks if the +fast-redirects{check-decoded-url} action is used.
-
-
-
-
- Fix a logic bug that could cause Privoxy to reuse a server
- socket after it got tainted by a server-header-tagger-induced
- block that was triggered before the whole server response had
- been read. If keep-alive was enabled and the request following
- the blocked one was to the same host and using the same forwarding
- settings, Privoxy would send it on the tainted server socket.
- While the server would simply treat it as a pipelined request,
- Privoxy would later on fail to properly parse the server's
- response as it would try to parse the unread data from the
- first response as server headers for the second one.
- Regression introduced in 3.0.17.
-
-
-
-
- When implying keep-alive in client_connection(), remember that
- the client didn't. Fixes a regression introduced in 3.0.13 that
- would cause Privoxy to wait for additional client requests after
- receiving a HTTP/1.1 request with "Connection: close" set
- and connection sharing enabled.
- With clients which terminates the client connection after detecting
- that the whole body has been received it doesn't really matter,
- but with clients that don't the connection would be kept open until
- it timed out.
-
-
-
-
- Fix a subtle race condition between prepare_csp_for_next_request()
- and sweep(). A thread preparing itself for the next client request
- could briefly appear to be inactive.
- If all other threads were already using more recent files,
- the thread could get its files swept away under its feet.
- So far this has only been reproduced while stress testing in
- valgrind while touching action files in a loop. It's unlikely
- to have caused any actual problems in the real world.
-
-
-
-
- Disable filters if SDCH compression is used unless filtering is forced.
- If SDCH was combined with a supported compression algorithm, Privoxy
- previously could try to decompress it and ditch the Content-Encoding
- header even though the SDCH compression wasn't dealt with.
- Reported by zebul666 in #3225863.
-
-
-
-
- Make a copy of the --user value and only mess with that when splitting
- user and group. On some operating systems modifying the value directly
- is reflected in the output of ps and friends and can be misleading.
- Reported by zepard in #3292710.
-
-
-
-
- If forwarded-connect-retries is set, only retry if Privoxy is actually
- forwarding the request. Previously direct connections would be retried
- as well.
-
-
-
-
- Fixed a small memory leak when retrying connections with IPv6
- support enabled.
-
-
-
-
- Remove an incorrect assertion in compile_dynamic_pcrs_job_list()
- It could be triggered by a pcrs job with an invalid pcre
- pattern (for example one that contains a lone quantifier).
-
-
-
-
- If the --user argument user[.group] contains a dot, always bail out
- if no group has been specified. Previously the intended, but undocumented
- (and apparently untested), behaviour was to try interpreting the whole
- argument as user name, but the detection was flawed and checked for '0'
- instead of '\0', thus merely preventing group names beginning with a zero.
-
-
-
-
- In html_code_map[], use a numeric character reference instead of '
- which wasn't standardized before XHTML 1.0.
-
-
-
-
- Fix an invalid free when compiled with FEATURE_GRACEFUL_TERMINATION
- and shut down through http://config.privoxy.org/die
-
-
-
-
- In get_actions(), fix the "temporary" backwards compatibility hack
- to accept block actions without reason.
- It also covered other actions that should be rejected as invalid.
- Reported by Billy Crook.
-
-
-
-
-
-
-
- General improvements:
-
-
-
- Privoxy can (re)compress buffered content before delivering
- it to the client. Disabled by default as most users wouldn't
- benefit from it.
-
-
-
-
- The +fast-redirects{check-decoded-url} action checks URL
- segments separately. If there are other parameters behind
- the redirect URL, this makes it unnecessary to cut them off
- by additionally using a +redirect{} pcrs command.
- Initial patch submitted by Jamie Zawinski in #3429848.
-
-
-
-
- When loading action sections, verify that the referenced filters
- exist. Currently missing filters only result in an error message,
- but eventually the severity will be upgraded to fatal.
-
-
-
-
- Allow to bind to multiple separate addresses.
- Patch set submitted by Petr Pisar in #3354485.
-
-
-
-
- Set socket_error to errno if connecting fails in rfc2553_connect_to().
- Previously rejected direct connections could be incorrectly reported
- as DNS issues if Privoxy was compiled with IPv6 support.
-
-
-
-
- Adjust url_code_map[] so spaces are replaced with %20 instead of '+'
- While '+' can be used by client's submitting form data, this is not
- actually what Privoxy is using the lookups for. This is more of a
- cosmetic issue and doesn't fix any known problems.
-
-
-
-
- When compiled without FEATURE_FAST_REDIRECTS, do not silently
- ignore +fast-redirect{} directives
-
-
-
-
- Added a workaround for GNU libc's strptime() reporting negative
- year values when the parsed year is only specified with two digits.
- On affected systems cookies with such a date would not be turned
- into session cookies by the +session-cookies-only action.
- Reported by Vaeinoe in #3403560
-
-
-
-
- Fixed bind failures with certain GNU libc versions if no non-loopback
- IP address has been configured on the system. This is mainly an issue
- if the system is using DHCP and Privoxy is started before the network
- is completely configured.
- Reported by Raphael Marichez in #3349356.
- Additional insight from Petr Pisar.
-
-
-
-
- Privoxy log messages now use the ISO 8601 date format %Y-%m-%d.
- It's only slightly longer than the old format, but contains
- the full date including the year and allows sorting by date
- (when grepping in multiple log files) without hassle.
-
-
-
-
- In get_last_url(), do not bother trying to decode URLs that do
- not contain at least one '%' sign. It reduces the log noise and
- a number of unnecessary memory allocations.
-
-
-
-
- In case of SOCKS5 failures, dump the socks response in the log message.
-
-
-
-
- Simplify the signal setup in main().
-
-
-
-
- Streamline socks5_connect() slightly.
-
-
-
-
- In socks5_connect(), require a complete socks response from the server.
- Previously Privoxy didn't care how much data the server response
- contained as long as the first two bytes contained the expected
- values. While at it, shrink the buffer size so Privoxy can't read
- more than a whole socks response.
-
-
-
-
- In chat(), do not bother to generate a client request in case of
- direct CONNECT requests. It will not be used anyway.
-
-
-
-
- Reduce server_last_modified()'s stack size.
-
-
-
-
- Shorten get_http_time() by using strftime().
-
-
-
-
- Constify the known_http_methods pointers in unknown_method().
-
-
-
-
- Constify the time_formats pointers in parse_header_time().
-
-
-
-
- Constify the formerly_valid_actions pointers in action_used_to_be_valid().
-
-
-
-
- Introduce a GNUMakefile MAN_PAGE variable that defaults to privoxy.1.
- The Debian package uses section 8 for the man page and this
- should simplify the patch.
-
-
-
-
- Deduplicate the INADDR_NONE definition for Solaris by moving it to jbsockets.h
-
-
-
-
- In block_url(), ditch the obsolete workaround for ancient Netscape versions
- that supposedly couldn't properly deal with status code 403.
-
-
-
-
- Remove a useless NULL pointer check in load_trustfile().
-
-
-
-
- Remove two useless NULL pointer checks in load_one_re_filterfile().
-
-
-
-
- Change url_code_map[] from an array of pointers to an array of arrays
- It removes an unnecessary layer of indirection and on 64bit system reduces
- the size of the binary a bit.
-
-
-
-
- Fix various typos. Fixes taken from Debian's 29_typos.dpatch by Roland Rosenfeld.
-
-
-
-
- Add a dok-tidy GNUMakefile target to clean up the messy HTML
- generated by the other dok targets.
-
-
-
-
- GNUisms in the GNUMakefile have been removed.
-
-
-
-
- Change the HTTP version in static responses to 1.1
-
-
-
-
- Synced config.sub and config.guess with upstream
- 2011-11-11/386c7218162c145f5f9e1ff7f558a3fbb66c37c5.
-
-
-
-
- Add a dedicated function to parse the values of toggles. Reduces duplicated
- code in load_config() and provides better error handling. Invalid or missing
- toggle values are now a fatal error instead of being silently ignored.
-
-
-
-
- Terminate HTML lines in static error messages with \n instead of \r\n.
-
-
-
-
- Simplify cgi_error_unknown() a bit.
-
-
-
-
- In LogPutString(), don't bother looking at pszText when not
- actually logging anything.
-
-
-
-
- Change ssplit()'s fourth parameter from int to size_t.
- Fixes a clang complaint.
-
-
-
-
- Add a warning that the statistics currently can't be trusted.
- Mention Privoxy-Log-Parser's --statistics option as
- an alternative for the time being.
-
-
-
-
- In rfc2553_connect_to(), start setting cgi->error_message on error.
-
-
-
-
- Change the expected status code returned for http://p.p/die depending
- on whether or not FEATURE_GRACEFUL_TERMINATION is available.
-
-
-
-
- In cgi_die(), mark the client connection for closing.
- If the client will fetch the style sheet through another connection
- it gets the main thread out of the accept() state and should thus
- trigger the actual shutdown.
-
-
-
-
- Add a proper CGI message for cgi_die().
-
-
-
-
- Don't enforce a logical line length limit in read_config_line().
-
-
-
-
- Slightly refactor server_last_modified() to remove useless gmtime*() calls.
-
-
-
-
- In get_content_type(), also recognize '.jpeg' as JPEG extension.
-
-
-
-
- Add '.png' to the list of recognized file extensions in get_content_type().
-
-
-
-
- In block_url(), consistently use the block reason "Request blocked by Privoxy"
- In two places the reason was "Request for blocked URL" which hides the
- fact that the request got blocked by Privoxy and isn't necessarily
- correct as the block may be due to tags.
-
-
-
-
- In listen_loop(), reload the configuration files after accepting
- a new connection instead of before.
- Previously the first connection that arrived after a configuration
- change would still be handled with the old configuration.
-
-
-
-
- In chat()'s receive-data loop, skip a client socket check if
- the socket will be written to right away anyway. This can
- increase the transfer speed for unfiltered content on fast
- network connections.
-
-
-
-
- The socket timeout is used for SOCKS negotiations as well which
- previously couldn't timeout.
-
-
-
-
- Don't keep the client connection alive if any configuration file
- changed since the time the connection came in. This is closer to
- Privoxy's behaviour before keep-alive support for client connection
- has been added and also less confusing in general.
-
-
-
-
- Treat all Content-Type header values containing the pattern
- 'script' as a sign of text. Reported by pribog in #3134970.
-
-
-
-
-
-
-
- Action file improvements:
-
-
-
- Moved the site-specific block pattern section below the one for the
- generic patterns so for requests that are matched in both, the block
- reason for the domain is shown which is usually more useful than showing
- the one for the generic pattern.
-
-
-
-
- Remove -prevent-compression from the fragile alias. It's no longer
- used anywhere by default and isn't known to break stuff anyway.
-
-
-
-
- Add a (disabled) section to block various Facebook tracking URLs.
- Reported by Dan Stahlke in #3421764.
-
-
-
-
- Add a (disabled) section to rewrite and redirect click-tracking
- URLs used on news.google.com.
- Reported by Dan Stahlke in #3421755.
-
-
-
-
- Unblock linuxcounter.net/.
- Reported by Dan Stahlke in #3422612.
-
-
-
-
- Block 'www91.intel.com/' which is used by Omniture.
- Reported by Adam Piggott in #3167370.
-
-
-
-
- Disable the handle-as-empty-doc-returns-ok option and mark it as deprecated.
- Reminded by tceverling in #2790091.
-
-
-
-
- Add ".ivwbox.de/" to the "Cross-site user tracking" section.
- Reported by Nettozahler in #3172525.
-
-
-
-
- Unblock and fast-redirect ".awin1.com/.*=http://".
- Reported by Adam Piggott in #3170921.
-
-
-
-
- Block "b.collective-media.net/".
-
-
-
-
- Widen the Debian popcon exception to "qa.debian.org/popcon".
- Seen in Debian's 05_default_action.dpatch by Roland Rosenfeld.
-
-
-
-
- Block ".gemius.pl/" which only seems to be used for user tracking.
- Reported by johnd16 in #3002731. Additional input from Lee and movax.
-
-
-
-
- Disable banners-by-size filters for '.thinkgeek.com/'.
- The filter only seems to catch pictures of the inventory.
-
-
-
-
- Block requests for 'go.idmnet.bbelements.com/please/showit/'.
- Reported by kacperdominik in #3372959.
-
-
-
-
- Unblock adainitiative.org/.
-
-
-
-
- Add a fast-redirects exception for '.googleusercontent.com/.*=cache'.
-
-
-
-
- Add a fast-redirects exception for webcache.googleusercontent.com/.
-
-
-
-
- Unblock http://adassier.wordpress.com/ and http://adassier.files.wordpress.com/.
-
-
-
-
-
-
-
- Filter file improvements:
-
-
-
- Let the yahoo filter hide '.ads'.
-
-
-
-
- Let the msn filter hide overlay ads for Facebook 'likes' in search
- results and elements with the id 's_notf_div'. They only seem to be
- used to advertise site 'enhancements'.
-
-
-
-
- Let the js-events filter additionally disarm setInterval().
- Suggested by dg1727 in #3423775.
-
-
-
-
-
-
-
- Documentation improvements:
-
-
-
- Clarify the effect of compiling Privoxy with zlib support.
- Suggested by dg1727 in #3423782.
-
-
-
-
- Point out that the SourceForge messaging system works like a black
- hole and should thus not be used to contact individual developers.
-
-
-
-
- Mention some of the problems one can experience when not explicitly
- configuring an IP addresses as listen address.
-
-
-
-
- Explicitly mention that hostnames can be used instead of IP addresses
- for the listen-address, that only the first address returned will be
- used and what happens if the address is invalid.
- Requested by Calestyo in #3302213.
-
-
-
-
-
-
-
- Log message improvements:
-
-
-
- If only the server connection is kept alive, do not pretend to
- wait for a new client request.
-
-
-
-
- Remove a superfluous log message in forget_connection().
-
-
-
-
- In chat(), properly report missing server responses as such
- instead of calling them empty.
-
-
-
-
- In forwarded_connect(), fix a log message nobody should ever see.
-
-
-
-
- Fix a log message in socks5_connect(), a failed write operation
- was logged as failed read operation.
-
-
-
-
- Let load_one_actions_file() properly complain about a missing
- '{' at the beginning of the file.
- Simply stating that a line is invalid isn't particularly helpful.
-
-
-
-
- Do not claim to listen on a socket until Privoxy actually does.
- Patch submitted by Petr Pisar #3354485
-
-
-
-
- Prevent a duplicated LOG_LEVEL_CLF message when sending out
- the "no-server-data" response.
-
-
-
-
- Also log the client socket when dropping a connection.
-
-
-
-
- Include the destination host in the 'Request ... marked for
- blocking. limit-connect{...} doesn't allow CONNECT ...' message
- Patch submitted by Saperski in #3296250.
-
-
-
-
- Prevent a duplicated log message if none of the resolved IP
- addresses were reachable.
-
-
-
-
- In connect_to(), do not pretend to retry if forwarded-connect-retries
- is zero or unset.
-
-
-
-
- When a specified user or group can't be found, put the name in
- single-quotes when logging it.
-
-
-
-
- In rfc2553_connect_to(), explain getnameinfo() errors better.
-
-
-
-
- Remove a useless log message in chat().
-
-
-
-
- When retrying to connect, also log the maximum number of connection
- attempts.
-
-
-
-
- Rephrase a log message in compile_dynamic_pcrs_job_list().
- Divide the error code and its meaning with a colon. Call the pcrs
- job dynamic and not the filter. Filters may contain dynamic and
- non-dynamic pcrs jobs at the same time. Only mention the name of
- the filter or tagger, but don't claim it's a filter when it could
- be a tagger.
-
-
-
-
- In a fatal error message in load_one_actions_file(), cover both
- URL and TAG patterns.
-
-
-
-
- In pcrs_strerror(), properly report unknown positive error code
- values as such. Previously they were handled like 0 (no error).
-
-
-
-
- In compile_dynamic_pcrs_job_list(), also log the actual error code as
- pcrs_strerror() doesn't handle all errors reported by pcre.
-
-
-
-
- Don't bother trying to continue chatting if the client didn't ask for it.
- Reduces log noise a bit.
-
-
-
-
- Make two fatal error message in load_one_actions_file() more descriptive.
-
-
-
-
- In cgi_send_user_manual(), log when rejecting a file name due to '/' or '..'.
-
-
-
-
- In load_file(), log a message if opening a file failed.
- The CGI error message alone isn't too helpful.
-
-
-
-
- In connection_destination_matches(), improve two log messages
- to help understand why the destinations don't match.
-
-
-
-
- Rephrase a log message in serve(). Client request arrival
- should be differentiated from closed client connections now.
-
-
-
-
- In serve(), log if a client connection isn't reused due to a
- configuration file change.
-
-
-
-
- Let mark_server_socket_tainted() always mark the server socket tainted,
- just don't talk about it in cases where it has no effect. It doesn't change
- Privoxy's behaviour, but makes understanding the log file easier.
-
-
-
-
-
-
-
- configure:
-
-
-
- Added a --disable-ipv6-support switch for platforms where support
- is detected but doesn't actually work.
-
-
-
-
- Do not check for the existence of strerror() and memmove() twice
-
-
-
-
- Remove a useless test for setpgrp(2). Privoxy doesn't need it and
- it can cause problems when cross-compiling.
-
-
-
-
- Rename the --disable-acl-files switch to --disable-acl-support.
- Since about 2001, ACL directives are specified in the standard
- config file.
-
-
-
-
- Update the URL of the 'Removing outdated PCRE version after the
- next stable release' posting. The old URL stopped working after
- one of SF's recent site "optimizations". Reported by Han Liu.
-
-
-
-
-
-
-
- Privoxy-Regression-Test:
-
-
-
- Added --shuffle-tests option to increase the chances of detection race conditions.
-
-
-
-
- Added a --local-test-file option that allows to use Privoxy-Regression-Test without Privoxy.
-
-
-
-
- Added tests for missing socks4 and socks4a forwarders.
-
-
-
-
- The --privoxy-address option now works with IPv6 addresses containing brackets, too.
-
-
-
-
- Perform limited sanity checks for parameters that are supposed to have numerical values.
-
-
-
-
- Added a --sleep-time option to specify a number of seconds to
- sleep between tests, defaults to 0.
-
-
-
-
- Disable the range-requests tagger for tests that break if it's enabled.
-
-
-
-
- Log messages use the ISO 8601 date format %Y-%m-%d.
-
-
-
-
- Fix spelling in two error messages.
-
-
-
-
- In the --help output, include a list of supported tests and their default levels.
-
-
-
-
- Adjust the tests to properly deal with FEATURE_TOGGLE being disabled.
-
-
-
-
-
-
-
- Privoxy-Log-Parser:
-
-
-
- Perform limited sanity checks for command line parameters that
- are supposed to have numerical values.
-
-
-
-
- Implement a --unbreak-lines-only option to try to revert MUA breakage.
-
-
-
-
- Accept and highlight: Added header: Content-Encoding: deflate
-
-
-
-
- Accept and highlight: Compressed content from 29258 to 8630 bytes.
-
-
-
-
- Accept and highlight: Client request arrived in time on socket 21.
-
-
-
-
- Highlight: Didn't receive data in time: a.fsdn.com:443
-
-
-
-
- Accept log messages with ISO 8601 time stamps, too.
-
-
-
-
-
-
-
- uagen:
-
-
-
- Bump generated Firefox version to 8.0.
-
-
-
-
- Only randomize the release date if the new --randomize-release-date
- option is enabled. Firefox versions after 4 use a fixed date string
- without meaning.
-
-
-
-
-
-
+
+ After invoking Privoxy with
+ --install, you will need to bring up the
+ Windows service console to assign the user you
+ want Privoxy to run under, and whether or not you
+ want it to run whenever the system starts. You can start the
+ Windows services console with the following
+ command: services.msc. If you do not take the manual step
+ of modifying Privoxy's service settings, it will
+ not start. Note too that you will need to give Privoxy a user account that
+ actually exists, or it will not be permitted to
+ write to its log and configuration files.
+
+
+
+
+
+OS/2
+
+
+ First, make sure that no previous installations of
+ Junkbuster and / or
+ Privoxy are left on your
+ system. Check that no Junkbuster
+ or Privoxy objects are in
+ your startup folder.
+
+
+
+ Then, just double-click the WarpIN self-installing archive, which will
+ guide you through the installation process. A shadow of the
+ Privoxy executable will be placed in your
+ startup folder so it will start automatically whenever OS/2 starts.
+
+
+
+ The directory you choose to install Privoxy
+ into will contain all of the configuration files.
+
+
+
+
+Mac OS X
+
+ Installation instructions for the OS X platform depend upon whether
+ you downloaded a ready-built installation package (.pkg or .mpkg) or have
+ downloaded the source code.
+
+
+
+Installation from ready-built package
+
+ The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
+ .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
+ installation will start; double-clicking the latter will unzip the .mpkg file
+ which can then be double-clicked to commence the installation.
+
+
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
+
+
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
+ (on OS X 10.5 and higher) or the folder named
+ /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
+
+
+ To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.
+
+
+ To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
+ administrator account.
+
+
+
+Installation from source
+
+ To build and install the Privoxy source code on OS X you will need to obtain
+ the macsetup module from the Privoxy Sourceforge CVS repository (refer to
+ Sourceforge help for details of how to set up a CVS client to have read-only
+ access to the repository). This module contains scripts that leverage the usual
+ open-source tools (available as part of Apple's free of charge Xcode
+ distribution or via the usual open-source software package managers for OS X
+ (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
+ and associated files. The macsetup module's README file contains complete
+ instructions for its use.
+
+
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
+
+
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
+ (on OS X 10.5 and higher) or the folder named
+ /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
+
+
+ To manually start or stop the privoxy service, use the Privoxy Utility
+ for Mac OS X (also part of the macsetup module). This application can start
+ and stop the privoxy service and display its log and configuration files.
+
+
+ To uninstall, run the macsetup module's uninstall.sh as sudo from an
+ administrator account.
+
+
+
+
+FreeBSD
+
+
+ Privoxy is part of FreeBSD's Ports Collection, you can build and install
+ it with cd /usr/ports/www/privoxy; make install clean.
+
+
+
+
+
+
+Building from Source
+
+
+ The most convenient way to obtain the Privoxy source
+ code is to download the source tarball from our
+
+ project download page,
+ or you can get the up-to-the-minute, possibly unstable, development version from
+ https://www.privoxy.org/.
+
+
+
+&buildsource;
+
+
+
+ Windows
+
+ Setup
+
+ Install the Cygwin utilities needed to build Privoxy.
+ If you have a 64 bit CPU (which most people do by now), get the
+ Cygwin setup-x86_64.exe program here
+ (the .sig file is here).
+
+
+ Run the setup program and from View / Category select:
+
+
+ Devel
+ autoconf 2.5
+ automake 1.15
+ binutils
+ cmake
+ gcc-core
+ gcc-g++
+ git
+ make
+ mingw64-i686-gcc-core
+ mingw64-i686-zlib
+ Editors
+ vim
+ Libs
+ libxslt: GNOME XSLT library (runtime)
+ Net
+ curl
+ openssh
+ Text
+ docbook-dssl
+ docbook-sgml31
+ docbook-utils
+ openjade
+ Utils
+ gnupg
+ Web
+ w3m
+
+
+
+ If you haven't already downloaded the Privoxy source code, get it now:
+
+
+ mkdir <root-dir>
+ cd <root-dir>
+ git clone https://www.privoxy.org/git/privoxy.git
+
+
+
+ Get the source code (.zip or .tar.gz) for tidy from
+
+ https://github.com/htacg/tidy-html5/releases,
+ unzip into <root-dir> and build the software:
+
+
+ cd <root-dir>
+ cd tidy-html5-x.y.z/build/cmake
+ cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local
+ make && make install
+
+
+
+ If you want to be able to make a Windows release package, get the NSIS .zip file from
+
+
+ https://sourceforge.net/projects/nsis/files/NSIS%203/
+ and extract the NSIS directory to privoxy/windows.
+ Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg:
+
+
+# Path to NSIS
+MAKENSIS = ./nsis/makensis.exe
+
+
+
+
+ Build
+
+
+ To build just the Privoxy executable and not the whole installation package, do:
+
+
+ cd <root-dir>/privoxy
+ ./windows/MYconfigure && make
+
+
+
+ Privoxy uses the GNU Autotools
+ for building software, so the process is:
+
+
+ $ autoheader # creates config.h.in
+ $ autoconf # uses config.h.in to create the configure shell script
+ $ ./configure [options] # creates GNUmakefile
+ $ make [options] # builds the program
+
+
+
+ The usual configure options for building a native Windows application under cygwin are
+
+
+
+ --host=i686-w64-mingw32
+ --enable-mingw32
+ --enable-zlib
+ --enable-static-linking
+ --disable-pthread
+ --disable-dynamic-pcre
+
+
+
+ You can set the CFLAGS and LDFLAGS envars before
+ running configure to set compiler and linker flags. For example:
+
+
+
+ $ export CFLAGS="-O2" # set gcc optimization level
+ $ export LDFLAGS="-Wl,--nxcompat" # Enable DEP
+ $ ./configure --host=i686-w64-mingw32 --enable-mingw32 --enable-zlib \
+ > --enable-static-linking --disable-pthread --disable-dynamic-pcre
+ $ make # build Privoxy
+
+
+
+ See the Developer's Manual
+ for building a Windows release package.
+
+
+
+
+
+
+
+
+Keeping your Installation Up-to-Date
+
+
+ If you wish to receive an email notification whenever we release updates of
+ Privoxy or the actions file, subscribe
+ to our announce mailing list, privoxy-announce@lists.privoxy.org.
+
+
+
+ In order not to lose your personal changes and adjustments when updating
+ to the latest default.action file we strongly
+ recommend that you use user.action and
+ user.filter for your local
+ customizations of Privoxy. See the Chapter on actions files for details.
+
+
+
+
+
+
+
+
+
+What's New in this Release
+
+&changelog;
@@ -1453,7 +531,6 @@ How to install the binary packages depends on your operating system:
versions of Privoxy:
-
@@ -1484,12 +561,6 @@ How to install the binary packages depends on your operating system:
files, thinking you will want to do that yourself.
-
-
- standard.action has been merged into
- the default.action file.
-
-
In the default configuration only fatal errors are logged now.
@@ -1544,11 +615,9 @@ How to install the binary packages depends on your operating system:
that filtering does not work on compressed pages, so if you use, or want to
use, filtering, you will need to force compression off. Example:
-
{ +filter{google} +prevent-compression }
.google.
-
Or if you use a number of filters, or filter many sites, you may just want
to turn off compression for all sites in
@@ -1576,14 +645,13 @@ How to install the binary packages depends on your operating system:
-->
-Quickstart to Using Privoxy
-
+
@@ -1668,18 +736,6 @@ How to install the binary packages depends on your operating system:
-
-
Please see the section Contacting the
@@ -1695,7 +751,6 @@ How to install the binary packages depends on your operating system:
-
@@ -1772,7 +827,6 @@ How to install the binary packages depends on your operating system:
set-image-blocker:
-
@@ -1847,7 +901,6 @@ How to install the binary packages depends on your operating system:
-
Advanced users will eventually want to explore &my-app;
@@ -1893,7 +946,6 @@ How to install the binary packages depends on your operating system:
A quick and simple step by step example:
-
@@ -1917,7 +969,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -1963,7 +1013,6 @@ How to install the binary packages depends on your operating system:
-
This is a very crude and simple example. There might be good reasons to use a
@@ -2011,7 +1060,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -2032,7 +1079,6 @@ How to install the binary packages depends on your operating system:
Tools -> Options -> Advanced -> Network ->Connection -> Settings
-
@@ -2041,7 +1087,6 @@ How to install the binary packages depends on your operating system:
Edit -> Preferences -> General -> Connection Settings -> Manual Proxy Configuration
-
@@ -2055,7 +1100,6 @@ How to install the binary packages depends on your operating system:
Edit -> Preferences -> Advanced -> Proxies -> HTTP Proxy
-
@@ -2075,7 +1119,6 @@ How to install the binary packages depends on your operating system:
-
-
@@ -2107,41 +1149,38 @@ How to install the binary packages depends on your operating system:
directory. Except on Win32 where it will try config.txt.
-
-Red Hat and Fedora
+
+Debian
- A default Red Hat installation may not start &my-app; upon boot. It will use
- the file /etc/privoxy/config as its main configuration
+ We use a script. Note that Debian typically starts &my-app; upon booting per
+ default. It will use the file
+ /etc/privoxy/config as its main configuration
file.
-
- # /etc/rc.d/init.d/privoxy start
+ # /etc/init.d/privoxy start
-
+
+
+
+FreeBSD and ElectroBSD
- Or ...
+ To start Privoxy upon booting, add
+ "privoxy_enable='YES'" to /etc/rc.conf.
+ Privoxy will use
+ /usr/local/etc/privoxy/config as its main
+ configuration file.
-
- # service privoxy start
-
+ If you installed Privoxy into a jail, the
+ paths above are relative to the jail root.
-
-
-
-Debian
- We use a script. Note that Debian typically starts &my-app; upon booting per
- default. It will use the file
- /etc/privoxy/config as its main configuration
- file.
+ To start Privoxy manually, run:
-
- # /etc/init.d/privoxy start
+ # service privoxy onestart
-
@@ -2163,96 +1202,53 @@ Click on the &my-app; Icon to start Privoxy. If no co
-Solaris, NetBSD, FreeBSD, HP-UX and others
+Generic instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)
Example Unix startup command:
-
- # /usr/sbin/privoxy /etc/privoxy/config
-
-
-
-
-
-OS/2
-
- During installation, Privoxy is configured to
- start automatically when the system restarts. You can start it manually by
- double-clicking on the Privoxy icon in the
- Privoxy folder.
-
-
-
-
-Mac OS X
-
- After downloading the privoxy software, unzip the downloaded file by
- double-clicking on the zip file icon. Then, double-click on the
- installer package icon and follow the installation process.
-
-
- The privoxy service will automatically start after a successful
- installation. In addition, the privoxy service will automatically
- start every time your computer starts up.
-
-
- To prevent the privoxy service from automatically starting when your
- computer starts up, remove or rename the folder named
- /Library/StartupItems/Privoxy.
-
-
- A simple application named Privoxy Utility has been created which
- enables administrators to easily start and stop the privoxy service.
-
-
- In addition, the Privoxy Utility presents a simple way for
- administrators to edit the various privoxy config files. A method
- to uninstall the software is also available.
-
+ # /usr/sbin/privoxy --user privoxy /etc/privoxy/config
+
- An administrator username and password must be supplied in order for
- the Privoxy Utility to perform any of the tasks.
+ Note that if you installed Privoxy through
+ a package manager, the package will probably contain a platform-specific
+ script or configuration file to start Privoxy
+ upon boot.
-
-
-AmigaOS
+
+OS/2
- Start Privoxy (with RUN <>NIL:) in your
- startnet script (AmiTCP), in
- s:user-startup (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx).
- Privoxy will automatically quit when you quit your
- TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
- Privoxy is still running).
+ During installation, Privoxy is configured to
+ start automatically when the system restarts. You can start it manually by
+ double-clicking on the Privoxy icon in the
+ Privoxy folder.
-
-Gentoo
-
- A script is again used. It will use the file /etc/privoxy/config
- as its main configuration file.
-
+
+Mac OS X
-
- /etc/init.d/privoxy start
-
+ The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
- Note that Privoxy is not automatically started at
- boot time by default. You can change this with the rc-update
- command.
+ To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file /Library/LaunchDaemons/org.ijbswa.privoxy.plist
+ (on OS X 10.5 and higher) or the folder named
+ /Library/StartupItems/Privoxy (on OS X 10.4 'Tiger').
-
- rc-update add privoxy default
-
+ To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.
+
-
+Controlling Privoxy with Your Web BrowserPrivoxy's user interface can be reached through the special
@@ -2511,20 +1506,18 @@ for details.
(shortcut: http://p.p/),
which is a built-in page and works without Internet access.
You will see the following section:
-
-
+ Privoxy Menu
-
▪ View & change the current configuration
- ▪ View the source code version numbers
+ ▪ View or toggle the tags that can be set based on the clients address
▪ View the request headers.
@@ -2537,7 +1530,7 @@ for details.
▪ Documentation
+ url="https://www.privoxy.org/&p-version;/user-manual/">Documentation
@@ -2559,10 +1552,7 @@ for details.
it as a test to see whether it is Privoxy
causing the problem or not. Privoxy continues
to run as a proxy in this case, but all manipulation is disabled, i.e.
- Privoxy acts like a normal forwarding proxy. There
- is even a toggle Bookmarklet offered, so
- that you can toggle Privoxy with one click from
- your browser.
+ Privoxy acts like a normal forwarding proxy.
@@ -2585,9 +1575,9 @@ for details.
Configuration Files Overview
- For Unix, *BSD and Linux, all configuration files are located in
- /etc/privoxy/ by default. For MS Windows, OS/2, and
- AmigaOS these are all in the same directory as the
+ For Unix, *BSD and GNU/Linux, all configuration files are located in
+ /etc/privoxy/ by default. For MS Windows and OS/2
+ these are all in the same directory as the
Privoxy executable.
@@ -2599,13 +1589,12 @@ for details.
principle configuration files are:
-
The main configuration file is named config
- on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt
+ on GNU/Linux, Unix, BSD, and OS/2, and config.txt
on Windows. This is a required file.
@@ -2657,7 +1646,6 @@ for details.
-
The syntax of the configuration and filter files may change between different
@@ -2743,7 +1731,6 @@ for details.
are three action files included with Privoxy with
differing purposes:
-
@@ -2806,7 +1793,6 @@ for details.
The default profiles, and their associated actions, as pre-defined in
default.action are:
-
Default Configurations
@@ -2924,11 +1910,9 @@ for details.
@@ -8840,85 +8256,6 @@ Requests
-
-
-
- These may be bookmarked for quick reference. See next.
-
-
-
-
-Bookmarklets
-
- Below are some bookmarklets to allow you to easily access a
- mini version of some of Privoxy's
- special pages. They are designed for MS Internet Explorer, but should work
- equally well in Netscape, Mozilla, and other browsers which support
- JavaScript. They are designed to run directly from your bookmarks - not by
- clicking the links below (although that should work for testing).
-
-
- To save them, right-click the link and choose Add to Favorites
- (IE) or Add Bookmark (Netscape). You will get a warning that
- the bookmark may not be safe - just click OK. Then you can run the
- Bookmarklet directly from your favorites/bookmarks. For even faster access,
- you can put them on the Links bar (IE) or the Personal
- Toolbar (Netscape), and run them with a single click.
-
-
-
-
-
-
-
- Privoxy - Enable
-
-
-
-
-
- Privoxy - Disable
-
-
-
-
-
- Privoxy - Toggle Privoxy (Toggles between enabled and disabled)
-
-
-
-
-
- Privoxy- View Status
-
-
-
-
-
- Privoxy - Why?
-
-
-
-
-
-
- Credit: The site which gave us the general idea for these bookmarklets is
- www.bookmarklets.com. They
- have more information about bookmarklets.
-
-
-
-
@@ -8932,7 +8269,6 @@ Requests
page is requested by your browser:
-
@@ -9041,7 +8377,7 @@ Requests
-
+
NOTE: This is somewhat of a simplistic overview of what happens with each URL
request. For the sake of brevity and simplicity, we have focused on
@@ -9071,8 +8407,7 @@ Requests
One quick test to see if Privoxy is causing a problem
or not, is to disable it temporarily. This should be the first troubleshooting
- step. See the Bookmarklets section on a quick
- and easy way to do this (be sure to flush caches afterward!). Looking at the
+ step (be sure to flush caches afterward!). Looking at the
logs is a good idea too. (Note that both the toggle feature and logging are
enabled via config file settings, and may need to be
turned on.)
@@ -9115,7 +8450,6 @@ Requests
configuration may vary):
-
Matches for http://www.google.com:
@@ -9145,7 +8479,6 @@ Requests
In file: user.action [ View ][ Edit ]
(no matches in this file)
-
This is telling us how we have defined our
@@ -9201,12 +8534,9 @@ In file: user.action [ View ][ Edit ]Privoxy is applying all its actions
to google.com:
-
-
-
Final results:
-add-header
@@ -9264,8 +8594,8 @@ In file: user.action [ View ][ Edit ]
-
+ +set-image-blocker {pattern}
+
Notice the only difference here to the previous listing, is to
@@ -9278,9 +8608,7 @@ In file: user.action [ View ][ Edit ]ad.doubleclick.net:
-
-
{ +block{Domains starts with "ad"} }
ad*.
@@ -9290,7 +8618,6 @@ In file: user.action [ View ][ Edit ]
-
We'll just show the interesting part here - the explicit matches. It is
@@ -9322,9 +8649,7 @@ In file: user.action [ View ][ Edit ]
-
-
Matches for http://www.example.net/adsl/HOWTO/:
In file: default.action [ View ][ Edit ]
@@ -9388,7 +8713,6 @@ In file: user.action [ View ][ Edit ]
-
Ooops, the /adsl/ is matching /ads in our
@@ -9404,13 +8728,10 @@ In file: user.action [ View ][ Edit ]
-
-
{ -block }
/adsl
-
Now the page displays ;-)
@@ -9424,13 +8745,10 @@ In file: user.action [ View ][ Edit ]
-
-
{ +block{Path starts with "ads".} +handle-as-image }
/ads
-
That actually was very helpful and pointed us quickly to where the problem
@@ -9444,9 +8762,7 @@ In file: user.action [ View ][ Edit ]+filter:
-
-
{ shop }
.quietpc.com
.worldpay.com # for quietpc.com
@@ -9454,25 +8770,20 @@ In file: user.action [ View ][ Edit ]
-{ shop } is an alias that expands to
{ -filter -session-cookies-only }.
Or you could do your own exception to negate filtering:
-
-
-
{ -filter }
# Disable ALL filter actions for sites in this section
.forbes.com
developer.ibm.com
localhost
-
This would turn off all filtering for these sites. This is best
@@ -9495,14 +8806,12 @@ In file: user.action [ View ][ Edit ]
-
-
+
{ fragile }
# Handle with care: easy to break
mail.google.
mybank.example.com
-