Skip to content

Commit 3f4b606

Browse files
robinkrahld-e-s-o
authored andcommitted
Document problems in conjunction with nitrokey-app
If nitrokey-app is running, the device it connected to cannot be detected by other applications. This patch adds this issue to the list of known problems in the README.
1 parent aae8315 commit 3f4b606

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

nitrocli/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,17 @@ $ cargo build --release
110110
It is recommended that the resulting executable be installed in a
111111
directory accessible via the `PATH` environment variable.
112112

113-
#### Known Problems
114113

115-
Due to a problem with the default `hidapi` version on macOS, users are advised
116-
to build and install [`libnitrokey`][] from source and then set the
117-
`USE_SYSTEM_LIBNITROKEY` environment variable when building `nitrocli` using
118-
one of the methods described above.
114+
Known Problems
115+
--------------
116+
117+
- Due to a problem with the default `hidapi` version on macOS, users are
118+
advised to build and install [`libnitrokey`][] from source and then
119+
set the `USE_SYSTEM_LIBNITROKEY` environment variable when building
120+
`nitrocli` using one of the methods described above.
121+
- `nitrocli` cannot connect to a Nitrokey device that is currently being
122+
accessed by `nitrokey-app` ([upstream issue][libnitrokey#32]). To
123+
prevent this problem, quit `nitrokey-app` before using `nitrocli`.
119124

120125

121126
Contributing
@@ -152,3 +157,4 @@ the full text of the license.
152157
[nitrocli-cratesio]: https://crates.io/crates/nitrocli
153158
[nitrocli-gentoo]: https://packages.gentoo.org/packages/app-crypt/nitrocli
154159
[gplv3-tldr]: https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)
160+
[libnitrokey#32]: https://github.com/Nitrokey/libnitrokey/issues/32

0 commit comments

Comments
 (0)