Opened 5 years ago

Closed 4 years ago

#14688 closed defect (fixed)

Can we optionally create shortcuts for Windows users?

Reported by: mikeperry Owned by: mo
Priority: Medium Milestone:
Component: Applications/Tor Browser Version:
Severity: Keywords: tbb-usability-stoppoint-app, tbb-4.5-alpha, TorBrowserTeam201503
Cc: mo, arthuredelstein, bastik.public@…, mcs, brade Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

At the UX sprint, Arthur pointed out that perhaps we can add an option to our NSIS installer to create a desktop shortcut, start menu shortcut, and/or application registration for Windows 8.

This might help more people to find TBB after installation, at the risk of leaving a tiny bit more evidence on disk that TBB was installed.

Child Tickets

Attachments (2)

FirefoxInstaller.png (11.0 KB) - added by mcs 5 years ago.
Firefox Windows Installer (on Windows desktop)
firefox.exe.png (12.5 KB) - added by mcs 5 years ago.
Firefox Executable (on Windows desktop)

Download all attachments as: .zip

Change History (25)

comment:1 Changed 5 years ago by mo

I suggested this a long time ago. I think it is also part of the lengthier discussion at #7842. This is a seemingly trivial feature to add to the NSIS installer, but UX wise I would prefer it to be a radio button selection ("portable" vs. "installed"), where "install" also adds Uninstall shortcuts/entries. Runa's "what does Tor leave behind" report could be useful to guide additional steps in the uninstall procedure (where the most basic uninstall is "remove the shortcuts, delete the directory").

comment:2 Changed 5 years ago by bastik

Cc: bastik.public@… added

This seems to require either an un-installer to clean up all the traces or instructions on how to remove what the installer placed somewhere.

Considering that it is difficult for people to find files they extracted I wonder how easy it is for them to delete the folder and the shortcuts to it. However adding shortcuts does not do much more damage from my understanding.

comment:3 Changed 5 years ago by mikeperry

Keywords: TorBrowserTeam201502 added

If this is simple, I am in favor of trying out the addition of a checkbox or radio button in the next 4.5-alpha (release date is 24 Feb, but we'd like to merge everything by mid next week).

comment:4 Changed 5 years ago by mikeperry

Keywords: tbb-4.5-alpha added

comment:5 Changed 5 years ago by mikeperry

Keywords: TorBrowserTeam201503 added; TorBrowserTeam201502 removed

comment:6 Changed 5 years ago by mikeperry

Owner: changed from tbb-team to mo
Status: newassigned

comment:7 Changed 5 years ago by mo

Status: assignedneeds_review

After a short discussion on IRC, we decided to add an option to create a shortcut in the user's Start Menu "Programs" section, and have that option enabled by default. Since the desktop is the default location for the Tor Browser installation itself, it does not make much sense to add another shortcut to the Desktop. Also, it is discouraged to do so on Windows.

With NSIS, there's two ways to do this: We either display an extra component page, where "Tor Browser" is a forced checkbox (not possible to unselect), and "Add start menu shortcut" is a separate checkbox. Or, we add the "Add start menu shortcut" to the last page that is displayed (it currently only has "Run Tor Browser", also checked by default).

I think adding the option to the last page makes more sense and is visually more appealing, which is what I implemented in https://github.com/moba/tbb-windows-installer/commit/07b1a92b2c8fdd20cd665e63d6b53d8d40348407 .

Both ways are not ideal since they add another custom string to the installer: no matter which language you select at the beginning, that option will currently not be translated unless we add translations ourselves. The only other custom string we currently have warns if you pick an existing target directory ("The destination directory already exists. You can try to upgrade the Tor Browser Bundle, but if you run into any problems, use a new directory instead. Continue? (Y/N)"), but at least many users don't see that (in contrast to the "Add start menu shortcut"), which all users will see.

comment:8 Changed 5 years ago by mcs

Cc: mcs brade added

I am not sure what to do about the strings that need translating, but in the older one that you mentioned we should replace "the Tor Browser Bundle" with "Tor Browser".

Also, I see that you added a torbrowser.ico file. I am a little nervous about copying extra files into the Browser directory now that we have an automated updater. Won't the shortcuts pick up the icon from firefox.exe? That seems to be the case for the existing "Start Tor Browser" shortcut on Windows 7 at least.

comment:9 Changed 5 years ago by mo

Yes, the icon gets picked up, but firefox.exe has an ugly default icon that has nothing to do with Tor? Unless that gets fixed, we should not create an ugly shortcut with a generic icon. I agree that copying the .ico is not a clean solution, but I mentioned this on IRC and went ahead so we at least have something that works before the release deadline.

I have replaced "Tor Browser Bundle" by "Tor Browser" in all strings that are user facing.

Last edited 5 years ago by mo (previous) (diff)

comment:10 in reply to:  9 Changed 5 years ago by gk

Replying to mo:

Yes, the icon gets picked up, but firefox.exe has an ugly default icon that has nothing to do with Tor?

Not sure which icon you are seeing but I have the icon we are using for Tor Browser for a while now. It is basically the same one used for the TorLauncher extension. It is the globe between the "T" and the "r" on https://www.torproject.org/projects/torbrowser.html.en.

comment:11 Changed 5 years ago by mo

Ah ok. Well, looks like an ugly default browser icon to me :) https://github.com/moba/tbb-windows-installer/commit/032511d14a6443954273462bf192fa189f72bc47 does not copy the .ico and uses firefox.exe as icon source.

