Simplify user instruction for 0.0.2.
Martin Peck

Martin Peck commited on 2009-05-17 20:02:02
Zeige 10 geänderte Dateien mit 43 Einfügungen und 247 Löschungen.

... ...
@@ -14,133 +14,42 @@
14 14
 <h3>Using Tor VM</h3>
15 15
 <ul>
16 16
 <li><a href="#Download">Download</a></li>
17
-<li><a href="#Setup">Setup</a></li>
18
-<li><a href="#InstallBundle">Install Bundle</a></li>
17
+<li><a href="#Install">Install</a></li>
19 18
 <li><a href="#Run">Run VM</a></li>
20 19
 <li><a href="#RecommendedUse">Use Torbutton</a></li>
20
+<li><a href="#Shutdown">Shutdown</a></li>
21 21
 </ul>
22 22
 </div>
23 23
 <!-- END SIDEBAR -->
24 24
 
25 25
 <h2>What Is It?</h2>
26
-<p>Tor VM is an experimental transparent Tor proxy for Windows that uses
26
+<p>Tor VM is a transparent Tor proxy for Windows built with
27 27
 <a href="http://www.qemu.org/">Qemu</a> virtualization technology for more
28 28
 resilient clients and relays.
29 29
 </p>
30
-<p><strong>This initial 0.0.1 release is a work in progress!</strong>
31
-See the
32
-<a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4&amp;cat=19"
33
->bug tracking database for known issues</a>. Remember to backup anything
34
-important before using this software on your system.</p>
35
-
30
+<p>
31
+The <a href="https://svn.torproject.org/svn/torvm/trunk/doc/design.html">Tor
32
+VM design document</a> contains additional detail about this work in progress.</p>
33
+</p>
36 34
 
37 35
 <hr />
38 36
 <a id="Download"></a>
39 37
 <h2><a class="anchor" href="#Download">Step One: Download Tor VM Software</a></h2>
40 38
 
41
-<p>The bundle packages are preferred since they include Vidalia and other Tor
42
-software that improves the user experience. If a portable Tor VM instance is
43
-required the self extracting archive can be used to install Tor VM alone
44
-onto a portable storage device.</p>
45
-
46 39
 <ul>
47
-<li><a href="dist/TorVM-0.0.1-Bundle.exe">Tor VM Bundle Installer</a>
48
-(<a href="dist/TorVM-0.0.1-Bundle.exe.asc" style="font-size: 90%;">sig</a>)</li>
40
+<li><a href="dist/TorVM-0.0.2-Bundle.exe">Tor VM Bundle Installer</a>
41
+(<a href="dist/TorVM-0.0.2-Bundle.exe.asc" style="font-size: 90%;">sig</a>)</li>
49 42
 
50
-<li><a href="dist/TorVM-0.0.1-NetInstaller.exe">Tor VM Network Installer</a>
51
-(<a href="dist/TorVM-0.0.1-NetInstaller.exe.asc" style="font-size: 90%;">sig</a>)</li>
52
-
53
-<li><a href="dist/Tor_VM.exe">Tor VM Portable Self Extractor</a>
54
-(<a href="dist/Tor_VM.exe.asc" style="font-size: 90%;">sig</a>)</li>
43
+<li><a href="dist/TorVM-0.0.2-NetInstaller.exe">Tor VM Network Installer</a>
44
+(<a href="dist/TorVM-0.0.2-NetInstaller.exe.asc" style="font-size: 90%;">sig</a>)</li>
55 45
 </ul>
56 46
 
57 47
 <hr />
