publickey-bot/README.md

43 lines
807 B
Markdown
Raw Permalink Normal View History

# Keyserver Bot
## Setup
```
python3 -m venv venv
. venv/bin/activate
pip install -e .
2025-04-05 22:14:10 +00:00
keyserver-bot --email keyserver@example.org --password s3cr3t
```
2025-04-05 22:14:10 +00:00
## Usage
If you send an email address to the bot,
it will try to query WKD,
and if that fails keys.openpgp.org,
for a public OpenPGP key belonging to the email address.
Then it will send you a VCard contact
2025-04-05 22:14:10 +00:00
which contains the public key,
so you can initiate an encrypted chat to it.
You can also send a .asc PGP key file to the bot,
and it will send you a VCard contact for it.
2025-04-05 22:14:10 +00:00
With the "/generate-invite" command,
you can also generate an invite link for the bot
so you can publish it.
2025-04-11 05:12:02 +00:00
## Contribute
Pull Requests are very welcome!
To run the tests and lint checks:
```
python3 -m venv venv
. venv/bin/activate
pip install -e .[dev]
tox
```