diff --git a/docs/CLIENT.md b/docs/CLIENT.md index af9dcbd..a44d4be 100644 --- a/docs/CLIENT.md +++ b/docs/CLIENT.md @@ -1,17 +1,17 @@ -### Client installation +# Client installation It's possible to deploy an ipsec connection on Linux clients. Supported distributives are: Debian, Ubuntu, CentOS, Fedora The playbook is `deploy_client.yml` -Required variables: +### Required variables: * client_ip - the IP address of your client machine (You can use `localhost` in order to deploy locally) * vpn_user - the username. (Ensure that you have valid certificates and keys in the `configs/SERVER_ip/pki/` directory) * client_ssh_user - the username that we need to use in order to connect to the client machine via SSH (ignore if you are deploying locally) * server_ip - the vpn server ip address -Example: +### Example: `ansible-playbook deploy_client.yml -e 'client_ip=client.com vpn_user=jack server_ip=vpn-server.com server_ssh_user=root'`