78 Commits

Author SHA1 Message Date
google-labs-jules[bot]
86720090b6
docs: Add GoDoc to pkg and improve markdown files (#3251)
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>
2025-09-22 19:37:15 +02:00
google-labs-jules[bot]
5f61510ab7
docs: Add note about pass compatibility (#3229)
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>
2025-09-17 21:52:40 +02:00
Marc
15a834ce83
Fix typo introduced in PR #2696 (#2707)
* 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>
2023-11-20 19:42:42 +01:00
Marc
55ea5cf369
Updated bash autocompletion setup commands (#2696)
Signed-off-by: Marc <fetwar@fetwar.com>
2023-11-18 07:43:59 +01:00
Daniel Possenriede
b81d8ba2de
[docs] add/update choco, scoop, winget instructions (#2647)
* 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>
2023-09-09 09:26:04 +02:00
Dominik Schulz
d9199cd9c2
Incorporate cleanup and simplifications ideas from kpitt/gopass (#2468)
* 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>
2022-12-11 23:08:46 +01:00
Dominik Schulz
aeaf247b1c
Recommend pass-import for importing existing credentials
Fixes #1007
2022-12-04 14:00:30 +01:00
Dominik Schulz
af9eec1de4
Readme cleanup (#2434)
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>
2022-12-01 22:54:02 +01:00
Dominik Schulz
18ffee354f
Add .gitconfig parser (#2395)
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 #1567
Fixes #1764
Fixes #1819
Fixes #1878
Fixes #2387
Fixes #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>
2022-11-25 10:50:34 +01:00
Dominik Schulz
cb634f813d
Set vim options instead of sniffing the config (#2343)
* 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>
2022-09-20 22:08:23 +02:00
BoostCookie
4f862dd9e8
Correct (neo)vim settings (#2318)
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>
2022-09-02 18:07:28 +02:00
Yolan Romailler
0dcc25b449
Correcting instructions for apt install (#2298)
* Correcting instructions for apt install

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* Revert "Correcting instructions for apt install"

This reverts commit 69643a581073dc51c5c8ac6adb44d8c16f2155c7.

* Correcting instructions for apt install

Fixes #2282

RELEASE_NOTES=n/a

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>
2022-08-02 22:28:27 +02:00
Dominik Schulz
b3fbbb176c
Use packages.gopass.pw (#2261)
RELEASE_NOTES=[ENHANCEMENT] Use packages.gopass.pw for APT packages

Fixes #1760

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2022-06-24 22:07:43 +02:00
Fabio Alessandro Locati
6b401f2ae5
Add Fedora installation instructions (#2197)
Signed-off-by: Fabio Alessandro Locati <me@fale.io>
2022-04-25 16:18:06 +02:00
Dominik Schulz
53a7476332
Mention pinentry-mac Keychain settings (#2136)
RELEASE_NOTES=n/a

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2022-02-22 11:07:50 +01:00
r0lh
826533d730
extend setup doc to freebsd and csh/tcsh (#2135) 2022-02-09 13:21:12 +01:00
Dominik Schulz
4adbeeebbf Update README
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2021-12-31 20:00:44 +01:00
txt-file
72057db800
update gnupg *.deb dependency (#2050)
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>
2021-11-26 18:45:41 +01:00
Dominik Schulz
e37adb4f34
Add some Apple Silicon setup notes (#2031)
Fixes #2020

RELEASE_NOTES=n/a

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2021-11-11 22:09:15 +01:00
astark13
c950855a33
Update setup.md (#1999)
RELEASE_NOTES=n/a
2021-09-29 15:41:07 +02:00
astark13
f11303d235
Update setup.md (#1996)
RELEASE_NOTES=n/a
2021-09-28 11:09:58 +02:00
Dominik Schulz
720e908e16 Clarify unattended setup instructions
Fixes #1875

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2021-03-24 21:27:11 +01:00
Dominik Schulz
2407a10fc6 Add missing words
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2021-03-24 21:23:02 +01:00
Dominik Schulz
de9f3a38a5
Add getting started docs (#1865)
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>
2021-03-24 21:13:44 +01:00
Dominik Schulz
3003e6ec39
Remove custom brew (#1847)
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>
2021-03-19 10:58:34 +01:00
Yolan Romailler
6a94849743
Fixing typos (#1834)
Thanks to Roel Van de Paar

RELEASE_NOTES=n/a

Signed-off-by: Yolan Romailler <yolan@romailler.ch>
2021-03-12 14:42:28 +01:00
Pharb
8baebe25c0
Update documentation for gopass-jsonapi (#1796)
RELEASE_NOTES=n/a

Signed-off-by: Patrick Harböck <patrick.harboeck@tngtech.com>
2021-02-14 11:05:10 +01:00
Dominik Schulz
9f3ef251d3 Add note about securing vim on MacOS
Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2021-01-12 14:21:57 +01:00
Fabian Affolter
d890fd3c07
Add Fedora (#1667) 2020-12-30 13:59:08 +01:00
Kifir Kifirkin
84de697cbb
Update go get instructions in setup.md (#1659)
Apply changes from #1468 to setup.md
2020-12-02 14:50:06 +01:00
Yolan Romailler
6b776d50c7
Updating the docs (#1605)
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>
2020-10-01 19:54:37 +02:00
Daniel P
6bb8bee4c3
Add useful type username command to docs/setup.md (#1606)
Signed-off-by: Daniel P <daniel.paquet@nokernel.com>
2020-09-30 21:49:52 +02:00
Pharb
e622574c52
Update docs/setup.md for new gopass-jsonapi binary (#1534)
RELEASE_NOTES=n/a

Signed-off-by: Patrick Harböck <patrick.harboeck@tngtech.com>
2020-08-17 07:11:52 +02:00
Yolan Romailler
bce0bdcf78
Clarifying the zsh documentation (#1525)
Fixes #585
Fixes #1424

RELEASE_NOTES=[DOCUMENTATION] Improve documentation of Zsh completion setup

Signed-off-by: Yolan Romailler <yolan@romailler.ch>
2020-08-14 22:33:44 +02:00
Gautam Kotian
ab8ad3089d
Remove obsolete docker setup documentation (#1433)
Support for docker was removed in
https://github.com/gopasspw/gopass/pull/1309.
2020-06-27 12:07:23 +02:00
Sergiusz Kierat
7da479de91
Clarify fish completion setup (#1360)
This is a clarification how to use auto completion in fish

Signed-off-by: Sergiusz Kierat <sergiusz.kierat@gmail.com>
2020-05-14 22:09:14 +02:00
Dominik Schulz
09493e0b2b Remove bintray instructions
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>
2020-05-07 20:55:44 +02:00
Martin Hoefling
53204e209b
add chocolatey instructions, closes #900 (#1271)
Signed-off-by: Martin Hoefling <martin.hoefling@gmx.de>
2020-04-24 21:51:03 +02:00
niklas.beinghaus
ed7edd29b1
Update Debian installation from trusty to buster
Signed-off-by: niklas.beinghaus <niklas.beinghaus@reservix.de>
2020-03-19 12:59:19 +01:00
Qiang Huang
6688b02d0f Update setup.md (#1217)
typo

of if you are not familiar -> or if you are not familiar
2019-12-19 10:42:04 +01:00
Sebastian Schulze
8c7b4a2500 Fix typo in zsh installation instructions (#1158)
Refs #1127 and just fixes a small typo to make the installation instructions actually work.

Signed-off-by: Sebastian Schulze <github.com@bascht.com>
2019-07-31 20:32:33 +02:00
Rob Cohen
56cf90b223 ZSH autocomplete instructions added (#1127) 2019-07-07 14:42:23 +02:00
Jonas DOREL
e807fd43dc [DOC] Use gpg --list-secret-keys for personal keys (#1129) 2019-06-30 22:09:08 +02:00
Iku Iwasa
fe4e21d621 Update installation methods on Windows (#1102)
gopass can be installed by Chocolatey or Scoop.

Signed-off-by: Iku Iwasa <iku.iwasa@gmail.com>
2019-04-13 20:28:04 +02:00
Jonas Verhoelen
e3699f02d7 Add Gopass UI to the list of available GUIs for gopass (#1069)
Signed-off-by: Jonas Verhoelen <jonas.verhoelen@codecentric.de>
2019-02-15 20:33:46 +01:00
Pharb
a931957501 Update documentation links for gopassbridge (#1038)
Signed-off-by: Patrick Harböck <patrick.harboeck@tngtech.com>
2019-01-08 12:36:18 +01:00
Andreas Nüßlein
a36394e696 Update setup.md (#969)
Tiny change - the option `print` has been renamed I think.
2018-11-11 21:08:13 +01:00
Christian Rebischke
5aee64c9a7 fixed various spelling errors and added arch linux (#958)
Signed-off-by: Christian Rebischke <chris@nullday.de>
2018-10-11 21:04:52 +02:00
eugenwick
4c05308841 Update setup documentation. Add macOS related commands. (#924)
Signed-off-by: Eugen Wick <wick@sipgate.de>
2018-09-15 13:52:08 +02:00
Thomas Broadley
28eb71c8d3 docs: fix typos (#920)
Signed-off-by: Thomas Broadley <buriedunderbooks@hotmail.com>
2018-09-15 13:43:41 +02:00