58
-<a id="Setup"></a>
59
-<h2><a class="anchor" href="#Setup">Step Two: Configure Windows For Less Risk</a></h2>
60
-
61
-<p>Running Firefox with Torbutton as a reduced privilege user provides
62
-defense in depth against various risks Internet users face. These steps
63
-explain how to create a restricted account for user name "anon".</p>
64
-
65
-<p>Navigate to the control panel "User Accounts" option. You can also use
66
-the menu navigation:<br />
67
-<!-- should this be a sequence of <span> instead? -->
68
-<strong>Start Menu -&gt; Settings -&gt; Control Panel -&gt; Add or Remove Programs</strong></p>
69
-
70
-<p><img src="img/uc01.png" alt="Control panel view - Select User Accounts option" /></p>
71
-
72
-<p>Select "Create a new account".</p>
73
-
74
-<p><img src="img/uc02.png" alt="User Accounts Tool - Select Create a new account" /></p>
75
-
76
-<p>Provide a nickname for the anonymous limited user account.</p>
77
-
78
-<p><img src="img/uc03.png" alt="Provide a nickname for the restricted account" /></p>
79
-
80
-<p>Choose the "Limited" account type for the reduced privilege user feature.</p>
81
-
82
-<p><img src="img/uc04.png" alt="Choose the Limited account type" /></p>
83
-
84
-<p>Select "Create Account".</p>
85
-
86
-<p><img src="img/uc05.png" alt="Select Create Account" /></p>
87
-
88
-<p>The new user is added to the list of accounts on the local system. This is
89
-the account that Internet applications like Firefox will run as when using
90
-Tor VM to route traffic through the Tor network.
91
-</p>
92
-
93
-<p><img src="img/uc06.png" alt="New user is available for login session" /></p>
94
-
95
-<p>The Switch User feature is used to run critical Tor VM software as Admin
96
-while Firefox and other Internet applications run with restricted rights.</p>
97
-
98
-<p>Press The Windows Key + L to switch between yourself and restricted user
99
-accounts.</p>
100
-
101
-<p><img src="img/win-el.png" alt="Windows Key + L to switch user" /></p>
48
+<a id="Install"></a>
49
+<h2><a class="anchor" href="#Install">Step Two: Install Tor VM</a></h2>
102 50
 
103
-<p>Or select the "Log off" Start Menu option followed by "Switch User"</p>
104
-
105
-<p><img src="img/uc07.png" alt="Log off and then switch user" /></p>
106
-
107
-<p>The new limited user desktop has its own configuration and environment.</p>
108
-
109
-<p><img src="img/uc09.png" alt="Both Tor VM admin and restricted user can be used concurrently" /></p>
110
-
111
-
112
-<hr />
113
-<a id="InstallExtractor"></a>
114
-<h2><a class="anchor" href="#InstallExtractor">Step Three: Tor VM Self-Extractor</a></h2>
115
-
116
-<p>Save the installer executable to Desktop or portable storage.</p>
117
-
118
-<p><img src="img/extr01.png" alt="Save installer exe to desktop or drive" /></p>
119
-
120
-<p>Select the path or folder to extract into.</p>
121
-
122
-<p><img src="img/extr02.png" alt="Select path for destination" /></p>
123
-
124
-<p>Run the torvm.exe program in the extracted Tor_VM folder.</p>
125
-
126
-<p><img src="img/extr03.png" alt="Run the torvm.exe program in the Tor_VM folder" /></p>
127
-
128
-<h2><a class="anchor" href="#Run">Proceed to: Run Tor VM</a></h2>
129
-
130
-
131
-<hr />
132
-<a id="InstallBundle"></a>
133
-<h2><a class="anchor" href="#InstallBundle">Step Three: Install Tor VM Bundle</a></h2>
134
-
135
-<p>The bundle installers include Vidalia and other software for the local
136
-machine instead of a portable folder. Double click on the Bundle or
137
-Network Installer EXE to begin installation to the current system.</p>
138
-
139
-<p><img src="img/bundle01.png" alt="Click to Run Bundle Installer" /> &nbsp;
140
-<img src="img/netinst01.png" alt="Click to Run Network Installer" /></p>
141
-
142
-<p>The bundle package installs each of the applications included with Tor VM like 
143
-Vidalia and Torbutton.</p>
51
+<p>Double click on the Bundle or Network Installer EXE to begin installation to the
52
+current system.</p>
144 53
 
145 54
 <p><img src="img/bundle02.png" alt="Click to Run Bundle Installer" /></p>
146 55
 
... ...
@@ -152,77 +61,29 @@ to reliably download all of the latest bundle application packages on demand.</p
152 61
 
153 62
 <hr />
154 63
 <a id="Run"></a>
