Skip to content

Commit

Permalink
Reword README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HuguesGuilleus committed Jun 11, 2020
1 parent 4b3972f commit 6b6a52e
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# go-mta
A simple Mail transfert Agent

[![GoDoc](https://godoc.org/github.com/HuguesGuilleus/go-mta/pkg?status.svg)](https://godoc.org/github.com/HuguesGuilleus/go-mta/pkg)

A simple Mail transfert Agent. You can use as a package or as a deamon.

## Deamon

You can build yourself or use the [Compiled binary](https://github.com/HuguesGuilleus/go-mta/releases/latest "Github Release")

### Configuration file

The configuration file is in `/etc/go-mta/config.ini` or it's the argument when you run the program.

```ini
; The file who contains login
login = /etc/#.txt
; The listen address
addrs = localhost:25 :446
; Log output directory, by default /var/etc/go-mta/
out = log/

; Every host has a section.
[host1]
dkim_key = /path/to/dkim/private/key.pem
dkim_selector = DKIM slector
crt = /path/to/tls/certificate.pem
key = /path/to/tls/private/key.pem
```

### Login file

Each line contain a login, separation blank(s) and a password. The login and the password can't contain blank or `#`. You can add some comments with `#` and blank lines.

### DKIM key generation

You must generate DKIM key you can do this:

```bash
openssl genrsa -out key.pem
openssl rsa -in key.pem -pubout -out pub.key
```

## TODO

- [ ] StartTLS
2 changes: 1 addition & 1 deletion go-mta.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func main() {
opt.Hosts = append(opt.Hosts, mta.HostOption{
Name: s.Name(),
DkimKey: s.Key("dkim_key").String(),
DkimSelector: s.Key("dkim_selecctor").String(),
DkimSelector: s.Key("dkim_selector").String(),
Cert: s.Key("crt").String(),
Key: s.Key("key").String(),
})
Expand Down

0 comments on commit 6b6a52e

Please # to comment.