sean/web-pinentry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Seán
2026-04-17 19:05:20 +01:00
parent 2816411d82
commit 2c0eca948c
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -14,14 +14,14 @@ config files poses a security threat. Server admins may ultimately
feel compelled to reject server access to engineers or technicians lest they feel compelled to reject server access to engineers or technicians lest they
gain knowledge of crucial passwords in config files. gain knowledge of crucial passwords in config files.
To solve this headache, passwords can be encrypted with a GPG wrapper tool such To solve this problem, passwords can be encrypted with a GPG wrapper tool such
as `pass`. Rather than pulling passwords from a file, they are obtained through as [`pass`](https://www.passwordstore.org/). Rather than pulling passwords from
subprocess calls, e.g. a file, they are obtained through subprocess calls, e.g.
`pass sql-root-password` `pass sql-root-password`
`pass github-token` `pass github-token`
This is standard practice on desktops, but not yet on servers. This is a standard practice on Linux desktops, but not yet on servers.
`web-pinentry` attempts to make this workflow more feasible on servers. Programs `web-pinentry` attempts to make this workflow more feasible on servers. Programs
typically pause for user authentication when executing GPG or `pass` commands. On desktop, typically pause for user authentication when executing GPG or `pass` commands. On desktop,
@@ -78,6 +78,7 @@ login, and attempt to prompt you for your password.
## Requirements ## Requirements
- [`GnuPG`](https://www.gnupg.org/)
- [`matrix-commander-rs`](https://github.com/8go/matrix-commander-rs) - [`matrix-commander-rs`](https://github.com/8go/matrix-commander-rs)
- [Matrix](https://matrix.org/) - [Matrix](https://matrix.org/)
- Your Matrix user - Your Matrix user
@@ -153,7 +154,7 @@ It will only ever communicate via messages from your server from now on.
Ensure you're logged into your Matrix account on your phone app to receive security Ensure you're logged into your Matrix account on your phone app to receive security
requests in your shared channel with the bot. requests in your shared channel with the bot.
Configuring `web-pinentry` as the default GNUPG pinentry program: Configuring `web-pinentry` as the default GnuPG pinentry program:
```{bash} ```{bash}
if [ ! "$GNUPGHOME" ]; then GNUPGHOME="$HOME/.gnupg"; fi if [ ! "$GNUPGHOME" ]; then GNUPGHOME="$HOME/.gnupg"; fi