155
-<h2><a class="anchor" href="#Run">Step Four: Run Tor VM</a></h2>
64
+<h2><a class="anchor" href="#Run">Step Three: Run Tor VM</a></h2>
156 65
 
157
-<p>After installing the bundle packages a Tor VM controller is started in
66
+<p>When installation is complete a Tor VM controller is started in
158 67
 the background. The installer program has finished and can be closed.</p>
159 68
 
160 69
 <p><img src="img/run01.png" alt="Tor VM controller will start at end of install" /></p>
161 70
 
162 71
 <p>After preparing network devices a Qemu virtual machine running the
163
-Tor VM kernel is launched. A status screen will be shown detailing progress
164
-bootstrapping the Tor software into the network.</p>
165
-
166
-<p><img src="img/run02.png" alt="Qemu launched with Tor VM kernel" /></p>
167
-
168
-<p>The bootstrap is 100% complete when Tor is able to create a circuit
169
-through the network.</p>
170
-
171
-<p><img src="img/run03.png" alt="Bootstrap not complete until circuit created" /></p>
172
-
173
-<p>If you are running the Tor VM bundle Vidalia will also display the current
174
-progress while bootstrapping into the Tor network.</p>
175
-
176
-<p><img src="img/vidalia-bootstrap.png" alt="Vidalia will also show bootstrap status" /></p>
177
-
178
-<p>After successful start a list of transparent proxy connection counts are
179
-shown. This indicates that Tor VM is up and ready to start transparently
180
-routing traffic through the Tor network. The socks port is also available to
181
-the host for use with Polipo or Privoxy http proxies.</p>
182
-
183
-<p><img src="img/run04.png" alt="Proxy traffic connection counts show Tor VM status" /></p>
184
-
185
-<!-- no marble for first release
186
-<p>The first time Vidalia is run the image tiles needed for the Marble Map
187
-plugin will be generated at start. If you do not have sufficient memory or
188
-CPU to generate these tiles you can install the full Vidalia Marble package
189
-with the generated image tiles already included.</p>
190
-
191
-<p><img src="img/vidalia-genmap.png" alt="It may take a minute to generate the Marble Map image tiles" /></p>
192
-
193
-<p>If any of the bundle applications stop working a repair can be requested
194
-which may resolve the problem.</p>
195
--->
72
+Tor VM kernel is launched with the Vidalia controller. It may take a
73
+few minutes to bootstrap into the Tor network. Please be patient.</p>
196 74
 
75
+<p><img src="img/run02.png" alt="Bootstrap not complete until circuit created" /></p>
197 76
 
198 77
 <hr />
199 78
 <a id="RecommendedUse"></a>
200
-<h2><a class="anchor" href="#RecommendedUse">Step Five: Using Firefox and Torbutton</a></h2>
201
-
202
-<p>You should run Firefox and other Internet software as a restricted user.
203
-Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>
204
-
205
-<p>Press The Windows Key + L to switch users, or select the "Log off".
206
-Start Menu option followed by "Switch User"</p>
207
-
208
-<p><img src="img/win-el.png" alt="Windows Key + L to switch user" /></p>
209
-
210
-<p><img src="img/switch-user.png" alt="_ Or Log Off to switch user" /></p>
211
-
212
-<p>Click the "Install Torbutton" shortcut if you do not have the Torbutton
213
-extension installed.</p>
214
-
215
-<p><img src="img/torbutton01.png" alt="Run Install Torbutton shortcut" /></p>
216
-
217
-<p>Continue with installation despite warning about installing from local file.</p>
218
-
219
-<p><img src="img/torbutton02.png" alt="Firefox will warn about local extension, continue" /></p>
79
+<h2><a class="anchor" href="#RecommendedUse">Step Four: Using Firefox and Torbutton</a></h2>
220 80
 
221
-<p>You will need to restart Firefox to use the new Torbutton extension.</p>
81
+<p>Once Tor has successfully built a circuit the Switch User menu is presented.
82
+Firefox and other Tor applications must be run with the "Tor" restricted user account.</p>
222 83
 
223
-<p><img src="img/torbutton03.png" alt="Restart Firefox to enable new extension" /></p>
84
+<p><img src="img/tor-user-switch.png" alt="Switch to Tor restricted user account" /></p>
224 85
 
