dm1sh/gnome-pass-search-provider
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
Jonathan Lestrelin 2021-03-02 08:02:27 +01:00
parent bbceb716b1
commit f0b065bbd7
2 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -13,22 +13,26 @@ Supports OTP, fields and can use GPaste.
Install `gnome-pass-search-provider-git` from the AUR.
## Debian, Ubuntu and derivatives
If a package is available for your distribution version (see above for packaging status), just install `gnome-pass-search-provider` through APT.
If a package is available for your distribution version (see above for packaging status), just install `gnome-pass-search-provider` through APT:
```
apt install gnome-pass-search-provider
```
## Fedora
Enable the copr repo and install the package with DNF:
```shell
```
dnf copr enable jle64/gnome-pass-search-provider
dnf install gnome-pass-search-provider
```
## Manual
Ensure that python>=3.5 as well as the dbus, gobject, fuzzywuzzy modules are installed. They should all be packaged under python-name or python3-name depending on your distribution.
Ensure that python>=3.5 as well as the dbus, gobject, fuzzywuzzy Python modules are installed. They should all be packaged under python-name or python3-name depending on your distribution.
Clone this repository and run the installation script as root:
```shell
```
git clone git@github.com:jle64/gnome-shell-pass-search-provider.git
sudo ./install.sh
```
@ -37,11 +41,9 @@ sudo ./install.sh
Log out and reopen your GNOME session.
The search provider will be loaded automatically when doing a search. You should see it enabled in GNOME Settings Search pane.
The search provider will be loaded automatically when doing a search.
# OTP
The [pass-otp](https://github.com/tadfisher/pass-otp) extension is supported. Searches starting with `otp` will copy the otp token to the clipboard.
You should see it enabled in GNOME Settings, in the Search pane. This is also where you can move it up or down in the list of results relatively to other search providers.
# Fields
@ -54,16 +56,20 @@ user: username
pin: 123456
```
To copy the pin start the search with `:pin` and for the username `:user`.
To copy the pin start the search with `:pin` and for the username with `:user`.
# OTP
The [pass-otp](https://github.com/tadfisher/pass-otp) extension is supported. Searches starting with `otp` will copy the otp token to the clipboard.
# Environment variables
If you are configuring `pass` through environment variables, such as `PASSWORD_STORE_DIR`, make sure to set them in a way that will propagate to the search provider executable, not just in your shell.
Setting them in `~/.profile` or `~/.pam_environment` should be sufficient, but stuff in shell-specific files such as `~/.bashrc` will not be picked up by gnome-shell.
Setting them in `~/.profile` (or `~/.pam_environment` if supported by your OS) should be sufficient, but stuff in shell-specific files such as `~/.bashrc` will not be picked up by gnome-shell.
If your values have no effect, make sure they propagate to the script environment:
```shell
If your values have no effect, make sure they propagate to the script environment. You can check this with ps:
```
ps auxeww | grep [g]nome-pass-search-provider.py
```
@ -74,12 +80,12 @@ Otherwise they are sent to the clipboard using `pass -c` which defaults to expir
# Compatibility
This implements the `org.gnome.Shell.SearchProvider2` D-Bus API and has been tested with GNOME Shell 3.22-3.38. This uses the `org.gnome.GPaste1` or `org.gnome.GPaste2` versions of the GPaste D-Bus API to add passwords to GPaste.
This implements the `org.gnome.Shell.SearchProvider2` D-Bus API and has been tested with GNOME Shell 3.22 to 40. This uses the `org.gnome.GPaste1` or `org.gnome.GPaste2` versions of the GPaste D-Bus API to add passwords to GPaste.
# Troubleshooting
If you don't see passphrase prompts when your key is locked, it might be because GPG is not using the right pinentry program. You can force gpg-agent to use pinentry-gnome3 by adding `pinentry-program /usr/bin/pinentry-gnome3` to `~/.gnupg/gpg-agent.conf`.
If you encounter problems, make sure to look to wherever GNOME and D-Bus are logging for error messages. You can do this using `journalctl --user` on systemd-using systems.
If you encounter problems, make sure to look in the logs of GNOME and D-Bus. On systems that use systemd, you can do this using `journalctl --user`.
Don't hesitate to open an issue.

BIN
misc/screencapture.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.9 MiB

After

Width:  |  Height:  |  Size: 2.8 MiB