butterfly
/
butterflyd
mirror of https://github.com/thebutterflyprotocol/butterflyd
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added documentation on setting it up

This commit is contained in:
Tristan B. Kildaire 2021-01-23 17:29:11 +02:00
parent 98c6208fe7
commit 5a9896613c
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
tutorial.md Normal file
View File

@ -0,0 +1,31 @@
Configuring Butterfly
=====================
In order to configure Butterfly you will want to create a file named `butterflyd.json` in the same directory as your
`butterflyd` executable. The contents should look something like this:
```json
{
"listeners" : {
"enabled" : ["listener1"],
"listener1" : {
"type" : "ipv4",
"domain" : "10.1.0.4:6969",
"address" : "0.0.0.0",
"port" : "6969"
},
"listener2" : {
"type" : "ipv6",
"domain" : "10.0.0.9:2222",
"address" : "::",
"port" : "6969"
}
}
}
```
The first section if the `"listeners"` section. This key contains an array, `"enabled"`, which contains a list of strings which name which listeners, specified in the same JSON object, should be enabled when the daemon starts up. Listeners are basically TCP port associations with
a few other settings that say the server should listen on this port and this IP address. If you take a look at the first listener (which also happens to be the only enabled one), `"listener1"`, you will see that is contains a `"type"` field. This spcifies whether or not the listener is for IPv4 or IPv6. The `"port"` and `"address"` fields specify the port and address to bind to.
Lastly the domain should be the publicly facing address/domain and port pair for your mail server. It is used when generating `from` field in outgoing mail as this isn't done on the client side but rather the server side. You want this to be a reachable address and port pairing
as replying to such an email recieved from such a domain should be possible.