Jonathan Lestrelin e73977f1b2 * rename various elements to be more consistent with other search
providers
* remove useless dbus config file
* add TODO
* minor changes
2017-03-14 21:47:52 +01:00

67 lines
2.0 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-gobject is installed on your system (probably already the case):
```shell
$PACKAGE_MANAGER install python-gobject
```
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
```
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 be autoloaded 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.
If you are on a systemd-based system, you can set them in the unit file :
```shell
systemctl --user edit org.gnome.Pass.SearchProvider.service
```
Add your variables like this :
```ini
[Service]
Environment=PASSWORD_STORE_DIR=/my/passwords/path
```
Then restart the service :
```shell
systemctl --user restart org.gnome.Pass.SearchProvider.service
```
# 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).