Add HTTPS inspection support
[OSXPackageBuilder.git] / pkg content skeleton / Applications / Privoxy / readme.rtfd / TXT.rtf
1 {\rtf1\ansi\ansicpg1252\cocoartf2513
2 \cocoascreenfonts1\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica;\f2\fswiss\fcharset0 Arial-BoldMT;
3 \f3\fswiss\fcharset0 ArialMT;\f4\fnil\fcharset0 LucidaGrande;\f5\fmodern\fcharset0 CourierNewPSMT;
4 }
5 {\colortbl;\red255\green255\blue255;\red255\green19\blue25;\red126\green0\blue20;\red126\green0\blue20;
6 \red10\green0\blue139;}
7 {\*\expandedcolortbl;;\csgenericrgb\c100000\c7451\c9804;\csgenericrgb\c49412\c0\c7843;\csgenericrgb\c49412\c0\c7843;
8 \csgenericrgb\c3922\c0\c54510;}
9 \margl1440\margr1440\vieww21240\viewh13460\viewkind0
10 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
11
12 \f0\b\fs34 \cf2 \
13 You must make the following change in order to start using Privoxy! Also see below for enabling HTTPS inspection.
14 \f1\b0\fs24 \cf0 \
15 \
16 \
17
18 \f0\b\fs26 Setting up your web browser(s) to use Privoxy
19 \f1\b0\fs24 \
20 \
21 In order for Privoxy to filter web content for you, it must be set up as a proxy for your web browser. To do this for most web browsers (Safari, Chrome, Camino - see later in this readme for other browsers) go into your System Preferences.. Network.. preference pane. If the padlock at the bottom-left of the window is locked, you'll need to click it and enter your password to makes changes, then click 'Advanced' and click on the Proxies tab. In both the Web Proxy (HTTP) 
22 \f0\b and
23 \f1\b0  Secure Web Proxy (HTTPS) entries, add the value 127.0.0.1 in the Web Proxy Server box and 8118 in the box to it's right (see screenshot below). Click 'OK' and then 'Apply' and you're all set!\
24 \
25 \pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
26 \cf0 {{\NeXTGraphic Screen shot 2012-01-30 at 1.12.07 PM.png \width13300 \height10400 \appleattachmentpadding0 \appleembedtype0 \appleaqc
27 }¬}\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
28 \cf0 \
29 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
30 \cf0 \
31 \
32 Firefox and Opera have their proxy server settings within the application, for Firefox you'll find the settings at:\
33 \
34 Firefox > Preferences > Network > Settings > Manual Proxy Configuration\
35 \
36 and for Opera at:\
37 \
38 Opera > Preferences > Advanced > Network > Proxy Servers\
39 \
40 All done! To test that you've set things up correctly please follow the instructions in the next section.\
41 \
42 \
43 \pard\pardeftab720\sa240\partightenfactor0
44
45 \f2\b\fs36 \cf3 Enabling HTTPS inspection
46 \f1\b0\fs24 \cf0 \
47 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
48 \cf0 If you would like Privoxy to be able to filter the content of your HTML files even when they are HTTPS encrypted, please refer to {\field{\*\fldinst{HYPERLINK "https://www.privoxy.org/user-manual/config.html#HTTPS-INSPECTION-DIRECTIVES"}}{\fldrslt this section}} of the User Manual for the required config file changes, and {\field{\*\fldinst{HYPERLINK "https://www.privoxy.org/user-manual/actions-file.html#HTTPS-INSPECTION"}}{\fldrslt this section}} for guidance on configuring actions to control which sites it applies to.\
49 \
50 \
51 \pard\pardeftab720\sa240\partightenfactor0
52
53 \f2\b\fs36 \cf4 Checking that Privoxy is working for you
54 \f1\b0\fs24 \cf0 \
55 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
56 \cf0 Simply point your web browser here:\
57 \
58 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
59 {\field{\*\fldinst{HYPERLINK "http://config.privoxy.org/"}}{\fldrslt \cf0 http://config.privoxy.org/}}\
60 \
61 If you see a page like the following screenshot then all is well and Privoxy is filtering web content for you.
62 \f0\b\fs26 \
63 \pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
64
65 \f1\b0\fs24 \cf0 {{\NeXTGraphic Screen shot 2012-01-30 at 1.23.15 PM.png \width25300 \height12660 \appleattachmentpadding0 \appleembedtype0 \appleaqc
66 }¬}\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\partightenfactor0
67 \cf0 \
68 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
69 \cf0 \
70 \
71 \
72
73 \f0\b\fs26 \
74 \pard\pardeftab720\sa240\partightenfactor0
75
76 \f2\fs36 \cf4 Known Problems
77 \f0\fs26 \cf0 \
78 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
79
80 \f1\b0\fs24 \cf0 The OS X 'Mavericks' & 'Yosemite' releases have a bug that causes an intermittent problem for Privoxy that a simple upgrade install will not cure. If you have a persistent problem with Privoxy not starting (in your web browser you get a "Cannot connect to proxy server" error) then the best advice is to completely uninstall Privoxy (using the guide in the readme file at /Applications/Privoxy) then reinstall from scratch. Please ensure you take a copy of your config file and filters if you have made any customisations you do not want to lose.\
81 \
82 For the technically minded, the bug is that the _privoxy user & group cannot be reliably read from directory services at system startup time (there are suggestions that usernames with leading underscore are no longer properly supported), causing Privoxy to fail to load. Details can be found in these discussion threads:\
83 \
84 https://sourceforge.net/p/ijbswa/support-requests/1601/\
85 https://sourceforge.net/p/ijbswa/support-requests/1599/\
86 https://sourceforge.net/p/ijbswa/bugs/882/
87 \f0\b\fs26 \
88 \
89 \
90 \
91 \pard\pardeftab720\sa240\partightenfactor0
92
93 \f2\fs36 \cf4 Is there a particular feature from our TODO list you'd like to see implemented sooner rather than later? Would you like to donate in general?\
94 \pard\pardeftab720\sa240\partightenfactor0
95
96 \f3\b0\fs24 \cf0 Donations are welcome, and you are free to discuss with us what your donation should be used for. Our {\field{\*\fldinst{HYPERLINK "http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO"}}{\fldrslt \cf5 TODO list}} is rather long and being able to pay one (or more) developers to work on Privoxy would make a huge difference, even if it was only for a couple of weeks. Donations may also be used for Privoxy-related travel expenses (for example to attend conferences), for hardware used for Privoxy development and for hosting expenses etc.\
97 Privoxy is an associated project of {\field{\*\fldinst{HYPERLINK "http://www.spi-inc.org/"}}{\fldrslt \cf5 Software in the Public Interest (SPI)}}, which allows us to receive tax-deductible donations in the United States. If you want to donate through SPI, please use {\field{\*\fldinst{HYPERLINK "http://www.spi-inc.org/donations"}}{\fldrslt \cf5 SPI's donation page}} to see what the options are.\
98 You can also donate to Privoxy using a bank account managed by {\field{\*\fldinst{HYPERLINK "https://www.zwiebelfreunde.de/"}}{\fldrslt \cf5 Zwiebelfreunde e.V.}}:\
99 \'a0Name\'a0on\'a0Account:\'a0Zwiebelfreunde\'a0e.V.
100 \f4 \uc0\u8232 
101 \f3 \'a0IBAN:\'a0DE95430609671126825604
102 \f4 \uc0\u8232 
103 \f3 \'a0BIC:\'a0GENODEM1GLS
104 \f4 \uc0\u8232 
105 \f3 \'a0Bank:\'a0GLS\'a0Bank\
106 Donations made through Zwiebelfreunde e.V. are tax-deductible in Germany and other countries that recognize German charitable clubs. Feel free to use the Subject field to provide a name to be credited and a list of TODO list items you are interested in the most. For example: Max Mustermann: #16, #1, #14.\
107 If you have any questions regarding donations please mail to either the public user mailing list or, if it's a private matter, to {\field{\*\fldinst{HYPERLINK "mailto:fk@fabiankeil.de"}}{\fldrslt \cf5 Fabian Keil}} (Privoxy's SPI liason) directly.\
108 \pard\pardeftab720\partightenfactor0
109 \cf0 \
110 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
111
112 \f0\b\fs26 \cf0 \
113 \pard\pardeftab720\sa240\partightenfactor0
114
115 \f2\fs36 \cf4 Configuring Privoxy
116 \f1\b0\fs24 \cf0 \
117 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
118 \cf0 You can access your Privoxy installation configuration at:\
119 \
120 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
121 {\field{\*\fldinst{HYPERLINK "http://config.privoxy.org/"}}{\fldrslt \cf0 http://config.privoxy.org/}}\
122 \
123 Note that to make configuration changes here you first have to manually enable this feature. This is done by setting parameter enable-edit-actions to the value 1 in {\field{\*\fldinst{HYPERLINK "file:///usr/local/etc/privoxy/config"}}{\fldrslt Privoxy's config file}}, which you'll need to edit as an administrator in order to save your changes. Full documentation for Privoxy can be found here:\
124 \
125 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
126 {\field{\*\fldinst{HYPERLINK "file:///usr/local/share/doc/privoxy/"}}{\fldrslt \cf0 file:///usr/local/share/doc/privoxy/}}  (a good place to start is index.html or README)\
127 \
128 \
129 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
130
131 \f0\b\fs26 \cf0 \
132 \pard\pardeftab720\sa240\partightenfactor0
133
134 \f2\fs36 \cf4 Merging in an existing configuration
135 \f1\b0\fs24 \cf0 \
136 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
137 \cf0 If you already had Privoxy installed prior to this installation, then your configuration is unchanged. It is possible however that the configuration files supplied with this new installation contain new options that your existing configuration files do not. If you wish to manually merge your settings into the new files you will find them all at /usr/local/etc/privoxy/\
138 \
139 \
140 \
141 \pard\pardeftab720\sa240\partightenfactor0
142
143 \f2\b\fs36 \cf4 Starting and stopping Privoxy
144 \f0\fs26 \cf0 \
145 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
146
147 \f1\b0\fs24 \cf0 Privoxy can be started and stopped using the two scripts in /Applications/Privoxy named startPrivoxy.sh and stopPrivoxy.sh. They must be run as sudo from an account that has administrative rights. To do this, open a Terminal window then enter the following commands:\
148 \
149 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
150
151 \f5 \cf0 cd /Applications/Privoxy\
152 sudo ./startPrivoxy.sh\
153 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
154
155 \f1 \cf0 \
156 <or>
157 \f0\b \
158 \
159 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
160
161 \f5\b0 \cf0 sudo ./stopPrivoxy.sh\
162 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
163
164 \f0\b \cf0 \
165 \
166 \
167 \pard\pardeftab720\sa240\partightenfactor0
168
169 \f2\fs36 \cf4 Uninstalling Privoxy
170 \f1\b0\fs24 \cf0 \
171 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
172 \cf0 To remove Privoxy once it has been installed, first of all reconfigure your web browser(s) not to use Privoxy as a proxy (see the top of this file for details). Once you're happy that you're not using Privoxy any more you can run its uninstall script.\
173 \
174 To do this, open a Terminal window then enter the following commands:\
175 \
176 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
177
178 \f5 \cf0 cd /Applications/Privoxy\
179 sudo ./uninstall.command\
180 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
181
182 \f1 \cf0 \
183 You will be prompted for your password, since the script requires super-user privileges to run. If your account is not an administrator account, then the script won't work; you'll need to log in using an administrator account and try again. If you have already dragged the Privoxy application folder to the trash, use the 'Put Back' feature to restore it or else recreate the Privoxy folder in your Applications folder, drag the uninstall.command file from the trash to that folder and proceed as above.\
184 \
185 \
186 \
187 \pard\pardeftab720\sa240\partightenfactor0
188
189 \f2\b\fs36 \cf4 Thanks
190 \f1\b0\fs24 \cf0 \
191 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
192 \cf0 This installer is based on previous work done by Mark Miller, David Schmidt and John Daniels, to whom I am indebted. Thanks also to Fabian Keil for occasional technical and significant licensing guidance, and to Andrew Jones, Andreas Rutkauskas, Julien Joubert, Lizik Grelier and Steven Kolins for testing.\
193 \
194 \
195 \
196 \pard\pardeftab720\sa240\partightenfactor0
197
198 \f2\b\fs36 \cf4 Copyright and licensing
199 \f1\b0\fs24 \cf0 \
200 \pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\partightenfactor0
201 \cf0 All files that comprise this installation of Privoxy are written by and Copyright (C) 2001-2023 the Privoxy team. http://www.privoxy.org/\
202 \
203 \pard\pardeftab720\partightenfactor0
204 \cf0 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.\
205 \
206 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \'a0See the GNU General Public License for more details.\
207 \
208 The GNU General Public License should be included with this file. \'a0If not, you can view it at http://www.gnu.org/copyleft/gpl.html or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\
209 }