Complete README, add screencapture
This commit is contained in:
parent
da2f709586
commit
9a256569d4
53
README.md
53
README.md
@ -2,6 +2,8 @@ A search provider for Gnome-Shell that adds support for searching in [pass](http
|
||||
|
||||
Names of passwords will show up in Gnome-Shell searches, choosing one will copy the corresponding content to the clipboard.
|
||||
|
||||

|
||||
|
||||
# Installation
|
||||
## Packages
|
||||
|
||||
@ -9,22 +11,55 @@ Names of passwords will show up in Gnome-Shell searches, choosing one will copy
|
||||
|
||||
## Manual
|
||||
|
||||
Ensure that python-gobject is installed on your system (probably already the case) :
|
||||
Ensure that python-gobject is installed on your system (probably already the case):
|
||||
```shell
|
||||
$PACKAGE_MANAGER install python-gobject
|
||||
```
|
||||
|
||||
`$PACKAGE_MANAGER install python-gobject`
|
||||
Download or clone this repository:
|
||||
```shell
|
||||
git clone git@github.com:jle64/gnome-shell-pass-search-provider.git
|
||||
```
|
||||
|
||||
Download or clone this repository :
|
||||
Run the installation script as root:
|
||||
```shell
|
||||
sudo ./install.sh
|
||||
```
|
||||
|
||||
`git clone git@github.com:jle64/gnome-shell-pass-search-provider.git`
|
||||
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
|
||||
```
|
||||
|
||||
Run the installation script as root :
|
||||
The search provider should show up and be enabled in Gnome search preferences and be autoloaded by Gnome-Shell.
|
||||
If that's not the case try closing and reopening your Gnome session.
|
||||
|
||||
`sudo ./install.sh`
|
||||
# Environment variables
|
||||
|
||||
If you need to you can change the installation paths :
|
||||
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 :
|
||||
|
||||
`sudo SYSCONFDIR=/etc DATADIR=/usr/share LIBDIR=/usr/lib LIBEXECDIR=/usr/lib ./install.sh`
|
||||
```shell
|
||||
systemctl --user edit org.gnome.pass.search.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.search.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.
|
||||
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).
|
||||
|
BIN
misc/screencapture.gif
Normal file
BIN
misc/screencapture.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 10 MiB |
Loading…
x
Reference in New Issue
Block a user