Rewrite README to make it less error-prone, closes #1

This commit is contained in:
Mengdi Gao 2015-05-03 23:59:39 +08:00
parent 717ea94e3e
commit 5f55084c73

View file

@ -2,24 +2,16 @@
Recipe to build [`gaomd/ikev2-vpn-server`](https://registry.hub.docker.com/u/gaomd/ikev2-vpn-server/) Docker image.
## Start the IKEv2 VPN Server
## 1. Start the IKEv2 VPN Server
CONTAINER_ID=$(docker run -d --privileged \
-p 500:500/udp -p 4500:4500/udp \
gaomd/ikev2-vpn-server)
docker run -d --name ikev2-vpn-server --privileged -p 500:500/udp -p 4500:4500/udp gaomd/ikev2-vpn-server
## Generate .mobileconfig file for iOS 8
## 2. Generate a .mobileconfig file for iOS 8
IKEv2 protocol requires iOS 8 or later, Mac OS X 10.10 (Yosemite) is not supported yet.
*Replace `vpn1.yourdomain.tld` with your own domain name and make sure it resolves to you server's IP address.*
# Fill in you actual domain name,
# and make sure it resolves to you server's IP address.
export HOST="vpn1.example.com"
docker run -i -t --rm --volumes-from ikev2-vpn-server -e "HOST=vpn1.example.com" gaomd/ikev2-vpn-server generate-mobileconfig > ikev2-vpn.mobileconfig
docker run -i -t --rm --volumes-from ${CONTAINER_ID} \
-e "HOST=${HOST}" gaomd/ikev2-vpn-server \
generate-mobileconfig > "${HOST}.mobileconfig"
This will generate an `ikev2-vpn.mobileconfig` file, transfer it your local computer via SSH tunnel (`scp`) or any other secure methods, then E-mail it to your iOS 8 devices via E-mail attachment.
After you've generated the `*.mobileconfig` file, firstly, transfer it your local computer via SSH tunnel (`scp`) or any other secure methods.
You may now open this file on your iOS 8 device (via E-mail attachment or AirDrop?, etc).
*IKEv2 protocol requires iOS 8 or later, Mac OS X 10.10 (Yosemite) is not supported yet.*