Mirrors/yggmail
1
0
Fork 0
mirror of https://github.com/neilalexander/yggmail.git synced 2026-05-20 10:16:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

User-facing command lines

Browse Source
This commit is contained in:
Neil Alexander
2021-07-09 18:42:52 +01:00
parent eb8b2d5822
commit 4b2f955f69
3 changed files with 35 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -33,15 +33,17 @@ Create a mailbox and set your password. Your Yggmail database will automatically
yggmail -password
```
Start Yggmail, using the database in your working directory:
Start Yggmail, using the database in your working directory, with either multicast enabled, an [Yggdrasil static peer](https://publicpeers.neilalexander.dev/) specified or both:
```
yggmail -smtp=localhost:1025 -imap=localhost:1026
yggmail -multicast
yggmail -peer=tls://...
yggmail -multicast -peer=tls://...
```
Connect your mail client to Yggmail. In the above example:
* SMTP is listening on `localhost` port 1025, password authentication, no SSL/TLS
* IMAP is listening on `localhost` port 1026, password authentication, no SSL/TLS
* IMAP is listening on `localhost` port 1143, password authentication, no SSL/TLS
Then try sending a mail to another Yggmail user!
@@ -50,6 +52,7 @@ Then try sending a mail to another Yggmail user!
The following command line switches are supported by the `yggmail` binary:
* `-peer=tls://...` or `-peer=tcp://...` — connect to a specific Yggdrasil node, like one of the [Public Peers](https://publicpeers.neilalexander.dev/);
* `-multicast` - enable multicast peer discovery for Yggdrasil nodes on your LAN
* `-database=/path/to/yggmail.db` — use a specific database file;
* `-smtp=listenaddr:port` — listen for SMTP on a specific address/port
* `-imap=listenaddr:port` — listen for IMAP on a specific address/port;