Skip to content

Commit c13cc10

Browse files
authored
README: Add a Troubleshooting section (#1689)
* README: Add a Troubleshooting section * Mention supported versions * Include the rekor 2 error message for SEO Signed-off-by: Jussi Kukkonen <jkukkonen@google.com> * README: mention a more obscure error as well This is what 3.6.5 says about bundles with rekor 2 entries Signed-off-by: Jussi Kukkonen <jkukkonen@google.com> * README: link to offline docs Signed-off-by: Jussi Kukkonen <jkukkonen@google.com> --------- Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent 2c397e5 commit c13cc10

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ else!
2424
* [Generic identities](#generic-identities)
2525
* [Signatures from GitHub Actions](#signatures-from-github-actions)
2626
* [Advanced usage](#advanced-usage)
27+
* [Troubleshooting](#troubleshooting)
2728
* [Documentation](#documentation)
2829
* [Licensing](#licensing)
2930
* [Community](#community)
@@ -302,6 +303,32 @@ Verification options:
302303
```
303304
<!-- @end-sigstore-verify-github-help@ -->
304305

306+
## Troubleshooting
307+
308+
First, please make sure you are using a recent and supported release:
309+
sigstore-python project provides support for the latest release and
310+
best effort critical bug fixes for the latest 3.6.x release.
311+
312+
### Common issues
313+
314+
1. "_bundle contains a transparency log entry that is incompatible with
315+
this version of sigstore-python_" (as well as "_not enough sources of
316+
verified time_") means an upgrade is necessary to verify this signature
317+
bundle: Signature bundles with Rekor v2 transparency log entries can only be
318+
verified with sigstore-python 4 and above
319+
1. verifying without a network connection results in HTTP errors: By default
320+
sigstore-python checks for updates to the trusted key material on every
321+
startup. This can be avoided temporarily with `--offline` but please read the
322+
[documentation](https://sigstore.github.io/sigstore-python/advanced/offline/)
323+
for caveats
324+
1. Signing results in HTTP errors: Signing with sigstore-python depends on multiple
325+
Sigstore services. Retrying on failure may be a useful workaround if any of
326+
these services fail but filing issues for specific failures is appreciated
327+
328+
### My problem is something else
329+
330+
Please [open an issue](https://github.com/sigstore/sigstore-python/issues/new?template=bug.md) or ask in the [slack channel](#community).
331+
305332
## Documentation
306333

307334
`sigstore` documentation is available on [https://sigstore.github.io/sigstore-python](https://sigstore.github.io/sigstore-python)

0 commit comments

Comments
 (0)