aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2018-10-01 16:04:46 +0200
committerFlorian Bruhin <me@the-compiler.org>2018-10-01 16:06:19 +0200
commit4caa19cccb6aa3045b897abac2b7c8d28d55687f (patch)
tree7e474f275897c52dae6b402f338454fe652ab595
parent73c8b42ba7af9a2f060eb3c6ddc510578bc3c938 (diff)
downloadhsrvpn-4caa19cccb6aa3045b897abac2b7c8d28d55687f.tar.gz
hsrvpn-4caa19cccb6aa3045b897abac2b7c8d28d55687f.zip
Add readme
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0aa1b96
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Swivel-VPNs without Swivel \o/
+
+General workflow:
+
+1) Run `hsrvpn-getsecret` to obtain a secret based on the rollout email.
+ Alternatively, obtain it via mitmproxy from the phone app, and run:
+ `keyring set hsrvpn-gettokens <username>` to set it.
+
+2) Run `hsrvpn-gettokens <username>` to get 100 tokens based on the secret.
+
+3) Use `keyring set openhsr-connect <username>` to set your HSR password
+ (unless you use OpenHSR connect already).
+
+4) Run `hsrvpn <username>` to connect, or `hsrvpn-showtoken <username>` to
+ show a single token.