Skip to content

Commit 8b85e2f

Browse files
docs: update readme
1 parent cbbf6a0 commit 8b85e2f

2 files changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1-
# YubiKey-Provision
1+
<p align="center">
2+
<img src="docs/header.png" alt="defguard">
3+
</p>
4+
25
[Defguard](https://github.com/DefGuard/defguard) provisioning client for Yubikeys module.
36

7+
8+
## Supported platforms
9+
10+
- Linux
11+
- Windows
12+
- MacOS
13+
414
## Prerequisites
515
Machine using this service needs to have proper drivers/tools to detect and operate on smartcard's.
616
While macOS and Windows should work without installing additional software, on Linux make sure your distribution has all the necessary tools to detect, read, and write on smartcard's.
@@ -24,3 +34,15 @@ This tool can also be used from a docker image like so:
2434
docker run --privileged ghcr.io/defguard/yubikey-provision:main -t <TOKEN> --id <ID> --grpc <DEFGUARD_GRPC_URL>
2535
```
2636
Note that image is using elevated privileges to access host's USB by default but you can also try to configure it with **--device**.
37+
38+
## Documentation
39+
40+
See the [documentation](https://defguard.gitbook.io) for more information.
41+
42+
## Community and Support
43+
44+
Find us on Matrix: [#defguard:teonite.com](https://matrix.to/#/#defguard:teonite.com)
45+
46+
## Contribution
47+
48+
Please review the [Contributing guide](https://defguard.gitbook.io/defguard/for-developers/contributing) for information on how to get started contributing to the project. You might also find our [environment setup guide](https://defguard.gitbook.io/defguard/for-developers/dev-env-setup) handy.

docs/header.png

4.34 KB
Loading

0 commit comments

Comments
 (0)