From 830d41c664f8e23200057ec434d9799a484cdc69 Mon Sep 17 00:00:00 2001 From: Robin Jarry Date: Fri, 24 Jun 2022 21:37:44 +0200 Subject: integrations: split into multiple files Acked-by: Robin Jarry --- integrations/abook.md | 20 ++++++++++++ integrations/index.md | 69 ++-------------------------------------- integrations/password-manager.md | 32 +++++++++++++++++++ integrations/pgp.md | 25 +++++++++++++++ 4 files changed, 80 insertions(+), 66 deletions(-) create mode 100644 integrations/abook.md create mode 100644 integrations/password-manager.md create mode 100644 integrations/pgp.md diff --git a/integrations/abook.md b/integrations/abook.md new file mode 100644 index 00000000..59861fbc --- /dev/null +++ b/integrations/abook.md @@ -0,0 +1,20 @@ +--- +title: "aerc-wiki: Integrations/abook" +--- + +# abook + +To use abook with aerc, you can simply add the following line to your +`aerc.conf`. + +```ini +address-book-cmd = abook --mutt-query "%s" +``` + +In some releases abook prints an empty line at the beginning. In this case, you +may want to remove it like this: + + +```ini +address-book-cmd = sh -c 'abook --mutt-query "%s" | tail -n +2' +``` diff --git a/integrations/index.md b/integrations/index.md index 5e56f784..e831dbdd 100644 --- a/integrations/index.md +++ b/integrations/index.md @@ -2,69 +2,6 @@ title: "aerc-wiki: Integrations" --- -# abook - -To use abook with aerc, you can simply add the following line to your -`aerc.conf`. - -```ini -address-book-cmd = abook --mutt-query "%s" -``` - -In some releases abook prints an empty line at the beginning. In this case, you -may want to remove it like this: - -```ini -address-book-cmd = sh -c 'abook --mutt-query "%s" | tail -n +2' -``` - -# Get Password from your Password manager - -Requires: -- a password-manager supporting Freedesktop.org Secret Service integration -- secret-tool (usually provided by `libsecret` or a similar package) - -Tested with: -- KeePassXC - -1. create the following script: -```shell -#!/bin/sh - -secret-tool lookup "$1" "$2" -# wait until the password is available -while [ $? != 0 ]; do - secret-tool lookup "$1" "$2" -done -``` - -2. Edit your `accounts.conf` to use `source-cred-cmd` and `outgoing-cred-cmd` - to point to the script. -```ini -source-cred-cmd = ~/.config/aerc/scripts/wait-for-creds.sh Title "Mailaccount (Work)" -``` - -aerc will now wait for the credentials to become available (for you to unlock -you password manager) when starting. - -# PGP - -> At the moment PGP Support is still in it's early stages and will likely -> change as time goes on. Tickets relating to this can be found in -> ~sircmpwn's tracker: [#353](https://todo.sr.ht/~sircmpwn/aerc2/353) -> [#354](https://todo.sr.ht/~sircmpwn/aerc2/354) -> [#355](https://todo.sr.ht/~sircmpwn/aerc2/355) -> [#357](https://todo.sr.ht/~sircmpwn/aerc2/357) -> [and more](https://todo.sr.ht/~sircmpwn/aerc2?search=label%3A%22pgp%22) - -**Please be aware:** at the moment PGP support requires you to export your -private keys. Please ensure that your home directory is protected against -unauthorised access. - -To create a PGP-Keyring and fill it with your keys from GPG, you can run the -following commands: - -```shell -gpg --export >> ~/.local/share/aerc/keyring.asc -gpg --export-secret-keys >> ~/.local/share/aerc/keyring.asc -``` +- [abook](abook.md) +- [password-manager](password-manager.md) +- [pgp](pgp.md) diff --git a/integrations/password-manager.md b/integrations/password-manager.md new file mode 100644 index 00000000..bd6d35cb --- /dev/null +++ b/integrations/password-manager.md @@ -0,0 +1,32 @@ +--- +title: "aerc-wiki: Integrations/password-manager" +--- + +# Get Password from your Password manager + +Requires: +- a password-manager supporting Freedesktop.org Secret Service integration +- secret-tool (usually provided by `libsecret` or a similar package) + +Tested with: +- KeePassXC + +1. create the following script: +```shell +#!/bin/sh + +secret-tool lookup "$1" "$2" +# wait until the password is available +while [ $? != 0 ]; do + secret-tool lookup "$1" "$2" +done +``` + +2. Edit your `accounts.conf` to use `source-cred-cmd` and `outgoing-cred-cmd` + to point to the script. +```ini +source-cred-cmd = ~/.config/aerc/scripts/wait-for-creds.sh Title "Mailaccount (Work)" +``` + +aerc will now wait for the credentials to become available (for you to unlock +you password manager) when starting. diff --git a/integrations/pgp.md b/integrations/pgp.md new file mode 100644 index 00000000..a5804a06 --- /dev/null +++ b/integrations/pgp.md @@ -0,0 +1,25 @@ +--- +title: "aerc-wiki: Integrations/PGP" +--- + +# PGP + +> At the moment PGP Support is still in it's early stages and will likely +> change as time goes on. Tickets relating to this can be found in +> ~sircmpwn's tracker: [#353](https://todo.sr.ht/~sircmpwn/aerc2/353) +> [#354](https://todo.sr.ht/~sircmpwn/aerc2/354) +> [#355](https://todo.sr.ht/~sircmpwn/aerc2/355) +> [#357](https://todo.sr.ht/~sircmpwn/aerc2/357) +> [and more](https://todo.sr.ht/~sircmpwn/aerc2?search=label%3A%22pgp%22) + +**Please be aware:** at the moment PGP support requires you to export your +private keys. Please ensure that your home directory is protected against +unauthorised access. + +To create a PGP-Keyring and fill it with your keys from GPG, you can run the +following commands: + +```shell +gpg --export >> ~/.local/share/aerc/keyring.asc +gpg --export-secret-keys >> ~/.local/share/aerc/keyring.asc +``` -- cgit v1.2.3-54-g00ecf