summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorgabrix73 <gabriel1@frozenstar.info>2026-06-03 02:59:08 +0200
committergabrix73 <gabriel1@frozenstar.info>2026-06-03 02:59:08 +0200
commitc57567ad9a9863a4f13591539ed64f0217ce0e39 (patch)
tree68361fba5dfdadb60b70674b9056528d06ca63cf /README.md
parent34c79384d55c746aa64a795402218c2f08120947 (diff)
downloadneomutt-config-c57567ad9a9863a4f13591539ed64f0217ce0e39.tar.gz
neomutt-config-c57567ad9a9863a4f13591539ed64f0217ce0e39.tar.xz
neomutt-config-c57567ad9a9863a4f13591539ed64f0217ce0e39.zip
docs: clarify GnuPG default and YubiKey as optional for Usenet
- Added GnuPG as default signing method for regular email - Clarified YubiKey PIV signing is optional (only for Usenet posts) - Added three signing options: GnuPG (default), YubiKey (optional), none - Updated requirements table with gnupg as required package - Added clear instructions to disable YubiKey (change to vim) for users without hardware - accounts/mail2news: added comment explaining how to switch to plain vim Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 41 insertions, 18 deletions
diff --git a/README.md b/README.md
index ea14cc9..19fdf82 100644
--- a/README.md
+++ b/README.md
@@ -9,38 +9,53 @@ Full write-up: [Posting to Usenet Anonymously with NeoMutt and Mail2News over To
## Features
- Multi-account IMAP/SMTP (STARTTLS, port 143/587)
+- **GnuPG support** — PGP signing/encryption for regular email (configured in `neomuttrc.common`)
- **Mail2news via Tor** — post to Usenet through a `.onion` SMTP gateway, no IP exposed
-- **YubiKey PIV Ed25519 signatures** — automatic signing with hardware key (PGP-like clearsign format)
+- **Optional YubiKey PIV Ed25519 signatures** — hardware-backed signing for Usenet posts (alternative to GnuPG)
- F7/F9 macro → interactive post script (newsgroup, subject, editor, review, send)
-- Ephemeral `.invalid` From address
+- Ephemeral `.invalid` From address for anonymous posting
- No IMAP for the mail2news account — send-only
---
## Requirements
-| Package | Purpose |
-|------------|-------------------------------|
-| `neomutt` | MUA |
-| `tor` | Tor daemon (127.0.0.1:9050) |
-| `torsocks` | Tor proxy wrapper |
-| `swaks` | SMTP test/send tool |
-| `vim` | Message editor |
-| `yubisigner-cli` | YubiKey PIV signing (optional) |
+| Package | Purpose | Required |
+|------------|-------------------------------|----------|
+| `neomutt` | MUA | Yes |
+| `gnupg` | PGP signing/encryption | Yes |
+| `tor` | Tor daemon (127.0.0.1:9050) | For Usenet posting |
+| `torsocks` | Tor proxy wrapper | For Usenet posting |
+| `swaks` | SMTP test/send tool | Optional |
+| `vim` | Message editor | Yes |
+| `yubisigner-cli` | YubiKey PIV signing | Optional |
On Arch:
```bash
-pacman -S neomutt tor torsocks swaks
+pacman -S neomutt gnupg tor torsocks vim
```
On Debian/Ubuntu:
```bash
-apt install neomutt tor torsocks swaks
+apt install neomutt gnupg tor torsocks vim
```
-### YubiKey signing (optional)
+### Signing options
-For automatic post signing with YubiKey PIV Ed25519:
+**Option 1: GnuPG (default, recommended)**
+
+GnuPG is pre-configured in `neomuttrc.common`. Set your key ID:
+```bash
+# Edit ~/.config/neomutt/neomuttrc.common and set:
+set pgp_sign_as = "0xYOURKEYID"
+set pgp_default_key = "0xYOURKEYID"
+```
+
+NeoMutt will prompt for signing/encryption when composing messages.
+
+**Option 2: YubiKey PIV Ed25519 (optional, for Usenet posts)**
+
+For hardware-backed signatures on Usenet posts via mail2news:
1. Configure YubiKey PIV slot 9c with Ed25519 key (one-time setup)
2. Install [yubisigner-cli](https://git.virebent.art/virebent/yubisigner-cli):
@@ -50,14 +65,22 @@ For automatic post signing with YubiKey PIV Ed25519:
cd yubisigner-cli
go build -o yubisigner-cli main.go
```
-3. Install `vim-yubisigner` wrapper from this repo:
+3. Install signing scripts from this repo:
```bash
mkdir -p ~/bin
- cp scripts/vim-yubisigner ~/bin/vim-yubisigner
- chmod +x ~/bin/vim-yubisigner
+ cp scripts/vim-yubisigner ~/bin/
+ cp scripts/yubisigner-with-pinentry ~/bin/
+ chmod +x ~/bin/vim-yubisigner ~/bin/yubisigner-with-pinentry
```
-The mail2news account is pre-configured to use `vim-yubisigner` as editor, which automatically signs messages with YubiKey after editing.
+The `accounts/mail2news` file is pre-configured to use `vim-yubisigner`. If you don't have YubiKey, edit the file and change:
+```
+set editor = "vim"
+```
+
+**Option 3: No signing**
+
+Comment out or remove GnuPG settings from `neomuttrc.common` and use plain vim for mail2news.
---