225
-<p>Click on the Torbutton status icon in the lower right to enable Tor.</p>
86
+<p>Start Firefox and click on the Torbutton status icon in the lower right to enable Tor.</p>
226 87
 
227 88
 <p><img src="img/torbutton04.png" alt="Click on Torbutton status icon to toggle ON" /></p>
228 89
 
... ...
@@ -236,93 +97,52 @@ extension installed.</p>
236 97
 <a id="ExperimentalUse"></a> 
237 98
 <h2><a class="anchor" href="#ExperimentalUse">Experimental: Using Flash</a></h2>
238 99
 
239
-<p><strong>IMPORTANT: Tor VM can protect your endpoint IP address when using
240
-Flash and other software but it does not yet protect against attacks which
241
-reduce your anonymity set.</strong> DO NOT use Tor VM in this manner if you
242
-rely on unlinkable anonymity; wait until this is addressed in future releases.
243
-</p>
100
+<p><strong>IMPORTANT: This is not a recommended use of Tor.</strong></p>
244 101
 
245
-<p>You should run Flash Player and other Internet software as a restricted user.
246
-Switch to the restricted user account configured in <a class="anchor" href="#Setup">Step Two</a>.</p>
102
+<p>Right click on Torbutton icon at lower right for menu. Select "Preferences..."
103
+option.</p>
247 104
 
248
-<p><img src="img/switch-user.png" alt="Switch to restricted user to play Flash content" /></p>
105
+<p><img src="img/tbprefs.png" alt="Select Torbutton Preferences menu option" /></p>
249 106
 
250
-<p>First be sure that transparent proxy of Internet traffic through Tor is
251
-working correctly. Tor VM ensures that all your traffic is relayed
252
-by default without any application configuration.</p>
107
+<p>Toggle the "Disable plugins..." dynamic content security setting.</p>
253 108
 
254
-<p><img src="img/flash01.png" alt="Verify Tor usage at check.torproject.org" /></p>
109
+<p><img src="img/tbcontent.png" alt="Toggle disable plugins dynamic content security setting" /></p>
255 110
 
256 111
 <p>Connections made from the Browser and Flash Player plugin will now
257 112
 be transparently proxied through the Tor network when viewing content.</p>
258 113
 
259 114
 <p><img src="img/flash02.png" alt="Flash player and other software now using Tor" /></p>
260 115
 
261
-<p>The transparent proxy redirection counts will indicate connections redirected
262
-through Tor in this manner. Traffic sent via Torbutton and Polipo are visible as
263
-SOCKS connections to the Tor VM instance.</p>
264
-
265
-<p><img src="img/transparent.png" alt="Transparent proxy traffic can be seen along with Torbutton and Polipo traffic" /></p>
266
-
267
-
268 116
 <hr />
269
-<a id="Modify"></a>
270
-<h2><a class="anchor" href="#Modify">Modify Tor VM Install Options</a></h2>
271
-
272
-<p>Once a package is installed you can change the default installation options
273
-via the "Change" option for the package. For example, Tor VM is configured to
274
-run at start up which can be disabled by modifying the installation.</p>
117
+<a id="Shutdown"></a>
118
+<h2><a class="anchor" href="#Shutdown">Step Five: Shutdown Tor VM</a></h2>
275 119
 
276
-<p><img src="img/change01.png" alt="Change option is in Add Remove Programs" /></p>
120
+<p>Press The Windows Key + L to switch back to administrator User.</p>
277 121
 
278
-<p>The Change package option will launch the installer GUI for the package.</p>
279
-
280
-<p><img src="img/change02.png" alt="Changes will launch application installer GUI" /></p>
281
- 
282
-<p>The list of configurable installation options can now be set as desired.
283
-For example, disabling the "Run at Startup" option as shown here.</p>
284
-
285
-<p><img src="img/change03.png" alt="Change desired installation options" /></p>
286
- 
287
-<p>Select "Next" once all changes have been selected.</p>
122
+<p><img src="img/win-el.png" alt="Windows Key + L to switch user" /></p>
288 123
 
