Skip to content

Commit

Permalink
Merge pull request #75 from smlx/docs-improvements
Browse files Browse the repository at this point in the history
Documentation improvements and bugfixes
  • Loading branch information
smlx authored Oct 17, 2021
2 parents 5515eae + e7d1730 commit 1f674c4
Show file tree
Hide file tree
Showing 9 changed files with 672 additions and 54 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## About

* `piv-agent` is an SSH and GPG agent providing simple integration of [PIV](https://csrc.nist.gov/projects/piv/piv-standards-and-supporting-documentation) hardware (e.g. a [Yubikey](https://developers.yubico.com/yubico-piv-tool/YubiKey_PIV_introduction.html)) with existing SSH and GPG workflows.
* `piv-agent` is an SSH and GPG agent providing simple integration of [PIV](https://csrc.nist.gov/projects/piv/piv-standards-and-supporting-documentation) hardware (e.g. a [Yubikey](https://developers.yubico.com/yubico-piv-tool/YubiKey_PIV_introduction.html)) with `ssh` and `gpg` workflows such as [`git`](https://git-scm.com/) signing, [`pass`](https://www.passwordstore.org/) encryption, or [keybase](https://keybase.io/) chat.
* `piv-agent` originated as a reimplementation of [yubikey-agent](https://github.com/FiloSottile/yubikey-agent) because I needed some extra features, and also to gain a better understanding of the PIV applet on security key hardware.
* `piv-agent` makes heavy use of the Go standard library and supplementary `crypto` packages, as well as [`piv-go`](https://github.com/go-piv/piv-go/) and [`pcsclite`](https://pcsclite.apdu.fr/). Thanks for the great software!

Expand Down
1 change: 0 additions & 1 deletion docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ title: "PIV Agent Documentation"
---

PIV Agent must be installed and set up to work with your hardware security device before use.
See below for instructions.
30 changes: 30 additions & 0 deletions docs/content/en/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "FAQ"
weight: 40
---

## How do I switch between gpg-agent and piv-agent

### Linux (systemd)

Stop both `gpg-agent` and `piv-agent`:

{{% alert title="Note" %}}
The `pkill` is required because `gpg` may be configured to automatically start `gpg-agent` in a manner which is not managed by `systemd`.
{{% /alert %}}

```
systemctl --user stop gpg-agent.socket gpg-agent.service piv-agent.socket piv-agent.service; pkill gpg-agent
```

Start `piv-agent`:

```
systemctl --user start piv-agent.socket
```

Or start `gpg-agent`:

```
systemctl --user start gpg-agent.socket
```
Loading

0 comments on commit 1f674c4

Please sign in to comment.