From 550c114f276c06af82c93d22970e5ec4d5156bb3 Mon Sep 17 00:00:00 2001 From: amdavidson Date: Fri, 3 May 2019 11:51:12 -0400 Subject: [PATCH] Update readme Read me simplification and updates. --- README.md | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b008ade..af00009 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,21 @@ # IKEv2 VPN Server on Docker -Recipe to build [`gaomd/ikev2-vpn-server`](https://registry.hub.docker.com/u/gaomd/ikev2-vpn-server/) Docker image. +Recipe to build [`amdavidson/vpn-server`](https://registry.hub.docker.com/u/amdavidson/vpn-server/) Docker image. ## Usage ### 1. Start the IKEv2 VPN Server - docker run --privileged -d --name ikev2-vpn-server --restart=always -p 500:500/udp -p 4500:4500/udp gaomd/ikev2-vpn-server:0.3.0 + docker run --privileged -d --name vpn-server --restart=always -p 500:500/udp -p 4500:4500/udp amdavidson/vpn-server:latest ### 2. Generate the .mobileconfig (for iOS / macOS) - docker run --privileged -i -t --rm --volumes-from ikev2-vpn-server -e "HOST=vpn1.example.com" gaomd/ikev2-vpn-server:0.3.0 generate-mobileconfig > ikev2-vpn.mobileconfig + docker run --privileged -i -t --rm --volumes-from vpn-server -e "HOST=vpn1.example.com" amdavidson/vpn-server:latest generate-mobileconfig > ikev2-vpn.mobileconfig -*Be sure to replace `vpn1.example.com` with your own domain name and resolve it to you server's IP address. Simply put an IP address is supported as well (and enjoy an even faster handshake speed).* +*Be sure to replace `vpn1.example.com` with your own domain name and resolve it to you server's IP address. Transfer the generated `ikev2-vpn.mobileconfig` file to your local computer via SSH tunnel (`scp`) or any other secure methods. -### 3. Install the .mobileconfig (for iOS / macOS) - -- **iOS 9 or later**: AirDrop the `.mobileconfig` file to your iOS 9 device, finish the **Install Profile** screen; - -- **macOS 10.11 El Capitan or later**: Double click the `.mobileconfig` file to start the *profile installation* wizard. - -## Technical Details - -Upon container creation, a *shared secret* was generated for authentication purpose, no *certificate*, *username*, or *password* was ever used, simple life! - ## License Copyright (c) 2016 Mengdi Gao, This software is licensed under the [MIT License](LICENSE). - ---- - -\* IKEv2 protocol requires iOS 8 or later, macOS 10.11 El Capitan or later. - -\* Install for **iOS 8 or later** or when your AirDrop fails: Send an E-mail to your iOS device with the `.mobileconfig` file as attachment, then tap the attachment to bring up and finish the **Install Profile** screen.