summaryrefslogtreecommitdiff
path: root/plugin/examples/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/examples/README')
-rw-r--r--plugin/examples/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugin/examples/README b/plugin/examples/README
new file mode 100644
index 0000000..4400cd3
--- /dev/null
+++ b/plugin/examples/README
@@ -0,0 +1,16 @@
+OpenVPN plugin examples.
+
+Examples provided:
+
+simple.c -- using the --auth-user-pass-verify callback, verify
+ that the username/password is "foo"/"bar".
+
+To build:
+
+ ./build simple (Linux/BSD/etc.)
+ ./winbuild simple (MinGW on Windows)
+
+To use in OpenVPN, add to config file:
+
+ plugin simple.so (Linux/BSD/etc.)
+ plugin simple.dll (MinGW on Windows)