Mercurial > lbo > hg > dnsoverrpc

changeset 5:2eff863290d5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add README files for client and server.
author Lewin Bormann <lbo@spheniscida.de>
date Thu, 01 Oct 2020 15:05:40 +0200
parents 0a6f3af05763
children 47d32e3a6b2a
files client/README server/README
diffstat 2 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/client/README	Thu Oct 01 15:05:40 2020 +0200
@@ -0,0 +1,7 @@
+The client acts as a DNS stub, wraps DNS requests into RPC requests. 
+
+Run `client --help` for an overview of its options.
+
+To encrypt requests, generate keys using `crpc-keygen` from the clusterrpc
+repository (https://github.com/dermesser/clusterrpc). Supply the public key to the client
+using the `--pubkeyfile` option.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/server/README	Thu Oct 01 15:05:40 2020 +0200
@@ -0,0 +1,9 @@
+The server receives RPC requests from the client(s), unwraps the DNS requests,
+and forwards them to a qualified resolver (such as 8.8.8.8 or your own).
+
+Use the `--help` option to see an overview of functionality.
+
+To encrypt requests, generate keys using `crpc-keygen` from the clusterrpc
+repository (https://github.com/dermesser/clusterrpc). Supply the public key to
+the client using the `--pubkeyfile` option, and both keys using the
+`--privkeyfile`/`--pubkeyfile` options.