This change adds GoDoc comments to many of the public symbols in the
`pkg/` directory. It also includes various improvements to the
documentation in `README.md` and other markdown files in the `docs/`
directory.
This is a partial documentation effort, as requested by the user, to
get a pull request submitted quickly.
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
gopass is in fact compatible with pass (aka password-store.org)
and can be used as a drop-in replacement.
This commit adds a note about this to the README, the FAQ, and
the setup documentation. It also explains some of the differences
in features.
Fixes#3195
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
* Updated bash autocompletion setup commands
Signed-off-by: Marc <fetwar@fetwar.com>
* Fix typo with bash completions command in setup.md
Signed-off-by: Marc <fetwar@fetwar.com>
---------
Signed-off-by: Marc <fetwar@fetwar.com>
* add/update choco, scoop, winget instructions
Signed-off-by: Daniel Possenriede <possenriede@gmail.com>
* remove Windows warning
Signed-off-by: Daniel Possenriede <possenriede@gmail.com>
* typo
Signed-off-by: Daniel Possenriede <possenriede@gmail.com>
* specify to add extras bucket if it's not present yet
Signed-off-by: Daniel Possenriede <possenriede@gmail.com>
---------
Signed-off-by: Daniel Possenriede <possenriede@gmail.com>
* Improve test isolation
These test shouldn't pick up user configs.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Use correct flag names for rcs init test
These flags must use the canonical names since they are not processed
by the CLI library and as such aliases are not applied.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Remove obsolete warning in fsck help
The default format should be fully compatible with other
password store implementations.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Remove unused "Verbose" context property
This was never set anywhere, so we can safely remove it.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Remove --clip option for the find command
When this is invoked as `gopass find` there is actually no
code path that leads to this flag being used.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Remove mount versions from the `version` command
The `version` command should generally only print the version and not
load the full config, trigger auto-sync and other operations the
happend when initializing the mounts.
Moving the mount point information to the new `mounts versions` command.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Update find integration test
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Do not run auto-sync if the command is `sync`
Otherwise sync might run twice.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Reset auto-sync if a full `sync` succeeds
Since a `gopass sync` without the `--store` option is the same
operation as an auto-sync we should reset the interval if it
was successfull.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Remove sync messages about importing and exporting keys
These usually don't take a lot of time and don't need a mention unless
they fail.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Refactor OTP action to reduce code complexity and duplication
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Clean up outdated Git documentation
`gopass` isn't configuring `git` to sign commits anymore.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
This commit moves much of the content out of the overloaded
README with the goal of making it easier for new users to get
a first impression and start using gopass. Most information
is still retained inside the docs/ folder.
RELEASE_NOTES=n/a
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
This commit adds yet another config handler for gopass. It is based on
the format used by git itself. This has the potential to address a lot
of long standing issues, but it also causes a lot of changes to how we
handle configuration, so bugs are inevitable.
Fixes#1567Fixes#1764Fixes#1819Fixes#1878Fixes#2387Fixes#2418
RELEASE_NOTES=[BREAKING] New config format based on git config.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Co-authored-by: Yolan Romailler <AnomalRoil@users.noreply.github.com>
address comments
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Set vim options instead of sniffing the config
Fixes#2317
RELEASE_NOTES=[ENHANCEMENT] Set vim options instead of sniffing
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
* Add a note on vim hardening flags to the docs.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
The previous recommended vim settings still allowed data to leak into
the .viminfo file
For Linux even the matching path was wrong which means that the
(insufficient) rules were not even used.
RELEASE_NOTES=[DOCUMENTATION] fix in recommended vim setting
Signed-off-by: Stefan Gehr <stefangehr@protonmail.com>
Signed-off-by: Stefan Gehr <stefangehr@protonmail.com>
In all upstream supported debian & ubuntu releases the package gnupg2 is
a dummy transitional package depending on gnupg. Depend directly on
gnupg instead of the transition.
RELEASE_NOTES=[BUGFIX] depend *.deb on gnupg instead of dummy
transitional package gnupg2
Signed-off-by: Vieno Hakkerinen <vieno@hakkerinen.eu>
This commit adds a getting started section to the readme and improves
the gopass clone UX a little it. It also fixes the call depth for nested
debug.Log invocations (e.g. during ExitError) and adds debug logging
for every out invocation.
Fixes#1839
RELEASE_NOTES=n/a
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
Gopass has an official homebrew formula. Remove our custom one.
RELEASE_NOTES=[CLEANUP] Remove the custom formula in favour of the official one.
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
RELEASE_NOTES=[DOCUMENTATION] Slight updates to reflect the recent code
changes and adding details about dmenu usage to type usernames
Signed-off-by: Yolan Romailler <yolan@romailler.ch>
Bintray has been broken for a long time. Remove the installation
instructions.
RELEASE_NOTES=n/a
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>