Improve setup script (set executable bit, be verbose about what happens)
TKLCZ opened this issue · comments
General information
- Operating system + version: Ubuntu 18.04, Windows 7 Professional 64bit
- Browser + version: Firefox 62
- Information about the host app:
- How did you install it? downloaded a pre-built binary
- If installed an official release, put a version: 2.0.22
- Information about the browser extension:
- How did you install it? webstore
- Browserpass extension version as reported by your browser: 2.0.22
Exact steps to reproduce the problem
- Run installation script in Linux
- Run installation script in Windows 7
What should happen?
Correct installation of host app
What happened instead?
-
In Linux:
a) Only the json file installed to ~/.mozilla/native.messaging-hosts folder. The binary file stay in their downloading location and this path is added to the json (this is very confusing, I want to delete all my old downloaded files immedially).
b) The installation script does not set the execution bit on the binary file. Without 'chmod +x' browserpass doesn't work. -
In Windows 7 (the powershell... why??? )
a) at first the allowing of unsigned scripts is needed
b) the json file conversion failed so only binary file is installed to AppData\Local\browserpass folder
By my opinion - because the 'pass' password manager is geeky thing - no installation scripts needed.
A simple installation instructions will be much much better, something like this for example:
- copy this two files to ~/mozilla/native-messaging-hosts
- run a chmod +x ~/mozilla/native-messaging-hosts/browserpass-linux64
for Linux
or
- copy this two files to c:\Users\username\AppData\Local\browserpass
- run a reg file browserpass.reg
for Windows.
The browserpass Firefox addon is great, much better than passff. It's a shame kill it by semi-functional installation scripts.
Thanks for the feedback 😉
I think it's better to provide a script, eliminates differences in how people install the app and helps debugging issues. But it's a simple shell script, if you don't want to blindly run it, open it in a text editor and read the commands 😉
A) the path to json file is set in stone by mozilla, the path to browserpass binary can be arbitrary, so this is by design.
B) Good point, should do this.
- Powershell because it was a user contribution, also why not? 😉
A) yes, this is by design
B) feel free to send a PR, I would be happy to merge the fix 😉 I can't test, I'm on Linux.
In summary, I prefer having a script over instructions, fixing 1.B will close this issue.
I think it's better to provide a script, eliminates differences in how people install the app and helps debugging issues. But it's a simple shell script, if you don't want to blindly run it, open it in a text editor and read the commands
OK, but the function of script needs to be clearly. I think that there is a big space for improvements. I can help you and try to improve the installation script.
A) the path to json file is set in stone by mozilla, the path to browserpass binary can be arbitrary, so this is by design.
No problem, but there needs to be provided a unambiguous information to the user of the script. For now is not evident where the binary file will be stored.
The common procedure is: download of a archive file - extraction - running of a installation script - deleting of ALL downloaded files.
In the case of browserpass the last step (deleting of downloaded files) cause the malfunction because the user dont'know that the binary file must stay in this place forever.
1. Powershell because it was a user contribution, also why not? B) feel free to send a PR, I would be happy to merge the fix I can't test, I'm on Linux.
I'm not familiar with the powershell too much and I'm on Windows sporadically, but I can try to get some information about the error and send it to you.
I would be happy to merge a patch that would print some info messages before performing an installation, to clarify to the user what will happen, and pausing to allow the user to press ctrl+c to abort and move the files. Don't want to overcomplicate the script too much though :)
Feel free to post the error messages that Powershell script throws at you, I won't be personally fixing them as I don't use pass on Windows, but perhaps one day someone from the community will chip in and submit a PR 😉
I would be happy to merge a patch that would print some info messages before performing an installation, to clarify to the user what will happen, and pausing to allow the user to press ctrl+c to abort and move the files. Don't want to overcomplicate the script too much though :)
I'm done. What's new in the script:
- introduction info for the users
- option for copying the binary host file to the same directory as the json file
- chmod +x on the binary host file
- checks if some operations was successfull (file or directory creation for example)
No big changes but now the script is (by my opinion) better understandable for users.
Tested with all browsers in their last versions (Firefox, Chromium, Chrome, Vivaldi) on Ubuntu 18.04.
Feel free to change anything, my english especially :-)
Because I'm not using git, here is a link to a gpg-signed file, placed on my website:
https://www.tkl.cz/download/browserpass_install_signed.zip
Unpack and verify:
gpg --verify install.sh.gpg install.sh
If you'll find any issue, please let me know.
Thanks 😉 I would like to make some changes to the script before merging, I will get back to this later.
Just in case, re-attaching the zip file on Github: browserpass_install_signed.zip
- Powershell because it was a user contribution, also why not? wink
A) yes, this is by design
B) feel free to send a PR, I would be happy to merge the fix wink I can't test, I'm on Linux.In summary, I prefer having a script over instructions, fixing 1.B will close this issue.
Hello, here is the error message from powershell installation script:
The term 'ConvertTo-json' is not recognized as the name of a cmdlet, function,
script file, or operable program. Check the spelling of the name, or if a path
was included, verify that the path is correct and try again.
At C:\Users\username\Downloads\browserpass\install.ps1:18 char:114
- $ffile -replace '%%replace%%', ((Join-Path -Path $dirpath -ChildPath 'browser
pass-windows64.exe' | ConvertTo-json <<<< ) -replace '^"|"$', "") | Out-File -E
ncoding UTF8 $ff_jsonpath- CategoryInfo : ObjectNotFound: (ConvertTo-json:String) [], Comm
andNotFoundException - FullyQualifiedErrorId : CommandNotFoundException
- CategoryInfo : ObjectNotFound: (ConvertTo-json:String) [], Comm
The term 'ConvertTo-json' is not recognized as the name of a cmdlet, function,
script file, or operable program. Check the spelling of the name, or if a path
was included, verify that the path is correct and try again.
At C:\Users\username\Downloads\browserpass\install.ps1:21 char:114
- $cfile -replace '%%replace%%', ((Join-Path -Path $dirpath -ChildPath 'browser
pass-windows64.exe' | ConvertTo-json <<<< ) -replace '^"|"$', "") | Out-File -E
ncoding UTF8 $chrome_jsonpath- CategoryInfo : ObjectNotFound: (ConvertTo-json:String) [], Comm
andNotFoundException - FullyQualifiedErrorId : CommandNotFoundException
- CategoryInfo : ObjectNotFound: (ConvertTo-json:String) [], Comm
WIndows 7 Professional SP1 64bit Czech. This was another computer than last time but the error is the same.
I hope it will help.
Nice, thanks 🙂 Quick googling shows:
-
ConvertTo-Json: This cmdlet was introduced in Windows PowerShell 3.0.
-
Windows PowerShell 3.0: v2.0 can only be found on some Windows 7, and it is possible to upgrade to v3.0.
I can see now why nobody reported this issue so far 🙂
I will accept PRs that achieve the same behavior without using ConvertTo-Json, but as a workaround you can upgrade your PowerShell to v3.0.