update README with release data.

master
Thurloat 6 years ago
parent a87cf85ea4
commit 573187b6c9
  1. 46
      README.md

@ -22,6 +22,44 @@ proxy server from sources they actually trust.
## Running the server
### From release
Current release is `0.1.0`, and is distributed via WebTorrent at
[magnet:?xt=urn:btih:0744fca4677180d58c1f04e58b7ac8fd5c061c91&dn=dough-0.1.0.tgz](https://instant.io/#0744fca4677180d58c1f04e58b7ac8fd5c061c91)
```
# extract the server .
$ tar zxvf dough-0.1.0.tgz
dough-0.1.0/
dough-0.1.0/dough.toml
dough-0.1.0/dough.sig
dough-0.1.0/dough
$ cd dough-0.1.0/
# verify it's the real deal.
$ keybase pgp verify -S thurloat -d dough.sig -i dough
▶ INFO Identifying thurloat
✔ public key fingerprint: 654D 176F 7C3F 7A1E F9A8 E78E 9899 F753 371E 6129
✔ ...
Signature verified. Signed by thurloat X hours ago (2018-09-12 11:28:39 -0300 ADT).
PGP Fingerprint: 654d176f7c3f7a1ef9a8e78e9899f753371e6129.
# or
$ gpg --verify dough.sig dough
# copy the configuration to ~/.config
$ cp dough.toml ~/.config
# run the server
./dough foreground
```
### Compile your own release from source
You can compile and run a release by executing the following.
```
@ -44,11 +82,19 @@ DNS Proxying to 37.235.1.174
```
### Run in development mode
```
$ mix deps.get
$ mix run --no-halt
```
Feel free to edit the config file at `~/.config/dough.toml` to configure it to
use your favourite DNS provider as the proxy. By default, it's configured to
use [OpenNIC](https://www.opennic.org/) DNS servers for maximum freedom (as in
birds).
## Configure Firefox
The quickest way to configure firefox is to visit `about:config`, then search

Loading…
Cancel
Save