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

Update readme

Browse Source
This commit is contained in:
Neil Alexander
2022-09-04 21:13:59 +01:00
parent def0bd8164
commit 2545641499
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -12,7 +12,7 @@ Yggmail is a single-binary all-in-one mail transfer agent which sends and receiv
* All mail exchange traffic between any two Yggmail nodes is always end-to-end encrypted without exception; * All mail exchange traffic between any two Yggmail nodes is always end-to-end encrypted without exception;
* Yggdrasil and Yggmail nodes on the same network are discovered automatically using multicast or you can configure a static Yggdrasil peer. * Yggdrasil and Yggmail nodes on the same network are discovered automatically using multicast or you can configure a static Yggdrasil peer.
Email addresses are based on your public key, like `617b5772c6d10feda41fc6e0e43b976c4cc9383d3729310d3dc9e1332f0d9acd@yggmail`. Email addresses are based on your public key, like `89cd1ea25d99b8ccf29e454280313128c234ffb82aa0eb2e3496f6f156d063d0@yggmail`.
## Why? ## Why?
@@ -29,16 +29,19 @@ go install github.com/neilalexander/yggmail/cmd/yggmail@latest
``` ```
It will then be installed into your `GOPATH`, so add that to your environment: It will then be installed into your `GOPATH`, so add that to your environment:
``` ```
export PATH=$PATH:`go env GOPATH`/bin export PATH=$PATH:`go env GOPATH`/bin
``` ```
Create a mailbox and set your password. Your Yggmail database will automatically be created in your working directory if it doesn't already exist: Create a mailbox and set your password. Your Yggmail database will automatically be created in your working directory if it doesn't already exist:
``` ```
yggmail -password yggmail -password
``` ```
Start Yggmail, using the database in your working directory, with either multicast enabled, an [Yggdrasil static peer](https://publicpeers.neilalexander.dev/) specified or both: 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 -multicast yggmail -multicast
yggmail -peer=tls://... yggmail -peer=tls://...