289
-<p><img src="img/change04.png" alt="Select Next when changes selected" /></p>
124
+<p><img src="img/admin-user-switchback.png" alt="Switch back to admin user account" /></p>
290 125
 
291
-<p>Select "Change" to apply the changes to the installed software.</p>
126
+<p>Select the Vidalia "Exit" option to shutdown the VM and restore network settings.
127
+The restricted Tor user will be logged off automatically.</p>
292 128
 
293
-<p><img src="img/change05.png" alt="Select Change to confirm changes" /></p>
129
+<p><img src="img/exit-vidalia.png" alt="Select Vidalia Exit option to close VM" /></p>
294 130
 
295
-<p>And finally "Finish" to exit the installer GUI. The requested changes
296
-are now in effect.</p>
131
+<p>Do not close the Tor VM controller window while restoring network settings.</p>
297 132
 
298
-<p><img src="img/change06.png" alt="Select Finish to complete modifications" /></p>
133
+<p><img src="img/vm-shutdown.png" alt="Do not close the Tor VM window while restoring network settings" /></p>
299 134
 
300 135
 
301 136
 <hr />
302 137
 <a id="Remove"></a>
303 138
 <h2><a class="anchor" href="#Remove">Uninstall Tor Bundle Software</a></h2>
304 139
 
305
-<p>A script to uninstall all of the Tor bundle applications at once is placed
306
-on the desktop. Run this utility to remove all of the Tor packages and files.</p>
140
+<p>A script to uninstall all of the Tor bundle applications is placed
141
+on the desktop. Run this utility to remove all of the Tor software and files.</p>
307 142
 
308 143
 <p><img src="img/uninstall.png" alt="The Uninstall_Tor script will remove all Tor packages and files" /></p>
309 144
 
310 145
 
311
-<hr />
312
-<a id="Repair"></a>
313
-<h2><a class="anchor" href="#Repair">Repair Installed Applications</a></h2>
314
-
315
-<p>If any installed files become corrupted or deleted you can repair them
316
-with the support option for the application package having problems.</p>
317
-
318
-<p><img src="img/vidalia-support.png" alt="In Add or Remove Programs - Select support option for package" /></p>
319
-
320
-<p>Choose the repair option and all of the package files and registry will be
321
-restored.</p>
322
-
323
-<p><img src="img/vidalia-repair.png" alt="Choose Repair option" /></p>
324
-
325
-
326 146
 <hr />
327 147
 <a id="Debug"></a>
328 148
 <h2><a class="anchor" href="#Debug">Troubleshoot Problems and Report Bugs</a></h2>
... ...
@@ -332,33 +152,9 @@ defects and features. See the
332 152
 <a href="http://bugs.noreply.org/flyspray/index.php?tasks=all&amp;project=4"
333 153
 >Tor flyspray bug tracker</a> for known issues and pending changes.</p>
334 154
 
335
-<!-- localized installers and full Marble data bundle?
336
-<a id="Advanced"></a>
337
-<h2><a class="anchor" href="#Advanced">Experimental Packages and Usage</a></h2>
338
--->
339
-
340
-
341
-<hr />
342
-<a id="More"></a>
343
-<h2><a class="anchor" href="#More">Additional Resources</a></h2>
344
-
345
-<p>The latest design document for Tor VM is available in revision control:
346
-<a href="https://svn.torproject.org/svn/torvm/trunk/doc/design.html"
347
->https://svn.torproject.org/svn/torvm/trunk/doc/design.html</a>.
348
-</p>
349
-
350 155
 <p>Features and fixes planned for the Tor VM software are documented in the
351 156
 <a href="https://svn.torproject.org/svn/torvm/trunk/TODO">Tor VM TODO</a>.</p>
352 157
 
353
-<p><a href="https://data.peertech.org/torbld/info/Tor_VM-svn">Automated package
354
-builds are available</a> for verifying fixes in subversion and testing work in
355
-progress.</p>
356
-
357
-<p>Be sure to build against a known working tag in the torvm repo. For
358
-example,<br />
359
-svn export https://svn.torproject.org/svn/torvm/tags/torvm-0_0_1 torvm-0.0.1-src
360
-</p>
361
-
362 158
 </div><!-- #main -->
363 159
 
364 160
 #include <foot.wmi>