aboutsummaryrefslogtreecommitdiffstats
path: root/README.poc0.md
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordberg.se>2019-04-05 09:48:02 +0200
committerLinus Nordberg <linus@nordberg.se>2019-04-05 09:48:02 +0200
commit97c97256af039b525b00cd5e12f8a756f2e98e16 (patch)
treea5cff928d5a4ea8d9c11f6cb08a04bd4c668fb32 /README.poc0.md
parentclarify TODO (diff)
downloadwg-dynamic-97c97256af039b525b00cd5e12f8a756f2e98e16.tar.xz
wg-dynamic-97c97256af039b525b00cd5e12f8a756f2e98e16.zip
add README
Diffstat (limited to '')
-rw-r--r--README.poc0.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.poc0.md b/README.poc0.md
new file mode 100644
index 0000000..a78753a
--- /dev/null
+++ b/README.poc0.md
@@ -0,0 +1,50 @@
+# wg-dynamic poc0 warning
+
+wg-dynamic ln/poc0 is unreleased code. It has not been reviewed. It's
+full of bugs.
+
+This code is meant for very early integration testing. Beware that any
+and all of the interfaces for interacting with wg-dynamic may change.
+
+# Building
+
+Download and build
+
+ git clone -b ln/poc0 https://git.zx2c4.com/wg-dynamic
+ cd wg-dynamic
+ make
+
+# Running a server on wg0
+
+Configure server side wg0 to have fe80::/64:
+
+ ip addr add fe80::/64 dev wg0
+
+Start wg-dynamic-server:
+
+ ./wg-dynamic-server wg0
+
+# Running a client on wg0
+
+NOTE: In order to run client and server on the same host, see
+IP-NETNS(8) and tests/netsh.sh.
+
+Configure client side wg0 to have an address with prefix length 128 in
+fe80::/64 and make sure that the server can be reached. Example:
+
+ ip addr add fe80::badc:ffe:e0dd:f00d/128 dev wg0
+ ip route add fe80::/128 dev wg0
+
+Start wg-dynamic-client:
+
+ ./wg-dynamic-client wg0
+
+# Known limitations
+
+- No running in the background like real daemons.
+
+- No real IP allocation from a pool -- the server simply replies with
+ whatever the client asks for, or predefined addresses (192.168.47.11
+ / fd00::badc:0ffe:e) in case client has no suggestions.
+
+- Server does not expire leases.