comment:12 in reply to:  11 Changed 5 years ago by mcs

Replying to mo:

Ah ok. Well, looks like an ugly default browser icon to me :)

It is strange that you do not see the correct firefox.exe icon. For TB 4.5, this commit:

https://gitweb.torproject.org/tor-browser.git/commit/?h=tor-browser-31.5.0esr-4.5-1&id=1fc3acd7bc98e1612365c3fbec56c31ad17e6e76

replaces files under here:

https://gitweb.torproject.org/tor-browser.git/tree/browser/branding/official?h=tor-browser-31.5.0esr-4.5-1

(and TB 4.0.x should have similar changes).

comment:13 Changed 5 years ago by mo

I see the 'correct' icon, I just didn't interpret it as such. If you want we can also change the installer icon to match the generic globe. I prefer the onion.

Changed 5 years ago by mcs

Attachment: FirefoxInstaller.png added

Firefox Windows Installer (on Windows desktop)

Changed 5 years ago by mcs

Attachment: firefox.exe.png added

Firefox Executable (on Windows desktop)

comment:14 Changed 5 years ago by mcs

I don't think the installer and program should have exactly the same icon, but onion vs. globe are maybe more different than would be ideal. I am not suggesting we take this on right now, but it would be nice if the installer icon looked more like other installers (and maybe had "Setup" in the name).

Here is the Firefox installer as it appears on the Windows desktop:
https://trac.torproject.org/projects/tor/raw-attachment/ticket/14688/FirefoxInstaller.png

And here is firefox.exe as it appears on the Windows desktop:
https://trac.torproject.org/projects/tor/raw-attachment/ticket/14688/firefox.exe.png

Of course I wonder if people even know that software used to come on a CD or a DVD that you pulled out of a mostly empty box.

comment:15 Changed 5 years ago by mikeperry

I think we should also provide a shortcut to firefox.exe on the Desktop if this is checked. To keep the UI simple, can we change "Add start menu shortcut" to "Add Start Menu and Desktop shortcuts", and simply do both at once?

I'd rather err on the side of enabling more people be able to find the app than worry about catering to people who want desktop or start menu shortcuts independently, especially since the real failure mode we're worried about here is allowing people to opt out of all non-installation dir disk activity.

comment:16 Changed 5 years ago by mikeperry

Oh, and what about the Windows 8 Metro-style app launcher? Are Windows 8 users still able to find things in the Start Menu if they stick with the wacky Metro-style UI? Does Windows 8 still display Start Menu apps somewhere in that UI?

comment:17 Changed 5 years ago by mikeperry

Status: needs_reviewneeds_revision

comment:18 in reply to:  16 Changed 5 years ago by mo

Replying to mcs:

I don't think the installer and program should have exactly the same icon, but onion vs. globe are maybe more different than would be ideal. I am not suggesting we take this on right now, but it would be nice if the installer icon looked more like other installers (and maybe had "Setup" in the name).

Hmm ok. My vote would be against a generic installer icon. The installer icon can easily be changed by replacing torbrowser.ico with whatever we want to use.

Replying to mikeperry:

I think we should also provide a shortcut to firefox.exe on the Desktop if this is checked. To keep the UI simple, can we change "Add start menu shortcut" to "Add Start Menu and Desktop shortcuts", and simply do both at once?

As pointed out earlier, since we already extract to the desktop by default and thus create a "Tor Browser" directory right there on the desktop, it didn't feel right to add another shortcut to it. But ok, we can do that.

Replying to mikeperry:

Oh, and what about the Windows 8 Metro-style app launcher? Are Windows 8 users still able to find things in the Start Menu if they stick with the wacky Metro-style UI? Does Windows 8 still display Start Menu apps somewhere in that UI?

Sounds like it. "Unfortunately, not every program on your computer is found when you search for it. To get around this you can create a Windows shortcut to the executable and place that shortcut in the user's Windows Start Menu folder. Once added to the Start Menu folder the shortcut will be shown in the Metro Start screen." http://www.bleepingcomputer.com/tutorials/add-remove-programs-windows-8-start-screen/

comment:19 Changed 5 years ago by mo

Status: needs_revisionneeds_review

Ok so this creates both Start Menu and Desktop shortcuts: https://github.com/moba/tbb-windows-installer/commit/400dd62230d7c219b44ee2e83362a52c5e96806e

Tested on Windows XP in a virtual machine and WINE. Someone should try this out on Windows 8.

comment:20 in reply to:  19 Changed 5 years ago by gk

Replying to mo:

Ok so this creates both Start Menu and Desktop shortcuts: https://github.com/moba/tbb-windows-installer/commit/400dd62230d7c219b44ee2e83362a52c5e96806e

Tested on Windows XP in a virtual machine and WINE. Someone should try this out on Windows 8.

Looks good on Windows 8. The icon is visible on the Metro thingy and launches Tor Browser successfully.

comment:21 Changed 5 years ago by mikeperry

Ok great! gamambel - can you create a gpg signed tag for this commit in your repo? Or we could have mcs pull your changes and tag in his repo, whichever you prefer.

comment:23 Changed 4 years ago by mikeperry

Resolution: fixed
Status: needs_reviewclosed

Ok, thanks a lot. I merged a commit to switch us back to your repo+gpg key for the tag. This should appear in 4.5a5.

Note: See TracTickets for help on using tickets.