From cbda85c926501a56904f11b5513c6443f73c9d99 Mon Sep 17 00:00:00 2001 From: Dominik Schulz Date: Tue, 12 Dec 2017 09:51:00 +0100 Subject: [PATCH] Documentation updates (#509) Fixes #497 --- README.md | 5 +++-- docs/features.md | 20 ++++++++++++++++++++ docs/setup.md | 4 +++- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 44debe8f4f..dde6a92f0f 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,6 @@ The slightly more awesome Standard Unix Password Manager for Teams. Written in G *gopass* is a rewrite of the *pass* password manager in [Go](https://golang.org/) with the aim of making it cross-platform and [adding additional features](#features). Our target audience are professional developers and sysadmins (and especially teams of those) who are well versed with a command line interface. One explicit goal for this project is to make it more approachable to non-technical users. We go by the UNIX philosophy and try to do one thing and do it well, providing a stellar user experience and a sane, simple interface. -Warning: gopass currently works on Ubuntu & macOS. Please feel free to help with others. - ## Demo [![asciicast](https://asciinema.org/a/101688.png)](https://asciinema.org/a/101688) @@ -51,6 +49,9 @@ Please see [docs/features.md](https://github.com/justwatchcom/gopass/blob/master | password leak checker | ❌ | ✔ | *alpha* | Perform **offline** checks against known leaked passwords | | PAGER support | ❌ | ✔ | *stable* | Automatically invoke a pager on long output | | JSON API | ❌ | ✔ | *alpha* | Allow gopass to be used as a native extension for browser plugins | +| Automatic fuzzy search | ❌ | ✔ | *stable* | Automatically search for matching store entries if a literal entry was not found | +| gopass sync | ❌ | ✔ | *beta* | Easy to use syncing of remote repos and GPG keys | +| Desktop Notifications | ❌ | ✔ | *beta* | [Linux only] Display desktop notifications and completing long running operations | ## Installation diff --git a/docs/features.md b/docs/features.md index 742a566269..f276f9307d 100644 --- a/docs/features.md +++ b/docs/features.md @@ -225,6 +225,21 @@ $ gopass cp emails/example.com emails/user@example.com Like other popular open-source projects, gopass automatically pipe the output to `$PAGER` if it's longer than one terminal page. You can disable this behavior by unsetting `$PAGER` or `gopass config nopager true`. +### Sync + +Gopass offers as simple and intuitive way to sync one or many stores with their +remotes. This will perform and git pull, push and import or export any missing +GPG keys. + +```bash +$ gopas sync +``` + +### Desktop Notifications + +Certain long running operations, like `gopass sync` or `copy to clipboard` will +try to show desktop notifications [Linux only]. + ### git auto-push and auto-pull If you want gopass to always push changes in git to your default remote server (origin), enable autosync: @@ -315,6 +330,11 @@ $ gopass foo/bar baz: zab ``` +Please note that gopass will try to leave your secret as is whenever possible, +but as soon as you mutate the YAML content through gopass, i.e. `gopass insert secret key`, +it will employ an YAML marshaler that may alter the order and escaping of your +entries. + ### Edit the Config gopass allows editing the config from the command-line. This is similar to how git handles config changes through the command-line. Any change will be written to the configured gopass config file. diff --git a/docs/setup.md b/docs/setup.md index 70ee9f2a3d..c6997d3373 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -53,6 +53,9 @@ pkg_add gopass For OpenBSD 6.2 and earlier, install via `go get`. +Please note that the OpenBSD builds uses `pledge(2)` to disable some syscalls, +so some features (e.g. version checks, auto-update) are unavailable. + ### Set up a GPG key pair gopass depends on the `gpg` program for encryption and decryption. You **must** have a @@ -91,7 +94,6 @@ Depending on your operating system, you can either use a package manager, downlo If you haven't already, install [homebrew](http://brew.sh). And then: ```bash -brew tap justwatchcom/gopass brew install gopass ```