Jonathan Lestrelin bed2f59052 * add gpaste support
* remove call to qtpass
* minor changes
2017-03-15 18:24:51 +01:00

56 lines
2.1 KiB
Markdown

A search provider for GNOME Shell that adds support for searching in [pass](https://www.passwordstore.org/).
Names of passwords will show up in GNOME Shell searches, choosing one will copy the corresponding content to the clipboard.
![Sreencapture](misc/screencapture.gif)
# Installation
## Packages
*TODO*
## Manual
Ensure that python>=3.5 and python-gobject are installed on your system and that pass is setup.
Download or clone this repository:
```shell
git clone git@github.com:jle64/gnome-shell-pass-search-provider.git
```
Run the installation script as root:
```shell
sudo ./install.sh
```
If you need to you can change the installation paths to suit your system:
```shell
sudo SYSCONFDIR=/etc DATADIR=/usr/share LIBDIR=/usr/lib LIBEXECDIR=/usr/lib ./install.sh
```
Recommended : set gpg agent to use pinentry-gnome3 by adding `pinentry-program /usr/bin/pinentry-gnome3` to `~/.gnupg/.gpg-agent.conf`.
Close and reopen your GNOME session or (if not on Wayland) just restart the Shell (alt + f2, r).
The search provider should show up and be enabled in GNOME search preferences and started on demand by GNOME Shell.
# 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` should be sufficient.
# Clipboard managers
If you are using GPaste, passwords will be sent to it marked as passwords, thus ensuring they are not visible.
Otherwise they are sent to the clipboard using `pass -c` which defaults to expiration after 45 seconds.
# Compatibility
This implements the `org.gnome.Shell.SearchProvider2` D-Bus API.
I'm not sure since when this has been in GNOME nor until when it will stay.
This works fine on GNOME 3.22 and I expect it will continue to work for some time with ulterior versions.
# Troubleshooting
If this does not work for you, make sure to look to wherever GNOME and D-Bus are logging for error messages (in the journal on systemd-using systems).
Don't hesitate to open an issue.